Retrieves the trust ledger for a file.
Name | Description | Default |
---|---|---|
id
|
Unique file ID. | |
accountID
|
Unique trust account ID. Omit to use the primary trust bank account. |
|
Content Type:
application/xml
or
application/json
Data set containing the transactions, or an error message.
XML JSON |
---|
<Response> <Result> <!--Array of 'Item'--> <Item> <TransactionID>long</TransactionID> <!--Unique transaction ID--> <TransferID>long</TransferID> <!--Unique trust transfer ID--> <TransactionDate>datetime</TransactionDate> <!--Transaction date--> <Number>string</Number> <!--Human-readable transaction number--> <Reference>string</Reference> <!--Bank reference--> <ContactID>long</ContactID> <!--Contact number of related contact--> <Description>string</Description> <!--Transaction description--> <DR>decimal</DR> <!--Debit amount--> <CR>decimal</CR> <!--Credit amount--> <Processed>bool</Processed> <!--Whether the transaction is processed--> <Sort>int</Sort> <!--Secondary sort order (when dates are identical)--> <PaymentMethod>string</PaymentMethod> <!--Abbreviation for payment method--> </Item> </Result> <Message>string</Message> <!--Error message--> </Response> |
{ "Result": [{ "TransactionID": "long", // Unique transaction ID "TransferID": "long", // Unique trust transfer ID "TransactionDate": "datetime", // Transaction date "Number": "string", // Human-readable transaction number "Reference": "string", // Bank reference "ContactID": "long", // Contact number of related contact "Description": "string", // Transaction description "DR": "decimal", // Debit amount "CR": "decimal", // Credit amount "Processed": "bool", // Whether the transaction is processed "Sort": "int", // Secondary sort order (when dates are identical) "PaymentMethod": "string" // Abbreviation for payment method }], "Message": "string" // Error message } |
Code | Condition |
---|---|
200 OK | The operation completed successfully. |
400 Bad Request | Invalid file ID. |
401 Unauthorized | Access token is invalid, expired or not specified. |
403 Forbidden | User does not have permission to view trust activity on the file. |
404 Not Found | File not found. |
406 Not Acceptable | Content type specified in the Accept header isn't supported. |
500 Internal Server Error | An internal error occurred. |
Value | Description |
---|---|
Chq | Cheque |
EFT | Electronic funds transfer |
BChq | Bank cheque |
TT | Trust transfer (to general account) |
Dep | Branch deposit |
Cash | Cash deposit |
BPAY | BPAY payment |
Intl | International transfer |