PowerBuilder

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

integer li_rc
long li_Success
oleobject loo_Http
oleobject loo_JsonToken
string ls_Url
oleobject loo_Bd

li_Success = 0

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")

li_Success = loo_JsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
if li_Success = 0 then
    Write-Debug loo_JsonToken.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    return
end if

loo_Http.AuthToken = loo_JsonToken.StringOf("access_token")

//  Replace the value here with an actual tenant ID obtained from this example:
//  Get Xero Tenant IDs
loo_Http.SetRequestHeader("Xero-tenant-id","83299b9e-5747-4a14-a18a-a6c94f824eb7")

loo_Http.Accept = "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
//      }
//    ]
//  }

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

//  Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
loo_Http.SetUrlVar("Endpoint","Invoices")

//  Guid is the ID of the item, such as the InvoiceID.
loo_Http.SetUrlVar("Guid","0032f627-3156-4d30-9b1c-4d3b994dc921")

//  AttachmentId is the ID of the particular attachment to be downloaded
loo_Http.SetUrlVar("AttachmentId","daf106e2-8634-4349-bfcc-86c1df0793b2")

//  Download the attachment data into bd.
loo_Bd = create oleobject
li_rc = loo_Bd.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_Http.QuickGetBd(ls_Url,loo_Bd)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_Bd
    return
end if

Write-Debug "Response Status Code: " + string(loo_Http.LastStatus)

if loo_Http.LastStatus = 200 then
    //  Success
    //  Save to a file..
    li_Success = loo_Bd.WriteFile("qa_output/penguines.jpg")
else
    //  Failed.  bd contains error information..
    Write-Debug loo_Bd.GetString("utf-8")
end if



destroy loo_Http
destroy loo_JsonToken
destroy loo_Bd