Skip to content
aerandil.com
GitHub

Read Housekeeping credit rule

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

Read an existing instance.

What one kind of housekeeping task is worth at a property (OPERA’s housekeeping credits; the unit of hubOS’s pacing report): credits — the workload unit a supervisor balances attendants’ sheets in and an attendant’s shift target is counted in — and optionally standard_minutes, what the work should take, against which the pacing report measures each cleaning’s deviation. Keyed by (task type, room type): a rule naming a room type prices that task type in rooms of that type, a rule naming none prices it in every other room. Task creation stamps the most specific active rule’s figures onto the task (create_housekeeping_task, generate_housekeeping_tasks), so a task keeps what it was worth when minted. Retiring a rule prices nothing new; authoring its key again revives it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

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

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.housekeeping_credit_rule
properties
required
object
credits
required
Credits one task of this kind is worth (zero or more)
string format: decimal
description
Operator-facing description
string
id
required
Housekeeping credit rule id
string
retired_at
When the rule was retired
string format: date-time
room_type_id
The room type this rule prices the task type in; absent = every room type without a rule of its own
string format: uuid
standard_minutes
Minutes the work should take (1 to 1440); the pacing report's deviation is measured against it
integer
status
required
Active (prices new tasks) or retired
string
Allowed values: active retired
task_type
required
The task type this rule prices
string
Allowed values: stayover departure vacant_pickup deep_clean turndown inspection public_area_clean public_area_inspection minibar laundry
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.housekeeping_credit_rule",
  "properties": {
    "status": "active",
    "task_type": "stayover"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

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