PureBasic

Xero Download Attachment for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to download a particular attachment for a particular Xero item. PureBasic

IncludeFile "CkBinData.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/xero-access-token.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    ; Replace the value here with an actual tenant ID obtained from this example:
    ; Get Xero Tenant IDs
    CkHttp::ckSetRequestHeader(http,"Xero-tenant-id","83299b9e-5747-4a14-a18a-a6c94f824eb7")

    CkHttp::setCkAccept(http, "application/json")

    ; The example to list Xero attachments shows how to get attachment information.
    ; Here's a sample JSON response obtained form listing attachments:
    ; Your application can get the AttachmentID's and filenames from it.

    ; {
    ;   "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
    ;     }
    ;   ]
    ; }

    url.s = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/{$AttachmentId}"

    ; Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    CkHttp::ckSetUrlVar(http,"Endpoint","Invoices")

    ; Guid is the ID of the item, such as the InvoiceID.
    CkHttp::ckSetUrlVar(http,"Guid","0032f627-3156-4d30-9b1c-4d3b994dc921")

    ; AttachmentId is the ID of the particular attachment to be downloaded
    CkHttp::ckSetUrlVar(http,"AttachmentId","daf106e2-8634-4349-bfcc-86c1df0793b2")

    ; Download the attachment data into bd.
    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetBd(http,url,bd)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkBinData::ckDispose(bd)
        ProcedureReturn
    EndIf

    Debug "Response Status Code: " + Str(CkHttp::ckLastStatus(http))

    If CkHttp::ckLastStatus(http) = 200
        ; Success
        ; Save to a file..
        success = CkBinData::ckWriteFile(bd,"qa_output/penguines.jpg")
    Else
        ; Failed.  bd contains error information..
        Debug CkBinData::ckGetString(bd,"utf-8")
    EndIf



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonToken)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure