digitaluapi

<back to all web services

PaymentsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/payments
PaymentsLookup Parameters:
NameParameterData TypeRequiredDescription
TenantsIdqueryintNo
ActionsIdquerylongNo
DebtsIdquerylongNo
PaymentDatequeryDateTimeOffsetNo
PaidAmountquerydoubleNo
DiscountAmountquerydoubleNo
CurrenciesIdqueryintNo
CurrencyRatesIdquerylongNo

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

HTTP + CSV

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

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

[{"TenantsId":0,"ActionsId":0,"DebtsId":0,"PaymentDate":"0001-01-01T00:00:00.0000000+00:00","PaidAmount":0,"DiscountAmount":0,"CurrenciesId":0,"CurrencyRatesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]