TRANXACT.AI Help

API package

CRM

Accounts, sales automation, service cases, and field service — closed-won deals bill through Accounting.

160 APIs1210 operationsBase path /api/crm

Accounts & Contacts

Automation

Broadcast

Credit Control

Customer Portal

Engagement & Retention

Forecasting & Quotas

Forecast Board Quota, closed, commit, best case and pipeline for you and the people who report to you: attainment, weighted pipeline and coverage, your call for the period, and how past calls compared with what closed. /api/crm/forecast-board GET3 POST4 Forecast Calls Every call made for a period: what the system saw, what the rep committed, and what their manager changed it to and why. /api/crm/forecast-submissions GET2 POST2 PUT1 DELETE1 Forecast Categories Pipeline, best case, commit, closed and omitted, and which opportunity stages fall in each. A deal can be moved out of its stage's category with a reason. /api/crm/forecast-categories GET2 POST2 PUT1 DELETE1 Forecast Snapshots A photograph of every salesperson's numbers each week, so forecast against actual can be read back afterwards. /api/crm/forecast-snapshots GET2 POST2 PUT1 DELETE1 Quota Periods The months or quarters of each plan, as the fiscal calendar gives them. /api/crm/quota-periods GET2 POST2 PUT1 DELETE1 Quota Plans A plan per fiscal year, cut into months, quarters or the year from the company's fiscal calendar. Activate one and the forecast board and the weekly snapshot read it. /api/crm/quota-plans GET2 POST5 PUT1 DELETE1 Quotas What each salesperson, team or territory is expected to close in a period, in money and units, optionally per product line. /api/crm/quotas GET2 POST2 PUT1 DELETE1 Sales Team Members The people in each team. /api/crm/sales-team-members GET2 POST2 PUT1 DELETE1 Sales Teams Who sells together and who manages them. A manager sees and rolls up their team's forecasts; a team may sit under another. /api/crm/sales-teams GET2 POST2 PUT1 DELETE1 Sales Territories Where each team sells: countries and regions. A territory can carry a quota of its own. /api/crm/sales-territories GET2 POST2 PUT1 DELETE1

Inbox & Calendar

Interaction Centre

Call Scripts What a call in a salesperson’s AI voice says. Only an approved script can be used, approved by somebody other than its author; changing an approved script makes a new version, and every call records the version it used. The AI-voice disclosure is always spoken before the script. /api/crm/call-scripts GET2 POST5 PUT1 DELETE1 Connected Channels Teams, Zoom, Twilio, a contact centre, an email provider — what this company can actually reach a customer through, and what each one is capable of. Microsoft Teams calls, meetings and presence are set up here: register an app in Microsoft Entra, grant it the Graph application permissions Calls.Initiate.All, OnlineMeetings.ReadWrite.All, Presence.Read.All and CallRecords.Read.All with admin consent, enter its tenant id and client id below, save its client secret with "Set the credential", then press "Test it" — the test names anything still missing. TRANXACT starts the call or meeting and logs it; the conversation itself happens in Teams. /api/crm/channel-connections GET2 POST2 PUT1 DELETE1 Dispositions The reasons a call can be closed with. Configuration rather than free text, because a disposition somebody types is a disposition nobody can count. /api/crm/call-dispositions GET2 POST2 PUT1 DELETE1 Interactions Every call, chat, meeting and message with a customer. The disposition is the field that makes a desk countable and the one most often left empty. /api/crm/calls GET2 POST2 PUT1 DELETE1 My Voice Record your consent and a sample of your own voice, so calls can be placed in it on your behalf. Every such call opens by saying it is an AI-generated voice. Only you can use your voice. /api/crm/voice-profiles GET4 POST8 PUT1 Queue Staffing Who staffs each queue and how good they are at it. The proficiency is what makes skill-based routing worth having: everybody can take a billing call, and three people should. /api/crm/queue-members GET2 POST2 PUT1 DELETE1 Queues What customers wait in. The columns are the promises a desk makes: answer within this many seconds, offer a callback rather than hold past this. /api/crm/interaction-queues GET2 POST2 PUT1 DELETE1 Recordings What was recorded, whether the caller was told, and when it must be destroyed. Most regimes cap how long a recording may be kept, and nobody deletes what has no date on it. /api/crm/call-recordings GET2 POST2 PUT1 DELETE1 Who Is Available Where each person is right now, and whether the platform agrees. They disagree constantly — somebody on a Teams call is on a call whether or not the desk knows — and the disagreement is shown rather than reconciled away. /api/crm/agent-presence GET2 POST2 PUT1 DELETE1

Lead Scoring

Marketing

Point of Sale

Pricing

Pricing Procedures

Access Sequence Steps One attempt of a sequence: the keys a condition record must carry to be found. The first step that finds a record wins. /api/crm/pricing-access-steps GET2 POST2 PUT1 DELETE1 Customer Pricing Group Assignments Which pricing group each customer is in. /api/crm/account-pricing-groups GET2 POST2 PUT1 DELETE1 Customer Pricing Groups Groups of customers that share pricing conditions (distributors, retail, key accounts). /api/crm/pricing-groups GET2 POST2 PUT1 DELETE1 Price List Discount Steps Discounts taken off a list’s price one after another, in step order, each with its own quantity threshold. A step with no entry applies to the whole list. /api/crm/price-list-steps GET2 POST2 PUT1 DELETE1 Pricing Access Sequences The order in which a condition looks for its value: the most specific key first (customer and item), then wider ones (item alone). Add the steps on Access Sequence Steps. /api/crm/pricing-access-sequences GET2 POST2 PUT1 DELETE1 Pricing Condition Records The values: 5% off for this customer on this item, 8% off for the distributor group on a category, a freight surcharge for any item. The access sequence decides which one applies. /api/crm/pricing-condition-records GET2 POST2 PUT1 DELETE1 Pricing Condition Types The kinds of element a procedure stacks: a price, discounts, surcharges -- and charges on the document (freight, insurance, packing, inspection, duty) for quotations, sales orders and purchase orders. PR00 is the list price. Liquidated damages (LD): 0.5% of the late goods’ net value for every week late, at most 5% of the order’s net value, no VAT/GST, found for an order by its own condition records. /api/crm/pricing-condition-types GET2 POST2 PUT1 DELETE1 Pricing Procedure by Document Which procedure prices each kind of document. A document type with no row uses the default procedure. "Apply on save" lets a new line left at its untouched default price take the procedure’s price; otherwise the procedure’s price is only recorded beside the line. /api/crm/pricing-procedure-assignments GET2 POST2 PUT1 DELETE1 Pricing Procedure Steps One step of a procedure: which condition, whether a percentage is taken of the running price or of the price after an earlier step, whether it is mandatory, whether it is only shown. /api/crm/pricing-procedure-steps GET2 POST2 PUT1 DELETE1 Pricing Procedures The ordered steps that arrive at a unit price. The standard procedure is the list-price lookup, exactly as before; add steps for discounts and surcharges and assign the procedure to a document type. /api/crm/pricing-procedures GET2 POST2 PUT1 DELETE1 Sales Document Charges Every charge a quotation or sales order carries: those worked out from the charge records and those added by hand. Billed charges are in the document’s total and are invoiced with the goods. /api/crm/sales-document-charges GET2 POST2 PUT1 DELETE1

Prospecting

Arrangement Installments Each installment of each arrangement: due, paid, missed. /api/crm/util-arrangement-installments GET2 POST2 PUT1 DELETE1 Bill Lines The charges on each bill, block by block. /api/crm/util-bill-lines GET2 POST2 PUT1 DELETE1 Customer · Credit Profile The limit, what it is made of, what happens when it is reached, and what security is held against it. Reviewed on its own cycle by different people. /api/crm/customer-credit GET2 POST2 PUT1 DELETE1 Customer · Financial Terms, payment method, how invoices are grouped and what happens when they do not pay — at account level, or overridden per site. /api/crm/customer-financials GET2 POST2 PUT1 DELETE1 Customer · Relationships Who acts for whom. A parent that pays a subsidiary, a buying group, a guarantor — and whether the exposure rolls up. /api/crm/customer-relationships GET2 POST2 PUT1 DELETE1 Customer · Selling Context The same account seen from one of your own business units — different terms, different price list, different salesperson, and all of them right. /api/crm/customer-orgs GET2 POST2 PUT1 DELETE1 Customer Addresses One customer, several places: where it orders from, where the invoice goes, where the goods go and which warehouse takes them in. Purposes are independent ticks because one address is very often both ship-to and bill-to. /api/crm/customer-sites GET2 POST2 PUT1 DELETE1 Interaction Events The transfers, the holds and the conference joins — what a supervisor reads when a customer says they were passed around four times. /api/crm/call-events GET2 POST2 PUT1 DELETE1 Recipients One row per person per broadcast, with what became of it — and why it was not sent where it was not. "No consent", "hard bounced before", "duplicate address" and "on the suppression list" are four different problems and three of them are fixable. /api/crm/broadcast-recipients GET2 POST2 PUT1 DELETE1

Records

Relationships

Reporting

Sales

Sales Channels

Sales Order Types

Selling

Service

Service & Feedback

Services and actions

Utilities

Utility Billing

Utility Cashiering & Payments

Autopay Accounts paid automatically by a card kept in the card vault: the mask, the consent and when it was given. Each posted bill becomes a one-off charge on its due date. /api/crm/util-autopay GET2 POST5 PUT1 DELETE1 Cash Approvals For a supervisor: voids the cashiers asked for and drawer closes waiting to be approved — never their own. /api/crm/util-cash-approvals GET1 POST3 Cash Drawers The drawers at the counter. /api/crm/util-cash-drawers GET2 POST2 PUT1 DELETE1 Cash Sessions Each cashier's session on a drawer: the float, the takings, the count, the over or short, and who approved the close. /api/crm/util-cash-sessions GET2 POST2 PUT1 DELETE1 Cashiering The counter: open a drawer session with its float, find the account, take cash, check, card or money order, take a deposit, ask for a void, close with the count. /api/crm/util-cashiering GET2 POST4 Lockbox & Bank Files A lockbox or bank file of payments: each line posted once by its reference, duplicates and bad lines named. /api/crm/util-payment-imports GET2 POST3 PUT1 DELETE1 Online Payments Pay-now from the customer portal, handed to the payment provider and posted when the provider confirms it. /api/crm/util-payment-requests GET2 POST4 PUT1 DELETE1 Refunds Credit balances and deposits paid back to customers. /api/crm/util-refunds GET2 POST3 PUT1 DELETE1 Utility Payments Every payment on a utility account — counter, mail, lockbox, bank, portal, autopay — what it paid, what became a credit, and any void. /api/crm/util-payments GET2 POST4 PUT1 DELETE1

Utility Collections

Utility Field Service

Utility Meters & Reads

Device Alarms Battery, tamper, leak and reverse-flow alarms the devices raised. A leak or tamper raises a service order by itself. /api/crm/util-device-alarms GET2 POST4 PUT1 DELETE1 IoT Devices AMI and IoT endpoints that post their own reads: each with a key the server makes and a secret shown once, its health (last seen, battery, signal) and its alarms. /api/crm/util-iot-devices GET2 POST3 PUT1 DELETE1 Meter History Every install, exchange and removal: which meter, where, the start and end reads, and the order that did it. /api/crm/util-meter-installs GET2 POST2 PUT1 DELETE1 Meter Reads Every read from every source — the reader, an AMR file, an IoT device, the field, the portal, an estimate — with its consumption and what billed it. /api/crm/util-reads GET2 POST3 PUT1 DELETE1 Meter Tests Bench and field accuracy tests of meters, pass or fail. /api/crm/util-meter-tests GET2 POST2 PUT1 DELETE1 Meters Every meter: serial, service, make and model, size, unit, multiplier and dials, how it is read, where it is installed and its last read. /api/crm/util-meters GET2 POST2 PUT1 DELETE1 Read Exceptions Reads that did not look right — high or low against the meter's history, no use at a live service, gone backwards — held from billing until somebody accepts, rejects or re-reads them. /api/crm/util-read-exceptions GET2 POST3 PUT1 DELETE1 Read Files (AMR) A handheld or AMR drive-by file of reads: each line checked on its own, duplicates counted, bad lines named. /api/crm/util-read-imports GET2 POST3 PUT1 DELETE1 Read Routes The reading books: which premises, in what walk order, read how and by whom. /api/crm/util-routes GET2 POST2 PUT1 DELETE1