List links of Guest check

GET

/v1/object-types/hospitality.guest_check/objects/{id}/links/{link_type}

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

List the neighbours of an instance along a typed link. Direction is inferred when the source binds the link on exactly one side; symmetric links (same object type on both ends) require an explicit ?direction=out or ?direction=in.

The order/check entity: opened against a service table (or takeaway / room service) in a meal period on a business date, owned by a server, open until its payments (check_payment) cover what is due — the payment that brings balance_due to zero settles it and marks the table dirty (Simphony model). Carries its running totals, kept by every action that moves them: subtotal (live lines, modifier lines included, voided and comped out), tax_total, total_due (subtotal plus add-on tax), paid_total (tips excluded), tip_total and balance_due. Mutates only through the fnb actions.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.guest_check:read

Parameters

Path Parameters

required

string format: uuid

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

link_type

required

Allowed values: hospitality.link.check_at_outlet hospitality.link.check_for_stay hospitality.link.check_line_on_check hospitality.link.check_opened_at_table hospitality.link.check_payment_on_check hospitality.link.check_settled_to_folio hospitality.link.receipt_for_check hospitality.link.ticket_for_check

API name of the link type. Narrowed to link types that bind this source object type on at least one side.

Query Parameters

direction

Allowed values: out in

Edge direction to follow. Optional when the link binds the source on exactly one side; required for symmetric links.

limit

integer

>= 1 <= 500

cursor

string

as_of

string format: date-time

RFC3339 temporal window: return neighbours whose edge was in effect at this instant ([effective_from, effective_to)) instead of now.

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

Neighbours along the typed link.

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

string

properties

required

object

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

direction

required

Allowed values: out in

has_more

required

boolean

link_type

required

string

next_cursor

string

Example

{
  "data": [
    {
      "scope": {
        "level": "tenant"
      }
    }
  ],
  "direction": "out"
}

404

No object with that id, or link type unknown.

422

Validation error — direction conflicts with the link’s binding.