v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Bank Accounts

Get a transaction

Retrieves a specified bank account transaction.

get/bankaccounts/{bankAccountId}/transactions/{id}

Path parameters

idstring required
bankAccountIdstring required

Response

When request is successful. Returns a 'Transaction' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the transaction.

payorNamestring nullable

The name of the associated contact.

typestring nullable

The type of the transaction.

Possible values: Deposit, DepositReversal, InvoicePayment, InvoicePaymentReversal, VendorPayment, VendorPaymentReversal Transfer, BankFees, BankFeesReversal, Interest, InterestReversal.

amountnumber double

The amount of the transaction in dollars. Limited to 2 decimal places (cents).

enteredDatestring date-time

Date the transaction was entered.

effectiveDatestring date-time

Date the transaction took effect.

referencestring nullable

Reference for the transaction.

reasonstring nullable

Reason for the transaction.

descriptionstring nullable

Description of the transaction.

notestring nullable

Note for the transaction (for internal use).

reversedboolean

True if this transaction has been reversed.

Example response

{
  "id": "64818ee0-c7b4-46ec-862e-514d8b29540a",
  "payorName": "John Smith",
  "type": "Deposit",
  "amount": 102.65,
  "reversed": true
}