Get Bank Transaction

Retrieves a single spent or received money transaction by using a unique bank transaction Id

GET/BankTransactions/{BankTransactionID}

Use it in a workflow

Add a step and choose the Xero connector.
Pick the Get Bank Transaction action (under Xero).
Fill in the fields below, then reference the result from later steps as {{getBankTransaction.response.data}}.

Request

Path parameters

BankTransactionIDstring (uuid)required

Xero generated unique identifier for a bank transaction

Query parameters

unitdpinteger

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Headers

xero-tenant-idstringrequired

Xero identifier for Tenant

Response

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

paginationobject

pageinteger

pageSizeinteger

pageCountinteger

itemCountinteger

Warningsarray<object>

Displays array of warning messages from the API

Messagestring

Validation error message

BankTransactionsarray<object>

Typestringrequired

See Bank Transaction Types

One ofRECEIVERECEIVE-OVERPAYMENTRECEIVE-PREPAYMENTSPENDSPEND-OVERPAYMENTSPEND-PREPAYMENTRECEIVE-TRANSFERSPEND-TRANSFER

Contactobject40 fields

LineItemsarray<object>required18 fields

See LineItems

BankAccountobjectrequired20 fields

IsReconciledboolean

Boolean to show if transaction is reconciled

Datestring

Date of transaction – YYYY-MM-DD

Referencestring

Reference for the transaction. Only supported for SPEND and RECEIVE transactions.

CurrencyCodestring

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

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBYRBZDCADCDFCHFCLFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

CurrencyRatenumber (double)

Exchange rate to base currency when money is spent or received. e.g.0.7500 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.

Urlstring

URL link to a source document – shown as “Go to App Name”

Statusstring

See Bank Transaction Status Codes

One ofAUTHORISEDDELETEDVOIDED

LineAmountTypesstring

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

One ofExclusiveInclusiveNoTax

SubTotalnumber (double)

Total of bank transaction excluding taxes

TotalTaxnumber (double)

Total tax on bank transaction

Totalnumber (double)

Total of bank transaction tax inclusive

BankTransactionIDstring (uuid)

Xero generated unique identifier for bank transaction

PrepaymentIDstring (uuid)

Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT

OverpaymentIDstring (uuid)

Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT

UpdatedDateUTCstring

Last modified date UTC format

HasAttachmentsboolean

Boolean to indicate if a bank transaction has an attachment

Default "false"

StatusAttributeStringstring

A string to indicate if a invoice status

ValidationErrorsarray<object>1 fields

Displays array of validation error messages from the API

json

{
  "pagination": {
    "page": 0,
    "pageSize": 0,
    "pageCount": 0,
    "itemCount": 0
  },
  "Warnings": [
    {
      "Message": "string"
    }
  ],
  "BankTransactions": [
    {
      "Type": "RECEIVE",
      "LineItems": [
        {
          "LineItemID": "00000000-0000-0000-0000-000000000000",
          "Description": "string",
          "Quantity": 0,
          "UnitAmount": 0,
          "ItemCode": "string",
          "AccountCode": "string",
          "AccountID": "00000000-0000-0000-0000-000000000000",
          "TaxType": "string",
          "TaxAmount": 0,
          "Item": {
            "Code": "string",
            "Name": "string",
            "ItemID": "00000000-0000-0000-0000-000000000000"
          },
          "LineAmount": 0,
          "Tracking": [
            {
              "TrackingCategoryID": null,
              "TrackingOptionID": null,
              "Name": null,
              "Option": null
            }
          ]
        }
      ],
      "BankAccount": {
        "Code": 4400,
        "Name": "Food Sales",
        "AccountID": "00000000-0000-0000-0000-000000000000",
        "Type": "BANK",
        "BankAccountNumber": "string",
        "Status": "ACTIVE",
        "Description": "string",
        "BankAccountType": "BANK",
        "CurrencyCode": "AED",
        "TaxType": "string",
        "EnablePaymentsToAccount": false,
        "ShowInExpenseClaims": false
      },
      "Contact": {
        "ContactID": "00000000-0000-0000-0000-000000000000",
        "MergedToContactID": "00000000-0000-0000-0000-000000000000",
        "ContactNumber": "string",
        "AccountNumber": "string",
        "ContactStatus": "ACTIVE",
        "Name": "string",
        "FirstName": "string",
        "LastName": "string",
        "CompanyNumber": "string",
        "EmailAddress": "string",
        "ContactPersons": [
          {
            "FirstName": "string",
            "LastName": "string",
            "EmailAddress": "string",
            "IncludeInEmails": false
          }
        ],
        "BankAccountDetails": "string"
      },
      "IsReconciled": false,
      "Date": "string",
      "Reference": "string",
      "CurrencyCode": "AED",
      "CurrencyRate": 0,
      "Url": "string",
      "Status": "AUTHORISED",
      "LineAmountTypes": "Exclusive"
    }
  ]
}

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

Was this page helpful?