# Proof payments The code (`code`) is the proof payments identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, a dash, etc. ## Credit note from proof of payment - [POST /api/proof-payments/{code}/credit-note](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/createcreditnotefromproofofpayment.md): Creating credit note from existing proof of payment. It will create a credit note from the given proof of payment. It will automatically take all proof of payment items and add them to the credit note. ## List of proof payments - [GET /api/proof-payments](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/getlistofproofpayments.md): The list of proof payments supports Paging. ## Proof payment insertion - [POST /api/proof-payments](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/createproofpayment.md) ## Proof payment detail - [GET /api/proof-payments/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/getproofpaymentdetail.md): Additional information about one proof payment. ## Proof payment update - [PATCH /api/proof-payments/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/updateproofpayment.md): If the proof payment is closed, response code is returned and the document cannot be updated. Proof payment is closed if: - proof payment is/was linked to the invoice or - there is a manual lock of proof payment. ## Proof payment deletion - [DELETE /api/proof-payments/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/deleteproofpayment.md): If the proof payment is closed, response code is returned and the document cannot be deleted. Proof payment is closed if: - proof payment is/was linked to the invoice or - there is a manual lock of proof payment. ## List of all proof payments - [GET /api/proof-payments/snapshot](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/getlistofallproofpayments.md): 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. Result file is compressed using GZIP. ## Proof payment detail by order code - [GET /api/proof-payments/order/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyordercode.md) ## Proof payment insertion by order code - [POST /api/proof-payments/order/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/createproofpaymentbyordercode.md) ## Proof payment detail by proforma invoice code - [GET /api/proof-payments/proforma-invoice/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyproformainvoicecode.md) ## Proof payment insertion by proforma invoice code - [POST /api/proof-payments/proforma-invoice/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/createproofpaymentbyproformainvoicecode.md) ## Proof payment document settings - [POST /api/proof-payments/{code}/document-settings](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/proofpaymentdocumentsettings.md): Using this endpoint, you can unlink an invoice from a proof of payment. After successfully unlinking the invoice, the price of the linked invoice will be recalculated and increased by the price of the proof of payment. Linking of the invoice to the proof of payment is not possible at this endpoint. You can also close a proof of payment with this endpoint. You can open a proof of payment if it is not linked to any invoice. Otherwise, a response code 409 is returned and the document cannot be closed. Important note: If the document is closed, the invoice or proof of payment may have already been sent to the customer! ## Download proof of payment as PDF - [GET /api/proof-payments/{code}/pdf](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/downloadproofofpaymentpdf.md): You can request the proof of payment as PDF file, response will be as application/octet-stream. You can download pdf documents only one-by-one for every e-shop. Parallel requests end with error. ## Download proof payment as ISDOC - [GET /api/proof-payments/{code}/isdoc](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/downloadproofpaymentasisdoc.md): You can request the proof payment as ISDOC file, response will be as application/octet-stream. You can download the documents only one-by-one for every e-shop. Parallel requests end with error. ## Last proof payments changes - [GET /api/proof-payments/changes](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/getlastproofpaymentschanges.md): Returns the list of proof payments, which were changed. The Endpoint is intended to determine the changes after you have loaded the list of proof payments and you need to know the changes. The guaranteed history of changes is 30 days. Each proof payment is only given in the listing with its last change. For example, if the proof payment was modified and then deleted, the listing will only show information about its deletion. Can be filtered by changeType = edit/delete parameter. Creation is considered as action. So, when there is a new item created, it will be displayed like action. Endpoint supports Paging ## Credit note from proof of payment - [POST /api/proof-payments/{code}/credit-note](https://api.docs.shoptet.com/shoptet-api/openapi/proof-payments/createcreditnotefromproofofpayment.md): Creating credit note from existing proof of payment. It will create a credit note from the given proof of payment. It will automatically take all proof of payment items and add them to the credit note.