POST
/
invoices
/
{id}
/
credit

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

Invoice identifier

Body

positions
object[]

The positions to cancel.

comment
string | null

Comment for the activity of crediting the invoice.

reason
enum<string>
default:
other

The reason for crediting the invoice.

Available options:
duplicate,
incorrect,
product_unsatisfactory,
order_change,
other
paymentMethod
string

The payment method for the credit note. The payment method must be valid and usable.

customIntroduction
string | null

The custom introduction for the credit note. It will be placed over the generic template.

customClosing
string | null

The custom closing for the credit note. It will be placed over the generic template.

Response

201
application/json
id
string

The unique identifier of the invoice.

customer
object

The customer of the invoice.

paymentMethod
object | null

The payment method which should be used to fullfill the payment of the invoice.

referencedInvoice
object | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.