Pricing Templates
Log in Sign up
Integrations / Xero Accounting / ...

PUT /BankTransfers

Servers

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
BankTransfers[] Array No
BankTransfers[].Date String No

The date of the Transfer YYYY-MM-DD
BankTransfers[].FromIsReconciled Boolean No

The Bank Transaction boolean to show if it is reconciled for the source account

Default value: false
BankTransfers[].ToBankAccount Object Yes
BankTransfers[].ToBankAccount.Code String No

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
BankTransfers[].ToBankAccount.EnablePaymentsToAccount Boolean No

Boolean – describes whether account can have payments applied to it
BankTransfers[].ToBankAccount.Name String No

Name of account (max length = 150)
BankTransfers[].ToBankAccount.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"
BankTransfers[].ToBankAccount.ShowInExpenseClaims Boolean No

Boolean – describes whether account code is available for use with expense claims
BankTransfers[].ToBankAccount.BankAccountNumber String No

For bank accounts only (Account Type BANK)
BankTransfers[].ToBankAccount.ReportingCodeName String No

Shown if set
BankTransfers[].ToBankAccount.Description String No

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
BankTransfers[].ToBankAccount.TaxType String No

The tax type from taxRates
BankTransfers[].ToBankAccount.AddToWatchlist Boolean No

Boolean – describes whether the account is shown in the watchlist widget on the dashboard
BankTransfers[].ToBankAccount.Class String No

See Account Class Types

Possible values:

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

Last modified date UTC format
BankTransfers[].ToBankAccount.BankAccountType String No

For bank accounts only. See Bank Account types

Possible values:

  • "CREDITCARD"
  • ""
  • "BANK"
  • "PAYPAL"
  • "NONE"
BankTransfers[].ToBankAccount.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"
BankTransfers[].ToBankAccount.Status String No

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

Possible values:

  • "ARCHIVED"
  • "DELETED"
  • "ACTIVE"
BankTransfers[].ToBankAccount.ReportingCode String No

Shown if set
BankTransfers[].ToBankAccount.AccountID String No

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

Displays array of validation error messages from the API
BankTransfers[].ToBankAccount.ValidationErrors[].Message String No

Validation error message
BankTransfers[].ToBankAccount.HasAttachments Boolean No

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

Default value: false
BankTransfers[].ToBankAccount.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"
BankTransfers[].BankTransferID String No

The identifier of the Bank Transfer
BankTransfers[].FromBankTransactionID String No

The Bank Transaction ID for the source account
BankTransfers[].FromBankAccount Object Yes
BankTransfers[].FromBankAccount.Code String No

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
BankTransfers[].FromBankAccount.EnablePaymentsToAccount Boolean No

Boolean – describes whether account can have payments applied to it
BankTransfers[].FromBankAccount.Name String No

Name of account (max length = 150)
BankTransfers[].FromBankAccount.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"
BankTransfers[].FromBankAccount.ShowInExpenseClaims Boolean No

Boolean – describes whether account code is available for use with expense claims
BankTransfers[].FromBankAccount.BankAccountNumber String No

For bank accounts only (Account Type BANK)
BankTransfers[].FromBankAccount.ReportingCodeName String No

Shown if set
BankTransfers[].FromBankAccount.Description String No

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
BankTransfers[].FromBankAccount.TaxType String No

The tax type from taxRates
BankTransfers[].FromBankAccount.AddToWatchlist Boolean No

Boolean – describes whether the account is shown in the watchlist widget on the dashboard
BankTransfers[].FromBankAccount.Class String No

See Account Class Types

Possible values:

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

Last modified date UTC format
BankTransfers[].FromBankAccount.BankAccountType String No

For bank accounts only. See Bank Account types

Possible values:

  • "CREDITCARD"
  • ""
  • "BANK"
  • "PAYPAL"
  • "NONE"
BankTransfers[].FromBankAccount.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"
BankTransfers[].FromBankAccount.Status String No

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

Possible values:

  • "ARCHIVED"
  • "DELETED"
  • "ACTIVE"
BankTransfers[].FromBankAccount.ReportingCode String No

Shown if set
BankTransfers[].FromBankAccount.AccountID String No

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

Displays array of validation error messages from the API
BankTransfers[].FromBankAccount.ValidationErrors[].Message String No

Validation error message
BankTransfers[].FromBankAccount.HasAttachments Boolean No

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

Default value: false
BankTransfers[].FromBankAccount.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"
BankTransfers[].Reference String No

Reference for the transactions.
BankTransfers[].Amount Number Yes

amount of the transaction
BankTransfers[].ToIsReconciled Boolean No

The Bank Transaction boolean to show if it is reconciled for the destination account

Default value: false
BankTransfers[].CurrencyRate Number No

The currency rate
BankTransfers[].ValidationErrors[] Array No

Displays array of validation error messages from the API
BankTransfers[].ValidationErrors[].Message String No

Validation error message
BankTransfers[].HasAttachments Boolean No

Boolean to indicate if a Bank Transfer has an attachment

Default value: false
BankTransfers[].ToBankTransactionID String No

The Bank Transaction ID for the destination account
BankTransfers[].CreatedDateUTC String No

UTC timestamp of creation date of bank transfer

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.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy