Documents

API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
get
https://{domain}.biapi/pro/2.0
/users/{userId}/documents
List documents
FIltering route aliases:
/users/{userId}/subscriptions/{subscriptionId}/documents
/users/{userId}/connections/{connectionId}/documents
/users/{userId}/transactions/{transactionId}/documents
get
https://{domain}.biapi/pro/2.0
/documents/{documentId}
Get a document
Document resources support update operations to edit metadata:
post
https://{domain}.biapi/pro/2.0
/documents/{documentId}
Update a document
Data model
DocumentsList object
Property
Type
Description
documents
Array of Document objects
List of documents.
first_date
Date
Minimum available date for results.
last_date
Date
Maximum available date for results.
result_min_date
Date
Minimum date of results in the current response.
result_max_date
Date
Maximum date of results in the current response.
Document object
Property
Type
Description
id
Integer
ID of the document.
id_user
Integer
ID of the related user.
id_subscription
Integer or null
ID of the related subscription.
id_type
Integer or null
ID of the related document type.
id_file
Integer or null
ID of the related file.
id_thumbnail
Integer or null
ID of the related thumbnail.
name
String or null
​
date
DateTime or null
​
timestamp
DateTime
The moment when this document has been created.
thumb_url
String or null
​
url
String or null
​
duedate
Date or null
​
total_amount
Decimal or null
​
untaxed_amount
Decimal or null
​
vat
Decimal or null
​
income
Boolean or null
​
readonly
Boolean
​
number
String or null
​
issuer
String or null
​
last_update
DateTime or null
​
has_file_on_website
Boolean
Whether the file is available on website.
currency
​Currency or null
Document currency.

Property	Type	Description
`documents`	Array of Document objects	List of documents.
`first_date`	Date	Minimum available date for results.
`last_date`	Date	Maximum available date for results.
`result_min_date`	Date	Minimum date of results in the current response.
`result_max_date`	Date	Maximum date of results in the current response.

Property	Type	Description
`id`	Integer	ID of the document.
`id_user`	Integer	ID of the related user.
`id_subscription`	Integer or null	ID of the related subscription.
`id_type`	Integer or null	ID of the related document type.
`id_file`	Integer or null	ID of the related file.
`id_thumbnail`	Integer or null	ID of the related thumbnail.
`name`	String or null
`date`	DateTime or null
`timestamp`	DateTime	The moment when this document has been created.
`thumb_url`	String or null
`url`	String or null
`duedate`	Date or null
`total_amount`	Decimal or null
`untaxed_amount`	Decimal or null
`vat`	Decimal or null
`income`	Boolean or null
`readonly`	Boolean
`number`	String or null
`issuer`	String or null
`last_update`	DateTime or null
`has_file_on_website`	Boolean	Whether the file is available on website.
`currency`	Currency or null	Document currency.

Subscriptions

Document types

Last modified 3mo ago