| GET | /Queries/DebtorAllocations | The current allocations of one debtor transaction: what a receipt paid, or what paid an invoice (AutoQuery; TransID is required). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransID | query | string | No | |
| CounterpartTransID | query | string | 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 |
|---|---|---|---|---|
| AllocID | form | string | No | |
| TransID | form | string | No | |
| DebtorID | form | string | No | |
| ChildDebtorID | form | string | No | |
| CounterpartTransID | form | string | No | |
| Amount | form | decimal? | No | |
| DateAlloc | form | DateTime? | No | |
| CounterpartTranDate | form | DateTime? | No | |
| CounterpartTransType | form | string | No | |
| CounterpartReference | form | string | No | |
| CounterpartInvoiceID | form | string | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/DebtorAllocations HTTP/1.1 Host: testapi.wagga.redpoint.com.au Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"AllocID":"String","TransID":"String","DebtorID":"String","ChildDebtorID":"String","CounterpartTransID":"String","Amount":0,"DateAlloc":"0001-01-01T00:00:00.0000000","CounterpartTranDate":"0001-01-01T00:00:00.0000000","CounterpartTransType":"String","CounterpartReference":"String","CounterpartInvoiceID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}