Credit notes

API endpoints

Authentication: endpoints listed in this page require header authentication with a user token.

List credit notes

GET https://{domain}.biapi.pro/2.0/users/{userId}/credit_notes

Path Parameters

Name	Type	Description
userId*	Integer or "me"	ID of the related user.

Query Parameters

Name	Type	Description
all	Value-less	Flag to include deleted credit notes.
limit*	Integer	Number of credit notes to return. The maximum value is 100.

200: OK List of credit notes

Response body: CreditNotesList object

200: No credit notes

Route aliases

/users/{userId}/credit_notes
/users/{userId}/connections/{connectionId}/credit_notes
/users/{userId}/invoices/{invoices_id}/credit_notes

Get a credit note

GET https://{domain}.biapi.pro/2.0/users/{userId}/credit_notes/{credit_notesId}

Get a single credit note by ID.

Path Parameters

Name	Type	Description
userId*	Integer or "me"	ID for the related user.
credit_notesId*	Integer	ID of the credit note.

200: OK Transaction

Response body: CreditNote object

Data model

CreditNotesList object

Property	Type	Description
credit_notes	Array of CreditNote object objects	List of credit notes.

CreditNote object

Property	Type	Description
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	CreditNoteAmount object	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	CreditNoteAmount object	Shipping amount of the credit note.
reason	CreditNotesReason valuesor null	Reason of the credit note
type	CreditNotesType values or null
status	Credit notes 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.

CreditNotesReason values

Property	Description
duplicate	Duplicate credit note.
fraudulent	Fraudulent.
order_change	Change of order.
product_unstatisfactory	Unsastifactory product.
unknown	Unknown.

CreditNotesType values

Property	Description
pre_payment	The credit note was issued when the invoice was open.
post_payment	The credit note was issued when the invoice was paid.

CreditNotesStatus values

Property	Description
void	The credit note is cancelled.
issued	The credit note is issued.

CreditNoteAmount object

Property	Type	Description
currency	String	ID of the currency (ISO 4217 code).
value	Decimal or null	Value.