# List of credit notes

The list of credit notes supports Paging

Endpoint: GET /api/credit-notes
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `isValid` (boolean)
    filtering according to document validity. Optional.
    Example: true

  - `invoiceCode` (string)
    filtering according to number of invoice. Optional.
    Example: "0000000006"

  - `creationTimeFrom` (string)
    date of credit note creation, in ISO 8601 format, lower limit.
Optional.
    Example: "2017-02-28T17:04:47+0100"

  - `creationTimeTo` (string)
    date of credit note creation, in ISO 8601 format, upper limit.
Optional.
    Example: "2028-02-28T17:04:47+0100"

  - `varSymbol` (string)
    filtering according to variable symbol of credit note
    Example: "0000000006"

  - `proofPaymentCode` (string)
    filtering according to proof payment code. Optional.
    Example: "P--2017200011-1"

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.creditNotes` (array, required)

  - `data.creditNotes.code` (string, required)
    credit note number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

  - `data.creditNotes.varSymbol` (number,null, required)

  - `data.creditNotes.isValid` (boolean, required)
    is the credit note valid?

  - `data.creditNotes.invoiceCode` (string,null, required)
    invoice number (can be ). Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

  - `data.creditNotes.proofPaymentCode` (string,null, required)
    proof payment code (can be ). Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

  - `data.creditNotes.orderCode` (string,null, required)
    purchase order number (can be ). Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

  - `data.creditNotes.creationTime` (string,null, required)
    date of issue, in ISO 8601 format

  - `data.creditNotes.billCompany` (string,null, required)
    name of the company (can be )

  - `data.creditNotes.billFullName` (string,null, required)
    full name of the customer (can be )

  - `data.creditNotes.price` (object, required)
    price informations

  - `data.creditNotes.price.vat` (string,null, required)
    VAT value, two decimal places

  - `data.creditNotes.price.toPay` (string,null, required)
    total price to pay

  - `data.creditNotes.price.currencyCode` (string, required)
    currency code. List of available currencies within the e-shop can be found in endpoint .

  - `data.creditNotes.price.withoutVat` (string,null, required)
    price excluding tax

  - `data.creditNotes.price.withVat` (string,null, required)
    price including tax

  - `data.creditNotes.price.exchangeRate` (string, required)
    currency rate of the receipt for the default currency of the shop. This value is saved together with the price and reflects the historical value valid in the instant of the order creation. If the shop changes the default currency, the value still refers to the original currency!

  - `data.creditNotes.price.invoicingExchangeRate` (string)
    currency rate of the receipt for the default currency of the shop. This value is saved together with the price and reflects the historical value valid in the instant of the order creation. If the shop changes the default currency, the value still refers to the original currency!

  - `data.creditNotes.price.partialPaymentAmount` (string,null)
    can be value expressed in percents or as exact money value expression (with up to two decimal places) - depends on partialPaymentType value

  - `data.creditNotes.price.partialPaymentType` (string)
    'percents' = partial payment as percentage from total price | 'absolute' = exact expression of partial payment in money

  - `data.creditNotes.changeTime` (string,null, required)
    date of last change, in ISO 8601 format

  - `data.creditNotes.reasonRemark` (string,null)
    Reason for credit note; default reason can be applied if not send.

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced