Wiresk

Wiresk

Xero – Create Records

Estimated reading time: 21 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 - Create Records
This unified Method is used to create various Records in a specific Entity.

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*Create Records
Connection*Select your connection or create one.
Entity*
(Set of data that contain records)		Select the available Entities to create records:

Invoice, Payment, Batch Payment, Contact, Bank Transaction, Bank Transfer, Credit Note, Quote, Manual Journal, Item, Purchase Order, Contact Groups, Employee, Asset, Asset Type, Tracking Category, Folder

(*) required field

Configuration tables for each Entity:

Use this Method to create an Invoice.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Invoice API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the invoice creation.
Additional fields: Tenant, Invoice Number, Reference, Date String, Date, Due Date String, Due Date, Status, Line Amount Types, Line Items, Url, Currency Code, Expected Payment Date, Planned Payment Date
Type*Select the Invoice Type:
Account receivable: A sales invoice – commonly known as an Accounts Receivable or customer invoice (ACCREC).
Account Payable : A bill – commonly known as an Accounts Payable or supplier invoice (ACCPAY).
Contact*Name*: Full name of contact/organization.

[+ Add Field] add more fields in Contact:
Contact ID: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

Email Address: Email address of contact person.
Bank Account Details: Bank account number.

Addresses [⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Address can be added as elements.
Element 1: Represents the first address.
_Address Type: If you do not specify an AddressType, Xero will treat the address as a STREET address by default. Possible values :
POBOX: For PO Box addresses.
STREET: For street addresses (default if no type is specified).
DELIVERY: For delivery addresses.

_Address Line 1 [+ Add Field] add more Address Line.
_City
_Region
_Postal Code
_Country

Phone [⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Phone can be added as elements.
Element 1: Represents the first Phone.
_Phone Type: If you do not specify a PhoneType, Xero will treat the phone number as a DEFAULT phone number. Possible values :
DEFAULT: The primary phone number (default if no type is specified).
MOBILE: For mobile phone numbers.
FAX: For fax numbers.
DDI: For direct dial-in numbers.

_Phone Number
_Phone Area Code
_Phone Country Code
Line Items*
At least one is required to create a complete Invoice.		[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Line can be added as elements.
Element 1: Represents the first Line.

Description*: Description of the line item (max length = 4000).
Unit Amount*: By default, unit amount will be rounded to two decimal places.
Quantity*: Line item Quantity.

[+ Add Field] add more fields in Line Items:

Tax Type: Used as an override if the default Tax Code for the selected Account Code is not correct – see TaxTypes.

Tax Amount: The tax amount is auto calculated as a percentage of the line amount based on the tax rate. You can change this value if the tax calculation is incorrect.

Line Amount: The line amount reflects the discounted price if a DiscountRate has been used i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) (can’t exceed 9,999,999,999.99 ).

Account Code: Customer defined alpha numeric account code e.g 200 or SALES.
specifies which revenue or expense account the credit note applies to.
Tip: Find the Account Code with the Method “Get Records” or “Find Records”, Entity “Account”.

Item Code: User defined item code.

Discount Amount
Discount Rate
Percentage discount or discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
Invoice Number
(max length = 255)		If your Invoice Type is ACCREC – Enter a Unique alpha numeric code identifying invoice ( when missing will auto-generate from your Organisation Invoice Settings).

If your Invoice Type is ACCPAY – Enter a non-unique alpha numeric code identifying invoice. This value will also display as Reference in the UI.
ReferenceACCREC only – additional reference number (max length = 255)
Date StringUse these fields if you are working with date strings that are not in the standard YYYY-MM-DD format.

The DateString and DueDateString fields accept dates in a human-readable string format (e.g., "1 January 2023" or "01/01/2023").
Xero will attempt to parse the string into a valid date.

If both Date and DateString (or DueDate and DueDateString) are provided, Xero will prioritize the Date and DueDate fields.
DateDate invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.
Due Date StringUse these fields if you are working with date strings that are not in the standard YYYY-MM-DD format.

The Date String and Due Date String fields accept dates in a human-readable string format (e.g., "1 January 2023" or "01/01/2023").
Xero will attempt to parse the string into a valid date.

If both Date and Date String (or Due Date and Due Date String) are provided, Xero will prioritize the Date and DueDate fields.
Due DateDate invoice is due – YYYY-MM-DD
StatusPossible values : Draft – Submitted – Authorized
For more details, refer to Invoice Status.
Line Amount TypesLine amounts are exclusive of tax by default if you don’t specify this element.

Possible values:
Exclusive: Line items are exclusive of tax
Inclusive: Line items are inclusive tax
NoTax: Line have no tax
UrlURL link to a source document – shown as “Go to [appName]” in the Xero app.
Currency codeThe currency that invoice has been raised in (see List of Currencies).
Expected Payment DateShown on sales invoices (Accounts Receivable) when this has been set.
Planned Payment DateShown on bills (Accounts Payable) when this has been set.

(*) required field

Example of a sales (ACCREC)

Invoice with every single element being specified:

{
  "Invoices": [
    {
      "Type": "ACCREC",
      "Contact": {
        "ContactID": "eaa28f49-6028-4b6e-bb12-d8f6278073fc"
      },
      "DateString": "20025-09-08T00:00:00",
      "DueDateString": "20025-10-20T00:00:00",
      "ExpectedPaymentDate": "2009-10-20T00:00:00",
      "InvoiceNumber": "OIT:01065",
      "Reference": "Ref:SMITHK",
      "BrandingThemeID": "3b148ee0-adfa-442c-a98b-9059a73e8ef5",
      "Url": "http://www.accounting20.com",
      "CurrencyCode": "NZD",
      "Status": "SUBMITTED",
      "LineAmountTypes": "Inclusive",
      "SubTotal": "87.11",
      "TotalTax": "10.89",
      "Total": "98.00",
      "LineItems": [
        {
          "ItemCode": "Test 01",
          "Description": "3 copies of OS X 10.6 Snow Leopard",
          "Quantity": "3.0000",
          "UnitAmount": "59.00",
          "TaxType": "OUTPUT",
          "TaxAmount": "19.67",
          "LineAmount": "177.00",
          "AccountCode": "200",
          "Tracking": [
            {
              "TrackingCategoryID": "e2f2f732-e92a-4f3a-9c4d-ee4da0182a13",
              "Name": "Region",
              "Option": "North"
            }
          ]
        },
        {
          "ItemCode": "Test 02",
          "Description": "Returned Apple Keyboard with Numeric Keypad (faulty)",
          "Quantity": "1.0000",
          "UnitAmount": "-79.00",
          "TaxType": "OUTPUT",
          "TaxAmount": "-8.78",
          "LineAmount": "-79.00",
          "AccountCode": "200"
        }
      ]
    }
  ]
}
Use this Method to create a Payment.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Payment API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Payment creation.
Additional fields: Tenant, Payment ID, Reference.
Invoice*Invoice ID*: Unique Identifier of the invoice you are applying payment to.
You can Look up the value by select Input > Lookup tab > Select Search button to display a list.
Account*Account ID*: Specify the unique identifier of the account from which the payment will be made, or Look up the value by select Input > Lookup tab > Select Search button to display a list.
Ensure that this account is either a BANK account or has the ‘enable payments’ setting activated.

⚠️ Provide either Account ID or Code.

[+ Add Field] add more fields
Code*: Code of account you are using to make the payment e.g. 001 ( note: not all accounts have a code value).
Date*Date the payment is being made (YYYY-MM-DD).
Amount*The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
ReferenceAn optional description for the payment e.g. Direct Debit

(*) required field

Example of request from Create Payment

Using Account Code:


{
  "Invoice": {
    "InvoiceID": "00000000-0000-0000-0000-000000000000"
  },
  "Account": {
    "Code": "001"
  },
  "Date": "2025-10-01",
  "Amount": 100.00,
  "Reference": "Payment for invoice 123"
}
Use this Method to create a Batch Payments.

Batch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement.

▪️ You can only make batch payments in the organisation base currency
▪️ You can’t create a batch payment with a mixture of sales invoices and bills
▪️ You can’t include credit notes, prepayments or overpayments on batch payments

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Batch Payment API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Batch Payment creation.
Additional fields: Tenant, Particulars, Code, Reference, Details, Narrative, Date.
Account ID*Specify the unique identifier of the account from which the payment will be made.

You can Look up the value by select Input > Lookup tab > Select Search button to display a list.

Ensure that this account is either a BANK account or has the ‘enable payments’ setting activated.
Payment*[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Line can be added as elements.

Element 1: Represents the first Payment.

Invoice ID*: Unique Identifier of the invoice you are applying payment to.
You can Look up the value by select Input > Lookup tab > Select Search button to display a list.

Amount*: The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice.

[+ Add Field] add more fields in Payment.
Bank Account Number: The suppliers bank account number the payment is being made to.
Particulars: (NZ Only) The information to appear on the supplier’s bank account and bank statement.
Code: (NZ Only) Optional references for the batch payment transaction.
Reference: (NZ Only) Optional references for the batch payment transaction.
Details: The information to appear on the supplier’s bank account.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
Particulars(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Max length =12.
Code(NZ Only) Optional references for the batch payment transaction.
Reference(NZ Only) Optional references for the batch payment transaction.
Details(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
Narrative(UK Only) Only shows on the statement line in Xero. Max length =18
DateDate the payment is being made (YYYY-MM-DD) e.g. 2018-09-06

(*) required field

Example of request from Create Batch Payment

Create an ACCPAY batch payment (NZ)

{
  "Date": "2018-08-01",
  "Particulars": "paying",
  "Code": "333",
  "Reference": "ddd",
  "Account": {
    "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c"
  },
  "Payments": [
    {
      "BankAccountNumber": "123-456-7890",
      "Particulars": "def",
      "Code": "543",
      "Reference": "ggg",
      "Invoice": {
        "InvoiceID": "d8ec835f-fef6-4d5c-ae41-28df59c57f11"
      },
      "Amount": "10"
    },
    {
      "BankAccountNumber": "123-456-7890",
      "Particulars": "abc",
      "Code": "123",
      "Reference": "fff",
      "Invoice": {
        "InvoiceID": "71d1c9ca-3e99-4ef5-8f44-19d24c500ac8"
      },
      "Amount": "10"
    }
  ]
}
Use this Method to create a Contact. Only a name is required to create a contact.

▪️ The business rules around contacts in Xero may be changing in the future and ‘Contact Name’ may no longer be a unique field.
▪️ We recommend all developers use ContactID to uniquely reference contacts in Xero and do not rely on ContactName as a way to reference contact data uniquely in Xero.


Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Contact API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Contact creation.
Additional fields: Tenant, FirstName, LastName, Contact Number, Email Address, Company Number, Addresses, Phones, Contact Persons, Bank Account Details, Tax Number, Accounts Receivable Tax Type, Accounts Payable Tax Type, IsSupplier, IsCustomer, Default Currency.
Name*Full name of contact/organisation (max length = 255)
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
FirstNameFirst name of contact person (max length = 255)
LastNameLast name of contact person (max length = 255)
Contact NumberThis field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.
Email AddressEmail address of contact person (umlauts (ä, ö, ü) not supported) (max length = 255)
Company NumberCompany registration number. Max 50 char.
Addresses[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Address can be added as elements.

Element 1: Represents the first address.
_Address Type: If you do not specify an AddressType, Xero will treat the address as a STREET address by default. Possible values :
POBOX: For PO Box addresses.
STREET: For street addresses (default if no type is specified).
DELIVERY: For delivery addresses.

_Address Line 1 [+ Add Field] add more Address Line.
_City
_Region
_Postal Code
_Country
Phones[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Phone can be added as elements.
Element 1: Represents the first Phone.
_Phone Type: If you do not specify a PhoneType, Xero will treat the phone number as a DEFAULT phone number. Possible values :
DEFAULT: The primary phone number (default if no type is specified).
MOBILE: For mobile phone numbers.
FAX: For fax numbers.
DDI: For direct dial-in numbers.

_Phone Number
_Phone Area Code
_Phone Country Code
Contact Persons
A contact can have a maximum of 5 Contact Persons.		[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Phone can be added as elements.

Element 1: Represents the first Contact person.

First Name
Last Name
Email Address
Include in Emails: True – False
To indicate whether contact should be included on emails with invoices etc.
Bank Account DetailsBank account number of contact.
Tax NumberTax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50).
Accounts Receivable Tax TypeDefault tax type used for contact on AR invoices.

This field is optional. If not provided, Xero will use the default tax type set in the organization’s settings.

The available tax types depend on your organization’s tax settings. You can view and manage tax types in the Xero UI under Settings > Tax Rates.
Accounts Payable Tax TypeDefault tax type used for contact on AP invoices.

This field is optional. If not provided, Xero will use the default tax type set in the organization’s settings.

The available tax types depend on your organization’s tax settings. You can view and manage tax types in the Xero UI under Settings > Tax Rates.
Default CurrencyRepresents the three-letter currency code (e.g., USD, EUR, GBP. See List of Currencies) that will be used as the default currency for the contact.

If not provided, Xero will use the organization’s default currency (as set in the Xero organization settings).

(*) required field

Example of request from Create Contact

Creating a contact record with additional contact people

{
  "Contacts": [
    {
      "Name": "24 locks",
      "FirstName": "Ben",
      "LastName": "Bowden",
      "EmailAddress": "ben.bowden@24locks.com",
      "ContactPersons": [
        {
          "FirstName": "John",
          "LastName": "Smith",
          "EmailAddress": "john.smith@24locks.com",
          "IncludeInEmails": "true"
        }
      ]
    }
  ]
}
Use this Method to create a Bank Transaction (spend money, receive money, spend prepayment, receive prepayment, spend overpayment or receive overpayment transactions).

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Bank Transaction API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Bank Transaction creation.
Additional fields: Tenant, Date, Reference, Currency Code, Currency rate, Url, LineAmountTypes.
Type*Bank Transaction Type, Possible values:
RECEIVE
RECEIVE-OVERPAYMENT
RECEIVE-PREPAYMENT
SPEND
SPEND-OVERPAYMENT
SPEND-PREPAYMENT
Contact*Contact ID*: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

[+ Add Field] add more fields in Contact:
Name: Full name of contact/organization.
Bank AccountOnly accounts of Type BANK will be accepted.

Account ID: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

⚠️ Provide either Account ID or Code.

[+ Add Field] add more fields
Code: BankAccount code (this value may not always be present for a bank account).
Line Items*
At least one is required to create a bank transaction.		[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Line can be added as elements.

Element 1: Represents the first Line.

Unit Amount*: By default, unit amount will be rounded to two decimal places. Must not equal 0. Amount may be negative, but the total value for the document must be positive.
Quantity*: Line item Quantity, must be > 0

Account Code*: Account Code must be active for the organisation.
specifies which revenue or expense account the credit note applies to.
Tip: Find the Account Code with the Method “Get Records” or “Find Records”, Entity “Account”.

[+ Add Field] add more fields in Line Items:
Description: Description of the line item (max length = 4000 chars).
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
DateDate of transaction – YYYY-MM-DD
ReferenceReference for the transaction. Only supported for SPEND and RECEIVE transactions.
Currency CodeThe currency that Bank Transaction has been raised in (see List of Currencies).
Setting currency is only supported on overpayments.
Currency RateExchange rate to base currency when money is spent or received.

Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.
URLURL link to a source document – shown as “Go to App Name”
LineA mount TypesLine amounts are inclusive of tax by default if you don’t specify this element.

Possible values :
Exclusive: Line items are exclusive of tax
Inclusive: Line items are inclusive tax
NoTax: Line have no tax

(*) required field

Example of request from Create Bank Transaction

Minimum elements required to add a new spend money transaction.

{
  "Type": "SPEND",
  "Contact": {
    "ContactID": "eaa28f49-6028-4b6e-bb12-d8f6278073fc"
  },
  "LineItems": [{
    "Description": "Yearly Bank Account Fee",
    "UnitAmount": "20.00",
    "AccountCode": "404"
  }],
  "BankAccount": {
    "Code": "BANK-ABC"
  }
}
Use this Method to create a bank transfer.
▪️ The two sides of each bank transfer will automatically be recorded as RECEIVE-TRANSFER and SPEND-TRANSFER types.
▪️ You cannot transfer between accounts in different currencies

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Bank Transfer API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Bank Transfer creation.
Additional fields: Tenant, Date, Reference.
From Bank Account*Account ID: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

⚠️ Provide either Account ID or Code.

[+ Add Field] add more fields
Code: BankAccount code (this value may not always be present for a bank account).
To Bank Account*Account ID: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

⚠️ Provide either Account ID or Code.

[+ Add Field] add more fields
Code: BankAccount code (this value may not always be present for a bank account).
Amount*The amount being transferred.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
DateThe date of the Transfer YYYY-MM-DD. Defaults to current date.
ReferenceReference for the transaction.

(*) required field

Example of request from Create Bank Transfer 
{
  "BankTransfers": [{
    "FromBankAccount": { "Code": "090" },
    "ToBankAccount": { "Code": "091" },
    "Amount": 20.00
  }]
}
Use this Method to create Credit Notes or allocate Credit Notes to outstanding Invoices.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Credit Notes API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Credit Notes creation.
Additional fields: Tenant, Date, Line Amount Types, Currency Code, Credit Note Number, SentToContact, Currency rate, Branding Theme ID.
Type*ACCPAYCREDIT
An Accounts Payable(supplier) Credit Note

ACCRECCREDIT
An Account Receivable(customer) Credit Note
Contact*Contact ID*: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

[+ Add Field] add more fields in Contact:
Name: Full name of contact/organization.
Line Items*[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Line can be added as elements.
Element 1: Represents the first Line.

Description*: Description of the line item (max length = 4000).
Unit Amount*: By default, unit amount will be rounded to two decimal places.
Quantity*: Line item Quantity.

[+ Add Field] add more fields in Line Items:
Account Code: specifies which revenue or expense account the credit note applies to.
Tip: Find the Account Code with the Method “Get Records” or “Find Records”, Entity “Account”.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
DateThe date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
StatusIf you do not specify a status when creating a credit note, Xero will default to DRAFT.

Possible values:
DRAFT – AUTHORISED
Line Amount TypesLine amounts are exclusive of tax by default if you don’t specify this element.

Possible values:
Exclusive: Line items are exclusive of tax
Inclusive: Line items are inclusive tax
NoTax: Line have no tax
Currency CodeCurrency used for the Credit Note (see List of Currencies).
Credit Note NumberIf ACCRECCREDIT – Enter a unique alpha numeric code identifying credit note.
If ACCPAYCREDIT – Enter a Non-unique alpha numeric code identifying credit note. This value will also display as Reference in the UI.
ReferenceACCRECCREDIT only – additional reference number
Currency RateThe currency rate for a multi-currency invoice. If no rate is specified, the XE.com day rate is used.
Branding Theme IDUnique Identifier of the Branding Theme that apply to this Credit Note.

(*) required field

Example of Create Credit Notes request 
{
  "Type": "ACCPAYCREDIT",
  "Contact": {
    "ContactID": "eaa28f49-6028-4b6e-bb12-d8f6278073fc"
  },
  "Date": "2025-03-29",
  "LineAmountTypes": "Exclusive",
  "LineItems": [
    {
      "Description": "MacBook - White",
      "Quantity": 1.0000,
      "UnitAmount": 1995.00,
      "AccountCode": "720"
    }
  ]
}
Use this Method to create Quotes.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Quotes API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Quotes creation.
Additional fields: Tenant, Status, Line Amount Types, Currency Code, Quote Number, Reference, Expiry Date, Branding Theme ID, Title, Summary, Terms.
Quotes*Contact*:
_Contact ID*: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

[+ Add Field] add more fields in Quote:
_Name: Full name of contact/organization.

_Date*: Date quote was issued – YYYY-MM-DD

Line Items*: [⊕ Element] [⊕ Map] Add fields or Map it from a Data Source. See Field Mapping.
Additional Line can be added as elements.
Element 1: Represents the first Line.

_Description*: Description of the line item (max length = 4000).
_Unit Amount*: By default, unit amount will be rounded to two decimal places.
_Quantity*: Line item Quantity.

_Account Code: specifies which revenue or expense account the credit note applies to.
Tip: Find the Account Code with the Method “Get Records” or “Find Records”, Entity “Account”.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
StatusIf you do not specify a status when creating a Quote, Xero will default to DRAFT.

Possible values:
DRAFT – SENT
Line Amount TypesLine amounts are exclusive of tax by default if you don’t specify this element.

Possible values:
Exclusive: Line items are exclusive of tax
Inclusive: Line items are inclusive tax
NoTax: Line have no tax
Currency CodeCurrency used for the Credit Note (see List of Currencies).
Quote NumberEnter Unique alpha numeric code identifying a quote (Max Length = 255).
ReferenceAdditional reference number.
Expiry DateDate quote expires – YYYY-MM-DD.
Branding Theme IDUnique Identifier of the Branding Theme that apply to this Quote.
TitleThe title of the quote (Max Length = 100).
SummaryThe summary of the quote (Max Length = 3000).
TermsThe terms of the quote (Max Length = 4000).

(*) required field

Example of Create Quote request

Create a single quote with all possible elements

{
 "QuoteNumber": "QU-1068",
 "Reference": "REF-90092",
 "Terms": "Quote is valid for 30 business days",
 "Contact": {
   "ContactID": "6d42f03b-181f-43e3-93fb-2025c012de92",
   "ContactName": "John Hammond"
 },
 "LineItems": [
   {
     "Description": "Jurassic Park Colouring Book",
     "UnitAmount": 12.50,
     "LineAmount": 12.50,
     "ItemCode": "BOOK",
     "Quantity": 1.0000
   }
 ],
 "Date": "2019-11-29",
 "ExpiryDate": "2019-12-29",
 "Status": "SENT",
 "CurrencyCode": "NZD",
 "SubTotal": 12.50,
 "TotalTax": 0.00,
 "Total": 12.50,
 "Title": "Quote for product sale",
 "Summary": "Sale of book",
 "LineAmountTypes": "EXCLUSIVE"
 }
Use this Method to create a Manual Journal.

⚠️ There are a few accounts that you can’t use when entering manual journals in Xero. These include system accounts (accounts receivable, accounts payable & retained earnings) and bank accounts. You will receive a 400 validation error if you try and use these reserved accounts. Consider setting up one or more clearing accounts if you need to journal to a bank account.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Manual Journals API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Manual Journal creation.
Additional fields: Tenant, Date, Status, Line Amount Types, Url, Show on Cash Basic Reports.
Narration*Description of journal being posted.
Journal Lines*
The JournalLines element must contain at least two individual JournalLine sub-elements.		Line Amount*: Total for line. Debits are positive, credits are negative value

Account Code*: specifies which revenue or expense account the credit note applies to.
Tip: Find the Account Code with the Method “Get Records” or “Find Records”, Entity “Account”.

[+ Add Field] add more fields in Journal Lines:
Description: Description of the line item (max length = 4000).

Tax Type: Used as an override if the default Tax Code for the selected Account Code is not correct – see TaxTypes.

Tracking: Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 TrackingCategory elements. Ensure the tracking categories and options you use are ACTIVE.
[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Tracking Category can be added as elements.

Element 1: Represents the first Tracking Category.
_Name: The name of the tracking category e.g. Department, Region (max length = 100).
_Option: The specific option within the tracking category (e.g., “Sales”, “Marketing”).
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
DateDate journal was posted – YYYY-MM-DD. Defaults to the current date if not provided.
Line Amount TypesLine amounts are exclusive of tax by default if you don’t specify this element.

Possible values:
Exclusive: Line items are exclusive of tax
Inclusive: Line items are inclusive tax
NoTax: Line have no tax
UrlUrl link to a source document – shown as “Go to [appName]” in the Xero app
Show on Cash Basic ReportsTrue – False
Default is true if not specified.

(*) required field

Example of Create Manual Journal request

Create a new draft manual journal with optional elements

{
  "Date": "2014-08-13",
  "Status": "DRAFT",
  "Narration": "Prepaid our phone a year in advance",
  "LineAmountTypes": "NoTax",
  "JournalLines": [
    {
      "Description": "Prepaid Annual Phone",
      "LineAmount": -1000,
      "AccountCode": "489",
      "TaxType": "NONE",
      "Tracking": [
        {
          "Name": "Region",
          "Option": "South"
        }
      ]
    },
    {
      "Description": "Prepayment",
      "LineAmount": 1000,
      "AccountCode": "620",
      "TaxType": "NONE",
      "Tracking": [
        {
          "Name": "Region",
          "Option": "South"
        }
      ]
    }
  ],
  "ShowOnCashBasisReports": "false"
}
Use this Method to create an Item.

⚠️ Tracked items in Xero have their inventory quantity and value monitored, and sales are restricted based on stock levels. Untracked items are simply listed on transactions without inventory tracking. Consult Xero’s help center for more information.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Items API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Item creation.
Additional fields: Tenant, Description, Inventory Asset Account Code, IsSold, IsPurchased, Purchase Description, Purchase Details, Sales Details.
Code*Enter a user defined item code.
Name*The name of the item.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
DescriptionDescription of the item.
Inventory Asset Account CodeThe inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item.
IsSoldTrue – False
If True the item will be available on sales transactions in the Xero UI.
IsPurchasedTrue- False
If True the item is available for purchase transactions in the Xero UI.
Purchase DescriptionThe purchase description of the item (max length = 4000)
Purchase Details[+ Add Field] add more fields:
Unit Price: By default UnitPrice is rounded to two decimal places.

Account Code: Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items.

Cost of good sold Account Code(COGSAccountCode): Cost of goods sold account. Only applicable to the purchase details of tracked items.

Tax Type: Used as an override if the default Tax Code for the selected Account Code is not correct – see TaxTypes.
Sales Details[+ Add Field] add more fields:
Unit Price: By default UnitPrice is rounded to two decimal places.

Account Code: Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items.

Tax Type: Used as an override if the default Tax Code for the selected Account Code is not correct – see TaxTypes.

(*) required field

Example of Create Item request

Create an untracked item with sales and purchase details:

{
  "Code": "Merino-2011-LG",
  "Name": "Full Tracked Item",
  "Description": "2011 Merino Sweater - LARGE",
  "PurchaseDescription": "2011 Merino Sweater - LARGE",
  "PurchaseDetails": {
    "UnitPrice": 149.0000,
    "AccountCode": "300"
  },
  "SalesDetails": {
    "UnitPrice": 299.0000,
    "AccountCode": "200"
  }
}

Minimum elements to create a tracked item:

{
  "Code": "TrackedItem",
  "PurchaseDetails": {
    "COGSAccountCode": "300"
  },
  "InventoryAssetAccountCode": "630"
}
Use this Method to create a Purchase Order.

⚠️ When creating a purchase order via this Method, you can set the Status field to DRAFT, SUBMITTED, or AUTHORISED. However, once a purchase order is set to SUBMITTED or AUTHORISED, it cannot be reverted to DRAFT through the API. Additionally, the statuses BILLED and DELETED are system-generated and cannot be assigned manually during creation or updates.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Purchase Order API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Purchase Order creation.
Additional fields: Tenant, Date, Status, Line Amount Types, Currency Code, Purchase Order Number, Reference, Branding Theme ID, Send To Contact, Delivery Address, Attention To, Telephone, Delivery Instructions, Expected Arrival Date.
Contact*
provide information of an existing contact.		Contact ID*: Enter the Unique Identifier or Look up the value by select Input > Lookup tab > Select Search button to display a list.

[+ Add Field] add more fields in Contact:
Name: Full name of contact/organization.
Line Items*
At least one Line Item is required to create a complete Purchase Order.		[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Line can be added as elements.
Element 1: Represents the first Line.

Unit Amount*: By default, unit amount will be rounded to two decimal places.
Quantity*: Line item Quantity.

[+ Add Field] add more fields in Line Items:
Description: Description of the line item (max length = 4000).

Account Code: specifies which revenue or expense account the credit note applies to.
Tip: Find the Account Code with the Method “Get Records” or “Find Records”, Entity “Account”.

Discount Rate: Percentage discount being applied to a line item

Tax Type: Used as an override if the default Tax Code for the selected Account Code is not correct – see TaxTypes.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
DateDate purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
Delivery DateDate the goods are to be delivered – YYYY-MM-DD (From supplier location).
StatusPossible values:
DRAFT
SUBMITTED
AUTHORISED
Line Amount TypesLine amounts are exclusive of tax by default if you don’t specify this element.

Possible values:
Exclusive: Line items are exclusive of tax
Inclusive: Line items are inclusive tax
NoTax: Line have no tax
Currency CodeThe currency that purchase order has been raised in (see List of Currencies).
Purchase Order NumberEnter the Unique alpha numeric code identifying purchase order ( when missing will auto-generate from your Organisation Invoice Settings).
ReferenceAdditional reference number.
Branding Theme IDUnique Identifier of the Branding Theme that apply to this Purchase Order.
Send To ContactTrue – False
To set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed.
Delivery AddressThe address the goods are to be delivered to.
Attention ToThe person that the delivery is going to.
TelephoneThe phone number for the person accepting the delivery.
Delivery InstructionsA free text field for instructions (500 characters max).
Expected Arrival DateThe date the goods are expected to arrive.

(*) required field

Example of Create Purchase Order

Create a purchase order with all elements specified:

{
  "PurchaseOrderNumber": "PO-0292",
  "Date": "2015-11-12",
  "DeliveryDate": "2015-12-12",
  "Reference": "REF123",
  "Contact": { "ContactID": "d7b78c9c-b34a-4dad-b999-c3c2504c7877" },
  "BrandingThemeID": "4c82c365-35cb-467f-bb11-dce1f2f2f67c",
  "Status": "AUTHORISED",
  "LineAmountTypes": "Exclusive",
  "LineItems": [
    {
      "ItemCode": "GB1-White",
      "Description": "Golf balls - white single. Wholesale catalog item #020812-1",
      "UnitAmount": 4.2595,
      "TaxType": "INPUT2",
      "AccountCode": "300",
      "Tracking": [
        {
          "Name": "Region",
          "Option": "Eastside"
        },{
          "Name": "Salesperson",
          "Option": "Adam"
        }
      ],
      "Quantity": 1.0000,
      "DiscountRate": 10.00
    }
  ],
  "CurrencyRate": 0.615310,
  "CurrencyCode": "EUR",
  "DeliveryAddress": "23 Main Street, Central City, Marineville,1234",
  "AttentionTo": "Bob",
  "Telephone": "0800 1234 5678",
  "DeliveryInstructions": "Don't forget the secret knock",
  "ExpectedArrivalDate": "2015-12-12"
}
Use this Method to create Contact Groups.

⚠️ You can’t create more than 100 contact groups. Trying to create a group when the limit of 100 has been reached will result in a validation error being returned.

See Xero Contact Groups API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Contact Group creation.
Additional fields: Tenant.
Contact Group Name*The Name of the contact group.
ADDITIONAL FIELDS
TenantOptionally 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 Create Contact Group 
{
  "Name": "VIP Customers"
}
Use this Method to create Employees.

⚠️ You can Create multiple employees by adding [⊕ Element] or [⊕ Map].
Employees Status:
▪️ Employees are automatically considered active upon creation.
▪️ If you want to “terminate” an employee, you need to update their TerminationDate.

See Xero Employees API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Employee creation.
Additional fields: Tenant.
Employees*[⊕ Element][⊕ Map] Add a repeating group of fields or Map it from an array. See Field Mapping.
Additional Employees can be added as elements.

Element 1: Represents the first Employee.

First Name: First name of an employee (max length = 255)
Last Name: Last name of an employee (max length = 255)

External Link: Link to an external resource, for example, an employee record in an external system. You can specify the URL element.
The description of the link is auto-generated in the form Go to <App name>. <App name> refers to the Xero application name that is making the API call.
ADDITIONAL FIELDS
TenantOptionally 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 Create employee 
{
  "Employees": [
    {
      "FirstName": "Joey",
      "LastName": "Bloggs",
      "ExternalLink": {
        "Url": "http://twitter.com/#!/search/Joey+Bloggs"
      }
    }
  ]
}
Use this Method to create draft fixed assets.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Asset API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Asset creation.
Additional fields: Tenant, Asset Type ID, Purchase Date, Purchase Price, Book Depreciation Setting, Book Depreciation Detail, Accounting Book value.
Asset Name*The name of the asset.
Asset Number*Must be unique.
ADDITIONAL FIELDS
TenantOptionally select a specific Organization (for Xero Account with multiple Organisations).
Select Input > Lookup tab > Select Search button to display a list.
Asset Type IDProvide the specific ID that links this asset to its asset type.
Purchase DateThe date the asset was purchased YYYY-MM-DD.
Purchase PriceThe purchase price of the asset.
Book Depreciation Setting[+ Add Field] add more fields:

Effective From Date: The date that this depreciation setting is effective from. Displayed as ‘Depreciation start date’ (YYYY-MM-DD)

Depreciation Method: The method of depreciation applied to this asset. Possible values:
– No Depreciation
– Straight Line
– DiminishingValue100 = Diminishing Value at 100%
– DiminishingValue150 = Diminishing Value at 150%
– DiminishingValue200 = Diminishing Value at 200%
– FullDepreciation = Full Depreciation at purchase

Averaging Method: The method of averaging applied to this asset. Possible values:
– Actual Days
– Full Month

Depreciation Rate: The rate of depreciation (e.g. 0.05)

Depreciation Calculation Method: Possible values:
– Rate = Depreciation Rate (e.g. 20%)
– Life = Effective life (e.g. 5 years)
– None

(*) required field

Example of Create Asset

Create an Asset with all elements specified:

{
      "assetName": "Keyboard",
      "assetNumber": "FA-00211",
      "purchaseDate": "2016-04-11T00:00:00",
      "purchasePrice": 3000,
      "assetTypeId": "5da209c5-5e19-4a43-b925-71b776c49ced"
      "bookDepreciationSettings": {
        "effectiveFromDate": "2015-07-01T00:00:00",
        "depreciationMethod": "StraightLine",
        "averagingMethod": "ActualDays",
        "depreciationRate": 33,
        "depreciationCalculationMethod": "None"
      }
}
Use this Method to create Asset Types.

Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.

See Xero Asset Type API Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Asset Type creation.
Additional fields: Tenant.
Asset Type Name*The name of the Asset Type.
Fixed Asset Account ID*The asset account for fixed assets of this type.

Tip: you can Look up the value by select Input > Lookup tab > Select Search button to display a list.
Depreciation Expense Account ID*The expense account for the depreciation of fixed assets of this type.

Tip: you can Look up the value by select Input > Lookup tab > Select Search button to display a list.
Accumulated Depreciation Account ID*The account for accumulated depreciation of fixed assets of this type.

Tip: you can Look up the value by select Input > Lookup tab > Select Search button to display a list.
Book Depreciation Setting*Depreciation Method*: The method of depreciation applied to this asset. Possible values:
– No Depreciation
– Straight Line
– DiminishingValue100 = Diminishing Value at 100%
– DiminishingValue150 = Diminishing Value at 150%
– DiminishingValue200 = Diminishing Value at 200%
– FullDepreciation = Full Depreciation at purchase

Averaging Method*: The method of averaging applied to this asset. Possible values:
– Actual Days
– Full Month

Depreciation Rate*: The rate of depreciation (e.g. 0.05)

Depreciation Calculation Method*: Possible values:
– Rate = Depreciation Rate (e.g. 20%)
– Life = Effective life (e.g. 5 years)
– None
ADDITIONAL FIELDS
TenantOptionally 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 Create Asset Type 
{
 "assetTypeName": "Computer Equipment",
 "fixedAssetAccountId": "afe53f21-1221-451c-a8c4-08457e129d84",
 "depreciationExpenseAccountId": "9a30bb28-6d9d-428b-8a98-b0b591518d5b",
 "accumulatedDepreciationAccountId": "b7e1f170-d238-41d7-ab2b-d0a89b16838f",
 "bookDepreciationSetting": {
  "depreciationMethod": "DiminishingValue100",
  "averagingMethod": "ActualDays",
  "depreciationRate": 40,
  "depreciationCalculationMethod": "None"
 }
}
Use this Method to create Tracking Categories.

See Xero Tracking Categories Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Tracking Category creation.
Additional fields: Tenant.
ID*Unique Identifier of the Tracking Category to update.
NameThe name of the Tracking Category.
ADDITIONAL FIELDS
TenantOptionally 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 Create Tracking Category 
{
  "Name": "New Category"
}
Use this Method to create Folder.

See Xero Folder Reference.
MAP FIELDS [+ Add Field] Select fields from a list, to configure the Folder creation.
Additional fields: Tenant.
Name*The name of the Folder.
ADDITIONAL FIELDS
TenantOptionally 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 Create Folder 
{
  "Name": "New folder",
  "FileCount": 0,
  "IsInbox": false,
  "Id": "1dd3419f-af99-44cf-b779-fb26730c38e1"
}

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.