Skip to content

List of all invoices

Request

Using this endpoint, you can get list of all invoices with detailed info of each invoice (like in Invoice Detail endpoint) asynchronously.

See how Asynchronous requests work on our developer's portal.

Response will be in jsonlines format with each invoice taking one line of output file.

One invoice in response has the same format as invoice detail response. See Invoice snapshot schema for more details.

Result file is compressed using GZIP.

This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand).

ValueSection
surchargeParametersItem surcharge parameters
Security
shoptetAccessToken or shoptetPrivateApiToken
Query
includestring

Sections to include

Example:include=surchargeParameters
creationTimeFromstring

Export invoices created after date

Example:creationTimeFrom=2014-09-05T00:00:00%2B0000
creationTimeTostring

Export invoices created before date

Example:creationTimeTo=2019-09-05T00:00:00%2B0000
changeTimeFromstring

Export invoices updated after date

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

Export invoices updated before date

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

Export invoices with code after given value

Example:codeFrom=0000000006
codeTostring

Export invoices with code before given value

Example:codeTo=0000000006
proformaInvoiceCodeFromstring

Export invoices with proforma invoice code after given value

Example:proformaInvoiceCodeFrom=2017000010
proformaInvoiceCodeTostring

Export invoices with proforma invoice code befor given value

Example:proformaInvoiceCodeTo=2017000010
dueDateFromstring

Export invoices with due date after date

Example:dueDateFrom=2014-09-05
dueDateTostring

Export invoices with due date before date

Example:dueDateTo=2019-09-05
taxDateFromstring

Export invoices with tax date after date

Example:taxDateFrom=2014-09-05
taxDateTostring

Export invoices with tax date before date

Example:taxDateTo=2019-09-05
orderCodeFromstring

Export invoices with order code after given value

Example:orderCodeFrom=2017000010
orderCodeTostring

Export invoices with order code before given value

Example:orderCodeTo=2017000010
customerGuidstring

Export invoices with given customer

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

Export invoices with given variable symbol

Example:varSymbol=2010001
isValidboolean

Filtering according to document validity

Example:isValid=true
hasTaxIdboolean

Filtering according to the presence of a TAX identification number

Example:hasTaxId=true
hasVatIdboolean

Filtering according to the presence of a VAT identification number

Example:hasVatId=true
hasCompanyIdboolean

Filtering according to the presence of a company registration number

Example:hasCompanyId=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/invoices/snapshot?include=surchargeParameters&creationTimeFrom=2014-09-05T00%3A00%3A00%252B0000&creationTimeTo=2019-09-05T00%3A00%3A00%252B0000&changeTimeFrom=2014-09-05T00%3A00%3A00%252B0000&changeTimeTo=2019-09-05T00%3A00%3A00%252B0000&codeFrom=0000000006&codeTo=0000000006&proformaInvoiceCodeFrom=2017000010&proformaInvoiceCodeTo=2017000010&dueDateFrom=2014-09-05&dueDateTo=2019-09-05&taxDateFrom=2014-09-05&taxDateTo=2019-09-05&orderCodeFrom=2017000010&orderCodeTo=2017000010&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&varSymbol=2010001&isValid=true&hasTaxId=true&hasVatId=true&hasCompanyId=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json
dataobject
Response
{
  "data": {
    "jobId": "ad24xod"
  }
}