JiwaAPI

<back to all web services

DebtorAllocationsQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/DebtorAllocationsThe current allocations of one debtor transaction: what a receipt paid, or what paid an invoice (AutoQuery; TransID is required).
DebtorAllocationsQuery Parameters:
NameParameterData TypeRequiredDescription
TransIDquerystringNo
CounterpartTransIDquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_TFM_DebtorAllocations Parameters:
NameParameterData TypeRequiredDescription
AllocIDformstringNo
TransIDformstringNo
DebtorIDformstringNo
ChildDebtorIDformstringNo
CounterpartTransIDformstringNo
Amountformdecimal?No
DateAllocformDateTime?No
CounterpartTranDateformDateTime?No
CounterpartTransTypeformstringNo
CounterpartReferenceformstringNo
CounterpartInvoiceIDformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}