Read Item class

GET

/v1/object-types/hospitality.item_class/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.item_class/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.item_class/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

The behaviour bundle a menu item inherits: the tax class its VAT resolves through (with an optional takeaway override — cold food is zero-rated off the premises, VAT Notice 709/1 §4), the revenue category a room charge posts to the folio by (food / soft drinks / alcohol / other), the default course, and whether discounts and service charge apply.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.item_class:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.item_class

properties

required

object

code

required

Class code

string

course_default

Default course number for items of this class

integer

description

Operator-facing description

string

discountable

required

Discounts apply

boolean

name

required

Class name

string

revenue_category

required

Revenue category

string

Allowed values: food non_alcoholic_beverage alcoholic_beverage other

service_chargeable

required

Service charge applies

boolean

takeaway_tax_class

Takeaway tax class

The tax class used instead when the item leaves the premises (takeaway, delivery). Absent = the same as tax_class — hot food and drinks are standard-rated either way.

string

tax_class

required

Tax class

The tax class code the item’s tax rules target (tax_rule.tax_class) when it is eaten on the premises — dine-in, in-room, breakfast. A class with no rule in force refuses to ring rather than selling at an unknown rate; a zero-rated class carries an explicit 0% rule.

string

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.item_class",
  "properties": {
    "revenue_category": "food"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).