Credit notes
Last updated
Last updated
Authentication: endpoints listed in this page require header authentication with a user token.
GET
https://{domain}.biapi.pro/2.0/users/{userId}/credit_notes
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Response body: CreditNotesList object
GET
https://{domain}.biapi.pro/2.0/users/{userId}/credit_notes/{credit_notesId}
Get a single credit note by ID.
Response body: CreditNote object
Name | Type | Description |
---|---|---|
Property | Type | Description |
---|---|---|
Property | Type | Description |
---|---|---|
Property | Description |
---|---|
Property | Description |
---|---|
Property | Description |
---|---|
Property | Type | Description |
---|---|---|
userId*
Integer or "me"
ID of the related user.
all
Value-less
Flag to include deleted credit notes.
limit*
Integer
Number of credit notes to return. The maximum value is 100.
userId*
Integer or "me"
ID for the related user.
credit_notesId*
Integer
ID of the credit note.
credit_notes
Array of CreditNote object objects
List of credit notes.
id
Integer
ID of the invoice.
id_user
Integer
ID of the related user.
id_connection
Integer
ID of the related connection.
id_connection_source
Integer
ID of the related connection source.
id_invoice
Integer
ID of the related invoice.
number
String
Credit notes number.
memo
String or null
Memo of the credit note.
issue_date
DateTime or nuIl
Issue date of the credit note.
created
DateTime
Creation date of the credit note.
total_amount
Total amount of the credit note.
total_amount_exclusing_tax
CreditNoteAmount objector null
Total amount excluding the tax of the credit note.
total_tax_amount
CreditNoteAmount objector null
Total tax amount of the credit note.
total_discount_amount
CreditNoteAmount objector null
Total discount amount of the invoice.
amount_paid_out_of_platform
Integer or null
shipping_amount
Shipping amount of the credit note.
reason
CreditNotesReason valuesor null
Reason of the credit note
type
CreditNotesType values or null
status
#status-values or null
Status of the credit note.
scraped_date
DateTime
Date and time when the invoice was retrieved.
attachments
Array of Transactions attachments
Original document.
last_update
DateTime
Last successful update of the credit note.
deleted
DateTime or null
Deleted date.
duplicate
Duplicate credit note.
fraudulent
Fraudulent.
order_change
Change of order.
product_unstatisfactory
Unsastifactory product.
unknown
Unknown.
pre_payment
The credit note was issued when the invoice was open.
post_payment
The credit note was issued when the invoice was paid.
void
The credit note is cancelled.
issued
The credit note is issued.
currency
String
ID of the currency (ISO 4217 code).
value
Decimal or null
Value.