GET api/Files/{id}/Financial

Retrieves a summary of the financial position of the matter.

Request

Parameters

Name Description Default
id File number or unique file ID.

Response

Body

Content Type: application/xml or application/json
Financial summary or an error message.

XML JSON 
<Response>                                                      
  <Result>                                                      
    <Exposure>decimal</Exposure>                                
    <Time>decimal</Time>                                        
    <FixedCharges>decimal</FixedCharges>                        
    <Disbursements>decimal</Disbursements>                      
    <Debtors>decimal</Debtors>                                  
    <Debtors14Days>decimal</Debtors14Days>                      
    <BadDebts>decimal</BadDebts>                                
    <Trust>decimal</Trust>                                      
    <TrustCleared>decimal</TrustCleared>                        
    <TrustUncleared>decimal</TrustUncleared>                    
    <TrustPending>decimal</TrustPending>                        
    <TrustUndeposited>decimal</TrustUndeposited>                
    <Investments>decimal</Investments>                          
    <TransitCheques>decimal</TransitCheques>                    
    <CreditLimit>decimal</CreditLimit>                          
    <CreditRemaining>decimal</CreditRemaining>                  
    <EstimatedProducts>decimal</EstimatedProducts>              
    <EstimatedDisbursements>decimal</EstimatedDisbursements>    
    <FutureValue>decimal</FutureValue>                          
    <TotalBilled>decimal</TotalBilled>                          
    <TimeWrittenOff>decimal</TimeWrittenOff>                    
  </Result>                                                     
  <Message>string</Message>                                     <!--Error message--> 
</Response>                                                     
{                                             
   "Result": {                                
      "Exposure": "decimal",                  
      "Time": "decimal",                      
      "FixedCharges": "decimal",              
      "Disbursements": "decimal",             
      "Debtors": "decimal",                   
      "Debtors14Days": "decimal",             
      "BadDebts": "decimal",                  
      "Trust": "decimal",                     
      "TrustCleared": "decimal",              
      "TrustUncleared": "decimal",            
      "TrustPending": "decimal",              
      "TrustUndeposited": "decimal",          
      "Investments": "decimal",               
      "TransitCheques": "decimal",            
      "CreditLimit": "decimal",               
      "CreditRemaining": "decimal",           
      "EstimatedProducts": "decimal",         
      "EstimatedDisbursements": "decimal",    
      "FutureValue": "decimal",               
      "TotalBilled": "decimal",               
      "TimeWrittenOff": "decimal"             
   },                                         
   "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 ForbiddenThe user does not have permission to view the matter.
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

Any figures above which are null or absent from the response do not apply to the particular matter type.