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.
get
https://{domain}.biapi.pro/2.0
/users/{userId}/pockets
List pockets
Filtering route aliases:
/users/{userId}/investments/{investmentId}/pockets
/users/{userId}/accounts/{accountId}/pockets
/users/{userId}/connections/{connectionId}/pockets
get
https://{domain}.biapi.pro/2.0
/pockets/{pocketId}
Get a pocket
Property | Type | Description |
---|---|---|
pockets | List of pockets. |
Property | Type | Description |
---|---|---|
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. |
Value | Description |
---|---|
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). |
Forward compatibility requirement: additional values may be added in the future. When implementing value matching, always fallback to a generic case for unknown values.
Last modified 4mo ago