WebAPI

<back to all web services

DownloadInvoices

Download account invoices for the given account id with filters for start and end dates and page size limit.

The following routes are available for this service:
POST/DownloadInvoicesDownload account invoices for the given account id with filters for start and end dates and page size limit.
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes
PageSizepathintegerNo
PageNumberpathintegerNo
SortingpathstringNo
StartDatepathstringNoYYYY-MM-DD
EndDatepathstringNoYYYY-MM-DD

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

HTTP + XML

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

POST /xml/reply/DownloadInvoices HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<DownloadInvoices 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>
  <SearchInvoiceNumber>String</SearchInvoiceNumber>
  <Sorting>String</Sorting>
  <StartDate>0001-01-01T00:00:00</StartDate>
</DownloadInvoices>

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

<DownloadInvoicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <DownloadStream>AA==</DownloadStream>
  <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>
</DownloadInvoicesResponse>