Sign in
ops

contractual_entity_headrooms pricing-category

Changed on

Fetch every pricing category with the external contractual entity's coverage and headrooms

get/ops/contractual_entities/{entity}/headrooms

Request

  • Base URL: https://api.topi-staging.eu
  • URL: https://api.topi-staging.eu/ops/contractual_entities/{entity}/headrooms
  • Auth: OAuth 2 (authorization code, authorization URL /oauth2/authorize, token URL /oauth2/token, scopes: ops-pricing-category:read)

Path parameters

entitystring required

Contractual entity code

Example:peac_de_gmbh

Response

OK response.

contractual_entitystring required

Contractual entity code

tenuresinteger[] required

Supported tenures in months; every covered category has one headroom per tenure

Example response

{
  "categories": [
    {
      "applied_at": "1970-01-01T00:00:01Z",
      "applied_by": "abc123",
      "coverage_state": "available",
      "description": "abc123",
      "headrooms": [
        {
          "expected_residual_value_ratio": 1,
          "headroom_ratio": 1,
          "is_default": false,
          "tenure": 1
        }
      ],
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "identifier": "abc123",
      "source_import_id": "abc123"
    }
  ],
  "contractual_entity": "abc123",
  "tenures": [
    1
  ]
}

Changes