Skip to content
aerandil.com
GitHub

Search Utility ledger entry

POST
/v1/object-types/hospitality.utility_ledger_entry/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.utility_ledger_entry/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

One posted utility cost line (USALI 12 Schedule 9 — Energy, Water, and Waste), with the metered consumption when the invoice carries it. category is stamped from kind (the four Schedule 9 groupings); the consumption quantity/unit pair stays in its source unit. Immutable except the terminal void.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id kind category consumption_quantity consumption_unit business_date period_start period_end source external_ref posted_at

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.utility_ledger_entry
properties
required
object
amount
Utility ledger entry amount

Amount

object
amount
required
string format: decimal
currency
required
string format: iso-4217
business_date
required
Business date
string format: date
category
required
USALI Schedule 9 category
string
Allowed values: energy water_sewer waste contract_services
consumption_quantity
Metered consumption quantity
string format: decimal
consumption_unit
Consumption unit
string
Allowed values: kwh mwh therm mmbtu gallon cubic_meter litre kilogram pound ton tonne cubic_yard other
external_ref
External ref
string
id
required
Entry id
string
kind
required
USALI Schedule 9 account
string
Allowed values: electricity natural_gas fuel_oil propane steam chilled_water renewable_electricity water sewer waste_landfill waste_recycling waste_organics waste_hazardous contract_services other
period_end
Billing-period end
string format: date
period_start
Billing-period start
string format: date
posted_at
required
Posted at
string format: date-time
source
required
Source
string
Allowed values: invoice_import manual
voided
required
Voided
boolean
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.utility_ledger_entry",
      "properties": {
        "category": "energy",
        "consumption_unit": "kwh",
        "kind": "electricity",
        "source": "invoice_import"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.