Sign in
RevenueCentres

Create a new revenue centre for the site

Use this endpoint to create a new revenue centre for a Site.

post/shop/sites/{siteId}/revenue-centres

Request body

keystring

The key for the revenue centre (an alias for its ID).

namestring required

Display name of the revenue centre, shown in the admin UI and on financial reports. Revenue centres group sales for tax and accounting (e.g. Spa, Retail, Food & Beverage). 1-120 characters.

tax_percentnumber nullable

The percentage of tax to be applied for this revenue centre.

tax_configuration_idstring mongo-id

Identifier of the tax configuration to apply to sales recorded against this revenue centre. The configuration controls the tax rate breakdown shown on receipts and reports; the configuration must belong to the same site.

Example request

{
  "key": "spa",
  "name": "Spa",
  "tax_percent": 20
}

Response

Details of a single revenue centre.

Example response

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

Changes

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