API Reference

Credit note object

Attributes


id

string
Unique object's identifier.


invoice

string
The ID of the invoice that was discounted. In read resources this field is expandable, returns the invoice object.


number

number
A unique, identifying number that appears on credit note header sent to the customer of this credit note. It's automatically assigned.


document

string
The ID of the document type for this credit note. Learn more about.


date

date
Closing date of the credit note. Typically this is the date on which credit note is generated.


lines

list
The list of line items for this credit note.


amount

decimal
Taxable subtotal of this credit note.


exempt

decimal
Non taxable subtotal of this credit note.


tax

decimal
Tax amount of this credit note.


tax_percent

decimal
Tax rate to this credit note.


subtotal

decimal
Sum of amount and exempt of this credit note.


total

decimal
Sum of subtotal and taxes to this invoice.


discount

decimal
Discount amount applicable to subtotal to this invoice.


discount_scheme

string
Scheme of the discount, one of $ or %.


local_file

url
URL to local format when document type of this credit note belong to a tax agency.


internal_note

string
An internal note to provide additional information about credit adjustment.


note

string
A note or reason for the customer of this credit note.


tax_agency

object
An object with key pairs for particular tax agency properties.


status

string
Status of this credit note, one of draft or finalized.


user

string
Email of the user that created this credit note.


created

datetime
Date and time of the creation of this credit note.


updated

datetime
Date and time of the last update of this credit note.