POST /Accounts/{AccountID}

Servers

Path parameters

Name Type Required Description
AccountID String Yes

Unique identifier for Account object

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

xero-tenant-id String Yes

Xero identifier for Tenant

Idempotency-Key String No

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

Request body fields

Name Type Required Description
Accounts[] Array No
Accounts[].Code String No

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)

Accounts[].EnablePaymentsToAccount Boolean No

Boolean – describes whether account can have payments applied to it

Accounts[].Name String No

Name of account (max length = 150)

Accounts[].Type String No

See Account Types

Possible values:

  • "BANK"
  • "DEPRECIATN"
  • "CURRENT"
  • "FIXED"
  • "EQUITY"
  • "NONCURRENT"
  • "PREPAYMENT"
  • "PAYG"
  • "EXPENSE"
  • "LIABILITY"
  • "TERMLIAB"
  • "DIRECTCOSTS"
  • "INVENTORY"
  • "SALES"
  • "OTHERINCOME"
  • "CURRLIAB"
  • "OVERHEADS"
  • "REVENUE"
Accounts[].ShowInExpenseClaims Boolean No

Boolean – describes whether account code is available for use with expense claims

Accounts[].BankAccountNumber String No

For bank accounts only (Account Type BANK)

Accounts[].ReportingCodeName String No

Shown if set

Accounts[].Description String No

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)

Accounts[].TaxType String No

The tax type from taxRates

Accounts[].AddToWatchlist Boolean No

Boolean – describes whether the account is shown in the watchlist widget on the dashboard

Accounts[].Class String No

See Account Class Types

Possible values:

  • "ASSET"
  • "EQUITY"
  • "EXPENSE"
  • "LIABILITY"
  • "REVENUE"
Accounts[].UpdatedDateUTC String No

Last modified date UTC format

Accounts[].BankAccountType String No

For bank accounts only. See Bank Account types

Possible values:

  • "CREDITCARD"
  • ""
  • "BANK"
  • "PAYPAL"
  • "NONE"
Accounts[].SystemAccount String No

If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.

Possible values:

  • ""
  • "TRACKINGTRANSFERS"
  • "CISMATERIALS"
  • "CISLABOURINCOME"
  • "CISLIABILITY"
  • "CISLABOUR"
  • "CISLABOUREXPENSE"
  • "GSTONIMPORTS"
  • "UNPAIDEXPCLM"
  • "CISASSETS"
  • "CISASSET"
  • "REALISEDCURRENCYGAIN"
  • "UNREALISEDCURRENCYGAIN"
  • "BANKCURRENCYGAIN"
  • "ROUNDING"
  • "HISTORICAL"
  • "GST"
  • "WAGEPAYABLES"
  • "DEBTORS"
  • "CREDITORS"
  • "RETAINEDEARNINGS"
Accounts[].Status String No

Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes

Possible values:

  • "ARCHIVED"
  • "DELETED"
  • "ACTIVE"
Accounts[].ReportingCode String No

Shown if set

Accounts[].AccountID String No

The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

Accounts[].ValidationErrors[] Array No

Displays array of validation error messages from the API

Accounts[].ValidationErrors[].Message String No

Validation error message

Accounts[].HasAttachments Boolean No

boolean to indicate if an account has an attachment (read only)

Default value: false

Accounts[].CurrencyCode String No

3 letter alpha code for the currency – see list of currency codes

Possible values:

  • "ISK"
  • "JMD"
  • "LTL"
  • "SVC"
  • "SAR"
  • "EEK"
  • "TTD"
  • "SBD"
  • "SHP"
  • "GBP"
  • "TRY"
  • "MOP"
  • "INR"
  • "MAD"
  • "CUP"
  • "CLF"
  • "SRD"
  • "SZL"
  • "IRR"
  • "CHF"
  • "EUR"
  • "KZT"
  • "ALL"
  • "MZN"
  • "CDF"
  • "BZD"
  • "KES"
  • "AOA"
  • "NGN"
  • "SEK"
  • "BND"
  • "UYU"
  • "BRL"
  • "YER"
  • "ANG"
  • "BYR"
  • "MRO"
  • "DJF"
  • "LSL"
  • "BBD"
  • "MGA"
  • "VND"
  • "DOP"
  • "TJS"
  • "FJD"
  • "BGN"
  • "TWD"
  • "QAR"
  • "VES"
  • "CNY"
  • "AUD"
  • "ZMW"
  • "WST"
  • "MDL"
  • "KHR"
  • "NZD"
  • "AMD"
  • "AZN"
  • "TZS"
  • "GIP"
  • "AED"
  • "AFN"
  • "DZD"
  • "PKR"
  • "KYD"
  • "AWG"
  • "BSD"
  • "PEN"
  • "XAF"
  • "NAD"
  • "ZWD"
  • "BTN"
  • "KRW"
  • "NPR"
  • "FKP"
  • "TND"
  • "LVL"
  • "MWK"
  • "JOD"
  • "LRD"
  • "RSD"
  • "SCR"
  • "HUF"
  • "IDR"
  • "LAK"
  • "UAH"
  • "ZAR"
  • "OMR"
  • "PGK"
  • "SLL"
  • "MVR"
  • "USD"
  • "MXV"
  • "MKD"
  • "COP"
  • "CAD"
  • "KMF"
  • "MXN"
  • "PYG"
  • "XCD"
  • "STD"
  • "IQD"
  • "TOP"
  • "VEF"
  • "VUV"
  • "SOS"
  • "CVE"
  • "CUC"
  • "KGS"
  • "TMT"
  • "THB"
  • "BOB"
  • "UZS"
  • "BYN"
  • "SKK"
  • "ILS"
  • "PLN"
  • "RON"
  • "BHD"
  • "BIF"
  • "SLE"
  • "XPF"
  • "ARS"
  • "GTQ"
  • "RUB"
  • "HKD"
  • "ZMK"
  • "RWF"
  • "BDT"
  • "ETB"
  • "LYD"
  • "JPY"
  • "SGD"
  • "STN"
  • "MNT"
  • "NIO"
  • "GEL"
  • "MUR"
  • "NOK"
  • "ERN"
  • "SYP"
  • "MYR"
  • "DKK"
  • "HRK"
  • "CLP"
  • "GNF"
  • "GMD"
  • "BAM"
  • "HTG"
  • "LBP"
  • "PHP"
  • "EGP"
  • "SDG"
  • "CRC"
  • "CZK"
  • "KWD"
  • "KPW"
  • "GHS"
  • "GYD"
  • "LKR"
  • "BMD"
  • "BWP"
  • "MRU"
  • "PAB"
  • "UGX"
  • "MMK"
  • "XOF"
  • "HNL"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.