SQL Server

Xero List Attachments for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to get information about the attachments for a particular Xero item. 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

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

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

    DECLARE @jsonToken int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT

    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/xero-access-token.json'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @jsonToken, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @jsonToken
        RETURN
      END

    EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
    EXEC sp_OASetProperty @http, 'AuthToken', @sTmp0

    -- Replace the value here with an actual tenant ID obtained from this example:
    -- Get Xero Tenant IDs
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Xero-tenant-id', '83299b9e-5747-4a14-a18a-a6c94f824eb7'

    EXEC sp_OASetProperty @http, 'Accept', 'application/json'

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/'

    -- Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'Endpoint', 'Invoices'

    -- Guid is the ID of the item, such as the InvoiceID.
    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'Guid', '0032f627-3156-4d30-9b1c-4d3b994dc921'

    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @http, 'HttpNoBody', @success OUT, 'GET', @url, @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END


    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT 'Response Status Code: ' + @iTmp0

    DECLARE @jsonResponse int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonResponse OUT

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @jsonResponse, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @jsonResponse, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonResponse, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @jsonResponse
        RETURN
      END

    -- Sample response:
    -- 
    -- Use the this online tool to generate parsing code from sample JSON: 
    -- Generate Parsing Code from JSON

    -- {
    --   "Id": "24bfbcb9-dec9-4d33-835c-8f165d776766",
    --   "Status": "OK",
    --   "ProviderName": "Chilkat2222",
    --   "DateTimeUTC": "\/Date(1587213296972)\/",
    --   "Attachments": [
    --     {
    --       "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
    --       "FileName": "penguins.jpg",
    --       "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
    --       "MimeType": "image/jpg",
    --       "ContentLength": 777835
    --     }
    --   ]
    -- }

    DECLARE @AttachmentID nvarchar(4000)

    DECLARE @FileName nvarchar(4000)

    DECLARE @v_Url nvarchar(4000)

    DECLARE @MimeType nvarchar(4000)

    DECLARE @ContentLength int

    DECLARE @Id nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @Id OUT, 'Id'
    DECLARE @Status nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @Status OUT, 'Status'
    DECLARE @ProviderName nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @ProviderName OUT, 'ProviderName'
    DECLARE @DateTimeUTC nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @DateTimeUTC OUT, 'DateTimeUTC'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @count_i OUT, 'Attachments'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jsonResponse, 'I', @i
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @AttachmentID OUT, 'Attachments[i].AttachmentID'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @FileName OUT, 'Attachments[i].FileName'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @v_Url OUT, 'Attachments[i].Url'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @MimeType OUT, 'Attachments[i].MimeType'
        EXEC sp_OAMethod @jsonResponse, 'IntOf', @ContentLength OUT, 'Attachments[i].ContentLength'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @jsonResponse


END
GO