TRANXACT.AI 帮助

API endpoint reference: how to call TRANXACT

How a third-party product reaches TRANXACT over HTTPS: the two ways in, authentication, every verb and parameter, the filter language, the answers and errors, MCP, and a page per module listing all 1110 resources with their fields.

Browse every API, operation by operation, in the API Hub (help.tranxact.ai/en/api/): packages, APIs, parameters, request and response bodies, data models, errors, samples and a specification to download for each API.

Two ways in

Published API (recommended for partners)Service account (whole modules)
基地址<your TRANXACT address>/api/v1<your TRANXACT address>/api
A resource/api/v1/<code> and /api/v1/<code>/<id>/api/<module>/<resource> and /api/<module>/<resource>/<id>
凭据An API key from Platform › Published API (sent as Authorization: Bearer <key> or X-API-Key: <key>)A client id and secret from Platform › Access › Service Accounts, exchanged for a bearer token at POST /api/auth/service-token
What it reachesOnly what an administrator published and granted to the key: chosen resources, columns, rows and verbsEverything the service account's roles allow, like a person with those roles
担任The run-as user set on the key's clientThe service account itself
Describes itselfGET /api/v1 · GET /api/v1/resources · GET /api/v1/openapi.json (this key's own reach)This reference, and the full OpenAPI file below

Every call goes through the same rules as the screen: validation, numbering, approvals, posting rules, the company and organisational unit the caller belongs to, and the audit trail. Nothing reached through the API can do what the same user could not do on screen.

Authenticating

# Published API: the key on every call
curl https://demo.tranxact.ai/api/v1 -H "Authorization: Bearer tx_partner_xxxxxxxxxxxxxxxx"
curl https://demo.tranxact.ai/api/v1 -H "X-API-Key: tx_partner_xxxxxxxxxxxxxxxx"

# Service account: a token first, then the token on every call
curl -X POST https://demo.tranxact.ai/api/auth/service-token -H "Content-Type: application/json" \
  -d '{"client_id":"loader@service.example","secret":"<the secret>"}'
# -> {"token":"eyJ...","token_type":"Bearer","expires_in":3600,...}
curl https://demo.tranxact.ai/api/scm/items?limit=10 -H "Authorization: Bearer eyJ..."

The verbs

称呼已发布的 APIService account回答
列表GET /api/v1/<code>GET /api/<module>/<resource>200 {"rows":[...],"count":N}; the published API also sends X-Total-Count
One recordGET /api/v1/<code>/<id>GET /api/<module>/<resource>/<id>200 the record, or 404
创造POST /api/v1/<code> with the record as JSONPOST /api/<module>/<resource>201 the created record, with its id and number
改变PATCH or PUT /api/v1/<code>/<id> with the fields to changePUT /api/<module>/<resource>/<id>200 the changed record
删除DELETE /api/v1/<code>/<id>DELETE /api/<module>/<resource>/<id>200 {"deleted":true}
Check without saving—POST /api/<module>/<resource>/_check, PUT /api/<module>/<resource>/<id>/_check200 when it would save, or the same refusal a save would give

Documents that move through a process (release an order, post an invoice, approve a requisition) have their own action routes, which are reached with a service account in the same way as the screen's buttons; the published API reaches records, not actions.

Listing: paging, search, sort and filter

范围意义例子
limitRows per page: 50 by default, at most 200 with a service account, at most the exposure's maximum on the published APIlimit=100
offsetRows to skipoffset=200
qFree-text search over the resource's search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc,item_no:asc
filterA JSON condition or group of conditions (below), URL-encodedfilter={"col":"status","op":"eq","value":"open"}
<column>=<value>Shorthand for "column is value"status=open

A condition is {"col": "<field>", "op": "<operator>", "value": <value>} ("values": [..] for operators that take several, none for empty and not_empty; "not": true inverts it). A group is {"join": "and" | "or", "conditions": [ ...conditions or groups... ]}, nested as deep as needed. On the published API the caller's filter is always applied underneath the restriction the administrator published, so it can only narrow what the key may see.

操作员意义
eq · neis · is not
in · not_inis any of · is none of (values: [...])
contains · startscontains · starts with (text, any case)
gt · gte · lt · ltemore than · at least · less than · at most (numbers and dates)
between · not_betweenwithin · outside two values (values: [from, to])
on · before · aftera date: on, before, after
last_days · not_last_dayswithin (or not) the last N days
empty · not_emptyhas no value · has a value
# open purchase orders over 10,000, or any from one supplier, newest first
FILTER='{"join":"or","conditions":[{"join":"and","conditions":[{"col":"status","op":"eq","value":"open"},{"col":"total","op":"gt","value":10000}]},{"col":"supplier_id","op":"eq","value":"<supplier id>"}]}'
curl -G https://demo.tranxact.ai/api/v1/purchase-orders -H "Authorization: Bearer $KEY" \
  --data-urlencode "filter=$FILTER" --data-urlencode "sort=order_date:desc" -d limit=50

Creating and changing

curl -X POST https://demo.tranxact.ai/api/v1/items -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"item_no":"SCREW-M4","name":"Screw M4 x 12","item_type":"raw","uom":"EA","standard_cost":0.1}'

curl -X PATCH https://demo.tranxact.ai/api/v1/items/<id> -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"standard_cost":0.12}'

Send only the fields to set; on a change, fields left out keep their value. On the published API a field the exposure does not publish is dropped rather than written. A number generated by TRANXACT (an order or invoice number) is assigned on create and cannot be sent.

In code

# Python (requests)
import requests
BASE, KEY = "https://demo.tranxact.ai/api/v1", "tx_partner_xxxxxxxx"
s = requests.Session(); s.headers["Authorization"] = f"Bearer {KEY}"
offset, rows = 0, []
while True:
    page = s.get(f"{BASE}/accounts", params={"limit": 100, "offset": offset}).json()["rows"]
    rows += page; offset += len(page)
    if len(page) < 100: break

// JavaScript (Node 18+ or a browser on an allowed origin)
const r = await fetch("https://demo.tranxact.ai/api/v1/accounts?limit=100", { headers: { Authorization: "Bearer " + KEY } });
const { rows, count } = await r.json();

Field types in JSON

Type in this referenceIn JSON
uuida string, e.g. "3f1c…"; ids and references to other records
text, character varyinga string
integer, smallinta number
numeric, biginta string holding the exact number (e.g. "1250.00"), so no precision is lost; send a number or a string
布尔值true or false
日期a string, YYYY-MM-DD
timestamp with time zonea string, ISO 8601 in UTC
jsonban object or array
_text, _uuid (arrays)an array of strings

Answers that are not a success

地位为什么
400The request could not be read: a filter that is not JSON, a bad parameter
401No key or token, or it is wrong, revoked or expired
403The key is not granted this verb on this resource, the run-as user's roles do not allow it, or the call came from an address or origin not allowed
404Nothing is published under that code, or no record with that id is visible to the caller
409A conflict: a duplicate number, or the record changed or is locked by someone else
422The record was refused by the same validation as the screen; the error says which field and why
429The key's calls per minute were used up (or too many unauthenticated calls from one address); wait and retry

Every error is JSON: {"error": "<a sentence saying what was wrong>"} and, where it applies, "field". Every call, allowed or refused, is on Platform › Published API › API Call Log.

MCP: the same resources for an AI assistant

POST /api/v1/mcp speaks the Model Context Protocol (JSON-RPC 2.0) with the same key, if its protocol is MCP or both. tools/list returns, for each published resource, list_<code>, get_<code>, create_<code>, update_<code> and delete_<code> as granted; tools/call runs them under exactly the same rules as the REST calls.

curl -X POST https://demo.tranxact.ai/api/v1/mcp -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

curl -X POST https://demo.tranxact.ai/api/v1/mcp -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_accounts","arguments":{"q":"acme","limit":5}}}'

The machine-readable reference

The whole catalogue, all 1110 resources with every field and type, is one OpenAPI 3.1 file: https://help.tranxact.ai/assets/tranxact-openapi.json. It describes the service-account paths (/api/<module>/<resource>); the published API serves the same records at /api/v1/<code>, and GET /api/v1/openapi.json on your own installation gives the exact document for one key.

The resources, by module

模块资源页
会计230API endpoints: Accounting
智能体人工智能22API endpoints: Agentic AI
客户关系管理134API endpoints: CRM
电子健康记录67API endpoints: EHR
员工自助服务5API endpoints: Employee Self Service
高分辨率质谱法168API endpoints: HRMS
india31API endpoints: india
制造业95API endpoints: Manufacturing
mdm9API endpoints: mdm
平台85API endpoints: Platform
学生生命周期52API endpoints: Student Lifecycle
供应链182API endpoints: Supply Chain
人才与临时工30API endpoints: Talent & Contingent Workforce

Setting up keys, what an administrator publishes and the roles involved: Connecting other software to TRANXACT: the published API. TRANXACT as an MCP server covers the governed MCP worker endpoint. Some resources appear only in a company of a given country (for example the India statutory resources).