WebAPI

<back to all web services

GetStatements

Get account statement for the given account id with filters for start and end dates and page size limit.

RESTFUL call with Account ID and Page Size in the URI
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes
PageSizepathintegerYes
PageNumberpathintegerYes
SortingpathstringNo
StartDatepathstringNoYYYY-MM-DD
EndDatepathstringNoYYYY-MM-DD

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: text/xml; charset=utf-8
Content-Length: length

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

<GetStatements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <AccountId>0</AccountId>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SearchAmount>0</SearchAmount>
  <SearchStatementNumber>String</SearchStatementNumber>
  <Sorting>String</Sorting>
  <StartDate>0001-01-01T00:00:00</StartDate>
</GetStatements>

    </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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

<GetStatementsResponse 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>
  <Statements xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:StatementRecord>
      <d2p1:AmountDue>0</d2p1:AmountDue>
      <d2p1:Balance>0</d2p1:Balance>
      <d2p1:BillingEndDate>0001-01-01T00:00:00</d2p1:BillingEndDate>
      <d2p1:BillingStartDate>0001-01-01T00:00:00</d2p1:BillingStartDate>
      <d2p1:Day>0</d2p1:Day>
      <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
      <d2p1:Month>0</d2p1:Month>
      <d2p1:OtherCharges>0</d2p1:OtherCharges>
      <d2p1:PaidDate>0001-01-01T00:00:00</d2p1:PaidDate>
      <d2p1:PreviousBalance>0</d2p1:PreviousBalance>
      <d2p1:Replenishments>0</d2p1:Replenishments>
      <d2p1:StatementDate>0001-01-01T00:00:00</d2p1:StatementDate>
      <d2p1:StatementId>0</d2p1:StatementId>
      <d2p1:StatementNumber>String</d2p1:StatementNumber>
      <d2p1:TollFees>0</d2p1:TollFees>
      <d2p1:Year>0</d2p1:Year>
    </d2p1:StatementRecord>
  </Statements>
  <TotalNumber>0</TotalNumber>
</GetStatementsResponse>

    </soap12:Body>
</soap12:Envelope>