Invoice list

Retrieve a list of invoices

This endpoint will return the all-in-one invoice for the last month. The optional period can be used to retrieve invoices from the past. For example: /services/rest/invoices?period=2017-01-01/2017-02-01. The period parameter has to comply to the ISO 6801 standard. The format of this standard is as follows: yyyy-mm-dd/yyyy-mm-dd. The period can be no longer than 32 days. The list of invoices is sorted on date in descending order.

GET /services/rest/invoices
 

The list of invoices does not contain all information about each invoice but only contains a minimal summary (e.g. invoice-id, monetary totals and formats in which the invoice is available). With the invoice-id the specific invoice can be obtained in the SI-UBL format, containing all relevant data of the invoice. This brings us to the second REST resource which is documented here.

Accept-headers

You can choose in which format you would like to receive the data by setting the correct accept-header. The available formats are part of the result you get when using the Invoice List, which are:

  • application/json
  • application/xml
  • application/pdf

Parameters

Note: Only one parameter can be used at a time.

Name Type Description
period string, ISO 6801 The default value when the parameter is not given. Default is a period of four weeks.
orderId integer The response will show an invoice if it can match the OrderId. If the response is empty you can safely assume that the OrderId has not generated an InvoiceId yet. In the end, this parameter could be used to check if you have been paid for a certain OrderId.

Example request and response

GET /services/rest/invoices?period=2017-01-01/2017-02-01
Status: 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InvoiceList>
<Period>2017-01-10T00:00:00.000+01:00/2017-01-30T00:00:00.000+01:00</Period>
<InvoiceListItem>
<InvoiceId>78910</InvoiceId> <!-- This identifier can be used to retrieve specific invoices and their specifications -->
<IssueDate>2017-01-19T00:00:00+01:00</IssueDate>
<InvoiceType>DAILY</InvoiceType>
<LegalMonetaryTotal>
<LineExtensionAmount>
<Amount>-21.08</Amount>
<CurrencyID>EUR</CurrencyID>
</LineExtensionAmount>
<TaxExclusiveAmount>
<Amount>-21.08</Amount>
<CurrencyID>EUR</CurrencyID>
</TaxExclusiveAmount>
<TaxInclusiveAmount>
<Amount>-20.26</Amount>
<CurrencyID>EUR</CurrencyID>
</TaxInclusiveAmount>
<PayableAmount>
<Amount>-20.26</Amount>
<CurrencyID>EUR</CurrencyID>
</PayableAmount>
</LegalMonetaryTotal>
<InvoiceMediaTypes> <!-- These indicate in which format the invoice can be retrieved -->
<AvailableMediaTypes>application/json</AvailableMediaTypes>
<AvailableMediaTypes>application/xml</AvailableMediaTypes>
<AvailableMediaTypes>application/pdf</AvailableMediaTypes>
</InvoiceMediaTypes>
<SpecificationMediaTypes> <!-- These indicate in which format the specification of the invoice can be retrieved -->
<AvailableMediaTypes>application/json</AvailableMediaTypes>
<AvailableMediaTypes>application/xml</AvailableMediaTypes>
<AvailableMediaTypes>application/pdf</AvailableMediaTypes>
</SpecificationMediaTypes>
</InvoiceListItem>
</InvoiceList>