Sites & Organisation

Revenue Centres

A revenue centre is an accounting category against which revenues should be recorded.

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

Get revenue centres for a site

getSiteRevenueCentres

Use this endpoint to retrieve a Site's revenue centres.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
A list of all revenue centres for a Site.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A list of all revenue centres for a `Site`.

{
  "data": [
    {
      "id": "spa",
      "key": "spa",
      "name": "Spa",
      "tax_percent": 20,
      "tax_configuration": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "name": "UK VAT"
      },
      "is_required": true
    }
  ],
  "meta": {
    "has_custom_revenue_centres": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

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

Create a new revenue centre for the site

createSiteRevenueCentre

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

Path parameters

siteIduuidrequired
The ID of the site

Request body

keystringoptional
The key for the revenue centre (an alias for its ID).
namestringrequired
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_percentnumberoptionalnullable
The percentage of tax to be applied for this revenue centre.
tax_configuration_idmongo-idoptional
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.

Responses

200
The revenue centre was successfully created
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "spa",
  "name": "Spa",
  "tax_percent": 20,
  "tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "key": "spa",
    "name": "Spa",
    "tax_percent": 20,
    "tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "key": "spa",
        "name": "Spa",
        "tax_percent": 20,
        "tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'key' => 'spa',
            'name' => 'Spa',
            'tax_percent' => 20,
            'tax_configuration_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"key": "spa",
		"name": "Spa",
		"tax_percent": 20,
		"tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The revenue centre was successfully created

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/sites/{siteId}/revenue-centres/{revenueCentreId}

Get a revenue centre

getSiteRevenueCentre

Use this endpoint to retrieve a single revenue centre.

Path parameters

siteIduuidrequired
The ID of the site
revenueCentreIdstringrequired
The ID of the revenue centre

Responses

200
Details of a single revenue centre.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Details of a single revenue centre.

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

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/shop/sites/{siteId}/revenue-centres/{revenueCentreId}

Update a revenue centre

updateSiteRevenueCentre

Use this endpoint to update a revenue centre for a Site.

Path parameters

siteIduuidrequired
The ID of the site
revenueCentreIdstringrequired
The ID of the revenue centre

Request body

keystringoptional
The key for the revenue centre (an alias for its ID).
namestringoptional
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_percentnumberoptionalnullable
The percentage of tax to be applied for this revenue centre.
tax_configuration_idmongo-idoptional
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.

Responses

200
Details of a single revenue centre.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "spa",
  "name": "Spa",
  "tax_percent": 20,
  "tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "key": "spa",
    "name": "Spa",
    "tax_percent": 20,
    "tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "key": "spa",
        "name": "Spa",
        "tax_percent": 20,
        "tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'key' => 'spa',
            'name' => 'Spa',
            'tax_percent' => 20,
            'tax_configuration_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"key": "spa",
		"name": "Spa",
		"tax_percent": 20,
		"tax_configuration_id": "64a9f3b2c3d8e1f4a5b6c7d8",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Details of a single revenue centre.

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/sites/{siteId}/revenue-centres/{revenueCentreId}

Delete a revenue centre

deleteSiteRevenueCentre

Use this endpoint to delete a revenue centre from a Site.

Path parameters

siteIduuidrequired
The ID of the site
revenueCentreIdstringrequired
The ID of the revenue centre

Responses

204
The revenue centre was successfully deleted
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/revenue-centres/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The revenue centre was successfully deleted

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}