Transaction Types

GET /reference/transaction-types

Returns HQ's list of standard transaction types. Use it to map your own POS transaction codes with PUT /mappings/transaction-types.

Authentication: API key (x-functions-key)

Request

No parameters.

Response

200 OK

Field	Type	Description
version	string	Version (date) of the code list. Changes whenever the list changes.
data	array	Transaction types
data[].code	string	Standard code. See Code Tables.
data[].name	localized text	Display name
data[].is_revenue	boolean	Whether the type counts toward revenue
data[].amount_sign	integer | null	Amount direction: 1, -1 or 0. null for EXCHANGE, whose direction depends on each line.
data[].description	string	Description

{
  "version": "2026-10-15",
  "data": [
    { "code": "SALE",   "name": { "en-US": "Sale",   "zh-TW": "銷售" }, "is_revenue": true, "amount_sign": 1,  "description": "Normal sale" },
    { "code": "REFUND", "name": { "en-US": "Refund", "zh-TW": "退款" }, "is_revenue": true, "amount_sign": -1, "description": "Refund without returning goods" }
  ]
}

Errors

HTTP	code	When
401	UNAUTHORIZED	Missing or invalid API key

Notes

Tip

Fetch this list before go-live and whenever HQ announces a code update. Compare version with the one you stored to detect changes.