TRANXACT.AI Help

API package

Platform

The layer that runs underneath every application rather than inside one: who may sign in and what they may do, the automation that reacts to what happens anywhere, the connectors and pipelines that move data in and out, and the analytics that read the whole estate. Administration lives here too — the split between the two was never legible, and both are the platform rather than the business.

116 APIs777 operationsBase path /api/platform

Access

AI Governance

Analytics

Automation

Automation Levels How far each background job may go by itself: tell people what it found, ask for approval and then act, or act and tell them. A job with no level here only tells. /api/platform/automation-policies GET2 POST3 PUT1 DELETE1 Automation Results Everything a background job handed over: what it found, the level it was handled at, and what became of it. The people it was for see theirs in My approvals. /api/platform/automation-results GET2 POST3 PUT1 DELETE1 Document Intake Folders and mailboxes whose documents become DRAFTS: a supplier invoice, a sales order. Nothing is ever posted; the file is attached to the draft it made. /api/platform/intake-sources GET2 POST4 PUT1 DELETE1 Event Delivery Events a subscriber (workflows, agent triggers, webhooks) could not take: retried with backoff, then set aside after five attempts. Send one again once the cause is fixed. /api/platform/event-deliveries GET2 POST3 PUT1 DELETE1 Intake Log Every file intake took in: what it read, the draft it made, or why it needs a person. /api/platform/intake-items GET2 POST2 PUT1 DELETE1 Reminders & Escalations Every reminder and escalation the time-limit sweep made. /api/platform/sla-actions GET2 POST2 PUT1 DELETE1 Time Limits When an approval, a support ticket or a customer's service case left alone is chased, and when and to whom it is escalated. Service cases can have a limit per priority, case type and service level, counted in business hours. Only what falls due after a limit is written is swept. /api/platform/sla-policies GET2 POST3 PUT1 DELETE1

Batch

Business Flows

Custom Objects

Data Retention

Email

Email Events Everything the product sends by email, and who receives it when you have written no rule. /api/platform/mail-events GET2 POST2 PUT1 DELETE1 Email Outbox Every message: to whom, about what, and what the mail server said. A failed one is retried on its own; a held one goes as soon as a transport is configured, unless it is three days old by then. /api/platform/mail-outbox GET2 POST4 PUT1 DELETE1 Email Rules Your own decision about an event: who receives it and in what words. Any rule for an event replaces its default, so an inactive rule is how an event is switched off. Any screen’s <module>.<screen>.created, .updated or .status_changed can have a rule. /api/platform/mail-rules GET2 POST2 PUT1 DELETE1 Email Settings The sender and the way mail leaves. "Platform" sends through this deployment’s own Microsoft 365 account as noreply@tranxact.ai. Choose Microsoft 365, SMTP or a mail provider to send through your own account and domain instead — the credential is sealed on the way in and never shown again. A company has one set of email settings: open it, press Edit, then Set credential and Send a test. /api/platform/mail-settings GET2 POST3 PUT2 DELETE1 Email Suppressions Everybody who pressed Unsubscribe in an email, or was unsubscribed for them. An address here is sent nothing by any company in this system, except a message the person asks for themself to get into their own account. Re-subscribing one needs a reason, and is audited. /api/platform/email-suppressions GET3 POST2 Support Copy Every step of every support ticket — raised, answered, assigned, escalated, resolved, closed — sent by email to the support desk within a minute of it happening. support@tranxact.ai unless you change it. Only what happens from the moment copying began is sent, and internal notes stay inside unless you tick them in. /api/platform/mail-support-copy GET2 POST3 PUT1 DELETE1

Events & Webhooks

Extension Hooks

External Accountants

Health

Integration

Certificates Certificates a connection trusts or presents. A trusted CA lets a connection verify a server whose certificate your own authority issued; a client certificate is presented to the server (mutual TLS). What a certificate says about itself is read from it. A private key is sealed on the way in and never shown again. /api/platform/certificates GET2 POST2 PUT2 DELETE1 Connections A connector configured against a real system — over HTTPS, or directly over the network (a VPN or interconnect) to a database, directory or service port. Every handshake is TLS 1.2 or higher and the server is verified, against a trusted root or a CA you upload under Certificates. Credentials are encrypted on the way in and never come back out — only the last four characters are ever shown. A connection here carries data; it does not place Microsoft Teams calls or create meetings — those run through CRM › Interaction Centre › Connected Channels, and testing a Teams connection here says what that still lacks. /api/platform/connections GET2 POST4 PUT2 DELETE1 Connector Catalog What can be connected to: protocols, ERP and finance systems, CRMs, identity directories, payment engines and clinical interfaces. Microsoft Teams calls, meetings and presence are not set up here: add them under CRM › Interaction Centre › Connected Channels. /api/platform/connectors GET2 POST2 PUT1 DELETE1 Data Pipelines Outbound: extract from a TRANXACT source, apply the field mapping, stage for a destination. Inbound: read an external API through its source connection, stage what came in, check it, have somebody else approve it, then load it through the target screen itself. /api/platform/pipelines GET3 POST4 PUT2 DELETE2 Pipeline Runs What each run read, staged and failed to stage. An inbound run is checked, approved by somebody other than the person who fetched it, and loaded through the target screen, or rejected and discarded. Whether an outbound destination can be reached is shown by its connection's health, on Connections. /api/platform/pipeline-runs GET3 POST2 PUT1 DELETE1

Legacy Migration

Archived History Closed documents from the old system, kept whole and addressable by their old number. Records, not transactions: nothing here has been posted. /api/platform/migration-history GET2 POST2 PUT1 DELETE1 Field Maps How a field becomes a field. The transform is where a SAP date, a German decimal or an X-means-blocked flag is dealt with. /api/platform/migration-fields GET2 POST2 PUT1 DELETE1 Migration Batches Every consignment of rows, with what became of each. /api/platform/migration-batches GET2 POST2 PUT1 DELETE1 Migration Cockpit The cutover as a numbered plan, one step at a time: where in the old system each extract comes from — with the program or query to produce it — then upload, read the rejections, and load, post, archive or post the balances. /api/platform/migration GET14 POST24 DELETE1 Migration Objects What comes across from each system, what it is called over there, and which of the three kinds of data it is. /api/platform/migration-objects GET2 POST2 PUT1 DELETE1 Migration Resets Every time a company’s cutover was started again, and what it took with it. Kept because the load runs a reset deletes were what accounted for records that now exist — so this is the only trace a wipe leaves. /api/platform/migration-resets GET2 POST2 PUT1 DELETE1 Migration Runs Validate, load, archive and balance runs. A run cannot be deleted — it accounts for records that now exist. /api/platform/migration-runs GET2 POST2 PUT1 DELETE1 Opening Balances The one thing the old ledger puts into this one, as a single conversion entry on the cutover date. /api/platform/opening-balances GET2 POST2 PUT1 DELETE1 Source Systems The systems TRANXACT knows how to be migrated from, and how data gets out of each. /api/platform/migration-sources GET2 POST2 PUT1 DELETE1

License

Payments

Printing

Process & Structure

Approval Document Types What can be sent for approval. The built-in types are run by their own modules' rules (listed under Approval Rule Catalogue) or by self-service; add a type of your own by naming the table it lives in. No code needed. /api/platform/approval-doc-types GET2 POST2 PUT1 DELETE1 Approval Requests Every document sent through this company's own routes, and where it stands. Approvers decide in My approvals. /api/platform/approval-requests GET2 POST2 PUT1 DELETE1 Approval Routes The first active route (lowest priority number) a document meets decides who approves it. Steps are added on Approval Steps: the same level is parallel, levels run in order. A step with no reachable approver and no fallback stops the document being sent -- nothing is approved by default. /api/platform/approval-routes GET2 POST2 PUT1 DELETE1 Approval Rule Catalogue Every approval rule in the company in one list: the routes written here and the rules the purchasing, sales, hiring and journal screens keep. The older ones still run exactly as before and are edited where they are kept. /api/platform/approval-rule-catalog GET2 POST2 PUT1 DELETE1 Approval Steps Who decides, in what order. Steps with the same level number are parallel (all must approve). Name a fallback for when the approver has left, is the requester, or the role is empty. /api/platform/approval-route-steps GET2 POST2 PUT1 DELETE1 Extendable Picklists The drop-down lists a company can add values to. Add a value under Admin > Configuration Lists with the list key shown here; the form then offers it and the record accepts it. /api/platform/picklists GET2 POST2 PUT1 DELETE1 Feature Toggles Switch a section of a module off for this company: its screens leave every menu, its routes refuse, and ASK stops offering it. Everything is on until you say otherwise. /api/platform/feature-toggles GET1 PUT1 Status Transitions A move from one status to another with a name: who may make it, the fields that must be filled first, a condition the record must meet, and whether a note is needed. A move named like a built-in verb (confirm, close) also lets that built-in action start from this status. Moves are made through the move route and ASK. /api/platform/status-transitions GET2 POST2 PUT1 DELETE1 Statuses The statuses a document can hold. The built-in ones are locked; add your own (On hold, Awaiting vendor) and join them with moves under Status Transitions. /api/platform/status-states GET2 POST2 PUT1 DELETE1 Unit Type Rules Which type may sit under which. A type with no rule here can sit anywhere, as before; once it has one, only the parent types named are allowed. /api/platform/org-unit-type-rules GET2 POST2 PUT1 DELETE1 Unit Types The kinds of organisation unit this company has. Company, business unit, division, department, cost center and site are built in and locked; add region, plant, branch or school beside them. /api/platform/org-unit-types GET2 POST2 PUT1 DELETE1

Published API

Allowed Software Where a key may be presented from: a browser origin, a host, an address or a network. A key that requires an allowlist and has no entries reaches nothing — "no addresses named" reads as "not reachable yet", never as "anywhere". /api/platform/api-allowlist GET2 POST2 PUT1 DELETE1 API Call Log Every call to the published API, allowed or refused, with the reason for each refusal. A call that came with no key, or a key nobody issued, is logged refused with the Client column empty: that includes anyone probing the address and an AI app's first call before it has signed in. To see how your own integrations are doing, filter on Client. This is not the audit log — that records what the record actually did, because a published call goes through the ordinary route and the ordinary route audits itself. This records what was asked, from where, and by which key. /api/platform/api-calls GET2 POST2 PUT1 DELETE1 API Clients The outside software that holds a key to this company. Every call it makes runs as a named user here, so nothing it can reach is anything that user could not already reach. The key is shown once when it is issued and never again. /api/platform/api-clients GET2 POST3 PUT1 DELETE1 API Grants Which software may reach which exposure, and with which verbs. Two partners can hold keys to this company and reach entirely different data; withdrawing one changes nothing for the other. /api/platform/api-grants GET2 POST2 PUT1 DELETE1 API Studio One board for the whole of the published API: what is exposed, who holds a key, what each key could not actually do, and every call made in the last few days with the reason for each refusal. Software calls in at <this address>/api/v1 (REST, with an OpenAPI document per key at /api/v1/openapi.json) and /api/v1/mcp (MCP); documented at help.tranxact.ai › Connecting other software. /api/platform/api-studio GET3 POST3 Exposures A decision, taken once, that one screen may leave this company — which columns of it, which rows of it, and whether anything may be written back. Nothing is reachable from outside until it is published here, and there is no "publish everything". /api/platform/api-exposures GET2 POST2 PUT1 DELETE1

Records

Hold Coverage Every table a legal hold can reach, the columns that name a person in it, the document type and date a hold reads, and the bookkeeping a held row may still have changed (a file moving to the document store, a virus scan). Every HR and recruiting table that names an employee, a person, a candidate or an application is covered. /api/platform/hold-coverage GET1 HR Document Types The kinds of employee document the company keeps — I-9s, contracts, reviews, medical certificates — each with how long it is kept after the person leaves. A legal hold can hold documents by type, and retention keeps each type for its own period. A type in use is not deleted: set it inactive. /api/platform/document-types GET2 POST2 PUT1 DELETE1 Legal Holds A matter — litigation, an audit, an investigation, a public records request, a grievance or a complaint — holds the records it may need. While a hold is active the records it reaches cannot be changed, deleted, archived or purged, and their files cannot be deleted: the database refuses, whoever asks. Name the people (employees, applicants), the document types, the dates and, if you want, only some tables. A hold is never deleted; Release ends it and both stay on record. /api/platform/legal-holds GET3 POST4 PUT1 DELETE1 Records Exports Everything about one employee, one applicant or one legal matter — or the whole company — as one ZIP: every record as JSON and CSV (and XML and Excel for a person or a matter), its audit history, its attachments from the document store, a manifest with a SHA-256 of every file and a PDF summary. Built in the background; every request and every download is audited. Passwords, keys and tokens are never exported. /api/platform/records-exports GET3 POST4 PUT1 DELETE1

Report Data Sources

Reporting

Services and actions

Synthetic Data

Workflow Automation