Skip to content

List of all credit notes

Request

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

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

One credit note in response has the same format as credit note detail response. See Credit note snapshot schema for more details.

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

ValueSection
surchargeParametersItem surcharge parameters.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
creationTimeFromstring

Export credit notes created after date

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

Export credit notes created before date

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

Export credit notes updated after date

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

Export credit notes updated before date

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

Export credit notes with code after given value

Example:codeFrom=0000000006
codeTostring

Export credit notes with code before given value

Example:codeTo=0000000006
invoiceCodeFromstring

Export credit notes with invoice code after given value

Example:invoiceCodeFrom=2017000010
invoiceCodeTostring

Export credit notes with invoice code before given value

Example:invoiceCodeTo=2017000010
dueDateFromstring

Export credit notes with due date after date

Example:dueDateFrom=2014-09-05
dueDateTostring

Export credit notes with due date before date

Example:dueDateTo=2019-09-05
hasProofPaymentCodeboolean

Export credit notes with or without proof payment codes only

Example:hasProofPaymentCode=true
taxDateFromstring

Export credit notes with tax date after date

Example:taxDateFrom=2014-09-05
taxDateTostring

Export credit notes with tax date before date

Example:taxDateTo=2019-09-05
orderCodeFromstring

Export credit notes with order code after given value

Example:orderCodeFrom=2017000010
orderCodeTostring

Export credit notes with order code before given value

Example:orderCodeTo=2017000010
customerGuidstring

Export credit notes with given customer

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

Export credit notes with given variable symbol

Example:varSymbol=2010001
restockedboolean

Export restocked or not restocked credit notes

Example:restocked=false
isValidboolean

Filtering according to document validity

Example:isValid=true
includestring

Sections to include

Example:include=surchargeParameters
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/credit-notes/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&codeFrom=0000000006&codeTo=0000000006&invoiceCodeFrom=2017000010&invoiceCodeTo=2017000010&dueDateFrom=2014-09-05&dueDateTo=2019-09-05&hasProofPaymentCode=true&taxDateFrom=2014-09-05&taxDateTo=2019-09-05&orderCodeFrom=2017000010&orderCodeTo=2017000010&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&varSymbol=2010001&restocked=false&isValid=true&include=surchargeParameters' \
  -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"
  }
}