Java

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. Chilkat2 Java

import com.chilkatsoft.chilkat2.BinData;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.JsonObject;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Http http = new Http();

        JsonObject jsonToken = new JsonObject();
        try {
            jsonToken.loadFile("qa_data/tokens/xero-access-token.json");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        http.setAuthToken(jsonToken.stringOf("access_token"));

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

        http.setAccept("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
        //     }
        //   ]
        // }

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

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

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

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

        // Download the attachment data into bd.
        BinData bd = new BinData();
        try {
            http.quickGetBd(url, bd);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Response Status Code: " + http.getLastStatus());

        if (http.getLastStatus() == 200) {
            // Success
            // Save to a file..
            bd.writeFile("qa_output/penguines.jpg");
        } else {
            // Failed.  bd contains error information..
            System.out.println(bd.getString("utf-8"));
        }
    }
}