| Field | Type | Required | Description | Example |
|---|---|---|---|---|
currency |
JsonNullable<Currency> | ➖ | Indicates the associated currency for an amount of money. Values correspond to ISO 4217. | USD |
currencyRate |
JsonNullable<Double> | ➖ | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
totalAmount |
Optional<Double> | ✔️ | The total amount of the transaction | 49.99 |
reference |
JsonNullable<String> | ➖ | Optional transaction reference message ie: Debit remittance detail. | 123456 |
paymentMethod |
JsonNullable<String> | ➖ | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
paymentMethodReference |
JsonNullable<String> | ➖ | Optional reference message returned by payment method on processing | 123456 |
paymentMethodId |
JsonNullable<String> | ➖ | A unique identifier for an object. | 12345 |
accountsReceivableAccountType |
JsonNullable<String> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Type of accounts receivable account. |
Account |
accountsReceivableAccountId |
JsonNullable<String> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Unique identifier for the account to allocate payment to. |
123456 |
account |
JsonNullable<LinkedLedgerAccountInput> | ➖ | N/A | |
transactionDate |
OffsetDateTime | ✔️ | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
customer |
JsonNullable<LinkedCustomerInput> | ➖ | The customer this entity is linked to. | |
supplier |
JsonNullable<DeprecatedLinkedSupplierInput> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The supplier this entity is linked to. |
|
companyId |
JsonNullable<String> | ➖ | The company or subsidiary id the transaction belongs to | 12345 |
reconciled |
JsonNullable<Boolean> | ➖ | Indicates if the transaction has been reconciled. | true |
status |
Optional<PaymentStatus> | ➖ | Status of payment | authorised |
type |
Optional<PaymentType> | ➖ | Type of payment | accounts_receivable |
allocations |
List<AllocationInput> | ➖ | N/A | |
note |
JsonNullable<String> | ➖ | Note associated with the transaction | Some notes about this transaction |
number |
JsonNullable<String> | ➖ | Number associated with the transaction | 123456 |
trackingCategories |
List<LinkedTrackingCategory> | ➖ | A list of linked tracking categories. | |
customFields |
List<CustomField> | ➖ | N/A | |
rowVersion |
JsonNullable<String> | ➖ | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
displayId |
JsonNullable<String> | ➖ | Id to be displayed. | 123456 |
passThrough |
List<PassThroughBody> | ➖ | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |