A receipt as plain text

GET

/v1/fnb/receipts/{receipt_id}/text

curl --request GET \
  --url https://api.aerandil.com/v1/fnb/receipts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/text \
  --header 'Authorization: Bearer <token>'

• Production API

The receipt as 42 columns of plain text (Font A on 80 mm paper) — the till’s preview, line for line what the printer prints: the supplier’s name, address and VAT number, the check, the time of supply, the lines, the total, VAT per rate (rate, net, VAT, VAT-inclusive total — VAT Notice 700 §16.6.1), the tenders and the receipt’s number on the property’s document chain. A pure function of the receipt’s snapshot. Read through hospitality.function.fnb_receipt under the caller’s own context: its grant, the house gate, and — for a till — the till’s own outlet (another outlet’s receipt is 403 outlet_out_of_scope).

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.fnb_receipt:invoke

Parameters

Path Parameters

receipt_id

required

string format: uuid

The hospitality.check_receipt a settled check was issued.

Responses

200

The receipt, 42 columns, one line feed per line.

Media typetext/plain

string

Headers

Cache-Control

string

Always no-store. Object and link state is live data and is never cacheable.

403

The bearer authenticated but does not hold the scope this operation requires.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object

error

required

object

code

required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string

instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string

message

required

Human-readable explanation of the failure.

string

parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Example^generated

{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}

404

No such object in the caller’s tenant — which is also the answer when it exists in another tenant, by design.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object

error

required

object

code

required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string

instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string

message

required

Human-readable explanation of the failure.

string

parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Example^generated

{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}