id string, not null
The unique identifier of the credit note.
order_id string, not null
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'.
change_type string
The column indicates the type of change [create, update, delete, read] and can be used to load data into the warehouse accordingly.
record_exported_at timestamp
The column represents the timestamp when the data was exported to the configured destination.
record_id integer
The column represents the unique integer identifier for each child record within a parent subset.
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.