Read Owner statement

GET

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

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

Read an existing instance.

One month’s owner package for one property: the USALI summary figures, the fee computation, and the budget-vs-actual-vs-prior-year snapshot, submitted by the operator inside the HMA’s reporting window (contract band: 8 business days to 20 calendar days after month-end) and approved by the owner through an approval gate (the statement implements approvable; separation-of-duties keeps the submitter out of the deciding set). A changes_requested statement is answered by a new revision, not an edit — statements are reporting records.

Authorizations

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

properties

required

object

base_fee

Owner statement base fee

Base management fee for the period

object

amount

required

string format: decimal

currency

required

string format: iso-4217

decided_at

When the owner's gate decided

string format: date-time

due_by

required

Contractual delivery deadline for the period

string format: date

external_ref

External ref

string

gop

Owner statement gop

Gross operating profit (pre-management-fee, per USALI)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Statement id

string

incentive_fee

Owner statement incentive fee

Incentive management fee for the period (accrual or true-up)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

noi

Owner statement noi

Net operating income for the period

object

amount

required

string format: decimal

currency

required

string format: iso-4217

period_end

required

Reporting-period end

string format: date

period_start

required

Reporting-period start

string format: date

revision

required

Revision number (1 = first submission for the period)

integer

status

required

Lifecycle status

string

Allowed values: submitted approved changes_requested

submitted_at

required

When the operator submitted

string format: date-time

total_revenue

required

Owner statement total revenue

Total operating revenue for the period

object

amount

required

string format: decimal

currency

required

string format: iso-4217

variance_snapshot

Budget-vs-actual-vs-prior-year comparison (the Strand §9.02 columns) as reported, JSON

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.owner_statement",
  "properties": {
    "status": "submitted"
  },
  "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).