v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

BankTransaction

Retrieves the collection of BankTransaction resources.

get/bank_transactions

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

BankTransaction collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for each bank transaction

contactIdstring nullable

ID of the associated contact

contactNamestring nullable

Full name of contact

datestring nullable

Transaction date

statusstring nullable

Status of bank transaction e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT"

lineAmountTypesstring nullable

The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.g. "NoTax"

lineItemDescriptionstring nullable

A description of the line item

lineItemUnitAmountinteger nullable

Unit amount of line item

lineItemTaxTypestring nullable

Type of tax applied to the line item e.g. "INPUT" e.g. "OUTPUT e.g. "GSTONIMPORTS"

lineItemTaxAmountinteger nullable

The amount taxed for the line item

lineAmountinteger nullable

The total of the line including discount

lineItemAccountCodestring nullable

Account code of line item

lineItemQuantityinteger nullable

Quantity of line item

lineItemIdstring nullable

ID for the line item

subtotalinteger nullable

Total of bank transaction excluding taxes

totalTaxinteger nullable

Total tax of bank transaction

totalinteger nullable

Total of bank transaction

modifiedstring nullable

Date and time the bank transaction was last updated

currencyCodestring nullable

The currency the bank transaction has been raised in

accountIdstring nullable

ID of the bank account

bankAccountCodestring nullable

Bank account code

bankAccountNamestring nullable

Name of the bank account

typestring nullable

Transaction Type

referencestring nullable

Reference for the transaction

isReconciledboolean nullable

Whether the transaction is reconciled

fromAccountIdstring nullable

Account ID from which money will be transferred

toAccountIdstring nullable

Account ID to which money will be transferred

paymentModestring nullable

Mode of payment for the transaction

customerIdstring nullable

ID of customer

vendorIdstring nullable

ID of vendor

createdstring date-time nullable

txnIdstring nullable

Transaction ID

categorystring nullable

merchantstring nullable

descriptionstring nullable

Example response

[
  {
    "integration": "quickbooks"
  }
]