Retrieves the list of trust bank accounts.
| Name | Description | Default |
|---|---|---|
includeCMA
|
Whether to include controlled money accounts in the list. |
False
|
Content Type:
application/xml
or
application/json
List of accounts or an error message.
| XML JSON |
|---|
<Response>
<Result> <!--Array of 'Item'-->
<Item>
<ID>long</ID> <!--Unique trust account ID-->
<IsPrimary>bool</IsPrimary> <!--Whether account is the primary trust account-->
<BSB>string</BSB>
<AccountNo>string</AccountNo>
<AccountName>string</AccountName>
<Description>string</Description>
<BankBranch>
<ID>long</ID> <!--Unique contact ID-->
<FileAs>string</FileAs> <!--File-as name-->
</BankBranch>
<AccountHolder>
<ID>long</ID> <!--Unique contact ID-->
<FileAs>string</FileAs> <!--File-as name-->
</AccountHolder>
<File>
<ID>long</ID> <!--Unique matter ID-->
<FileNumber>string</FileNumber> <!--File number-->
<Matter>string</Matter> <!--Matter description-->
</File>
<TFN>string</TFN> <!--Tax file number-->
<Trustees> <!--Array of 'Item'-->
<Item>
<ID>long</ID> <!--Unique contact ID-->
<FileAs>string</FileAs> <!--File-as name-->
</Item>
</Trustees>
</Item>
</Result>
<Message>string</Message> <!--Error message-->
</Response>
|
{
"Result": [{
"ID": "long", // Unique trust account ID
"IsPrimary": "bool", // Whether account is the primary trust account
"BSB": "string",
"AccountNo": "string",
"AccountName": "string",
"Description": "string",
"BankBranch": {
"ID": "long", // Unique contact ID
"FileAs": "string" // File-as name
},
"AccountHolder": {
"ID": "long", // Unique contact ID
"FileAs": "string" // File-as name
},
"File": {
"ID": "long", // Unique matter ID
"FileNumber": "string", // File number
"Matter": "string" // Matter description
},
"TFN": "string", // Tax file number
"Trustees": [{
"ID": "long", // Unique contact ID
"FileAs": "string" // File-as name
}]
}],
"Message": "string" // Error message
}
|
| Code | Condition |
|---|---|
| 200 OK | The operation completed successfully. |
| 401 Unauthorized | Access token is invalid, expired or not specified. |
| 403 Forbidden | User does not have permission to view trust accounts. |
| 406 Not Acceptable | Content type specified in the Accept header isn't supported. |
| 500 Internal Server Error | An internal error occurred. |