Skip to content

List of invoices

Request

Returns the list of invoices with basic information. The list of invoices supports Paging

The code (code) is the invoice identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, a dash, etc. Filtering uses string comparison with >=, <= operators.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
isValidboolean

filtering according to document validity

Example:isValid=true
proformaInvoiceCodestring

filtering according to number of proforma invoice

Example:proformaInvoiceCode=2017000017
creationTimeFromstring

filtering according to date of invoice issue

Example:creationTimeFrom=2017-02-28T17:04:47+0100
creationTimeTostring

filtering according to date of invoice issue

Example:creationTimeTo=2028-02-28T17:04:47+0100
changeTimeFromstring

filtering invoices updated after date

Example:changeTimeFrom=2014-09-05T00:00:00%2B0000
changeTimeTostring

filtering invoices updated before date

Example:changeTimeTo=2019-09-05T00:00:00%2B0000
taxDateFromstring

filtering invoices with tax date after date

Example:taxDateFrom=2017-02-28
taxDateTostring

filtering invoices with tax date before date

Example:taxDateTo=2019-09-05
orderCodestring

filtering according to order code of invoice

Example:orderCode=2018000012
codeFromstring

filtering according to code of invoice

Example:codeFrom=2018000001
codeTostring

filtering according to code of invoice

Example:codeTo=2018000012
customerGuidstring

filtering invoices with given customer

Example:customerGuid=443cad54-73bc-11e8-8216-002590dad85e
varSymbolstring

filtering according to variable symbol of invoice

Example:varSymbol=666
itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 1000.

Example:itemsPerPage=888
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/invoices?isValid=true&proformaInvoiceCode=2017000017&creationTimeFrom=2017-02-28T17%3A04%3A47%2B0100&creationTimeTo=2028-02-28T17%3A04%3A47%2B0100&changeTimeFrom=2014-09-05T00%3A00%3A00%252B0000&changeTimeTo=2019-09-05T00%3A00%3A00%252B0000&taxDateFrom=2017-02-28&taxDateTo=2019-09-05&orderCode=2018000012&codeFrom=2018000001&codeTo=2018000012&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&varSymbol=666&itemsPerPage=888&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "invoices": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}