younifyd
Menu

Create Credit Note Attachment By File Name

Creates an attachment for a specific credit note

PUT/CreditNotes/{CreditNoteID}/Attachments/{FileName}

Use it in a workflow

  1. Add a step and choose the Xero connector.
  2. Pick the Create Credit Note Attachment By File Name action (under Xero).
  3. Fill in the fields below, then reference the result from later steps as {{createCreditNoteAttachmentByFileName.response.data}}.

Request

Path parameters

CreditNoteIDstring (uuid)required

Unique identifier for a Credit Note

FileNamestringrequired

Name of the attachment

Query parameters

IncludeOnlineboolean

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

Default false

Headers

xero-tenant-idstringrequired

Xero identifier for Tenant

Idempotency-Keystring

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

Response

Returns 200 with an object. Read it in later steps with {{createCreditNoteAttachmentByFileName.response.data.<field>}}.

Attachmentsarray<object>
AttachmentIDstring (uuid)

Unique ID for the file

FileNamestring

Name of the file

Urlstring

URL to the file on xero.com

MimeTypestring

Type of file

ContentLengthinteger

Length of the file content

IncludeOnlineboolean

Include the file with the online invoice

json
{
  "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",
      "ContentLength": 0,
      "IncludeOnline": false
    }
  ]
}

Need more? See the Xero guide for connection setup and behaviour shared by every action.

Create Credit Note Attachment By File Name — Xero — Documentation