Read Tax exemption

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.tax_exemption/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.tax_exemption/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A reservation’s exemption from named tax codes — a government or diplomatic guest’s certificate on file. Every tax line the kernel derives for the booking (room nights, day use, retained payments) skips a rule whose code is listed, from the moment it is set until it is revoked; postings already made keep their tax, as an invoice already printed would.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.tax_exemption: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.tax_exemption

properties

required

object

description

Operator-facing note

string

exempt_codes

required

The tax rule codes the booking is exempt from

Array<string>

granted_at

required

When the exemption was recorded

string format: date-time

required

Tax exemption id

string

reason

required

Why the booking is exempt

string

Allowed values: government diplomatic international_organisation other

reference

required

The exemption certificate or authority reference an auditor asks for

string

revoked_at

When the exemption stopped applying; absent = in force

string format: date-time

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.tax_exemption",
  "properties": {
    "reason": "government"
  },
  "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).