TOtopi
ops
ops-contractual-entities

List headroom imports

Changed on

List the headroom imports of an external contractual entity, most recently uploaded first

get/ops/contractual_entities/{entity}/headroom_imports

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/contractual_entities/{entity}/headroom_imports
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-pricing-category:read

Path parameters

entitystring required

External contractual entity code

Example:peac_de_gmbh

Query parameters

status'pending' | 'validated' | 'invalid' | 'applied'

Only imports in this status

Example:validated
limitinteger

the size of the page, capped at 100

Example:20
pageinteger

the index of the page, zero-based

Response

OK response.

Example response

{
  "headroom_imports": [
    {
      "applied_at": "1970-01-01T00:00:01Z",
      "applied_by": "abc123",
      "category_count": 1,
      "filename": "abc123",
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "status": "validated",
      "uploaded_at": "1970-01-01T00:00:01Z",
      "uploaded_by": "abc123",
      "validation_error_count": 1
    }
  ],
  "pagination": {
    "limit": 1,
    "page": 1,
    "totalPages": 1,
    "totalRows": 1
  }
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id pricing-category.list_headroom_imports removed and replaced with pricing-category#list_headroom_imports

  • 7ff7ee94b30eRevision changes
    • info

      api operation id pricing-category#list_headroom_imports removed and replaced with pricing-category.list_headroom_imports

    • info

      api tag ops-contractual-entities added