Skip to content

List of all proof payments

Request

Using this endpoint, you can get list of all proof payments with detailed info of each proof payment (like in Proof payment Detail endpoint).

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

One proof payment in response has the same format as proof payment detail response. See Proof payment snapshot schema for more details.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
creationTimeFromstring

Export proof payments created after date

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

Export proof payments created before date

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

Export proof payments updated after date

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

Export proof payments updated before date

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

Export proof payments with tax date after date

Example:taxDateFrom=2014-09-05
taxDateTostring

Export proof payments with tax date before date

Example:taxDateTo=2019-09-05
isValidboolean

Filtering according to document validity

Example:isValid=true
currencyCodestring

Proof payment currency

Example:currencyCode=CZK
closedboolean

Is the proof payment closed?

Example:closed=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/proof-payments/snapshot?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&taxDateFrom=2014-09-05&taxDateTo=2019-09-05&isValid=true&currencyCode=CZK&closed=true' \
  -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"
  }
}