Wiresk

Wiresk

Xero – history Note, Attachment

Estimated reading time: 4 min

What your automation will do…

A connection to your Xero account is needed so we can sync it with our platform.
Refer to Xero – Connection
You can include between 1 and 255 Methods to build complex Flows.
XERO Xero - history Note, Attachment

Notes are the only type of Change that can be manually created. All other types of Change are created automatically when certain actions occur (e.g. an invoice is paid).

The note will be displayed in history & notes showing the date of creation and “System Generated” as the user that created it.

⚠️ It’s not possible to update history and notes.
Use this Method to add a Note to a Document (record) by specifying the IDs.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Add Note to Record
Connection*Select your connection or create one.
Entity*
(Set of data that contain records)		Select the available Entities to retrieve records from:

Invoice, Payment, Batch Payment, Contact, Bank Transaction, Credit Note, Quote, Manual Journal, Item, Purchase Order
MAP FIELDS [+ Add Field] Add addiotnal fields: Tenant
Entities Invoice: specify the Invoice ID.
Payment: specify the Payment ID.
Batch Payment: specify the Batch Payment ID.
Contact: specify the Contact ID.
Bank Transaction: specify the Bank Transaction ID.
Credit Note: specify the Credit Note ID.
Quote: specify the Quote ID.
Manual Journal: specify the Manual Journal ID.
Item: specify the Item ID.
Purchase Order: specify the Purchase Order ID.
History Records*[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional History Records can be added as elements.

Element 1: Represents the first History Record.
Details*: Add the Note.
ADDITIONAL FIELDS
Tenant
Available in All entities.		Optionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.

(*) required field

Example of creating a note against payment 
PUT https://api.xero.com/api.xro/2.0/Payments/{Guid}/History
{
  "HistoryRecords": [
    {
      "Details": "Note added by Wiresk"
    }
    ...
  ]
}
Example of response 
{
  "DateUTCString": "2025-03-05T09:54:20",
  "DateUTC": "/Date(1741168460543)/",
  "Details": "test note wiresk",
  "ValidationErrors": []
}
Use this Method to add a Note to a Document (record) by specifying the IDs.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Get Record Notes
Connection*Select your connection or create one.
Entity*
(Set of data that contain records)		Select the available Entities to retrieve records from:

Invoice, Payment, Batch Payment, Contact, Bank Transaction, Bank Transfer, Credit Note, Quote, Manual Journal, Item, Purchase Order
MAP FIELDS [+ Add Field] Add addiotnal fields: Tenant
Entities Invoice: specify the Invoice ID.
Payment: specify the Payment ID.
Batch Payment: specify the Batch Payment ID.
Contact: specify the Contact ID.
Bank Transaction: specify the Bank Transaction ID.
Bank Transfer: specify the Bank Transfer ID.
Credit Note: specify the Credit Note ID.
Quote: specify the Quote ID.
Manual Journal: specify the Manual Journal ID.
Item: specify the Item ID.
Purchase Order: specify the Purchase Order ID.
Tenant
Available in All entities.		Optionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.

(*) required field

Example of response from Get Invoice Note 
[
  {
    "Changes": "Note",
    "DateUTCString": "2025-03-05T09:54:20",
    "DateUTC": "/Date(1741168460523+0000)/",
    "User": "System Generated",
    "Details": "test note wiresk"
  },
  {
    "Changes": "Approved",
    "DateUTCString": "2025-02-17T01:37:59",
    "DateUTC": "/Date(1739756279057+0000)/",
    "User": "Wiresk Business",
    "Details": ""
  },
  {
    "Changes": "Created",
    "DateUTCString": "2025-02-17T01:37:58",
    "DateUTC": "/Date(1739756278057+0000)/",
    "User": "Wiresk Business",
    "Details": ""
  }
]
Use this Method to download an Attachment. The attachment will be returned in Base64 encoded, to save the attachment, you will need to decode the file. refer to Base64 encoding documentation.

See Xero Attachment API Reference.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Download Attachment
Connection*Select your connection or create one.
Entity*
(Set of data that contain records)		Select the available Entities to retrieve records from:

Invoice, Payment, Batch Payment, Contact, Bank Transaction, Bank Transfer, Credit Note, Quote, Manual Journal, Item, Purchase Order
MAP FIELDS [+ Add Field] Add addiotnal fields: Tenant
In Entities* Invoice: specify the Invoice ID.
Payment: specify the Payment ID.
Batch Payment: specify the Batch Payment ID.
Contact: specify the Contact ID.
Bank Transaction: specify the Bank Transaction ID.
Bank Transfer: specify the Bank Transfer ID.
Credit Note: specify the Credit Note ID.
Quote: specify the Quote ID.
Manual Journal: specify the Manual Journal ID.
Item: specify the Item ID.
Purchase Order: specify the Purchase Order ID.
Attachment ID* Provide the attachment ID. Get the ID from Method “Get attachment“.
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Enter the search.
if not Found Consider asSuccess – When the record is not found during execution, the system does not treat this as an error. Instead, it considers the operation successful and continues with the workflow.
Failed – Wiresk treats this as an error or failure. The workflow stops or takes a predefined failure action.

(*) required field

Sample response on success 
{
  "file": {
    "filename": "file.png",
    "extension": "png",
    "content": "<base64 encoded content string>"
  }
}
Use this Method to retrieve a list of attachments that have been uploaded against a document.

See Xero Attachment API Reference.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature.
Name*Get Attachment
Connection*Select your connection or create one.
Entity*
(Set of data that contain records)		Select the available Entities to retrieve records from:

Invoice, Account, Contact, Bank Transaction, Bank Transfer, Credit Note, Quote, Manual Journal, Purchase Order.
MAP FIELDS [+ Add Field] Add addiotnal fields: Tenant
Entities Invoice: specify the Invoice ID.
Account: specify the Account ID.
Contact: specify the Contact ID.
Bank Transaction: specify the Bank Transaction ID.
Bank Transfer: specify the Bank Transfer ID.
Credit Note: specify the Credit Note ID.
Quote: specify the Quote ID.
Manual Journal: specify the Manual Journal ID.
Purchase Order: specify the Purchase Order ID.
Tenant
Available in All entities.		Optionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.

(*) required field

Example of response from Get Attachment 
{
  "Attachments": [
    {
      "AttachmentID": "e59a2c7f-1306-4078-a0f3-73537afcbba9",
      "FileName": "Image00394.png",
      "Url": "https://api.xero.com/api.xro/2.0/Receipts/220ddca8-3144-4085-9a88-2d72c5133734/Attachments/Image00394.png",
      "MimeType": "image/png",
      "ContentLength": "10294"
    }
  ]
}

Once your Flow is configured, you can test or automate it using the Run panel or by managing Triggers from the Flow Management screen.

  • Run Flow: Manually runs the Flow once using sample data. Ideal for testing logic and field mapping. See How to Run a Flow.
  • Run Scheduler: Force-runs the Trigger immediately using live input. This bypasses the recurrence rule and is useful for verifying real data mapping. Learn more in Wiresk Scheduler – The Fundamentals.

From the Trigger management panel (clock icon), you can:

  • Activate or deactivate Triggers
  • Force-run the scheduler
  • Copy Routing Keys (for HTTP Triggers)

If your Flow uses a Webhook Trigger, it runs automatically on each incoming webhook—no scheduler required. It remains active until you manually deactivate it.