List of credit notes

Request

The list of credit notes supports Paging

Security

shoptetAccessToken or shoptetPrivateApiToken

Query

isValidboolean

filtering according to document validity. Optional.

Example:isValid=true

invoiceCodestring

filtering according to number of invoice. Optional.

Example:invoiceCode=0000000006

creationTimeFromstring

date of credit note creation, in ISO 8601 format, lower limit. Optional.

Example:creationTimeFrom=2017-02-28T17:04:47+0100

creationTimeTostring

date of credit note creation, in ISO 8601 format, upper limit. Optional.

Example:creationTimeTo=2028-02-28T17:04:47+0100

varSymbolstring

filtering according to variable symbol of credit note

Example:varSymbol=0000000006

proofPaymentCodestring

filtering according to proof payment code. Optional.

Example:proofPaymentCode=P--2017200011-1

itemsPerPageinteger

Returned items per page. Default and max value is 20.

Example:itemsPerPage=15

pageinteger

Page number to return. Default value is 1.

Example:page=3

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/credit-notes?isValid=true&invoiceCode=0000000006&creationTimeFrom=2017-02-28T17%3A04%3A47%2B0100&creationTimeTo=2028-02-28T17%3A04%3A47%2B0100&varSymbol=0000000006&proofPaymentCode=P--2017200011-1&itemsPerPage=15&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

{
  "data": {
    "creditNotes": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}