1. Invoicing
  2. Orders
  3. Order linked credit notes

Order linked credit notes

order_linked_credit_notes
copy
Click to Copy
The credit notes linked to the order

Columns

No match found
id string, not null
The unique identifier of the credit note.
order_id string, not null
Foreign Key orders.id
The unique identifier of the order.
amount long, null
The amount issued for this order
amount_adjusted long, null
Total amount adjusted on the order for the linked credit note. Applicable if the linked credit note is of the type 'adjustment'.
amount_refunded long, null
Total refundable credits issued on the order for the linked credit note. Applicable if the linked credit note is of the type 'refundable'.
status string, not null
The credit note status. Possible values are:
  • adjusted: When the Credit Note has been adjusted against an invoice.
  • refunded: When the entire credits (Credit Note amount) have been used (i.e., either allocated to invoices or refunded).
  • refund_due: When the credits are yet to be used, or have been partially used.
  • voided: When the Credit Note has been cancelled.
type string, not null
The credit note type. Learn more about credit note types. Possible values are:
  • adjustment: Adjustment Credit Note.
  • refundable: Refundable Credit Note.
  • store: Store Credit Note.