DataFlex

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. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Handle hoJsonToken
    String sUrl
    Variant vResp
    Handle hoResp
    Handle hoJsonResponse
    String sAttachmentID
    String sFileName
    String sV_Url
    String sMimeType
    Integer iContentLength
    String sId
    String sStatus
    String sProviderName
    String sDateTimeUTC
    Integer i
    Integer iCount_i
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/xero-access-token.json" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoJsonToken To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Set ComAuthToken Of hoHttp To sTemp1

    // Replace the value here with an actual tenant ID obtained from this example:
    // Get Xero Tenant IDs
    Send ComSetRequestHeader To hoHttp "Xero-tenant-id" "83299b9e-5747-4a14-a18a-a6c94f824eb7"

    Set ComAccept Of hoHttp To "application/json"

    Move "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/" To sUrl

    // Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    Get ComSetUrlVar Of hoHttp "Endpoint" "Invoices" To iSuccess

    // Guid is the ID of the item, such as the InvoiceID.
    Get ComSetUrlVar Of hoHttp "Guid" "0032f627-3156-4d30-9b1c-4d3b994dc921" To iSuccess

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoResp to vResp
    Get ComHttpNoBody Of hoHttp "GET" sUrl vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln "Response Status Code: " iTemp1

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonResponse
    If (Not(IsComObjectCreated(hoJsonResponse))) Begin
        Send CreateComObject of hoJsonResponse
    End
    Get ComBodyStr Of hoResp To sTemp1
    Get ComLoad Of hoJsonResponse sTemp1 To iSuccess
    Set ComEmitCompact Of hoJsonResponse To False
    Get ComEmit Of hoJsonResponse To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iTemp1
    If (iTemp1 <> 200) Begin
        Showln "Failed."
        Procedure_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
    //     }
    //   ]
    // }

    Get ComStringOf Of hoJsonResponse "Id" To sId
    Get ComStringOf Of hoJsonResponse "Status" To sStatus
    Get ComStringOf Of hoJsonResponse "ProviderName" To sProviderName
    Get ComStringOf Of hoJsonResponse "DateTimeUTC" To sDateTimeUTC
    Move 0 To i
    Get ComSizeOfArray Of hoJsonResponse "Attachments" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJsonResponse To i
        Get ComStringOf Of hoJsonResponse "Attachments[i].AttachmentID" To sAttachmentID
        Get ComStringOf Of hoJsonResponse "Attachments[i].FileName" To sFileName
        Get ComStringOf Of hoJsonResponse "Attachments[i].Url" To sV_Url
        Get ComStringOf Of hoJsonResponse "Attachments[i].MimeType" To sMimeType
        Get ComIntOf Of hoJsonResponse "Attachments[i].ContentLength" To iContentLength
        Move (i + 1) To i
    Loop



End_Procedure