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
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 |
---|---|---|
| Array of Invoice objects | List of invoices. |
Invoice 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. |
| String | Invoice number. |
| String or null | Description of the invoice. |
| Status of invoice. | |
| Array of Items object | Items of the invoice. If no items, the list is empty. |
| Customer of the invoice. | |
| Invoicer of the invoice. | |
| Total amount of the invoice. | |
| Total amount excluding the tax of the invoice. | |
| Total tax amount of the invoice. | |
| Total discount amount of the invoice. | |
| Decimal or null | Paid amount of the invoice. |
| Decimal or null | Remaining amount of the invoice. |
| Decimal or null | Shipping amount of the invoice. |
| Decimal or null | Credit note amount applied before the payment. |
| Decimal or null | Credit note amount applied after the payment. |
| DateTime | Last successful update of the invoice. |
| DateTime | Date and time when the invoice was retrieved. |
| DateTime or null | Date when the invoice was created. |
| DateTime or null | Issue date of the invoice. |
| DateTime or null | Due date of the invoice. |
| DateTime or null | Fully paid date of the invoice. |
| DateTime or null | Deleted date. |
| Invoice's attachment. Can be the original invoice. |
Status values
Property | Description |
---|---|
| Invoice is still open. |
| Invoice is paid. |
| Invoice is partially paid. |
| Invoice is in draft. |
| Invoice is cancelled. |
| Invoice is waiting its payment. |
| Invoice is uncollectible. |
| Invoice is refunded. |
| Invoice is partially refunded. |
Items object
Property | Type | Description |
---|---|---|
| String or null | Title of the item. |
| String or null | Description of the item. |
| Integer | Quantity of item. |
| Total amount of the item. | |
| Unit price of the item. | |
| Array of Taxes object or null | Taxes of the item. |
| Array of Discount object or null | Discounts of the item. |
| Total amount of the item excluding the taxes. | |
| Total tax amount of the item. | |
| Total discount amount of the item. |
InvoiceAmount object
Property | Type | Description |
---|---|---|
| String | ID of the currency (ISO 4217 code). |
| Decimal or null | Value. |
Taxes object
Property | Type | Description |
---|---|---|
| String | ID of the currency (ISO 4217 code). |
| Decimal or null | Value. |
| String or null | Description of the tax. |
| String or null | Country of the tax. |
| Tax type. | |
| Integer or null | Percentage of the tax. |
| Integer or null | Taxable amount. |
TaxType values
Property | Description |
---|---|
| Tax related to entertainment or leisure activities. |
| Tax applied to communication services. |
| Goods and services tax. |
| Harmonized sales tax. |
| Integrated goods and services tax (applied in India). |
| Japan consumption tax. |
| Tax related to leasing agreements. |
| Provincial sales tax. |
| Quebec sales tax. |
| Retail sales tax. |
| General term for tax applied to the sale of goods or services. |
| Tax applied specifically to services provided. |
| Value added tax, a consumption tax at each stage of the supply chain. |
| unknow tax. |
Discount object
Property | Type | Description |
---|---|---|
| Amount of the discount. | |
| Discount type. | |
| 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 |
---|---|---|
| String or null | Full name of the customer. |
| String or null | First name of the customer. |
| String or null | Last name of the customer. |
| String or null | Phone number of the customer. |
| String or null | Email of the user. |
| Customer type. | |
| Shipping address of the customer. | |
| Billing address of the customer. |
CustomerType values
Property | Description |
---|---|
| Company customer. |
| Individual customer. |
| Unknown customer. |
CustomerShippingAddress object
Property | Type | Description |
---|---|---|
| String or null | Street name. |
| String or null | Postal code. |
| String or null | City. |
| String or null | Country code (ISO 3166-1 alpha-2 codes). |
| String or null | Customer shipping address. |
| String or null | Customer name of the shipping address. |
| String or null | Phone number of the customer. |
CustomerBillingAddress object
Property | Type | Description |
---|---|---|
| String or null | Street name. |
| String or null | Postal code. |
| String or null | City. |
| String or null | Country code (ISO 3166-1 alpha-2 codes). |
| String or null | Customer billing address. |
Invoicer object
Property | Type | Description |
---|---|---|
| String or null | Name of the invoicer. |
| String or null | Phone of the invoicer. |
| String or null | Email of the invoicer. |
| String or null | Siren of the invoicer. |
| String or null | Activity area of the invoicer. |
| Invoicer shipping address. |
InvoicerShippingAddress object
Property | Type | Description |
---|---|---|
| String or null | Street name. |
| String or null | Postal code. |
| String or null | City. |
| String or null | Country code (ISO 3166-1 alpha-2 codes). |
| String or null | Invoicer address. |
Last updated