Sign in
Organisations

Create a Revenue Centre

Add a new revenue centre to the organisation. Pass at minimum a display name; key can be supplied if you want a stable identifier for use from external integrations. Adding the first custom centre flips has_custom_revenue_centres to true on subsequent list responses.

post/shop/organisations/{organisationId}/revenue-centres

Path parameters

organisationIdstring uuid required

Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

keystring

Optional stable key for the new revenue centre. Used when looking the centre up from external integrations. Defaults to a slugified form of name when omitted.

namestring required

Display name of the revenue centre, shown in the admin UI and on financial reports.

tax_percentnumber nullable

The percentage of tax to apply to sales recorded against this revenue centre when no per-line tax configuration overrides it.

Example request

{
  "key": "retail",
  "name": "Retail",
  "tax_percent": 20
}

Response

The revenue centre was successfully retrieved.

Example response

{
  "data": {
    "id": "spa",
    "key": "spa",
    "name": "Spa",
    "tax_percent": 20,
    "tax_configuration": {
      "name": "UK VAT"
    },
    "is_required": true
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.