Search Payout line

POST

/v1/object-types/hospitality.payout_line/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.payout_line/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"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"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.payout_line/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 balance transaction a payout carried (Stripe’s txn_…): its reporting category, the processor object it came from, the gross, the fee and the net, as the processor states them. matched when the source resolves to a ledger payment — a charge to the payment it captured, a refund to its refund leg or original, a dispute to the payment disputed, a destination charge’s py_… through its transfer to the platform charge. Append-only; a re-run reconciliation may match a line it could not before.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.payout_line:read

Request Body^required

application/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 psp_reference payout_id property_id reporting_category line_type source_reference available_on payment_id

Responses

200

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

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.payout_line

properties

required

object

amount

required

Payout line amount

Gross, as the processor states it (negative for money out)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

available_on

The day the line's money became available to pay out

string format: date

fee

required

Payout line fee

The processor’s fee on the line

object

amount

required

string format: decimal

currency

required

string format: iso-4217

required

Payout line id

string

line_type

The processor's own transaction type (`payment`, `charge`, `payment_refund`, `stripe_fee`, …)

string

matched

required

Whether the line resolved to a ledger payment

boolean

net

required

Payout line net

Gross less fee — what the line added to the payout

object

amount

required

string format: decimal

currency

required

string format: iso-4217

payment_id

The ledger payment the line came from (its object id) — the payout_line_for_payment edge's target

string

payout_id

required

The payout that carried the line (its object id) — the payout_line_for_payout edge's target

string

property_id

required

The house the payout is for (its object id)

string

psp_reference

required

The processor's id for the balance transaction (Stripe `txn_…`) — the replay key

string

reporting_category

required

The processor's reporting category for the line

string

Allowed values: charge refund dispute dispute_reversal transfer transfer_reversal fee partial_capture_reversal payout payout_reversal adjustment other

source_reference

The processor object the money came from (`ch_…`, `py_…`, `re_…`, `du_…`, `tr_…`)

string

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.payout_line",
      "properties": {
        "reporting_category": "charge"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Payout line

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required