Invoices

The invoices feature lets you retrieve the invoices of the end user.

API endpoints

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

List invoices

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

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 invoices.

limit*

Integer

Number of invoices to return. The maximum value is 100.

Response body: InvoicesList object

Route aliases
/users/{userId}/invoices
/users/{userId}/connections/{connectionId}/invoices

Get an invoice

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

Get a single invoice by ID.

Path Parameters

Name
Type
Description

userId*

Integer or "me"

ID for the related user.

invoiceId*

Integer

ID of the invoice.

Response body: Invoice object

Data model

InvoicesList object

Property
Type
Description

invoices

List of invoices.

Invoice 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.

number

String

Invoice number.

description

String or null

Description of the invoice.

status

Status of invoice.

items

Items of the invoice. If no items, the list is empty.

customer

Customer of the invoice.

invoicer

Invoicer of the invoice.

total_amount

Total amount of the invoice.

total_amount_exclusing_tax

Total amount excluding the tax of the invoice.

total_tax_amount

Total tax amount of the invoice.

total_discount_amount

Total discount amount of the invoice.

paid_amount

Decimal or null

Paid amount of the invoice.

remaining_amount

Decimal or null

Remaining amount of the invoice.

shipping_amount

Decimal or null

Shipping amount of the invoice.

total_pre_payment_credit_notes_amount

Decimal or null

Credit note amount applied before the payment.

total_post_payment_credit_notes_amount

Decimal or null

Credit note amount applied after the payment.

last_update

DateTime

Last successful update of the invoice.

scraped_date

DateTime

Date and time when the invoice was retrieved.

created

DateTime or null

Date when the invoice was created.

issue_date

DateTime or null

Issue date of the invoice.

due_date

DateTime or null

Due date of the invoice.

fully_paid_date

DateTime or null

Fully paid date of the invoice.

deleted

DateTime or null

Deleted date.

attachments

Invoice's attachment. Can be the original invoice.

Status values

Property
Description

open

Invoice is still open.

paid

Invoice is paid.

partially_paid

Invoice is partially paid.

draft

Invoice is in draft.

cancelled

Invoice is cancelled.

pending

Invoice is waiting its payment.

uncollectible

Invoice is uncollectible.

refunded

Invoice is refunded.

partially_refunded

Invoice is partially refunded.

Items object

Property
Type
Description

title

String or null

Title of the item.

description

String or null

Description of the item.

quantity

Integer

Quantity of item.

total_amount

Total amount of the item.

unit_price

Unit price of the item.

taxes

Taxes of the item.

discounts

Discounts of the item.

total_amount_excluding_tax

Total amount of the item excluding the taxes.

total_tax_amount

Total tax amount of the item.

total_discount_amount

Total discount amount of the item.

InvoiceAmount object

Property
Type
Description

currency

String

value

Decimal or null

Value.

Taxes object

Property
Type
Description

currency

String

value

Decimal or null

Value.

description

String or null

Description of the tax.

country

String or null

Country of the tax.

tax_type

Tax type.

percentage

Integer or null

Percentage of the tax.

taxable_amount

Integer or null

Taxable amount.

TaxType values

Property
Description

amusement

Tax related to entertainment or leisure activities.

communications

Tax applied to communication services.

gst

Goods and services tax.

hst

Harmonized sales tax.

igst

Integrated goods and services tax (applied in India).

jct

Japan consumption tax.

lease

Tax related to leasing agreements.

pst

Provincial sales tax.

qst

Quebec sales tax.

rst

Retail sales tax.

sales

General term for tax applied to the sale of goods or services.

service

Tax applied specifically to services provided.

vat

Value added tax, a consumption tax at each stage of the supply chain.

unknown

unknow tax.

Discount object

Property
Type
Description

amount

Amount of the discount.

discount_type

Discount type.

value

Decimal or null

Value of the discount type.

DiscountType values

Property
Description

percentage

Discount type value is a percentage.

absolute

Discount type value is absolute.

Customer object

Property
Type
Description

full_name

String or null

Full name of the customer.

first_name

String or null

First name of the customer.

last_name

String or null

Last name of the customer.

phone

String or null

Phone number of the customer.

email

String or null

Email of the user.

type

Customer type.

shipping_address

Shipping address of the customer.

billing_address

Billing address of the customer.

CustomerType values

Property
Description

company

Company customer.

individual

Individual customer.

unknown

Unknown customer.

CustomerShippingAddress object

Property
Type
Description

street

String or null

Street name.

postal_code

String or null

Postal code.

city

String or null

City.

country_code

String or null

full_address

String or null

Customer shipping address.

name

String or null

Customer name of the shipping address.

phone

String or null

Phone number of the customer.

CustomerBillingAddress object

Property
Type
Description

street

String or null

Street name.

postal_code

String or null

Postal code.

city

String or null

City.

country_code

String or null

full_address

String or null

Customer billing address.

Invoicer object

Property
Type
Description

name

String or null

Name of the invoicer.

phone

String or null

Phone of the invoicer.

email

String or null

Email of the invoicer.

siren

String or null

Siren of the invoicer.

activity_area

String or null

Activity area of the invoicer.

address

Invoicer shipping address.

InvoicerShippingAddress object

Property
Type
Description

street

String or null

Street name.

postal_code

String or null

Postal code.

city

String or null

City.

country_code

String or null

full_address

String or null

Invoicer address.

Last updated