WebAPI

<back to all web services

GetSettlements

Retrieve settlements for customer

Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes
PageSizepathintegerYes
PageNumberpathintegerYes
SortingpathstringNo

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: localhost 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetSettlements

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetSettlements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <AccountId>0</AccountId>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <Sorting>String</Sorting>
</GetSettlements>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetSettlementsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Settlements>
    <Settlement>
      <Balance>0</Balance>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <InstalmentId>0</InstalmentId>
      <InstalmentStatus>0</InstalmentStatus>
      <PaymentDue>0</PaymentDue>
      <Payments>0</Payments>
      <PreviousBalance>0</PreviousBalance>
      <SettlementId>0</SettlementId>
      <SettlementTypeId>0</SettlementTypeId>
    </Settlement>
  </Settlements>
  <TotalNumber>0</TotalNumber>
</GetSettlementsResponse>

    </soap:Body>
</soap:Envelope>