digitaluapi

<back to all web services

DebtsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/debts
DebtsLookup Parameters:
NameParameterData TypeRequiredDescription
TenantsIdqueryintNo
CustomersIdquerylongNo
InvoiceNumberquerystringNo
DebtDatequeryDateTimeNo
DebtAgequeryintNo
AmountOutstandingquerydoubleNo
CapitalOutstandingquerydouble?No
InterestOutstandingquerydouble?No
FeesOutstandingquerydouble?No
LastPaidDatequeryDateTime?No
LastPaidAmountquerydouble?No
VulnerabilityFlagqueryboolNo
CurrenciesIdqueryintNo
CurrencyRatesIdquerylongNo
StatusCodesIdquerylongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /debts HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

[{"TenantsId":0,"CustomersId":0,"InvoiceNumber":"String","DebtDate":"0001-01-01T00:00:00.0000000","DebtAge":0,"AmountOutstanding":0,"CapitalOutstanding":0,"InterestOutstanding":0,"FeesOutstanding":0,"LastPaidDate":"0001-01-01T00:00:00.0000000","LastPaidAmount":0,"VulnerabilityFlag":false,"CurrenciesId":0,"CurrencyRatesId":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]