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. |
Response body: CreditNotesList object
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. |
Response body: CreditNote object
Data model
CreditNotesList object
Property | Type | Description |
---|---|---|
| Array of CreditNote object objects | List of credit notes. |
CreditNote object
Property | Type | Description |
---|---|---|
| Integer | ID of the invoice. |
| Integer | ID of the related user. |
| Integer | ID of the related connection. |
| Integer | ID of the related connection source. |
| Integer | ID of the related invoice. |
| String | Credit notes number. |
| String or null | Memo of the credit note. |
| DateTime or nuIl | Issue date of the credit note. |
| DateTime | Creation date of the credit note. |
| Total amount of the credit note. | |
| CreditNoteAmount objector null | Total amount excluding the tax of the credit note. |
| CreditNoteAmount objector null | Total tax amount of the credit note. |
| CreditNoteAmount objector null | Total discount amount of the invoice. |
| Integer or null | |
| Shipping amount of the credit note. | |
| CreditNotesReason valuesor null | Reason of the credit note |
| CreditNotesType values or null | |
| #status-values or null | Status of the credit note. |
| DateTime | Date and time when the invoice was retrieved. |
| Array of Transactions attachments | Original document. |
| DateTime | Last successful update of the credit note. |
| DateTime or null | Deleted date. |
CreditNotesReason values
Property | Description |
---|---|
| Duplicate credit note. |
| Fraudulent. |
| Change of order. |
| Unsastifactory product. |
| Unknown. |
CreditNotesType values
Property | Description |
---|---|
| The credit note was issued when the invoice was open. |
| The credit note was issued when the invoice was paid. |
CreditNotesStatus values
Property | Description |
---|---|
| The credit note is cancelled. |
| The credit note is issued. |
CreditNoteAmount object
Property | Type | Description |
---|---|---|
| String | ID of the currency (ISO 4217 code). |
| Decimal or null | Value. |
Last updated