Pockets
In France, a company can deliver some of its own shares for free to its employees: it's the allocation of free shares, called pockets.
Last updated
Was this helpful?
In France, a company can deliver some of its own shares for free to its employees: it's the allocation of free shares, called pockets.
Last updated
Was this helpful?
Authentication: endpoints listed in this page require with a user token.
GET https://{domain}.biapi.pro/2.0/users/{userId}/pockets
List pockets related to a user.
userId*
Integer or "me"
ID of the related user.
Response body: PocketsList object
GET https://{domain}.biapi.pro/2.0/pockets/{pocketId}
Get a single pocket by ID.
pocketId*
Integer
ID of the pocket.
Response body: Pocket object
pockets
List of pockets.
id
Integer
ID of the pocket.
id_investment
Integer
ID of the related investment.
id_account
Integer
ID of the related account.
label
String
Display name of the pocket.
quantity
Decimal
Quantity of stocks in the pocket.
value
Decimal
Total current value of the pocket.
condition
Condition for the availability of the pocket.
availability_date
Date or null
Date of availability, if applicable.
deleted
Date or null
Deletion date for pockets that no longer exist (null if still present).
last_update
DateTime
Date of the last synchronization of the pocket.
unknown
There is no available information on the condition.
date
The pocket will become available at a specific date.
acquired
The pocket is acquired (the underlying shares are acquired but cannot be transferred).
available
The pocket is available and the underlying shares are transferable (the condition was fulfilled or the availability date is in the past).
retirement
The pocket will be available when the employee retires (precise date is not always indicated).
Array of objects
string