Skip to content

General document export

Request

You can request documents of several types in several formats in combination with settings as includes. See tables bellow for possibilities and settings. Export is processed asynchronously. See how Asynchronous requests work on our developer's portal.

Document typeDocument formatParametersIncludes
invoicecsvDetailcodeFromexportWithHistoricalVat
xlsDetailcodeToexportAsForeignCurrency
pdfdateFromlinkProformaInvoices
isdocdateTodescOrder
xmlPohodaCztaxDateFrom
xmlPohodaSktaxDateTo
xmlMoneyS3CZcurrency
xmlMoneyS3Sk
xlsxSummary
csvSummary
proformaInvoicecsvDetailcodeFromexportWithHistoricalVat
xlsDetailcodeToexportAsForeignCurrency
pdfdateFrom
xmlPohodaCzdateTo
xmlPohodaSktaxDateFrom
xmlMoneyS3CZtaxDateTo
xmlMoneyS3Skcurrency
xlsxSummary
csvSummary
creditNotecsvDetailcodeFromexportWithHistoricalVat
xlsDetailcodeToexportAsForeignCurrency
pdfdateFrom
isdocdateTo
xmlPohodaCztaxDateFrom
xmlPohodaSktaxDateTo
xmlMoneyS3CZcurrency
xmlMoneyS3Sk
xlsxSummary
csvSummary
proofPaymentxmlPohodaCzcodeFromexportWithHistoricalVat
xmlPohodaSkcodeToexportAsForeignCurrency
csvDetaildateFromonlyClosedProofPayments
xlsDetaildateTo
pdftaxDateFrom
taxDateTo
currency
deliveryNotecsvDetailcodeFrom
xlsDetailcodeTo
pdfdateFrom
dateTo
taxDateFrom
taxDateTo
IncludeDoes
exportWithHistoricalVatWill export historical rates.
exportAsForeignCurrencyCurrency will be exported as foreign regardless of e-shop settings.
linkProformaInvoicesCorresponding proforma invoices will be added to export file.
onlyClosedProofPaymentsExports only finished documents.
descOrderSort as starting from oldest
Security
shoptetAccessToken or shoptetPrivateApiToken
Path
typestringrequired

See tables for all document types

Example:proofPayment
formatstringrequired

See tables for all document formats

Example:xmlPohodaCz
Query
currencystring

Mandatory except for Delivery notes

Example:currency=czk
codeFromstring
Example:codeFrom=2018000004
codeTostring
Example:codeTo=2018000006
dateFromstring
Example:dateFrom=2022-12-12
dateTostring
Example:dateTo=2023-12-12
taxDateFromstring
Example:taxDateFrom=2022-12-12
taxDateTostring
Example:taxDateTo=2023-12-12
includestring

Sections to include

Example:include=exportWithHistoricalVat, exportAsForeignCurrency, linkProformaInvoices, onlyClosedProofPayments, descOrder
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/export/proofPayment/xmlPohodaCz?currency=czk&codeFrom=2018000004&codeTo=2018000006&dateFrom=2022-12-12&dateTo=2023-12-12&taxDateFrom=2022-12-12&taxDateTo=2023-12-12&include=exportWithHistoricalVat%2C%20exportAsForeignCurrency%2C%20linkProformaInvoices%2C%20onlyClosedProofPayments%2C%20descOrder' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

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