GET api/Files/{id}/Debtors

Retrieves the debtors ledger for a file.

Request

Parameters

Name	Description	Default
`id`	Unique file ID.

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> <BillID>long</BillID> <!--Unique bill ID--> <TransactionID>long</TransactionID> <!--Unique transaction ID--> <TransactionDate>datetime</TransactionDate> <!--Transaction date--> <Number>string</Number> <!--Human-readable transaction number--> <Reference>string</Reference> <!--Bank reference--> <Description>string</Description> <!--Transaction description--> <GST>decimal</GST> <!--GST component amount--> <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)--> </Item> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": [{ "BillID": "long", // Unique bill ID "TransactionID": "long", // Unique transaction ID "TransactionDate": "datetime", // Transaction date "Number": "string", // Human-readable transaction number "Reference": "string", // Bank reference "Description": "string", // Transaction description "GST": "decimal", // GST component amount "DR": "decimal", // Debit amount "CR": "decimal", // Credit amount "Processed": "bool", // Whether the transaction is processed "Sort": "int" // Secondary sort order (when dates are identical) }], "Message": "string" // Error message }

XML JSON

<Response>                                           
  <Result>                                           <!--Array of 'Item'--> 
    <Item>                                           
      <BillID>long</BillID>                          <!--Unique bill ID--> 
      <TransactionID>long</TransactionID>            <!--Unique transaction ID--> 
      <TransactionDate>datetime</TransactionDate>    <!--Transaction date--> 
      <Number>string</Number>                        <!--Human-readable transaction number--> 
      <Reference>string</Reference>                  <!--Bank reference--> 
      <Description>string</Description>              <!--Transaction description--> 
      <GST>decimal</GST>                             <!--GST component amount--> 
      <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)--> 
    </Item>                                          
  </Result>                                          
  <Message>string</Message>                          <!--Error message--> 
</Response>

{                                       
   "Result": [{                         
      "BillID": "long",                 // Unique bill ID
      "TransactionID": "long",          // Unique transaction ID
      "TransactionDate": "datetime",    // Transaction date
      "Number": "string",               // Human-readable transaction number
      "Reference": "string",            // Bank reference
      "Description": "string",          // Transaction description
      "GST": "decimal",                 // GST component amount
      "DR": "decimal",                  // Debit amount
      "CR": "decimal",                  // Credit amount
      "Processed": "bool",              // Whether the transaction is processed
      "Sort": "int"                     // Secondary sort order (when dates are identical)
   }],                                  
   "Message": "string"                  // Error message
}

Status Codes

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 debtor 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.

Remarks

The payment method can be one of the following values (or empty):

Value	Description
`Chq`	Cheque
`BChq`	Bank cheque
`EFT`	Electronic funds transfer
`Cash`	Cash deposit
`CC`	Credit card / EFTPOS
`Dep`	Branch deposit
`DD`	Direct debit
`BPAY`	BPAY payment
`PCsh`	Petty cash
`TT`	Trust transfer
`Loan`	Loan account