orders/exportdocuments/JPK

get

https://{domain}/api/admin/v8/orders/exportdocuments/JPK

Method returns sales and warehouse documents in universal JPK format.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

documentType

string

enum

Document type

Allowed:

fileId

integer

JPK file identifier to download.

documentVersion

integer

JPK format version. If empty, takes the latest version number.

schemaVersion

string

Schema version

dateBegin

string

Beginning date in YYYY-MM-DD HH:MM:SS format. (JPK_FA, JPK_MAG)

dateEnd

string

Ending date in YYYY-MM-DD HH:MM:SS format. (JPK_FA, JPK_MAG)

month

integer

Billing month for which to generate the document. (JPK_VAT)

year

integer

Billing year for which to generate the document. (JPK_VAT)

currency

string

Currency symbol in ISO 4217 format.

shop

array of integers

Store ID only required if a specific store is selected.

shop

stockId

array of integers

Stock ID

stockId

forceBackgroundGenerate

boolean

Forces the file to be generated by background tasks. The file will be generated later. Then, after it is generated, you will be able to download the given file using the returned ID. The file will be available 24h after the task is completed.

Responses

401

Authorization error

403

Access denied

404

Not found

422

Invalid data format

429

Too many requests

500

Internal server error

200OK

207Multi-Status