[Beta – preprod] Retrieve a product for a company
GET/companies/:companyID/products/:productID
[Beta – preprod] Retrieve a product for a company
Request
Path Parameters
companyID uuidrequired
productID uuidrequired
Responses
- 200
- 404
success - product details
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
id uuidrequired
referentialId uuidnullablerequired
name stringnullablerequired
Catalogue name, falling back to the referential name.
type stringnullablerequired
Possible values: [custom, referential]
Explicit product kind: 'custom' when a custom_product row references this entry, 'referential' when it points to a referential product. Derived from the data, not from the unreliable productSource column.
isActive booleanrequired
commercializationStatus stringnullablerequired
commercializationStart stringnullablerequired
commercializationEnd stringnullablerequired
minimumAmounts
object
nullable
required
initialDeposit numbernullable
additionalDeposit numbernullable
minArbitration numbernullable
minPartialWithdrawal numbernullable
scheduledPayments
object
nullable
required
monthly numbernullable
quarterly numbernullable
semiAnnual numbernullable
annual numbernullable
exitOptions
object
nullable
required
scheduledPartialWithdrawal stringnullable
floorGuarantee stringnullable
lifeAnnuity stringnullable
contractAdvance stringnullable
earlyExitPenalty stringnullable
fees
object[]
required
feeType stringrequired
value numbernullablerequired
unit stringnullablerequired
frequency stringnullablerequired
isNegotiated booleanrequired
true when the cabinet negotiated value overrides the default.
clauses
object
nullable
required
beneficiaryClause stringnullablerequired
advantagesAndRisks stringnullablerequired
selectionJustification stringnullablerequired
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"type": "custom",
"isActive": true,
"commercializationStatus": "string",
"commercializationStart": "string",
"commercializationEnd": "string",
"minimumAmounts": {
"initialDeposit": 0,
"additionalDeposit": 0,
"minArbitration": 0,
"minPartialWithdrawal": 0
},
"scheduledPayments": {
"monthly": 0,
"quarterly": 0,
"semiAnnual": 0,
"annual": 0
},
"exitOptions": {
"scheduledPartialWithdrawal": "string",
"floorGuarantee": "string",
"lifeAnnuity": "string",
"contractAdvance": "string",
"earlyExitPenalty": "string"
},
"fees": [
{
"feeType": "string",
"value": 0,
"unit": "string",
"frequency": "string",
"isNegotiated": true
}
],
"clauses": {
"beneficiaryClause": "string",
"advantagesAndRisks": "string",
"selectionJustification": "string"
}
}
Product not found
Loading...