GET api/Accounts/Trust/{id}/Balance

Retrieves the balance on a trust account.

Request

Parameters

Name Description Default
id Unique trust account ID or 'primary'.
fileID Unique file ID. Omit to get the balance on the entire account.
date Date to retrieve the balance for. Omit to get the current balance.
forecast Whether to include transactions currently pending processing. False

Response

Body

Content Type: application/xml or application/json
Account balance or an error message.

XML JSON 
<Response>                     
  <Result>decimal</Result>     <!--Account balance--> 
  <Message>string</Message>    <!--Error message--> 
</Response>                    
{                          
   "Result": "decimal",    // Account balance
   "Message": "string"     // Error message
}

Status Codes

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