TOtopi
ops
ops-contractual-entities

Create a headroom import

Changed on

Create a pending headroom import of an external contractual entity and sign the URL its CSV is uploaded to. Each category in the file replaces the entity's rows for it once applied; categories not in the file are untouched.

post/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:edit

Path parameters

entitystring required

External contractual entity code

Example:peac_de_gmbh

Request body

filenamestring required

Name of the file to upload, for display

Example request

{
  "filename": "peac_de_headrooms_2026-10.csv"
}

Response

Created response.

idstring regexp required

Headroom import ID

upload_headersobject required

Headers the upload must send, or GCS rejects it

upload_urlstring required

Signed URL to PUT the CSV to, valid for one hour

Example response

{
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "upload_headers": {
    "abc123": "abc123"
  },
  "upload_url": "abc123"
}

Changes

  • ac6979514123Revision changes
    • info

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

  • 7ff7ee94b30eRevision changes
    • info

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

    • info

      api tag ops-contractual-entities added