<back to all web services

InvoicesOverview

Requires Authentication
Requires any of the roles:Klant, Kassasysteem, Vertegenwoordiger, KCU Bestelprogramma
The following routes are available for this service:
GET/Customer/Invoice/Overview/{Page}
GET/Customer/{CustomerNumber}/Invoice/Overview/
GET/Customer/{CustomerNumber}/Invoice/Overview/{Page}
GET/Customer/Invoice/Overview
InvoicesOverview Parameters:
NameParameterData TypeRequiredDescription
CustomerNumberpathstringNo
IncludePaidInvoicesquerybool?No
MaxQuantityqueryint?No
Pagepathint?No
InvoicesOverviewResponse Parameters:
NameParameterData TypeRequiredDescription
InvoicesformList<InvoiceOverview>No
NextPageformint?No
ResponseStatusformResponseStatusNo
InvoiceOverview Parameters:
NameParameterData TypeRequiredDescription
InvoiceNrformstringNo
CustomerNumberformstringNo
InvoiceDateformDateTimeNo
DueDateformDateTime?No
CurrencyCodeformstringNo
InvoiceOpenformboolNo
InvoiceAmountformdecimal?No
PayedAmountformdecimal?No
BalanceAmountformdecimal?No
DownloadPDFUrlformUriNo

To override the Content-type in your clients, use the 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/InvoicesOverview HTTP/1.1 
Host: webservice.kruitbosch.nl 
Content-Type: application/xml
Content-Length: length

<InvoicesOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webservices.ServiceModel.Operations">
  <CustomerNumber>String</CustomerNumber>
  <IncludePaidInvoices>false</IncludePaidInvoices>
  <MaxQuantity>0</MaxQuantity>
  <Page>0</Page>
</InvoicesOverview>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoicesOverviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webservices.ServiceModel.Operations">
  <Invoices xmlns:d2p1="http://schemas.datacontract.org/2004/07/Webservices.ServiceModel.Types">
    <d2p1:InvoiceOverview>
      <d2p1:BalanceAmount>0</d2p1:BalanceAmount>
      <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
      <d2p1:CustomerNumber>String</d2p1:CustomerNumber>
      <d2p1:DownloadPDFUrl i:nil="true" />
      <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
      <d2p1:InvoiceAmount>0</d2p1:InvoiceAmount>
      <d2p1:InvoiceDate>0001-01-01T00:00:00</d2p1:InvoiceDate>
      <d2p1:InvoiceNr>String</d2p1:InvoiceNr>
      <d2p1:InvoiceOpen>false</d2p1:InvoiceOpen>
      <d2p1:PayedAmount>0</d2p1:PayedAmount>
    </d2p1:InvoiceOverview>
  </Invoices>
  <NextPage>0</NextPage>
  <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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</InvoicesOverviewResponse>