The credit note object

Credit note

Parameter	Data type	Default	Description
`credit_note_number`	`int`	`NULL`	The credit note number for this credit note. This is `null` until `status` is `booked`
`status`	`string`	`draft`	Is the credit note booked or not? Possible values: `draft`, `booked`
`order_type`	`string`	`b2b`	Order type
`customer_id`	`int`		The customer of the credit note
`currency`	`string`		The currency of the credit note
`order_id`	`int`	`NULL`	A "manual credit note" has empty `order_id`
`order_invoice_id`	`int`	`NULL`	A "manual credit note" has empty `order_invoice_id`
`notes`	`string`	`NULL`	An optional note/comment
`meta`	`object`	`{}`	An object with `{"key": "value"}` with custom meta data of the order. This is used for storing custom fields
`total_quantity`	`int`		The total credited quantity
`price_before_discount`	`float`		The total price of the order before discount and ex VAT
`discount_amount`	`float`		The total discount given as an amount ex VAT
`discount_percentage`	`float`		The total discount given as a percentage
`net_price`	`float`		The total price of the order ex VAT, shipping and handling fee and after discount
`shipping`	`float`		The shipping amount ex VAT
`handling_fee`	`float`		The handling fee amount ex VAT
`vat_amount`	`float`		The total VAT amount
`total_price_after_vat`	`float`		The total price of the order incl VAT
`created_at`	`datetime`
`updated_at`	`datetime`
`lines.*`			An array of object credit note line

Parameter	Data type	Default	Description
`product_id`	`int`		The product credited
`variant_id`	`int`		The variant credited
`quantity`	`int`		The quantity credited
`claim_type`	`string`	`return`	The claim type of the line. Possible values: `return`, `claim`. `return` will return the item to inventory, `claim` will not
`claim_cause_id`	`int`	`NULL`	The claim cause of the line
`price_before_discount`	`float`		The unit price of the line before discount and ex VAT
`discount_amount`	`float`		The unit discount given as an amount ex VAT
`discount_percentage`	`float`		The discount given as a percentage
`net_price`	`float`		The unit price of the line ex VAT and after discount
`vat_amount`	`float`		The unit VAT amount
`total_price`	`float`		The total price of the line ex VAT. This is calculated as `quantity * net_price`
`total_price_after_vat`	`float`		The total price of the line incl VAT
`created_at`	`datetime`
`updated_at`	`datetime`