List contracts for a company

GET 
/companies/:company-id/contracts

List contracts for a company

Request

Path Parameters

company-id uuidrequired

Query Parameters

available booleanrequired
offset number

Default value: 0

limit number

Possible values: >= 1

Default value: 10

Responses

200

success - paginated list of contracts

application/json

Schema

Schema

• Array [

id integerrequired

Internal identifier of the contract/company relation.

contractId integerrequired

Identifier of the related contract.

companyId uuidrequired

Identifier of the related company.

date stringnullablerequired

metadata

object

required

Arbitrary metadata attached to the relation.

performance numbernullable

accountUnits numbernullable

insurerSolvencyRatio numbernullable

managedOptions string[]nullable

fundsOrigin stringnullable

annuityType stringnullable

minTransferAmount numbernullable

minFreeTransferAmount numbernullable

minScheduledTransfersAmount numbernullable

minPartialRedemption numbernullable

transferFees numbernullable

prevoyanceGuarantee stringnullable

mortalityTable stringnullable

anuityExitFees numbernullable

advantagesAndRisks stringnullable

fees

object

nullable

property name*

object

nullable

type stringnullable

Possible values: [fixed, percentage]

Default value: percentage

total numbernullable

contract numbernullable

company numbernullable

feesMode stringnullable

feesType stringnullable

fees

object

Fees definition linked to the contract/company relation.

anyOf

MOD1

string

MOD3

services

object

required

property name*

object

type stringrequired

Possible values: [percentage, fixed]

total numberrequired

percentage numberrequired

feesMode string

Possible values: [complementary, desinvest, both]

feesType string

Possible values: [enter, variable]

feesLink string

exanteAmount number

tiers

object

required

property name*

object

type stringrequired

Possible values: [percentage, fixed]

total numberrequired

percentage numberrequired

feesMode string

Possible values: [complementary, desinvest, both]

feesType string

Possible values: [enter, variable]

feesLink string

exanteAmount number

products

object

required

property name*

object

type stringrequired

Possible values: [percentage, fixed]

total numberrequired

percentage numberrequired

feesMode string

Possible values: [complementary, desinvest, both]

feesType string

Possible values: [enter, variable]

feesLink string

exanteAmount number

enterFeesAmount number

variableFeesAmount number

enterPercent number

variablePercent number

totalValue number

totalPercentage number

arbitrationEnterFeesAmount number

arbitrationVariableFeesAmount number

arbitrationEnterPercent number

arbitrationVariablePercent number

arbitrationTotalValue number

arbitrationTotalPercentage number

bothEnterFeesAmount number

bothVariableFeesAmount number

bothEnterPercent number

bothVariablePercent number

bothTotalValue number

bothTotalPercentage number

• ]

Example (from schema)

[
  {
    "id": 1200,
    "contractId": 45,
    "companyId": "adfdfaca-48f0-4f3b-b30a-c6d97293090c",
    "date": "2024-01-18T10:52:16.123Z",
    "metadata": {
      "performance": 0,
      "accountUnits": 0,
      "insurerSolvencyRatio": 0,
      "managedOptions": [
        "string"
      ],
      "fundsOrigin": "string",
      "annuityType": "string",
      "minTransferAmount": 0,
      "minFreeTransferAmount": 0,
      "minScheduledTransfersAmount": 0,
      "minPartialRedemption": 0,
      "transferFees": 0,
      "prevoyanceGuarantee": "string",
      "mortalityTable": "string",
      "anuityExitFees": 0,
      "advantagesAndRisks": "string",
      "fees": {}
    },
    "fees": "string"
  }
]

Loading...