v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01235140905.8 KB
Accounting

Creates an attachment for a specific credit note

put/CreditNotes/{CreditNoteID}/Attachments/{FileName}

Path parameters

CreditNoteIDstring uuid required

Unique identifier for a Credit Note

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.

Response

Success - return response of type Attachments array with newly created Attachment for specific Credit Note

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"
    }
  ]
}