SQL Server

Xero Build Hashtable of Account Codes

To create a new account, a unique and unused account Code would need to be selected. How do we know what account Codes already exist? One way of finding out is to download the complete set of Accounts every time. Another way is to download once, and keep a local hash table of the account Codes. This makes it possible to find a new and unused Code without having to continually fetch data from the Xero server.

Note: Requires Chilkat v9.5.0.64 or greater.

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- Note: Requires Chilkat v9.5.0.64 or greater.

    -- This requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Before sending REST API calls, the REST object needs to be
    -- initialized for OAuth1.
    -- See Xero 2-Legged OAuth1 Setup for sample code.

    -- Assuming the REST object's OAuth1 authenticator is setup, and the initial
    -- connection was made, we may now send REST HTTP requests..

    -- -----------------------------------------------------
    -- Get the full list of accounts.
    DECLARE @sbXml int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbXml OUT

    EXEC sp_OAMethod @rest, 'FullRequestNoBodySb', @success OUT, 'GET', '/api.xro/2.0/Accounts', @sbXml
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbXml
        RETURN
      END

    -- A 200 response is expected for actual success.
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        EXEC sp_OAMethod @sbXml, 'GetAsString', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbXml
        RETURN
      END

    -- Iterate over the accounts, and build a Hashtable where the
    -- key is the account Code, and the value is the XML record for the account.
    DECLARE @htAccounts int
    EXEC @hr = sp_OACreate 'Chilkat.Hashtable', @htAccounts OUT

    DECLARE @bAutoTrim int
    SELECT @bAutoTrim = 0
    DECLARE @xml int
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT

    EXEC sp_OAMethod @xml, 'LoadSb', @success OUT, @sbXml, @bAutoTrim
    EXEC sp_OASetProperty @xml, 'EmitXmlDecl', 0
    EXEC sp_OASetProperty @xml, 'EmitCompact', 1

    -- How many accounts exist?
    DECLARE @numAccounts int
    EXEC sp_OAMethod @xml, 'NumChildrenAt', @numAccounts OUT, 'Accounts'

    PRINT 'numAccounts = ' + @numAccounts

    DECLARE @i int
    SELECT @i = 0
    WHILE @i < @numAccounts
      BEGIN
        EXEC sp_OASetProperty @xml, 'I', @i
        DECLARE @hashKey nvarchar(4000)
        EXEC sp_OAMethod @xml, 'GetChildContent', @hashKey OUT, 'Accounts|Account[i]|Code'
        -- Update the xml object's internal reference to the i'th account record.
        DECLARE @notUsed nvarchar(4000)
        EXEC sp_OAMethod @xml, 'ChilkatPath', @notUsed OUT, 'Accounts|Account[i]|$'


        PRINT 'hash key = ' + @hashKey
        IF @i < 5
          BEGIN
            -- Show a few of the values..
            EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
            PRINT @sTmp0
          END
        EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
        EXEC sp_OAMethod @htAccounts, 'AddStr', @success OUT, @hashKey, @sTmp0

        -- Update the xml object's internal reference to the XML root node.
        EXEC sp_OAMethod @xml, 'GetRoot2', NULL
        SELECT @i = @i + 1
      END

    -- At this point the Hashtable is built.
    -- Save the Hashtable to a file.  This will be used in subsequent requests
    -- when we need to find a unique/unused Code, or if we want to get
    -- the account information from the local hash table.
    DECLARE @htXmlSb int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @htXmlSb OUT

    EXEC sp_OAMethod @htAccounts, 'ToXmlSb', @success OUT, @htXmlSb
    EXEC sp_OAMethod @htXmlSb, 'WriteFile', @success OUT, 'qa_cache/xero_accounts_by_code.xml', 'utf-8', 0


    PRINT 'success = ' + @success

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @sbXml
    EXEC @hr = sp_OADestroy @htAccounts
    EXEC @hr = sp_OADestroy @xml
    EXEC @hr = sp_OADestroy @htXmlSb


END
GO