Skip to content

List of all proforma invoices

Request

Using this endpoint, you can get list of all proforma invoices with detailed info of each proforma invoice (like in Proforma invoice detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal.

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

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

Result file is compressed using GZIP.

This endpoint has one section, which is 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 proforma invoices created after date

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

Export proforma invoices created before date

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

Export proforma invoices updated after date

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

Export proforma invoices updated before date

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

Export proforma invoices with code after given value (given code included)

Example:codeFrom=0000000006
codeTostring

Export proforma invoices with code before given value (given code included)

Example:codeTo=0000000006
isValidboolean

Filtering according to document validity

Example:isValid=true
paidboolean

Filtering according to if proforma invoice is paid

Example:paid=true
currencyCodestring

Export proforma invoices with given currency code, if given currency code does not exists, or is not valid, it will throw an exception

Example:currencyCode=CZK
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/proforma-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&isValid=true&paid=true&currencyCode=CZK' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

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