# Credit notes

Managing credit notes in the e-shop.

The code (`code`) is the credit note identifier. Although this is usually
a number, it is necessary to take into account that this might also
include letters, a dash, etc.

## List of credit notes

 - [GET /api/credit-notes](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/getlistofcreditnotes.md): The list of credit notes supports Paging

## List of all credit notes

 - [GET /api/credit-notes/snapshot](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/getlistofallcreditnotes.md): Additional information about one credit notes.

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

Value | Section
--------|------
| Item surcharge parameters

## Credit note detail

 - [GET /api/credit-notes/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/getcreditnotedetail.md): Additional information about one credit note.

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

Value | Section
--------|------
| Item surcharge parameters

## Credit note update

 - [PATCH /api/credit-notes/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/updatecreditnote.md)

## Credit note deletion

 - [DELETE /api/credit-notes/{code}](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/deletecreditnote.md)

## Credit note restock

 - [POST /api/credit-notes/{code}/restock](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/restockcreditnote.md): Restock items from credit note.

## Credit note from invoice creation

 - [POST /api/invoices/{code}/credit-note](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/createcreditnotefrominvoice.md): Creating credit note from existing invoice.

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


Value | Section

--------|------

| Item surcharge parameters

It will create a credit note from the given invoice. It will
automatically take all invoice items and add them to the credit note. If
you want to add just some items from the invoice or different amount,
use the parameter . This parameter will allow you to generate
credit note only with provided items.

## 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.

## Creation of credit note item

 - [POST /api/credit-notes/{code}/item](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/createcreditnoteitem.md): Creates a new credit note item to an existing credit note.

## Update of credit note item

 - [PATCH /api/credit-notes/{code}/item/{id}](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/updatecreditnoteitem.md): Updates credit note item. It's not possible to change 
property and it's not possible to update credit note item of another
type then  or .

## Deletion of credit note item

 - [DELETE /api/credit-notes/{code}/item/{id}](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/deletecreditnoteitem.md): Deletes credit note item. It's not possible to delete credit note item
of another type then  or .

## Download credit note as PDF

 - [GET /api/credit-notes/{code}/pdf](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/downloadcreditnotepdf.md): You can request the credit note 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 credit note as ISDOC

 - [GET /api/credit-notes/{code}/isdoc](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/downloadcreditnoteasisdoc.md): You can request the credit note 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 credit note changes

 - [GET /api/credit-notes/changes](https://api.docs.shoptet.com/shoptet-api/openapi/credit-notes/getlastcreditnotechanges.md): Returns the list of credit notes, which were changed. The Endpoint is intended to determine
the changes after you have loaded the list of credit notes and you need to know the changes. 
The guaranteed history of changes is 30 days.


Each credit note is only given in the listing with its last change. For example, if the credit note 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.