XExeroapi
Accounting

Creates an attachment for a specific invoice or purchase bill by filename

put/Invoices/{InvoiceID}/Attachments/{FileName}

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/Attachments/{FileName}
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.attachments

Path parameters

InvoiceIDstring uuid required

Unique identifier for an Invoice

FileNamestring required

Name of the attachment

Query parameters

IncludeOnlineboolean

Allows an attachment to be seen by the end customer within their online invoice

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body application/octet-stream

string byte required

Response

Success - return response of type Attachments array with newly created Attachment

Example response

{
  "Attachments": [
    {
      "AttachmentID": "00000000-0000-0000-0000-000000000000",
      "FileName": "xero-dev.jpg",
      "Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
      "MimeType": "image/jpg"
    }
  ]
}

Changes

No recorded changes to this operation across all 62 revisions of this API.