# List of proof payments

The list of proof payments supports Paging.

Endpoint: GET /api/proof-payments
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `code` (string)
    filtering according to proof payments code. Optional.
    Example: "P--2015000170-1"

  - `orderCode` (string)
    filtering according to order code. Optional.
    Example: "2015000001"

  - `proformaInvoiceCode` (string)
    filtering according to proforma invoice code. Optional.
    Example: "2015000170"

  - `invoiceCode` (string)
    filtering by invoice code
    Example: "2017100013"

  - `issueDate` (string)
    filtering according to date on which was proof payment issued. In
ISO 8601 format. Optional.
    Example: "2024-12-24T15:22:02+0200"

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

  - `closed` (boolean)
    filtering by proof payment closed/open
    Example: true

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.items` (array, required)

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

  - `data.items.orderCode` (string,null, required)
    order code (can be )

  - `data.items.proformaInvoiceCode` (string,null, required)
    proforma invoice code (can be )

  - `data.items.issueDate` (string,null, required)
    Linked to invoice code (can be )

  - `data.items.billFullName` (string,null, required)
    name on the bill

  - `data.items.payment` (string,null, required)
    total price on the bill

  - `data.items.isValid` (boolean, required)
    is the proof payment valid?

  - `data.items.vatMode` (string,null)
    VAT mode, can be null, for possible values see [VAT modes](#section/code-lists/vat-modes) code list

  - `data.items.invoicingExchangeRate` (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.items.invoiceCode` (string,null, required)
    Linked to invoice code (can be )

  - `data.items.closed` (boolean, required)
    is the proof payment closed?

  - `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