Overview
Credit notes are a way to give money back to a customer. A credit note must be linked to a paid invoice. An invoice can have multiple credit notes. However, their total amount must not exceed the paid amount on the invoice.
A credit notes generates a refund of a payment for the customer.
Properties of a Credit Note Object
id(String): Credit note ID.currency(Object): Object describing currency.amount(String): Credit amount.reason(String): Reason why the credit was issued.creditNoteCode(String): Credit note code.creditNoteItems(Array): Credit note items. An array of Credit Note Item objects.createdDate(String): Date and time the credit note was created.
Properties of a Detailed Credit Note Object
id(String): Credit note ID.memo(String): Credit note memo.customerEmail(String): Customer's email address.amount(String): Amount.currencyIsoCode(String): ISO code of the currency.reason(String): Reason why the credit was issued.invoiceCode(String): Invoice code.creditNoteCode(String): Credit note code.metadata(Array): Any custom properties of the credit note in the form of key-value pairs.createdDate(String): Date and time the credit note was created.creditNoteItems(Array): Credit note items. An array of Credit Note Item objects.
Properties of a Credit Note Item Object
id(String): Credit note item ID.productPricesId(String): Product price ID.quantity(number): Quantity.price(String): Price.amount(String): Amount.