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/platformAccess
Provisioning (SCIM)
Your directory creates, changes and deactivates people here through SCIM 2.0, with a token made on this screen and shown once. Groups it pushes give the roles you choose.
GET1 POST2 PUT1 DELETE1
Service Accounts
Identities for software. They hold roles like a person but cannot sign in to the console and are never asked for a second step: a secret, shown once, is exchanged for a short-lived token.
GET1 POST3 PUT1 DELETE1
Single Sign-On
One connection per directory — SAML 2.0 and OpenID Connect sign people in; OAuth 2.0, WS-Federation, CAS, LDAP and the rest are described — and the email domains each of them answers for, the directory’s MFA and the roles its groups give.
GET2 POST6 PUT1 DELETE2
Web & User Sessions
Every web session and every signed-in person, with what each is doing now. Sign out one, several, a person, or everybody else.
GET1 POST1 DELETE1
AI Governance
AI Decision Reviews
Every AI-assisted employment decision a person must review: a resume score or a candidate summary made under suggest-only. Accept it, override it with what you decided, or reject it — with your reason, on the record.
GET2 POST2 PUT1 DELETE1
AI Disclosure Register
Each AI and automated decision tool in the product: what it does, how it is configured here today, what data it uses, who else is involved, and how a person reviews it. Company data is not used to train AI models. Download it for a disclosure or an RFP.
GET1 POST1
AI Settings
AI features are allowed by default for this company; an administrator can turn any area off. Per area, whether AI and automated decision tools may act here: off (they do not run, and ASK and agents cannot read or change these records), suggest (they may propose, a person decides — every AI output about a person opens a review, and an agent's change waits for approval) or allowed (as the product behaves today). Enforced where each tool runs, not on a screen. Company data is not used to train AI models.
GET3 POST2 PUT1 DELETE1
AI Use
Every use of AI and automated decision tools in the last 90 days, and every refusal: ASK questions, agent runs, resume scoring, AI summaries and support auto-answers — who, when, which area, and whether it ran, only suggested or was refused.
GET1 POST1
Analytics
Dashboards
Tiles over metrics and saved queries. Render one to see the current numbers; a tile that breaks reports its error without taking the rest down.
GET3 POST3 PUT2 DELETE2
Datasets
A governed view over the estate, defined once and used by every metric and query built on it.
GET2 POST2 PUT1 DELETE1
Metrics
One number, defined once, so the same question gets the same answer everywhere. Whether higher is better decides whether the target is met.
GET2 POST2 PUT1 DELETE1
Query Log
Who ran what, how long it took and how much came back — including every statement the guard refused. Append-only.
GET2 POST2 PUT1 DELETE1
Saved Queries
Ad-hoc analysis that anyone can re-run. Only SELECT and WITH are allowed, one statement at a time, capped and timed out — and every run is logged, including the ones that were refused.
GET2 POST2 PUT1 DELETE1
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.
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.
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.
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.
GET2 POST3 PUT1 DELETE1
Intake Log
Every file intake took in: what it read, the draft it made, or why it needs a person.
GET2 POST2 PUT1 DELETE1
Reminders & Escalations
Every reminder and escalation the time-limit sweep made.
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.
GET2 POST3 PUT1 DELETE1
Batch
Batch Console
The job library for every module, with a rehearsal that shows which records a job would touch before it touches them.
GET5 POST4 PATCH1 DELETE1
Job Definitions
What each job selects, what it does to what it selects, and whether it is safe to run twice.
GET2 POST2 PUT1 DELETE1
Job Runs
Every run that has happened, what it selected, and what it did to each record. A run cannot be deleted — that is the point of keeping it.
GET2 POST2 PUT1 DELETE1
Job Schedules
When each job runs without anybody starting it. Every one of these fires in the background as the person who created it, so it may take as long as it takes — which is the point for a large file read off a drive, or a folder somebody drops one into every morning. "State" says whether it is waiting, running, overdue or paused; overdue for long means the API is not running the scheduler.
GET2 POST2 PUT1 DELETE1
Job Sets
A run book: several jobs in the order somebody would run them by hand, and what to do when one of them fails.
GET2 POST2 PUT1 DELETE1
Set Runs
A run book executed end to end, including where it stopped.
GET2 POST2 PUT1 DELETE1
Set Steps
The order of a run book, and which steps may fail without stopping it.
GET2 POST2 PUT1 DELETE1
Business Flows
Flow Definitions
The chains themselves. A template ships with the platform; a copy belongs to whoever made it.
GET10 POST5 PUT1 DELETE1
Flow Handovers
The column that carries each link. Without one an edge can be drawn but not counted, and the map says so.
GET2 POST2 PUT1 DELETE1
Flow Snapshots
The shape of a flow on a given day, so a slide from 8% stalled to 21% is a record rather than a memory.
GET2 POST2 PUT1 DELETE1
Flow Steps
What each step is backed by, and what "still in this step" means in the words the table itself uses.
GET2 POST2 PUT1 DELETE1
Scenario Runs
What each run created, and whether the flow’s handovers moved as a result.
GET3 POST2 PUT1 DELETE1
Scenario Steps
The call each step makes, with tokens for the parts that vary. {{ref:module/resource}} picks an existing record; {{prev.x}} takes it from the step before.
GET2 POST2 PUT1 DELETE1
Test Scenarios
Augmented data for a flow, made by calling the same routes the screens call rather than by inserting rows behind the application’s back.
GET4 POST3 PUT1 DELETE1
Custom Objects
Custom Objects
Tables this company defines for itself: name the object, add its fields, and it gets a screen, search, import, audit and its own grants (Custom Objects tab). Nothing here changes a standard screen. Limits: 50 objects, 80 fields and a million records each. Switch an object off to hide it and keep its records; delete it only on purpose.
GET4 POST4 PUT1 DELETE1
Object Fields
The fields of each custom object. A field has a type, optional limits, and may be required, unique, searchable or sensitive (kept out of reports, search and anything an AI assistant is shown). A field is retired by default: it disappears from the screens and its values stay; Purge drops the column and its values. A field's key and type cannot be changed.
GET3 POST2 PUT1 DELETE1
Data Retention
Archived Records
What archive runs took out of the live tables, each with the rows that went with it. Restore puts a record back exactly as it was — refused as a whole if anything it refers to has gone since.
GET2 POST3 PUT1 DELETE1
Retention Policies
Archive or purge one kind of data once it is older than the years you set AND has not been added to or changed for the years you set — then again on the period you choose. There are no defaults and none is shipped. A policy starts switched off: preview it, then switch it on. Records something else still refers to are kept and counted. Purging needs the delete permission on this screen.
GET2 POST4 PUT1 DELETE1
Retention Runs
Every run of every retention policy — scheduled, run by hand, or previewed — with what it looked at, what it archived or purged, and what it kept and why.
GET2 POST2 PUT1 DELETE1
Email Events
Everything the product sends by email, and who receives it when you have written no rule.
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.
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.
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.
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.
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.
GET2 POST3 PUT1 DELETE1
Events & Webhooks
Webhook Deliveries
Every event sent to a webhook, with its signature and what the receiver answered. One that did not go is tried again, waiting longer each time, up to the webhook's retry limit and never more than a day after it was queued. One that failed in the end can be sent again with Redeliver.
GET2 POST3 PUT1 DELETE1
Webhooks
Events pushed out to another system, signed with HMAC-SHA256 so the receiver can prove where they came from.
GET2 POST3 PUT2 DELETE1
Extension Hooks
Extension Hooks
Rules attached to named points in a record's life: before or after it is saved, posted or approved, and when its status changes. A hook is a condition (the same expression language as custom rules) and one action: refuse with a message, warn, send on one of this company's webhooks, or write a log line. A hook cannot change a record or run code. New hooks start in dry run: evaluated and logged, never acting, until you switch them live. To fill in, work out, check, show or lock a field, use Custom Logic instead.
GET4 POST5 PUT1 DELETE1
Hook Runs
Every run of every hook that did something or failed, and every evaluation of a hook still in dry run: when, what fired, what it did and how long it took. Kept for thirty days.
GET2 POST1 PUT1 DELETE1
External Accountants
Health
Locks
Locks being waited on, locks that block others, advisory locks and batch runs that still say running — which are stale, and releasing them.
GET1 POST1 DELETE1
System Traces
One process in full: every statement it sent with timings, the locks it holds and waits on, who it blocks and who blocks it, and the plan of what it is running. The slowest recent work and the statements with the most database time.
GET2
Work Processes
Every request, background worker and batch run on every container, each tied to the database backend it is using, and every backend tied back to the work that sent it. Cancel a runaway statement or end a stuck backend.
GET1 POST1 DELETE1
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.
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.
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.
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.
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.
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.
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.
GET2 POST2 PUT1 DELETE1
Migration Batches
Every consignment of rows, with what became of each.
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.
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.
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.
GET2 POST2 PUT1 DELETE1
Migration Runs
Validate, load, archive and balance runs. A run cannot be deleted — it accounts for records that now exist.
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.
GET2 POST2 PUT1 DELETE1
Source Systems
The systems TRANXACT knows how to be migrated from, and how data gets out of each.
GET2 POST2 PUT1 DELETE1
License
Backups
The backups this installation holds of its own data, what each one weighs on the meter, and deleting the ones you no longer need.
GET1 POST1 DELETE1
License & Metering
The license in force and the fee it implies, and the data units this installation has consumed — incoming, outgoing, persistent disk, processed and backup data — this month, day by day and for each month before it. Read-only: the license changes only when a new key from TRANXACT is applied.
GET1 POST1
Payments
Payment Engines
Stripe, PayPal, Adyen, Visa, Mastercard and the rest. The published rate is what the fee is calculated at, and takings post to the clearing account rather than sitting in a table.
GET2 POST3 PUT2 DELETE1
Transactions
Every authorization, capture and refund, the fee taken out of it, and the journal it produced.
GET2 POST2 PUT1 DELETE1
Printing
All Print Queues
The print jobs of every person: who printed what, on which printer, and where it stands. Release a held job, cancel one, move it to another printer, or open its PDF.
GET5 POST6 PUT1 DELETE1
Printers
The printers people can choose as their default and that print jobs go to. "PDF only" keeps the output as a PDF in the print queue and prints nothing. A device printer needs the site print agent; without one its jobs wait in the queue and the PDF can be opened and printed by hand.
GET2 POST2 PUT1 DELETE1
Queue Settings
How long the PDF output of print jobs is kept: finished jobs, and jobs nobody released. After that the output is cleared and the job stays as a record. A record under legal hold keeps its output.
GET2 POST2 PUT1 DELETE1
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.
GET2 POST2 PUT1 DELETE1
Approval Requests
Every document sent through this company's own routes, and where it stands. Approvers decide in My approvals.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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".
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.
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.
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.
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.
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".
GET2 POST2 PUT1 DELETE1
Reachable by link
Records
Records & Legal Hold
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.
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.
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.
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.
GET3 POST4 PUT1 DELETE1
Report Data Sources
Reporting
Services and actions
^\
The ^\ service of Platform: 1 operation(s).
DELETE1
Analytics
The analytics service of Platform: 3 operation(s).
GET2 POST1
Automation
The automation service of Platform: 2 operation(s).
GET2
Content
The content service of Platform: 11 operation(s).
GET6 POST2 PUT2 DELETE1
Event deliveries status
The event deliveries status service of Platform: 1 operation(s).
GET1
Forms
The forms service of Platform: 17 operation(s).
GET9 POST5 PUT2 DELETE1
Mail transport
The mail transport service of Platform: 1 operation(s).
GET1
Overview
The overview service of Platform: 1 operation(s).
GET1
Payments
The payments service of Platform: 2 operation(s).
POST2
Retention
The retention service of Platform: 1 operation(s).
GET1
Social
The social service of Platform: 21 operation(s).
GET8 POST6 PUT4 DELETE3
Viz
The viz service of Platform: 3 operation(s).
GET1 POST2
Synthetic Data
Generation Runs
What was produced, how close it came to the real distribution, and how much was withheld for sitting too near a real record.
GET2 POST2 PUT1 DELETE1
Synthetic Data Generators
A statistical generator TRANXACT fits and runs itself, or an endpoint at a service hosting a trained model. Every run says which produced it.
GET2 POST2 PUT1 DELETE1
Workflow Automation
Workflow Approvals
A workflow that needs a human waits here. Deciding it releases the run — or stops it.
GET2 POST3 PUT1 DELETE1
Workflow Runs
Every run, with the step log underneath it. Open one to see which step stopped it and why.
GET3 POST3 PUT2 DELETE2
Workflows
A trigger, a condition and a list of steps. Run one by hand to see exactly what it would do before letting an event drive it.
GET3 POST5 PUT2 DELETE2