| GET | /Queries/DebtorLedger | A debtor's ledger (invoices, credit notes, receipts, refunds, adjustments) with the amount outstanding on each, newest first; a branch's own rows plus, for a head office, its branches' (AutoQuery: Skip, Take, OrderBy, Include=Total and column filters; LedgerDebtorID is required). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LedgerDebtorID | query | string | No | |
| TransID | query | string | No | |
| TransIDIn | query | string[] | No | |
| TransType | query | string | No | |
| TransTypeIn | query | string[] | No | |
| InvoiceID | query | string | No | |
| Reference | query | string | No | |
| TranDateGreaterThanOrEqualTo | query | DateTime? | No | |
| TranDateGreaterThan | query | DateTime? | No | |
| TranDateLessThan | query | DateTime? | No | |
| TranDateLessThanOrEqualTo | query | DateTime? | No | |
| DueDateGreaterThanOrEqualTo | query | DateTime? | No | |
| DueDateLessThan | query | DateTime? | No | |
| DueDateLessThanOrEqualTo | query | DateTime? | No | |
| OutstandingNotEqualTo | query | decimal? | No | |
| OutstandingGreaterThan | query | decimal? | No | |
| OutstandingLessThan | query | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LedgerDebtorID | form | string | No | |
| TransID | form | string | No | |
| DebtorID | form | string | No | |
| ChildDebtorID | form | string | No | |
| TranDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| DebitCredit | form | bool? | No | |
| SubType | form | short? | No | |
| TransType | form | string | No | |
| Reference | form | string | No | |
| Ref | form | string | No | |
| Remark | form | string | No | |
| Amount | form | decimal? | No | |
| AllocatedAmount | form | decimal? | No | |
| Outstanding | form | decimal? | No | |
| GSTAmount | form | decimal? | No | |
| InvoiceID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/DebtorLedger HTTP/1.1 Host: testapi.wagga.redpoint.com.au Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"LedgerDebtorID":"String","TransID":"String","DebtorID":"String","ChildDebtorID":"String","TranDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","DebitCredit":false,"SubType":0,"TransType":"String","Reference":"String","Ref":"String","Remark":"String","Amount":0,"AllocatedAmount":0,"Outstanding":0,"GSTAmount":0,"InvoiceID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}