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

Query Parameters

Response body: CreditNotesList object

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

Response body: CreditNote object

Data model

CreditNotesList object

CreditNote object

CreditNotesReason values

CreditNotesType values

CreditNotesStatus values

CreditNoteAmount object

Last updated