Read Property budget

GET

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

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

Read an existing instance.

One fiscal year’s operating budget for one property, submitted by the operator in the HMA’s window (contract band: Oct 15 – Dec 1) and approved or objected to by the owner through an approval gate (implements approvable; objected is the PHR HMA’s own vocabulary). Load-bearing beyond narrative: the owner statement’s variance columns and the performance test’s NOI prong are computed against it.

Authorizations

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

properties

required

object

budgeted_gop

Property budget budgeted gop

Budgeted gross operating profit

object

amount

required

string format: decimal

currency

required

string format: iso-4217

budgeted_noi

Property budget budgeted noi

Budgeted net operating income (the performance test’s denominator)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

budgeted_revenue

required

Property budget budgeted revenue

Budgeted total operating revenue

object

amount

required

string format: decimal

currency

required

string format: iso-4217

decided_at

When the owner's gate decided

string format: date-time

external_ref

External ref

string

fiscal_year

required

Fiscal year

integer

required

Budget id

string

status

required

Lifecycle status

string

Allowed values: submitted approved objected

submitted_at

required

When the operator submitted

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.property_budget",
  "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).