JiwaAPI

<back to all web services

DebtorLedgerQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/DebtorLedgerA 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).
DebtorLedgerQuery Parameters:
NameParameterData TypeRequiredDescription
LedgerDebtorIDquerystringNo
TransIDquerystringNo
TransIDInquerystring[]No
TransTypequerystringNo
TransTypeInquerystring[]No
InvoiceIDquerystringNo
ReferencequerystringNo
TranDateGreaterThanOrEqualToqueryDateTime?No
TranDateGreaterThanqueryDateTime?No
TranDateLessThanqueryDateTime?No
TranDateLessThanOrEqualToqueryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
OutstandingNotEqualToquerydecimal?No
OutstandingGreaterThanquerydecimal?No
OutstandingLessThanquerydecimal?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_TFM_DebtorLedger Parameters:
NameParameterData TypeRequiredDescription
LedgerDebtorIDformstringNo
TransIDformstringNo
DebtorIDformstringNo
ChildDebtorIDformstringNo
TranDateformDateTime?No
DueDateformDateTime?No
DebitCreditformbool?No
SubTypeformshort?No
TransTypeformstringNo
ReferenceformstringNo
RefformstringNo
RemarkformstringNo
Amountformdecimal?No
AllocatedAmountformdecimal?No
Outstandingformdecimal?No
GSTAmountformdecimal?No
InvoiceIDformstringNo
LastSavedDateTimeformDateTime?No
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/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"}}}