Code Tables

Strict lists reject unknown values with 400 INVALID_PAYLOAD. Suggested lists (order_source, payment_type) also accept free strings up to 50 characters.

You can also fetch these lists from GET /reference/{code_type}.

Transaction types

Fetched from GET /reference/transaction-types. Map your own codes to these with Transaction Type Mappings.

code	Name	is_revenue	amount_sign	Description
SALE	Sale	true	+1	Normal sale
RETURN	Return	true	-1	Goods returned (with refund)
REFUND	Refund	true	-1	Refund only, no goods returned
EXCHANGE	Exchange	true	±1 (null)	Return and new item in one transaction. See Recording Rules.
VOID	Void	false	0	Voided before checkout or on the same day; not revenue
GIFT_CARD_SALE	Gift card sale	false	+1	Prepayment; not revenue
GIFT_CARD_REDEEM	Gift card redemption	true	+1	Sale paid with a gift card
DEPOSIT	Deposit	false	+1	Prepayment
PAID_IN	Paid in	false	+1	Non-sales cash into the drawer
PAID_OUT	Paid out	false	-1	Non-sales cash out of the drawer
NO_SALE	No sale	false	0	Drawer opened without a sale (audit)
TRAINING	Training	false	0	Excluded from all reports
OTHER	Other	false	0	Requires manual review

Order types

Strict. Field: order_type.

code	Name
DINE_IN	Dine-in
TO_GO	To go
PICK_UP	Pick-up
DELIVERY	Delivery
ONLINE	Online
KIOSK	Kiosk
THIRD_PARTY	Third-party platform

Tip

Prefer order_type for fulfillment (DINE_IN, TO_GO, PICK_UP, DELIVERY) and record the channel in order_source.

Order sources

Suggested. Field: order_source. Free strings accepted; null / omitted means unknown.

code	Name	Description
POS	Counter POS	Order entered by staff at the POS
KIOSK	Self-service kiosk	Customer ordered at an in-store kiosk
QR_ORDER	QR ordering	Customer scanned a table / in-store QR code and ordered by phone
WEB	Brand website	Order from the brand's own website
APP	Brand app	Order from the brand's own app
PHONE	Phone order	Phone order entered by staff
DELIVERY_PLATFORM	Third-party platform	Uber Eats, DoorDash, foodpanda, etc.; put the platform in order_source_detail
CATERING	Catering / corporate	Bulk or corporate orders
OTHER	Other	Known channel not listed above

Payment methods

Strict. Field: payment_method.

code	Name
CASH	Cash
CREDIT_CARD	Credit card
DEBIT_CARD	Debit card
GIFT_CARD	Gift card
MOBILE_WALLET	Mobile wallet
BANK_TRANSFER	Bank transfer
THIRD_PARTY	Third-party payment
VOUCHER	Voucher
LOYALTY_POINTS	Loyalty points
OTHER	Other

Payment types

Suggested. Field: payment_type. Free strings accepted. SALE and REFUND must be supported by every partner. Payment amount is always positive; the direction below determines its effect.

code	Name	Direction	Required	Description
SALE	Sale payment	+1	Yes	Normal payment for a sale
REFUND	Return / refund	-1	Yes	Money paid back for a return or refund; original_payment_id points to the original payment
VOID	Payment void	-1		Payment cancelled after checkout, before the day closes (e.g. same-day card cancellation); original_payment_id points to the original payment
DEPOSIT	Deposit received	+1		Prepayment, not revenue (e.g. deposit for a cake order)
DEPOSIT_APPLIED	Deposit applied	+1		Earlier deposit used toward this purchase — no new money received; original_payment_id points to the DEPOSIT
DEPOSIT_REFUND	Deposit refunded	-1		Deposit returned to the customer
TIP_ADJUST	Tip adjustment	+1		Tip added or changed after the card was charged
ADJUSTMENT	Adjustment	±1		Manual correction or rounding; the only type where amount may be negative
OTHER	Other	—		Known type not listed above

Tax categories

Strict. Field: tax_category.

code	Name
STANDARD	Standard rate
REDUCED	Reduced rate
ZERO	Zero rate
EXEMPT	Exempt

Other enums

Field	Values
Store status, Product status	ACTIVE, INACTIVE
Product product_type, TradeItem product_type	SINGLE, COMBO, SIDE, DRINK, MODIFIER
TradeRecord status	OPEN, COMPLETED, VOIDED, REFUNDED, PARTIALLY_REFUNDED
Reconciliation status	NOT_RECEIVED, RECEIVED, MATCHED, MISMATCHED
Write response status	ACCEPTED, ALREADY_RECEIVED