Read Stock movement

GET

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

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

Read an existing instance.

One movement of stock into or out of a store, on its level (stock_movement_for_level): a receipt, an issue, a consumption (on a fault — stock_movement_for_work_order — or a minibar task — stock_movement_for_housekeeping_task), an adjustment with its reason, a count (the level set to what was counted; the movement carries the difference), or one leg of a transfer (the receiving leg names the issuing one, stock_movement_transfer_from). quantity is signed, in the material’s unit; on_hand_before and on_hand_after are the level either side of it, so a store’s stock card reads off its movements. Each kind is pinned to its sign and its references by validator. recorded_by names the principal; a staff member who recorded it is linked (stock_movement_recorded_by). Never edited: a correction is another movement.

Authorizations

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

properties

required

object

charged

Stock movement charged

What the guest was charged for it (a minibar consumption)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

counted

What a count found (a count movement only; equals on_hand_after)

string format: decimal

required

Stock movement id

string

kind

required

receipt, issue, consumption, adjustment, count, transfer

string

Allowed values: receipt issue consumption adjustment count transfer

on_hand_after

required

The level after it — on_hand_before + quantity

string format: decimal

on_hand_before

required

The level before this movement

string format: decimal

quantity

required

How much moved, signed (in positive, out negative), in the material's unit

string format: decimal

reason

Why — required for an adjustment (breakage, expiry, theft)

string

recorded_at

required

When it was recorded — the handset's own time when it queued offline

string format: date-time

recorded_by

required

The principal that recorded it (`user:…`, `agent:…`, `service:…`, `system`)

string

reference

An outside reference — the supplier's delivery note, an invoice number

string

uncharged

Stock movement uncharged

What it would have charged — a minibar consumption recorded with nobody in house, the desk’s late charge (never beside charged)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

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.stock_movement",
  "properties": {
    "kind": "receipt"
  },
  "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).