C

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

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkBinData.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttp http;
    HCkJsonObject jsonToken;
    const char *url;
    HCkBinData bd;

    success = FALSE;

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

    http = CkHttp_Create();

    jsonToken = CkJsonObject_Create();
    success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/xero-access-token.json");
    if (success == FALSE) {
        printf("%s\n",CkJsonObject_lastErrorText(jsonToken));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        return;
    }

    CkHttp_putAuthToken(http,CkJsonObject_stringOf(jsonToken,"access_token"));

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

    CkHttp_putAccept(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 = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/{$AttachmentId}";

    // Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    CkHttp_SetUrlVar(http,"Endpoint","Invoices");

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

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

    // Download the attachment data into bd.
    bd = CkBinData_Create();
    success = CkHttp_QuickGetBd(http,url,bd);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        CkBinData_Dispose(bd);
        return;
    }

    printf("Response Status Code: %d\n",CkHttp_getLastStatus(http));

    if (CkHttp_getLastStatus(http) == 200) {
        // Success
        // Save to a file..
        success = CkBinData_WriteFile(bd,"qa_output/penguines.jpg");
    }
    else {
        // Failed.  bd contains error information..
        printf("%s\n",CkBinData_getString(bd,"utf-8"));
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(jsonToken);
    CkBinData_Dispose(bd);

    }