Accounting Transactions

Overview

From the Accounting Transactions endpoint, you can retrieve a transactions summary for a specified business from the accounting service provider. See Accounting Transactions endpoint for more details.

Data Model

Field	Type	Description
id sortable, filterable	string	Identifier for the transaction, unique to the business in the accounting platform.
transactionNumber sortable, filterable	string	Reference number for the transaction, e.g. Invoice or Bill Number.
postedDate sortable, filterable	string See Date	Date of the transaction as recorded in the accounting service provder.
entityRef sortable, filterable	Reference Types	Reference to the vendor or customer associated with the transaction.
type sortable, filterable	string	The transaction type. Valid values are: `expense`, `invoice`, `payment`, `journalEntry`, `bill`, `vendorCreditNote`, `creditNote`, `billPayment`, `transfer`, `deposit`, `refund`, `estimate`, `inventoryAdjustment`, `purchaseOrder`, `taxPayment`, `taxAdjustment`, `taxRefund`, `taxReversal`, `other`, `unknown`
isPosting sortable, filterable	boolean	Indicates if the transaction is a posting accounting transaction. *Non-posting transactions are saved, but the transactions are not reflected on report totals. Also, they don't affect the customer's/vendor's balance, or the accounts receivable/payable balance.
isReconciled sortable, filterable	boolean	Indicates if a transaction has been reconciled in the accounting system. Applicable for Xero bank transactions only.
accountRef sortable, filterable	Reference Types	Reference to the account to which the transaction is linked to.
currencyRef sortable, filterable	Reference Types	Currency of the transaction.
currrencyRate	decimal	Rate between the currency of the transaction and the base currency of the business.
isSplitTransaction filterable	boolean	Indicates if a transaction is a split transaction/expense or line item transaction related to a parent transaction.
parentTransactionId	string	The parent transaction id of a split transaction.
subTotal	decimal	Value of the transaction, including discounts and excluding tax.
taxAmount	decimal	Any tax applied to the bill amount.
totalAmount sortable, filterable	decimal	Total amount of the transaction, inclusive of tax.
memo	string	User-friendly reference for the transaction.
trackingCategoryRef	Reference Types	Reference to the tracking category to which the transaction is linked to.
sourceModifiedDate	string See Date	Date the record was last changed in the accounting service provider.

Example Data

{
  "data":
  [
    {
      "id": "1045",
      "transactionNumber": "INV-001",
      "postedDate": "2020-11-25T01:02:03Z",
      "entityRef":
      {
        "id": "233",
        "name": "Railz Inc."
      },
      "type": "invoice",
      "isPosting": true,
      "isReconciled": true,
      "accountRef":
      {
        "id": "145",
        "name": "Depreciation Expense"
      },
      "currencyRef":
      {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "currencyRate": 1.13,
      "isSplitTransaction": true,
      "parentTransactionId": "1043",
      "subTotal": 300.5,
      "taxAmount": 10.5,
      "totalAmount": 311,
      "memo": "Transaction reference",
      "trackingCategoryRef":
      {
        "id": "4040",
        "name": "Region",
        "option": "East",
        "optionId": "40401"
      },
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}