Dart Requires Chilkat v11.0.0+

Xero Upload Attachment

See more Xero Examples

Demonstrates how to upload an attachment to Xero. Dart

import 'package:chilkat/chilkat.dart';

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

  final http = CkHttp();

  // Important: Make sure your OAuth2 access token was obtained with the scope "accounting.attachments"
  // included in the list of scopes.

  final jsonToken = CkJsonObject();
  try {
    jsonToken.loadFile('qa_data/tokens/xero-access-token.json');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  http.authToken = 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.accept = 'application/json';

  final url = 'https://api.xero.com/api.xro/2.0/{\$Endpoint}/{\$Guid}/Attachments/{\$Filename}';

  // 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');

  // Filename is the filename of the attachment you are uploading.
  http.setUrlVar('Filename', 'penguins.jpg');

  // Load the file to be uploaded (from the local filesystem).
  final bd = CkBinData();
  try {
    bd.loadFile('qa_data/jpg/penguins.jpg');
  } on ChilkatException {
    print('Failed to load attachment file.');
    return;
  }

  // Indicate the content-type according to the file content type.
  // Common content-types are:   image/jpg, image/png, application/pdf, application/zip, application/msword
  // If you don't know, use application/octet-stream
  final resp = CkHttpResponse();
  try {
    http.httpBd('POST', url, bd, 'image/jpg', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Response Status Code: ${resp.statusCode}');

  final jsonResponse = CkJsonObject();
  jsonResponse.load(resp.bodyStr);
  jsonResponse.emitCompact = false;
  print(jsonResponse.emit());

  if (resp.statusCode != 200) {
    print('Failed.');
    return;
  }

  // A sample response:

  // Use this online tool to generate parsing code from sample JSON: 
  // Generate Parsing Code from JSON

  // {
  //   "Id": "35333c64-4449-457b-bf6a-1b64d538e3c7",
  //   "Status": "OK",
  //   "ProviderName": "Chilkat2222",
  //   "DateTimeUTC": "\/Date(1587212597758)\/",
  //   "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
  //     }
  //   ]
  // }
}