GET api/Files/{id}/Trust

Retrieves the trust ledger for a file.

Request

Parameters

Name Description Default
id Unique file ID.
accountID Unique trust account ID. Omit to use the primary trust bank account.

Response

Body

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
}                                       
                                        

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid file ID.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to view trust activity on the file.
404 Not FoundFile not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

The payment method can be one of the following values:
ValueDescription
ChqCheque
EFTElectronic funds transfer
BChqBank cheque
TTTrust transfer (to general account)
DepBranch deposit
CashCash deposit
BPAYBPAY payment
IntlInternational transfer