API Reference
DocumentationChangelogConsoleWebsite
  • API Guides
  • Overview
    • API design
    • Errors
    • Webview
    • Fair usage policy
    • Authentication
  • USER CONNECTIONS
    • Users
    • Connectors
    • Connections
  • PRODUCTS
    • DATA AGGREGATION
      • Bank accounts
      • Bank transactions
      • Transactions attachments
      • Categorization
      • Bank account types
      • Balances
      • Currencies
      • Account Ownerships
      • Identities (obsolete)
      • Categories (obsolete)
      • Invoices
      • Credit notes
      • Advisory (obsolete)
      • Indicators
    • WEALTH AGGREGATION
      • Investments
      • Market orders
      • Pockets
      • Loan amortizations
    • DOCUMENTS AGGREGATION
      • Subscriptions
      • Documents
      • Document types
      • Connection Identity
    • PAYMENTS
      • Payments
      • Payment Links
      • Transfers (obsolete)
  • API SETUP
    • Configuration
    • Client applications
Powered by GitBook
On this page
  • API endpoints
  • List credit notes
  • Get a credit note
  • Data model
  • CreditNotesList object
  • CreditNote object
  • CreditNotesReason values
  • CreditNotesType values
  • CreditNotesStatus values
  • CreditNoteAmount object

Was this helpful?

  1. PRODUCTS
  2. DATA AGGREGATION

Credit notes

PreviousInvoicesNextAdvisory (obsolete)

Last updated 1 year ago

Was this helpful?

API endpoints

Authentication: endpoints listed in this page require 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

Response body: empty list

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.

Response body: CreditNote object

Data model

CreditNotesList object

Property
Type
Description

credit_notes

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

Total amount of the credit note.

total_amount_exclusing_tax

Total amount excluding the tax of the credit note.

total_tax_amount

Total tax amount of the credit note.

total_discount_amount

Total discount amount of the invoice.

amount_paid_out_of_platform

Integer or null

shipping_amount

Shipping amount of the credit note.

reason

Reason of the credit note

type

status

Status of the credit note.

scraped_date

DateTime

Date and time when the invoice was retrieved.

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

value

Decimal or null

Value.

Array of objects

or null

or null

or null

or null

or null

or null

Array of

ID of the currency ().

header authentication
Transactions attachments
CreditNote object
CreditNoteAmount object
CreditNoteAmount object
CreditNoteAmount object
CreditNoteAmount object
CreditNoteAmount object
CreditNotesReason values
CreditNotesType values
#status-values
ISO 4217 code