WebAPI

<back to all web services

GetSettlements

Retrieve settlements for customer

The following routes are available for this service:
POST/GetSettlements
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes
PageSizepathintegerYes
PageNumberpathintegerYes
SortingpathstringNo

To override the Content-type in your clients 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.

POST /json/reply/GetSettlements HTTP/1.1 
Host: localhost 
Content-Type: application/json
Content-Length: length

{"AccountId":0,"PageSize":0,"PageNumber":0,"Sorting":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Settlements":[{"SettlementId":0,"InstalmentId":0,"DueDate":"\/Date(-62135596800000-0000)\/","SettlementTypeId":0,"PaymentDue":0,"PreviousBalance":0,"Balance":0,"Payments":0,"InstalmentStatus":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"TotalNumber":0}