StabisoDocs

API reference

Stabiso API reference

Version 0.1.0. The machine-readable document is erp-openapi.json. Authentication, errors, idempotency and the other conventions are in the conventions guide.

Area Operations What it covers
addresses 3 Address help: whole addresses suggested as people type, from Google's Places API through the ERP (only the text typed and the country reach Google), the parts of the one chosen, and the towns of a postal code from open data shipped with Stabiso. Nothing is stored.
agents 8 Built-in agents (bill capture, reconciliation, close review, assistant, Q&A).
analytics 6 Close analytics: period flux and unusual entries.
approval policy 4 The decision table that says who may post, approve or release what.
approvals 6 The queue of actions waiting for a second person, and the decision.
audit 3 The audit trail, the hash chain verification and the archive export for auditors.
audit files 5 The files a company hands its auditors, for one fiscal year: the FEC (fichier des écritures comptables) in France, the GoBD data carrier (Datenträgerüberlassung, CSV with index.xml) in Germany, the OECD SAF-T 2.0 XML elsewhere, and the audit evidence pack (AICPA Audit Data Standards) everywhere.
autopilot 7
banking 16 Bank statement import (camt.053, camt.054, CSV), matching and posting.
capacity 9 Capacity: products sold by the time slot (a room by the night, a meeting room or a person's day by the day, people's time by the hour) with the units of each slot, what is free on each day, and bookings that never take more than is free. Nothing here posts.
cash-forecast 1 Cash forecast: today's cash and what comes in and goes out in each of the next 13 weeks, from open invoices and bills at each party's payment habit, payments not posted yet and what recurring invoices, subscriptions and recurring journals will make; with its lowest point and what changed since the forecast of an earlier week. Nothing here posts.
close 12 Period-end: depreciation, FX revaluation, deferred tax, checklist, close, reopen.
close tracker 8 The close calendar of an entity (owner, the working day each step is due on), its own month-end tasks and the close status of a period: the steps, the tasks, who did what and what is overdue.
company sign-in 5 Company sign-in: the organization's own identity provider (Okta, Microsoft Entra ID or any OpenID Connect provider), the e-mail domains whose people sign in there, and the sign-in itself, which the passkey step follows.
consolidation 17 Group consolidation: the group structure and its approval, a run that translates the subsidiaries to the reporting currency (IAS 21) and aggregates them, the translated trial balances, the group statements before eliminations and the translation reserve roll-forward.
crm 57 Customer relationships: the deals of an entity's pipeline (opportunities with a customer or a prospect, their stages and probability), the timeline of calls, meetings, notes and tasks, the pipeline by stage, and the sales reports: the pipeline by owner and month, the win rate, each person's activity, quotas and the forecast; the people at customers and vendors (contacts, erased on request) and the organization's own fields on companies, contacts and deals. Nothing here posts.
delivery notes 9 Delivery notes: goods shipped to a customer from a warehouse, posted at moving average cost (Dr cost of goods sold / Cr inventory), their PDF, invoicing them, and what is delivered but not yet invoiced.
dimensions 8 Cost centres, profit centres and projects: the values postings are analysed by, the accounts that require them, and the results by value.
direct debits 8
documents 25 Sales invoices, purchase bills and credit notes: draft, submit, void, history; the invoice PDF, ZUGFeRD / Factur-X, sending by e-mail or recording a hand-over; the files of a document: originals, archived outputs and attachments.
dunning 17 Customer statements: the open items of one customer on a day, tied to the receivables control account, as JSON, CSV or a PDF in the customer's language, archived with its hash when a person issues it. Vendor statements: the movements on a vendor's account between two days with the running balance. Reminder letters: which customers are due one, the letter in their language, archived, sent or recorded as handed over. No fee and no interest; nothing here posts.
e-invoicing 3 XRechnung and ZUGFeRD / Factur-X: check, receive as a draft bill, issue.
exchange rates 7 ECB rates against the entity's currency, cross rates, history, a converter, the official VAT rates next to them, and the foreign-currency exposure a revaluation would remeasure. Reference data only: nothing here changes the books.
expenses 18 Expenses: a receipt's photo becomes an expense whose category, VAT, project and card fill in by themselves; the AI reviewer checks it against the company's expense policy, so a person sees only what it flags; it is booked as a bill and paid back in the next payment run. Company cards and their lines, matched to the receipts.
exports 5 The complete package of the organization's own data for its archive: every table as CSV and JSON, reports, stored files, hash-chain verification and hashes. Started by an administrator, built asynchronously, downloaded or fetched through a signed link.
fixed assets 25 Assets, depreciation books, disposals and book-tax differences.
goods received 4 Goods received on purchase orders and the GR/IR account (goods received, not invoiced): what a receipt posts, per order line what was received, billed and is still open, and the open items on a day tied to the GR/IR account.
hospitality 14 Hospitality: room types let by the night (their rooms kept as capacity, so a night is never let twice), seasonal rates, what a stay costs, and stays from reservation through check-in to check-out, which drafts the stay's sales invoice.
imports 3 Import customers, vendors, accounts, opening balances and open items from CSV or Excel: dry run, all-or-nothing commit, templates.
intercompany 18 Trade between two entities of one organization: the approved relationship (with its VAT group and transfer-pricing record), the draft bill an invoice creates in the counterpart and its acceptance, loans with their interest, group dividends, the settlements, and the reconciliation of the two sides.
inventory 18 Stock: warehouses, the products kept in stock with their inventory and cost of goods sold accounts, adjustments, transfers between warehouses, stock counts, the stock postings with their journal entries, and the valuation at moving average tied to the inventory accounts.
journals 7 Manual journal entries: create, submit through the approval policy, reverse.
meta 1 Health check.
notifications 4 Your notification centre: tasks given to you, due or overdue, deals of yours assigned, won or lost, your approval requests decided; which of them also come by e-mail.
organization 10 The organization of the credential, its API keys and your own profile.
parties 10 Customers and vendors: master data, activation, bank details.
payments 8 Receipts and payments with allocations, payment proposals and payment runs.
plans 12 Budgets and rolling forecasts: plans with versions that a person approves, lines by account and period, and the comparison with what was posted. Never posted to the ledger.
platform 24 For the platform operator only, with a platform key or a session of the operator portal: provision organizations, list and open them, suspend and reactivate them, invite their administrators, mark a demo, export an organization's data for its offboarding, read the audit record. A tenant's keys and sessions do not work here, and a platform credential works nowhere else.
price lists 8 Prices per customer and currency: an entity's price lists, each in one currency, with prices of its products in volume tiers from a day, and the list each customer takes in a currency. A sales line proposes the customer's price before the list price; it still states its own. Nothing here posts.
products 7 What the entities sell: products with the revenue account, supply type and VAT rate type their invoice lines take, list prices by currency from a day, and the standalone selling prices a person records with their basis. Nothing here posts.
purchase-orders 14 Purchase orders, receipts, matching of bills to orders and the matching tolerances.
recurring invoices 8 Templates of invoices that repeat (monthly, quarterly, yearly): created as drafts, activated by a human after a second person approves the terms, and made on demand by a run that is idempotent and never makes a period twice.
recurring journals 8 Journal entries that repeat (rent, allocations, accruals) monthly, quarterly or yearly, optionally reversed on the first day of the next period: posted on demand by a run that is idempotent, each entry through the approval policy.
reports 10 Trial balance, profit and loss, balance sheet, general ledger, aging, VAT report.
revenue contracts 12 IFRS 15 revenue contracts: the customer, the transaction price and the performance obligations with their standalone selling prices; a second person approves the terms, which allocates the price and writes the recognition schedule, and a person records when a point-in-time obligation is satisfied. Nothing here posts yet.
roles 11 Roles in plain words: the ready-made roles and the organization's own, each a person's rights, the areas of the app it opens and which sales records its people see; who has which, what a person can open and do, and the rights nobody used for 90 days.
rolling-forecast 1 Rolling forecast: the forecast of profit and loss every company has for the next 12 periods, made by the system and rolled after each close from actuals and the run rate, never below what is already scheduled. Its versions are plans (plans).
sales 23
sales tax 20
saved reports 12 Lists and reports a person builds (or asks the assistant for) and keeps: run, shared, pinned to Home and e-mailed on a schedule, each reader seeing what they may.
search 1 Find an invoice, bill, credit note, purchase order, journal entry, payment, customer or vendor by its number, a reference or a name, in every entity.
settings 3 The organization's reference-data sources and their status.
setup 22 Legal entities, charts of accounts, fiscal years and periods.
shopify 11 Shopify: a company's online shop connected with an app of its own; every 5 minutes the shop's products come in as the company's products and its orders as sales orders, invoiced when sent and paid to the payment provider's balance; a drop shipper's suppliers get a purchase order for what they ship.
subscriptions 11 Subscriptions: a committed term of recurring products billed monthly, quarterly or yearly, in advance or in arrears. A second person approves the terms, which activates the term's revenue contract; the run bills each period against the contract's obligations.
support 14 The support desk: queues with an inbox address, service levels and working hours; cases from e-mail, calls and agents, with their customer and contact, the person working them, notes, draft replies a person sends, and when the first reply and the resolution are due or were breached. Nothing here posts.
swiss payments 8 Bank accounts, QR-bills and payment files (pain.001).
test copies 6 A test organization with the organization's setup (companies, chart of accounts, customers, vendors, products, people) and empty books, to try things out without touching the real ones; removing one; and sample data for a test organization.
users 19 People who sign in to the web UI, their roles, and the UI's sign-in endpoints.
vat returns 17 VAT settings and returns (CH, DE; Canada's GST/HST and QST): compute, finalise, amend, settle.
webhooks 10 Other systems told of events (deal won, invoice posted, payment received ...): the endpoints, signed messages (Standard Webhooks), retries and the delivery log.
withholding tax 2
year-end close 10 Close a fiscal year into the annual-result account, lock it, reopen it by reversal, book the shareholders' resolution on the result (appropriation) and catch up the years booked before the books were closed.

Schemas used by more than one area: schemas.md.

All operations

Operation Summary Scope Idempotency-Key
GET /v1/addresses/details Get the parts of a suggested address read
GET /v1/addresses/suggestions Suggest addresses read
GET /v1/addresses/towns Find the town of a postal code read
POST /v1/agents/ask Ask a question about the books read
POST /v1/agents/assistant Talk to the assistant read
POST /v1/agents/assistant/stream Talk to the assistant, with its progress read
POST /v1/agents/bill-capture Capture a vendor bill from a file draft required
POST /v1/agents/bill-capture/read Read a vendor bill without booking it draft required
POST /v1/agents/entities/{entity}/reconcile Propose bank reconciliations draft required
POST /v1/agents/form-suggestions Suggest what to enter in a form read
POST /v1/agents/periods/{period_id}/close-review Review a period before closing draft required
GET /v1/entities/{entity}/analytics/breakdowns Top customers, vendors, currencies and expenses read
GET /v1/entities/{entity}/analytics/flux Flux analysis of a period read
GET /v1/entities/{entity}/analytics/insights What moved, in words read
GET /v1/entities/{entity}/analytics/kpis Key figures with comparison read
GET /v1/entities/{entity}/analytics/series A metric over time read
GET /v1/entities/{entity}/analytics/unusual-entries Unusual entries of a period read
GET /v1/approval-policy Get the approval policy read
PUT /v1/approval-policy Replace the approval policy admin
DELETE /v1/approval-policy Reset the approval policy admin
GET /v1/approval-policy/versions List policy versions read
GET /v1/approvals List Approvals read
POST /v1/approvals/{approval_id}/approve Approve a request approve
POST /v1/approvals/{approval_id}/reject Reject a request approve
POST /v1/approvals/{approval_id}/withdraw Withdraw one's own request admin
GET /v1/approvers The approver register read
POST /v1/me/approver-acknowledgement Confirm that my approvals are recorded in my name read
GET /v1/access-log List what external auditors opened admin
GET /v1/audit-events Audit Events read
GET /v1/entities/{entity}/chain-verification Chain Verification read
GET /v1/entities/{entity}/audit-files What the audit file of a year covers read
GET /v1/entities/{entity}/audit-files/evidence Download the audit evidence pack read
GET /v1/entities/{entity}/audit-files/fec Download the FEC (France) read
GET /v1/entities/{entity}/audit-files/gobd Download the GoBD audit file (Germany) read
GET /v1/entities/{entity}/audit-files/saft Download the SAF-T file (outside France and Germany) read
GET /v1/autopilot/passes/{pass_id} Get an Autopilot pass read
POST /v1/autopilot/questions/{question_id}/answer Answer a question of Autopilot draft required
GET /v1/entities/{entity}/autopilot Get what Autopilot keeps and what waits for a person read
GET /v1/entities/{entity}/autopilot/passes List Autopilot's passes read
PUT /v1/entities/{entity}/autopilot/{outcome} Switch an outcome of Autopilot on or off draft
POST /v1/entities/{entity}/autopilot/{outcome}/passes Run a pass of an outcome now draft
POST /v1/entities/{entity}/autopilot/{outcome}/passes/stream Run a pass of an outcome now, with its progress draft
GET /v1/bank-lines/{line_id}/candidates List matching documents for a bank line read
POST /v1/bank-lines/{line_id}/ignore Ignore a bank line post
POST /v1/bank-lines/{line_id}/link Link a bank line to a booked payment draft
POST /v1/bank-lines/{line_id}/match Match a bank line to documents draft
POST /v1/bank-lines/{line_id}/post Post a bank line to an account draft
POST /v1/bank-lines/{line_id}/reopen Reopen an ignored bank line post
POST /v1/bank-lines/{line_id}/unmatch Undo the match of a bank line post
GET /v1/entities/{entity}/bank-lines List bank statement lines read
GET /v1/entities/{entity}/bank-reconciliation Reconcile a bank account read
GET /v1/entities/{entity}/bank-reconciliations List bank reconciliations read
POST /v1/entities/{entity}/bank-reconciliations Mark a bank account reconciled post
POST /v1/entities/{entity}/bank-reconciliations/{reconciliation_id}/reset Reset a bank reconciliation approve
GET /v1/entities/{entity}/bank-statements List bank statements read
POST /v1/entities/{entity}/bank-statements Import a bank statement draft
POST /v1/entities/{entity}/bank-statements/preview Preview a CSV bank file draft
POST /v1/entities/{entity}/payment-status-reports Import the bank's status report on a payment file draft
GET /v1/capacity-bookings List bookings read
POST /v1/capacity-bookings Book capacity draft required
GET /v1/capacity-bookings/{booking_id} Get a booking read
POST /v1/capacity-bookings/{booking_id}/cancel Cancel a booking draft
GET /v1/capacity-items List capacity items read
POST /v1/capacity-items Sell a product by the time slot draft required
GET /v1/capacity-items/{product_id} Get a capacity item read
PATCH /v1/capacity-items/{product_id} Change a capacity item's units draft
GET /v1/capacity-items/{product_id}/availability What is free on each day read
GET /v1/entities/{entity}/cash-forecast Forecast cash for 13 weeks read
PUT /v1/documents/{document_id}/doubtful Mark an invoice doubtful draft
DELETE /v1/documents/{document_id}/doubtful Unmark a doubtful invoice draft
GET /v1/entities/{entity}/receivable-allowance/settings Get the general allowance percents read
PUT /v1/entities/{entity}/receivable-allowance/settings Set the general allowance percents post
POST /v1/periods/{period_id}/close Close a period approve
GET /v1/periods/{period_id}/close-checklist Get the close checklist of a period read
POST /v1/periods/{period_id}/deferred-tax Run deferred tax for a period draft
POST /v1/periods/{period_id}/depreciation Run depreciation for a period draft
POST /v1/periods/{period_id}/fx-revaluation Run FX revaluation for a period draft
GET /v1/periods/{period_id}/receivable-allowance Calculate the allowance for doubtful receivables read
POST /v1/periods/{period_id}/receivable-allowance Run the allowance for doubtful receivables draft
POST /v1/periods/{period_id}/reopen Reopen a period approve
PATCH /v1/close-tasks/{task_id} Change a close task draft
GET /v1/entities/{entity}/close-schedule Get the close calendar of an entity read
PUT /v1/entities/{entity}/close-schedule Set the close calendar of an entity draft
GET /v1/entities/{entity}/close-tasks List the close tasks of an entity read
POST /v1/entities/{entity}/close-tasks Add a close task draft required
GET /v1/periods/{period_id}/close-status Get where the close of a period stands read
POST /v1/periods/{period_id}/close-tasks/{task_id}/complete Record that a close task was done draft required
POST /v1/periods/{period_id}/close-tasks/{task_id}/withdraw Withdraw that a close task was done draft
POST /v1/auth/company/finish Finish a company sign-in
POST /v1/auth/company/start Start a company sign-in
GET /v1/company-sign-in Get the company sign-in admin
PUT /v1/company-sign-in Set up the company sign-in admin
DELETE /v1/company-sign-in Remove the company sign-in admin
GET /v1/consolidation-groups List the consolidation groups read
POST /v1/consolidation-groups Create a consolidation group draft required
GET /v1/consolidation-groups/{group} Get a consolidation group read
GET /v1/consolidation-groups/{group}/checklist Get the close checklist of a group read
GET /v1/consolidation-groups/{group}/members List the member versions of a group read
POST /v1/consolidation-groups/{group}/members Request a subsidiary's place in the group draft required
GET /v1/consolidation-groups/{group}/runs List the runs of a group read
POST /v1/consolidation-groups/{group}/runs Run a consolidation draft required
GET /v1/consolidation-runs/{consolidation_run} Get a consolidation run read
GET /v1/consolidation-runs/{consolidation_run}/balance-sheet Get the group balance sheet of a run read
GET /v1/consolidation-runs/{consolidation_run}/cash-flow Get the group cash flow statement of a run read
GET /v1/consolidation-runs/{consolidation_run}/cta Get the translation reserve roll-forward of a run read
GET /v1/consolidation-runs/{consolidation_run}/eliminations List the eliminations of a run read
GET /v1/consolidation-runs/{consolidation_run}/exceptions List the exceptions of a run read
GET /v1/consolidation-runs/{consolidation_run}/profit-and-loss Get the group profit and loss of a run read
GET /v1/consolidation-runs/{consolidation_run}/rates List the rates a run used read
GET /v1/consolidation-runs/{consolidation_run}/trial-balance Get an entity's translated trial balance read
POST /forms/leads/{key} Send a lead from a website
GET /v1/activities List activities read
POST /v1/activities Record an activity draft required
POST /v1/activities/{activity_id}/complete Mark a task done draft
GET /v1/contacts List contacts read
POST /v1/contacts Add a contact draft required
GET /v1/contacts/{contact_id} Get a contact read
PATCH /v1/contacts/{contact_id} Change a contact draft
POST /v1/contacts/{contact_id}/erase Erase a contact's personal data draft
POST /v1/contacts/{contact_id}/merge Merge a duplicate contact draft
GET /v1/custom-fields List the organization's own fields read
POST /v1/custom-fields Add a field of the organization's own admin required
PATCH /v1/custom-fields/{field_id} Change or retire a field of the organization's own admin
GET /v1/hubspot Get HubSpot admin
POST /v1/hubspot/authorize Start connecting HubSpot on its consent page admin
POST /v1/hubspot/connections Connect HubSpot with a private app admin
POST /v1/hubspot/connections/oauth Connect HubSpot with its consent page's answer admin
PATCH /v1/hubspot/connections/{connection_id} Change what HubSpot hands over admin
DELETE /v1/hubspot/connections/{connection_id} Disconnect HubSpot admin
POST /v1/hubspot/connections/{connection_id}/sync Read HubSpot now admin
GET /v1/lead-forms List website forms read
POST /v1/lead-forms Set up a website form admin required
PATCH /v1/lead-forms/{form_id} Change or switch off a website form admin
POST /v1/lead-forms/{form_id}/new-key Give a website form a new key admin
GET /v1/leads List leads read
POST /v1/leads Add a lead draft required
GET /v1/leads/summary Count leads by status read
GET /v1/leads/{lead_id} Get a lead read
PATCH /v1/leads/{lead_id} Change a lead draft
POST /v1/leads/{lead_id}/convert Convert a lead into a customer, contact and deal draft required
POST /v1/leads/{lead_id}/erase Erase a lead's personal data draft
GET /v1/me/mailbox Get your mailbox link read
DELETE /v1/me/mailbox Unlink your mailbox read
POST /v1/me/mailbox/google Link your Google account draft
POST /v1/me/mailbox/sync Read your mailbox now draft
GET /v1/me/record-access Which sales records you see read
GET /v1/opportunities List opportunities read
POST /v1/opportunities Create an opportunity draft required
GET /v1/opportunities/pipeline Get the pipeline of an entity read
GET /v1/opportunities/{opportunity_id} Get an opportunity read
PATCH /v1/opportunities/{opportunity_id} Change an opportunity draft
POST /v1/opportunities/{opportunity_id}/stage Move an opportunity to a stage draft required
PUT /v1/people/{user_id}/record-visibility Set which sales records a person sees admin
GET /v1/record-access List what each person sees admin
POST /v1/record-access/hand-over Hand one person's records to another admin required
GET /v1/sales-teams List sales teams read
POST /v1/sales-teams Set up a sales team admin required
PATCH /v1/sales-teams/{team_id} Rename a sales team admin
DELETE /v1/sales-teams/{team_id} Remove a sales team admin
PUT /v1/sales-teams/{team_id}/members/{user_id} Add a person to a sales team admin
DELETE /v1/sales-teams/{team_id}/members/{user_id} Take a person out of a sales team admin
GET /v1/sales/activity Get the sales activity per person read
GET /v1/sales/forecast Get the sales forecast read
GET /v1/sales/pipeline Get the pipeline report read
GET /v1/sales/quotas List quotas read
PUT /v1/sales/quotas Set quotas approve
GET /v1/sales/win-rate Get the win rate read
GET /v1/delivery-notes List delivery notes read
POST /v1/delivery-notes Create a delivery note draft required
GET /v1/delivery-notes/{note} Read a delivery note read
PATCH /v1/delivery-notes/{note} Change a delivery note draft
POST /v1/delivery-notes/{note}/cancel Cancel a delivery note draft
POST /v1/delivery-notes/{note}/invoice Invoice a delivery note draft required
GET /v1/delivery-notes/{note}/pdf Download a delivery note read
POST /v1/delivery-notes/{note}/post Post a delivery note post
GET /v1/entities/{entity}/delivered-not-invoiced Delivered, not invoiced read
GET /v1/dimensions List dimensions read
POST /v1/dimensions Add a dimension admin
PATCH /v1/dimensions/{code} Change a dimension admin
PUT /v1/dimensions/{code}/required-accounts Set the accounts that require a dimension admin
POST /v1/dimensions/{code}/values Add a value admin
PATCH /v1/dimensions/{code}/values/{value} Change a value admin
GET /v1/entities/{entity}/reports/dimension-balances Results by cost centre, profit centre or project read
GET /v1/entities/{entity}/reports/dimension-lines The postings of a cost centre, profit centre or project read
POST /v1/direct-debit-exports Release direct debits as a pain.008 file post required
GET /v1/entities/{entity}/customers/{party}/mandates List a customer's SEPA mandates read
POST /v1/entities/{entity}/customers/{party}/mandates Record a customer's SEPA mandate draft required
POST /v1/entities/{entity}/direct-debit-proposals Suggest invoices to collect by direct debit read
POST /v1/entities/{entity}/direct-debit-runs Collect the invoices of a proposal draft required
GET /v1/entities/{entity}/direct-debits List direct debit collections read
PUT /v1/mandates/{mandate_id}/account Change the debtor account of a mandate draft
POST /v1/mandates/{mandate_id}/revoke Revoke a mandate draft
GET /v1/archive/export Download the archive of an entity as a ZIP audit
GET /v1/documents List documents read
POST /v1/documents Create an invoice, bill or credit note draft required
POST /v1/documents/preview Preview a document and its VAT draft
GET /v1/documents/{document_id} Get a document read
PATCH /v1/documents/{document_id} Change a draft document draft
GET /v1/documents/{document_id}/allocations List what settled a document read
GET /v1/documents/{document_id}/dispatches List what was sent of an invoice and how it can be sent read
GET /v1/documents/{document_id}/file Download the original file of a document read
GET /v1/documents/{document_id}/files List the files of a document read
POST /v1/documents/{document_id}/files Attach a scanned or received original to a document draft required
GET /v1/documents/{document_id}/files/{file_id} Download a file of a document read
GET /v1/documents/{document_id}/history Get the history of a document read
POST /v1/documents/{document_id}/mark-sent Record that an invoice or credit note was handed over post required
GET /v1/documents/{document_id}/pdf Download an invoice or credit note as PDF read
POST /v1/documents/{document_id}/reopen Reopen a rejected document draft required
POST /v1/documents/{document_id}/send Send an invoice or credit note by e-mail post required
POST /v1/documents/{document_id}/submit Submit a draft document draft
POST /v1/documents/{document_id}/void Void a draft document draft required
POST /v1/documents/{document_id}/write-off Write off what is open on a customer invoice draft required
POST /v1/documents/{document_id}/write-off/recovery Book money received after a write-off draft required
POST /v1/documents/{document_id}/write-off/vat-correction Correct the VAT a write-off kept draft required
GET /v1/documents/{document_id}/write-offs List the write-offs of an invoice read
GET /v1/entities/{entity}/invoice-content What an invoice must show about the seller and the customer read
GET /v1/entities/{entity}/vat-rate-types List the VAT rate types a document line can choose read
GET /v1/documents/{document_id}/dunning-block Get whether the reminders of an invoice are stopped read
POST /v1/documents/{document_id}/dunning-block Stop the reminders of an invoice post required
DELETE /v1/documents/{document_id}/dunning-block Resume the reminders of an invoice post
GET /v1/entities/{entity}/customers/{party}/activity Get a customer's activity statement: invoices, credit notes and payments read
POST /v1/entities/{entity}/customers/{party}/reminders Make a reminder letter to a customer post required
GET /v1/entities/{entity}/customers/{party}/statement Get a customer's statement of account read
POST /v1/entities/{entity}/customers/{party}/statement/issue Issue a customer's statement: archive its PDF post required
GET /v1/entities/{entity}/reminder-settings Get the fees and default interest of the reminder levels read
PUT /v1/entities/{entity}/reminder-settings Save the fees and default interest of the reminder levels admin
GET /v1/entities/{entity}/reminders List the reminder letters read
GET /v1/entities/{entity}/reminders/proposal List the customers due a reminder letter read
GET /v1/entities/{entity}/vendors/{party}/statement Get a vendor's statement: what we owe, by bill, credit note and payment read
GET /v1/reminders/{notice_id} Get a reminder letter read
POST /v1/reminders/{notice_id}/mark-sent Record that a reminder letter was handed over post required
GET /v1/reminders/{notice_id}/pdf Download a reminder letter read
POST /v1/reminders/{notice_id}/send Send a reminder letter by e-mail post required
POST /v1/reminders/{notice_id}/withdraw Withdraw a reminder letter not handed over post required
POST /v1/documents/einvoice Receive an e-invoice as a draft bill draft required
POST /v1/einvoices/check Check an e-invoice read
GET /v1/invoices/{invoice}/xrechnung Issue a sales invoice as XRechnung read
GET /v1/entities/{entity}/fx/convert Convert an amount at the ECB rate read
GET /v1/entities/{entity}/fx/exposure Get the foreign-currency exposure read
GET /v1/entities/{entity}/fx/exposure/items List the positions behind the exposure read
GET /v1/entities/{entity}/fx/history Get the rate history of a currency pair read
GET /v1/entities/{entity}/fx/matrix Get the cross-rate matrix of a set of currencies read
GET /v1/entities/{entity}/fx/rates List exchange rates against the entity's currency read
GET /v1/entities/{entity}/fx/tax-rates Compare accounting rates with the official VAT rates read
GET /v1/entities/{entity}/expense-policy Get the expense policy read
PUT /v1/entities/{entity}/expense-policy Set the expense policy admin
GET /v1/expense-card-lines List card payments read
POST /v1/expense-card-lines Add card payments admin required
GET /v1/expense-cards List cards read
POST /v1/expense-cards Add a company card admin required
PATCH /v1/expense-cards/{card_id} Change a card admin
POST /v1/expense-cards/{card_id}/statement Read a card statement admin required
GET /v1/expenses List expenses read
POST /v1/expenses Claim an expense without a receipt draft required
GET /v1/expenses-reimbursement Where you are paid back read
PUT /v1/expenses-reimbursement Set where you are paid back draft
POST /v1/expenses/receipts Claim an expense from a receipt's photo draft required
GET /v1/expenses/{expense_id} Get an expense read
PATCH /v1/expenses/{expense_id} Change your draft draft
GET /v1/expenses/{expense_id}/receipt Download an expense's receipt read
POST /v1/expenses/{expense_id}/submit Submit your expense draft
POST /v1/expenses/{expense_id}/withdraw Withdraw your draft draft
GET /v1/exports List the organization's exports audit
POST /v1/exports Export the organization's data audit required
GET /v1/exports/{run_id} Get an export's status audit
GET /v1/exports/{run_id}/download Download the package of an export audit
GET /v1/exports/{run_id}/link Get a link to download the package of an export audit
POST /v1/assets Register a fixed asset draft required
GET /v1/assets/{asset} Get a fixed asset read
GET /v1/assets/{asset}/books List the books of a fixed asset read
POST /v1/assets/{asset}/books Add a fixed asset to a tax book draft required
GET /v1/assets/{asset}/books/{book}/schedule Get an asset's depreciation schedule in one book read
POST /v1/assets/{asset}/dispose Dispose of a fixed asset draft required
GET /v1/assets/{asset}/history Get the history of a fixed asset read
POST /v1/assets/{asset}/impairment Write down a fixed asset (impairment) draft required
POST /v1/assets/{asset}/impairment-reversal Reverse an impairment of a fixed asset draft required
POST /v1/assets/{asset}/partial-retirement Retire a part of a fixed asset draft required
POST /v1/assets/{asset}/revaluation Revalue a fixed asset to fair value draft required
POST /v1/assets/{asset}/reverse-acquisition Reverse the acquisition of a fixed asset post required
POST /v1/assets/{asset}/sale Sell a fixed asset to a customer on an invoice draft required
GET /v1/entities/{entity}/assets List the fixed asset register read
GET /v1/entities/{entity}/book-tax-differences Get book-tax differences read
GET /v1/entities/{entity}/depreciation-books List depreciation books read
POST /v1/entities/{entity}/depreciation-books Create a tax depreciation book admin required
PATCH /v1/entities/{entity}/depreciation-books/{code} Update a tax depreciation book admin
GET /v1/entities/{entity}/leases List leases read
POST /v1/leases Enter a lease draft required
GET /v1/leases/{lease} Get a lease and its schedule read
POST /v1/leases/{lease}/activate Activate a lease draft required
POST /v1/leases/{lease}/changes Change a lease's payments draft required
POST /v1/leases/{lease}/terminate End a lease draft required
POST /v1/periods/{period_id}/leases Post lease entries for a period draft
GET /v1/entities/{entity}/grni Goods received not invoiced on a day read
GET /v1/purchase-orders/{order}/goods-received Received, billed and open GR/IR per order line read
POST /v1/purchase-orders/{order}/grni-write-off Write off goods received that will never be billed post required
POST /v1/purchase-orders/{order}/receipts/preview Show what a receipt would post read
GET /v1/hotel-stays List stays read
POST /v1/hotel-stays Reserve a stay draft required
GET /v1/hotel-stays/{stay_id} Get a stay read
POST /v1/hotel-stays/{stay_id}/cancel Cancel a stay draft
POST /v1/hotel-stays/{stay_id}/check-in Check guests in draft
POST /v1/hotel-stays/{stay_id}/check-out Check guests out and draft the invoice draft
POST /v1/hotel-stays/{stay_id}/invoice Draft a stay's invoice again draft
DELETE /v1/room-rates/{rate_id} Remove a season draft
GET /v1/room-types List room types read
POST /v1/room-types Add a room type draft required
GET /v1/room-types/{product_id} Get a room type read
PATCH /v1/room-types/{product_id} Change a room type draft
GET /v1/room-types/{product_id}/quote Price a stay read
POST /v1/room-types/{product_id}/rates Add a season draft required
POST /v1/entities/{entity}/imports Import customers, vendors, accounts, balances or open items draft required
POST /v1/entities/{entity}/imports/salesforce Import a Salesforce export draft required
GET /v1/entities/{entity}/imports/templates/{type} Download an import template read
GET /v1/ic/links List the intercompany links read
GET /v1/ic/links/{link_id} Get an intercompany link read
POST /v1/ic/links/{link_id}/reject Reject the mirror of an intercompany document post
POST /v1/ic/links/{link_id}/retry Make the counterpart of a link again post
GET /v1/ic/loans List the intercompany loans read
POST /v1/ic/loans Request an intercompany loan draft required
GET /v1/ic/loans/{loan_id} Get an intercompany loan read
POST /v1/ic/loans/{loan_id}/drawdowns Draw down an intercompany loan post required
POST /v1/ic/loans/{loan_id}/interest Accrue the interest of an intercompany loan post required
POST /v1/ic/loans/{loan_id}/repayments Repay an intercompany loan post required
GET /v1/ic/movements List the intercompany movements read
GET /v1/ic/movements/{movement_id} Get an intercompany movement read
GET /v1/ic/reconciliation Reconcile the intercompany balances read
GET /v1/ic/relationships List the intercompany relationships read
POST /v1/ic/relationships Request an intercompany relationship draft required
GET /v1/ic/relationships/{relationship_id} Get an intercompany relationship read
PATCH /v1/ic/relationships/{relationship_id} Change, suspend or resume an intercompany relationship draft
POST /v1/ic/settlements Settle intercompany interest or a group dividend post required
GET /v1/entities/{entity}/stock-valuation Value the stock on a day read
POST /v1/stock-adjustments Adjust stock draft required
GET /v1/stock-counts List stock counts read
POST /v1/stock-counts Open a stock count draft required
GET /v1/stock-counts/{count_id} Get a stock count read
POST /v1/stock-counts/{count_id}/cancel Cancel a stock count draft
PUT /v1/stock-counts/{count_id}/lines Enter counted quantities draft
POST /v1/stock-counts/{count_id}/post Post a stock count draft required
GET /v1/stock-items List stock items read
POST /v1/stock-items Keep a product in stock draft required
GET /v1/stock-items/{product_id} Get a stock item read
PATCH /v1/stock-items/{product_id} Change a stock item's accounts draft
GET /v1/stock-postings List stock postings read
GET /v1/stock-postings/{posting_id} Get a stock posting read
POST /v1/stock-transfers Move stock between warehouses draft required
GET /v1/warehouses List warehouses read
POST /v1/warehouses Create a warehouse draft required
PATCH /v1/warehouses/{warehouse_id} Change a warehouse draft
GET /v1/journal-entries List Entries read
POST /v1/journal-entries Create a journal entry draft required
GET /v1/journal-entries/{entry_id} Get a journal entry read
PUT /v1/journal-entries/{entry_id} Change a draft entry draft required
DELETE /v1/journal-entries/{entry_id} Delete a draft entry draft
POST /v1/journal-entries/{entry_id}/reverse Reverse a posted entry post required
POST /v1/journal-entries/{entry_id}/submit Submit a draft entry draft
GET /health Check that the service is running
GET /v1/me/notification-settings Get which notifications come by e-mail read
PUT /v1/me/notification-settings Choose which notifications come by e-mail read
GET /v1/me/notifications List your notifications read
POST /v1/me/notifications/read Mark notifications read read
GET /v1/api-keys List API keys admin
POST /v1/api-keys Issue an API key admin
GET /v1/api-keys/{key_id} Get an API key admin
DELETE /v1/api-keys/{key_id} Revoke an API key admin
GET /v1/connectors/authorization Check an app's request to connect read
POST /v1/connectors/authorization Allow or refuse an app read
GET /v1/me Me
PATCH /v1/me Update my preferences
GET /v1/organization Get Organization read
PATCH /v1/organization Rename the organization admin
GET /v1/entities/{entity}/credit-exposure Get the credit exposure of customers with a credit limit read
GET /v1/entities/{entity}/parties List customers and vendors read
POST /v1/entities/{entity}/parties Create a customer or vendor draft required
GET /v1/entities/{entity}/parties/{party} Get a customer or vendor card read
PATCH /v1/entities/{entity}/parties/{party} Change a customer or vendor draft
POST /v1/entities/{entity}/parties/{party}/activate Activate a draft customer or vendor draft
POST /v1/entities/{entity}/parties/{party}/merge Merge a duplicate customer draft
POST /v1/entities/{entity}/parties/{party}/status Block a customer or vendor, set it inactive, or make it active again draft
POST /v1/entities/{entity}/parties/{party}/vat-check Check a customer's or vendor's VAT number in its public register draft
POST /v1/vat-registers/check Check a VAT number against its public register draft
POST /v1/applications Apply an amount on account or a credit note to open documents draft required
GET /v1/entities/{entity}/open-credits List amounts on account and open credit notes read
POST /v1/entities/{entity}/payment-proposals Suggest vendor payments read
POST /v1/entities/{entity}/payment-runs Create the payments of a proposal draft required
POST /v1/payments Record a payment or receipt draft required
GET /v1/payments/{payment_id} Get a payment read
POST /v1/payments/{payment_id}/refund Pay back an amount on account draft required
POST /v1/payments/{payment_id}/reverse Reverse a payment or receipt draft required
GET /v1/plan-versions/{version_id} Get a plan version with its lines read
POST /v1/plan-versions/{version_id}/approve Approve a plan version approve
GET /v1/plan-versions/{version_id}/comparison Compare a plan version with what was posted read
PUT /v1/plan-versions/{version_id}/lines Set the lines of a draft plan version draft
POST /v1/plan-versions/{version_id}/send-back Send a submitted plan version back to draft draft
POST /v1/plan-versions/{version_id}/submit Submit a plan version for approval draft
GET /v1/plans List plans read
POST /v1/plans Create a plan draft required
GET /v1/plans/{plan_id} Get a plan read
PATCH /v1/plans/{plan_id} Rename a plan draft
POST /v1/plans/{plan_id}/roll Roll a forecast forward from actuals draft required
POST /v1/plans/{plan_id}/versions Start a new version of a plan draft required
GET /v1/platform/audit List the operator's audit record platform:read
POST /v1/platform/auth/google Sign in to the operator portal with Google
POST /v1/platform/auth/logout Sign out of the operator portal platform:read
GET /v1/platform/charts List chart templates platform:read
GET /v1/platform/health Service health: SLOs, error budget, latency, uptime and deploy platform:read
GET /v1/platform/me Who the platform credential is platform:read
GET /v1/platform/models Show the models behind the built-in agents platform:read
PUT /v1/platform/models Choose the models behind the built-in agents platform:provision
POST /v1/platform/models/check Check that a model answers platform:provision
GET /v1/platform/organizations List organizations platform:read
POST /v1/platform/organizations Provision an organization platform:provision required
GET /v1/platform/organizations/{org_id} Get an organization platform:read
POST /v1/platform/organizations/{org_id}/admins Invite or show again an organization's first administrator platform:provision
POST /v1/platform/organizations/{org_id}/delete Delete an organization platform:provision
GET /v1/platform/organizations/{org_id}/exports List an organization's exports platform:read
POST /v1/platform/organizations/{org_id}/exports Export an organization's data platform:provision required
GET /v1/platform/organizations/{org_id}/exports/{run_id} Get an organization's export platform:read
GET /v1/platform/organizations/{org_id}/exports/{run_id}/download Download an organization's export platform:provision
GET /v1/platform/organizations/{org_id}/exports/{run_id}/link Get a link to download an organization's export platform:provision
POST /v1/platform/organizations/{org_id}/mark-demo Mark an organization as a demo platform:provision
POST /v1/platform/organizations/{org_id}/passkey-reset Reset a person's passkeys platform:provision
POST /v1/platform/organizations/{org_id}/reactivate Reactivate an organization platform:provision
POST /v1/platform/organizations/{org_id}/suspend Suspend an organization platform:provision
POST /v1/platform/organizations/{org_id}/undo-delete Undo the deletion of an organization platform:provision
GET /v1/entities/{entity}/customers/{party}/price-lists List a customer's price lists read
PUT /v1/entities/{entity}/customers/{party}/price-lists/{currency} Give a customer a price list draft
DELETE /v1/entities/{entity}/customers/{party}/price-lists/{currency} Take a customer's price list away draft
GET /v1/price-lists List price lists read
POST /v1/price-lists Create a price list draft required
GET /v1/price-lists/{price_list_id} Get a price list read
PATCH /v1/price-lists/{price_list_id} Change a price list draft
POST /v1/price-lists/{price_list_id}/prices Record a price on a price list draft required
GET /v1/products List products read
POST /v1/products Create a product draft required
GET /v1/products/{product_id} Get a product read
PATCH /v1/products/{product_id} Change a product draft
GET /v1/products/{product_id}/price Get the price in force read
POST /v1/products/{product_id}/prices Record a list price draft required
POST /v1/products/{product_id}/ssps Record a standalone selling price draft required
GET /v1/documents/{document_id}/match Get Document Match read
POST /v1/documents/{document_id}/match Match Document draft
POST /v1/documents/{document_id}/match/approve Approve Document Variance approve
GET /v1/entities/{entity}/purchase-orders List Purchase Orders read
POST /v1/entities/{entity}/purchase-orders Create Purchase Order draft required
GET /v1/entities/{entity}/purchase-settings Get Purchase Settings read
PUT /v1/entities/{entity}/purchase-settings Set Purchase Settings admin
GET /v1/purchase-orders/{order} Get Purchase Order read
PATCH /v1/purchase-orders/{order} Update Purchase Order draft
POST /v1/purchase-orders/{order}/cancel Cancel Purchase Order draft required
POST /v1/purchase-orders/{order}/close Close Purchase Order draft required
GET /v1/purchase-orders/{order}/history Purchase Order History read
POST /v1/purchase-orders/{order}/receipts Receive Purchase Order draft required
POST /v1/purchase-orders/{order}/submit Submit Purchase Order draft
GET /v1/recurring-invoices List recurring invoices read
POST /v1/recurring-invoices Create a recurring invoice draft required
POST /v1/recurring-invoices/run Make the recurring invoices that are due draft required
GET /v1/recurring-invoices/{template_id} Get a recurring invoice read
PATCH /v1/recurring-invoices/{template_id} Change a recurring invoice draft
POST /v1/recurring-invoices/{template_id}/activate Activate a recurring invoice draft
POST /v1/recurring-invoices/{template_id}/pause Pause a recurring invoice draft
GET /v1/recurring-invoices/{template_id}/runs List the invoices a recurring invoice made read
GET /v1/recurring-journals List recurring journals read
POST /v1/recurring-journals Create a recurring journal draft required
POST /v1/recurring-journals/run Post the recurring journals that are due draft required
GET /v1/recurring-journals/{recurring_journal_id} Get a recurring journal read
PATCH /v1/recurring-journals/{recurring_journal_id} Change a recurring journal draft
POST /v1/recurring-journals/{recurring_journal_id}/activate Activate a recurring journal draft
POST /v1/recurring-journals/{recurring_journal_id}/pause Pause a recurring journal draft
GET /v1/recurring-journals/{recurring_journal_id}/runs List the entries a recurring journal made read
GET /v1/entities/{entity}/overview Entity Overview read
GET /v1/entities/{entity}/reports/aging Aging of receivables or payables read
GET /v1/entities/{entity}/reports/balance-sheet Balance Sheet read
GET /v1/entities/{entity}/reports/cash-flow Cash Flow read
GET /v1/entities/{entity}/reports/general-ledger General Ledger read
GET /v1/entities/{entity}/reports/period-profit-and-loss Period Profit And Loss read
GET /v1/entities/{entity}/reports/period-trial-balance Period Trial Balance read
GET /v1/entities/{entity}/reports/profit-and-loss Profit And Loss read
GET /v1/entities/{entity}/reports/trial-balance Trial Balance read
GET /v1/entities/{entity}/reports/vat VAT report from the ledger read
POST /v1/periods/{period_id}/revenue-recognition Run the revenue recognition of a period draft
GET /v1/periods/{period_id}/revenue-recognition/preview Preview the revenue recognition of a period read
GET /v1/revenue-contracts List revenue contracts read
POST /v1/revenue-contracts Create a revenue contract draft required
GET /v1/revenue-contracts/{contract_id} Get a revenue contract read
POST /v1/revenue-contracts/{contract_id}/activate Activate a revenue contract draft
POST /v1/revenue-contracts/{contract_id}/cancel Cancel a revenue contract draft
GET /v1/revenue-contracts/{contract_id}/changes List a revenue contract's changes read
POST /v1/revenue-contracts/{contract_id}/changes Ask for an active revenue contract to end early or be modified draft
POST /v1/revenue-contracts/{contract_id}/changes/preview Preview ending a revenue contract early or modifying it read
GET /v1/revenue-contracts/{contract_id}/schedule Get a revenue contract's recognition schedule read
POST /v1/revenue-obligations/{obligation_id}/satisfy Record that a point-in-time obligation is satisfied draft
GET /v1/roles List the roles admin
POST /v1/roles Make an own role admin
GET /v1/roles/areas List the areas of the app read
GET /v1/roles/me See what I can open and do read
GET /v1/roles/people List who has which role admin
PUT /v1/roles/people/{user_id} Give a person a role admin
GET /v1/roles/people/{user_id}/preview See what a person can open and do admin
GET /v1/roles/suggestions List unused rights admin
POST /v1/roles/suggestions/{suggestion_id}/apply Take away an unused right admin
PATCH /v1/roles/{role_id} Change an own role admin
DELETE /v1/roles/{role_id} Remove an own role admin
GET /v1/entities/{entity}/rolling-forecast Read the rolling forecast read
GET /v1/entities/{entity}/quotes List Quotes read
POST /v1/entities/{entity}/quotes Create Quote draft required
GET /v1/entities/{entity}/sales-orders List Sales Orders read
POST /v1/entities/{entity}/sales-orders Create Sales Order draft required
GET /v1/public/quotes/{token} View Quote Online
POST /v1/public/quotes/{token}/accept Accept Quote Online
POST /v1/public/quotes/{token}/decline Decline Quote Online
GET /v1/public/quotes/{token}/pdf Quote Online Pdf
GET /v1/sales-documents/{document} Get Sales Document read
PATCH /v1/sales-documents/{document} Update Sales Document draft
POST /v1/sales-documents/{document}/accept Accept Quote draft required
POST /v1/sales-documents/{document}/cancel Cancel Sales Document draft
POST /v1/sales-documents/{document}/close Close Sales Order draft
POST /v1/sales-documents/{document}/confirm Confirm Sales Order draft
POST /v1/sales-documents/{document}/decline Decline Quote draft
GET /v1/sales-documents/{document}/history Sales Document History read
POST /v1/sales-documents/{document}/invoice Invoice Sales Order draft required
POST /v1/sales-documents/{document}/links Create Quote Link post
POST /v1/sales-documents/{document}/links/{quote_link}/revoke Revoke Quote Link post
POST /v1/sales-documents/{document}/mark-sent Mark Sales Document Sent post required
GET /v1/sales-documents/{document}/pdf Download a quote or order confirmation read
GET /v1/sales-documents/{document}/revisions/{revision}/pdf Download a version of a quote as the customer got it read
POST /v1/sales-documents/{document}/send Send Sales Document post required
GET /v1/entities/{entity}/customers/{party}/sales-tax Get a customer's tax area and exemption read
PUT /v1/entities/{entity}/customers/{party}/sales-tax Set a customer's tax area and exemption draft
GET /v1/entities/{entity}/sales-tax Get the sales tax setup read
POST /v1/entities/{entity}/sales-tax/areas Add a tax area admin
PATCH /v1/entities/{entity}/sales-tax/areas/{area} Change a tax area admin
PUT /v1/entities/{entity}/sales-tax/category-rules Set how much of a product category a state taxes admin
POST /v1/entities/{entity}/sales-tax/jurisdictions Add a county, city or district admin
POST /v1/entities/{entity}/sales-tax/jurisdictions/{jurisdiction}/rates Set a jurisdiction's rate from a day admin
GET /v1/entities/{entity}/sales-tax/periods List the sales tax return periods of a year read
POST /v1/entities/{entity}/sales-tax/registrations Register the company in a state admin required
PATCH /v1/entities/{entity}/sales-tax/registrations/{state} Change a state registration admin
POST /v1/entities/{entity}/sales-tax/returns Record a sales tax return as filed draft required
GET /v1/entities/{entity}/sales-tax/returns/{state}/{period} Get a state's sales tax return read
GET /v1/products/{product_id}/sales-tax Get a product's sales tax category read
PUT /v1/products/{product_id}/sales-tax Set a product's sales tax category admin
POST /v1/sales-tax-returns/{sales_tax_return_id}/approve Approve a sales tax filing draft required
GET /v1/sales-tax-returns/{sales_tax_return_id}/payment-candidates List the entries that may have paid a sales tax return read
POST /v1/sales-tax-returns/{sales_tax_return_id}/payments Link the entry that paid a sales tax return draft required
POST /v1/sales-tax-returns/{sales_tax_return_id}/payments/{sales_tax_payment_id}/unlink Unlink a payment from a sales tax return draft required
POST /v1/sales-tax-returns/{sales_tax_return_id}/withdraw Withdraw a sales tax filing draft required
GET /v1/entities/{entity}/saved-reports List saved reports read
POST /v1/entities/{entity}/saved-reports Save a report read
POST /v1/entities/{entity}/saved-reports/run Run a report read
GET /v1/saved-report-sources List what a report can read read
GET /v1/saved-reports/{report_id} Read a saved report read
PATCH /v1/saved-reports/{report_id} Change a saved report read
DELETE /v1/saved-reports/{report_id} Delete a saved report read
GET /v1/saved-reports/{report_id}/csv Download a saved report read
PUT /v1/saved-reports/{report_id}/pin Pin to Home read
DELETE /v1/saved-reports/{report_id}/pin Unpin from Home read
GET /v1/saved-reports/{report_id}/result Run a saved report read
POST /v1/saved-reports/{report_id}/send E-mail a report now read
GET /v1/search Find records by number or name read
GET /v1/settings/controls Get the controls mode read
PUT /v1/settings/controls Set the controls mode admin
GET /v1/settings/data-sources Get the reference-data sources admin
GET /v1/charts List chart templates read
GET /v1/entities List Entities read
POST /v1/entities Create an entity admin required
GET /v1/entities/{entity} Get Entity read
PATCH /v1/entities/{entity} Update Entity admin
GET /v1/entities/{entity}/accounts List Accounts read
POST /v1/entities/{entity}/accounts Add an account admin
PATCH /v1/entities/{entity}/accounts/{code} Change an account admin
GET /v1/entities/{entity}/brand Read a company's brand read
PATCH /v1/entities/{entity}/brand Change a company's colours admin
GET /v1/entities/{entity}/brand/logo Download a company's logo read
POST /v1/entities/{entity}/brand/logo Upload a company's logo admin
DELETE /v1/entities/{entity}/brand/logo Remove a company's logo admin
GET /v1/entities/{entity}/fiscal-years List Fiscal Years read
POST /v1/entities/{entity}/fiscal-years Open a fiscal year admin
GET /v1/entities/{entity}/periods List Periods read
POST /v1/entities/{entity}/role-accounts Add Role Accounts admin required
GET /v1/industries List the industries a company can choose read
GET /v1/setup Tell whether the organization waits for its setup read
POST /v1/setup Set up the organization: Production, then Test admin
POST /v1/setup/companies Add a further company from the setup wizard's answers admin required
GET /v1/setup/options List what the setup wizard offers per country read
GET /v1/shopify Get Shopify admin
POST /v1/shopify/authorize Start connecting a Shopify shop on its consent page admin
POST /v1/shopify/connections Connect a Shopify shop admin
POST /v1/shopify/connections/consent Connect a Shopify shop with its consent page's answer admin
DELETE /v1/shopify/connections/{shopify_connection_id} Disconnect Shopify admin
GET /v1/shopify/connections/{shopify_connection_id}/orders List the shop's orders admin
GET /v1/shopify/connections/{shopify_connection_id}/payouts List the shop's payouts admin
GET /v1/shopify/connections/{shopify_connection_id}/products List the shop's products admin
GET /v1/shopify/connections/{shopify_connection_id}/suppliers List the shop's vendors admin
PUT /v1/shopify/connections/{shopify_connection_id}/suppliers Set who ships a shop vendor's goods admin
POST /v1/shopify/connections/{shopify_connection_id}/sync Read the shop now admin
GET /v1/subscriptions List subscriptions read
POST /v1/subscriptions Create a subscription draft required
GET /v1/subscriptions/metrics Get MRR, ARR and churn read
POST /v1/subscriptions/run Bill the subscription periods that are due draft required
GET /v1/subscriptions/{subscription_id} Get a subscription read
POST /v1/subscriptions/{subscription_id}/activate Ask for a subscription's terms to be approved draft
GET /v1/subscriptions/{subscription_id}/amendments List a subscription's amendments read
POST /v1/subscriptions/{subscription_id}/amendments Ask for an amendment of an active subscription draft
POST /v1/subscriptions/{subscription_id}/amendments/preview Preview an amendment of a subscription read
POST /v1/subscriptions/{subscription_id}/cancel Cancel a subscription draft
GET /v1/subscriptions/{subscription_id}/invoices List a subscription's billed periods read
GET /v1/support/cases List support cases read
POST /v1/support/cases Open a support case draft required
GET /v1/support/cases/{case_id} Get a case read
PATCH /v1/support/cases/{case_id} Triage a case draft
POST /v1/support/cases/{case_id}/notes Add an internal note draft
POST /v1/support/cases/{case_id}/replies Write a reply draft required
PATCH /v1/support/cases/{case_id}/replies/{message_id} Change a draft reply draft
POST /v1/support/cases/{case_id}/replies/{message_id}/discard Discard a draft reply draft
POST /v1/support/cases/{case_id}/replies/{message_id}/send Send a draft reply draft required
POST /v1/support/cases/{case_id}/status Close, reopen or set a case to wait draft
POST /v1/support/inbound Hand over an e-mail to a queue's inbox draft required
GET /v1/support/queues List support queues read
POST /v1/support/queues Add a support queue admin required
PATCH /v1/support/queues/{queue_id} Change a support queue admin
GET /v1/entities/{entity}/bank-accounts List registered bank accounts read
PUT /v1/entities/{entity}/bank-accounts/{account} Register the IBAN of a bank account admin
GET /v1/invoices/{invoice}/qr-bill Get the QR-bill of a sales invoice read
GET /v1/payment-exports List payment files read
POST /v1/payment-exports Release payments as a pain.001 file post required
GET /v1/payment-exports/{export_id} Get a payment file read
GET /v1/payment-exports/{export_id}/file Download a payment file read
GET /v1/payments List payments read
POST /v1/entities/{entity}/sample-data Add sample data to a test organization admin required
GET /v1/test-copies List the test copies of the organization admin
POST /v1/test-copies Make a test copy of the organization admin required
DELETE /v1/test-copies/{copy_id} Remove a test copy admin
POST /v1/test-copies/{copy_id}/refresh Refresh a test copy from the organization admin required
PUT /v1/test-copies/{copy_id}/schedule Set when a test copy is refreshed by itself admin
GET /v1/auth/config Get the sign-in settings
POST /v1/auth/google Sign in with Google
POST /v1/auth/logout Sign out of the web UI
GET /v1/auth/organizations List my organizations
POST /v1/auth/passkey Sign in with a passkey
POST /v1/auth/password Sign in with a password
POST /v1/auth/step-up Touch your passkey again
POST /v1/auth/step-up/options Ask for a fresh passkey touch
POST /v1/auth/switch Switch organization
GET /v1/me/passkeys List my passkeys
POST /v1/me/passkeys Add a passkey
POST /v1/me/passkeys/options Start adding a passkey
DELETE /v1/me/passkeys/{passkey_id} Remove a passkey
GET /v1/people List the people to choose from read
GET /v1/users List users admin
POST /v1/users Invite a user admin
PATCH /v1/users/{user_id} Update a user admin
POST /v1/users/{user_id}/passkeys/reset Reset a user's passkeys admin
POST /v1/users/{user_id}/password-email E-mail a user a link to set their password admin
GET /v1/entities/{entity}/vat-periods List the return periods of a year read
GET /v1/entities/{entity}/vat-settings Get the VAT settings of an entity read
PUT /v1/entities/{entity}/vat-settings Save the VAT settings of an entity admin
GET /v1/vat-returns List VAT returns read
POST /v1/vat-returns Compute a draft VAT return draft required
GET /v1/vat-returns/{return_id} Get a VAT return read
POST /v1/vat-returns/{return_id}/amend Open a correction of a final VAT return approve required
GET /v1/vat-returns/{return_id}/boxes/{box}/lines List the ledger lines behind a box read
POST /v1/vat-returns/{return_id}/discard Discard a draft VAT return draft required
GET /v1/vat-returns/{return_id}/file Return File read
POST /v1/vat-returns/{return_id}/finalize Finalise a VAT return draft required
GET /v1/vat-returns/{return_id}/payment-candidates List the entries that may have paid a VAT return read
POST /v1/vat-returns/{return_id}/payments Link the entry that paid a VAT return draft required
POST /v1/vat-returns/{return_id}/payments/{payment_id}/unlink Unlink a payment from a VAT return draft required
POST /v1/vat-returns/{return_id}/recompute Recompute a draft VAT return draft required
POST /v1/vat-returns/{return_id}/submitted Record that a VAT return was submitted draft required
POST /v1/vat-returns/{return_id}/submitted/withdraw Withdraw the recorded submission of a VAT return draft required
POST /v1/webhook-deliveries/{delivery_id}/send-again Send a delivery again admin
GET /v1/webhooks List webhooks admin
POST /v1/webhooks Add a webhook admin
GET /v1/webhooks/event-types List the events webhooks send read
GET /v1/webhooks/{endpoint_id} Get a webhook admin
PATCH /v1/webhooks/{endpoint_id} Change a webhook admin
DELETE /v1/webhooks/{endpoint_id} Delete a webhook admin
GET /v1/webhooks/{endpoint_id}/deliveries List a webhook's deliveries admin
POST /v1/webhooks/{endpoint_id}/rotate-secret Give a webhook a new secret admin
POST /v1/webhooks/{endpoint_id}/test Send a test event admin
GET /v1/entities/{entity}/withholding-tax Get the withholding tax kept back from vendors in a period read
GET /v1/entities/{entity}/withholding-tax/codes List the withholding tax codes for vendors read
GET /v1/entities/{entity}/appropriations List the appropriations of an entity read
POST /v1/entities/{entity}/appropriations Appropriate the result of a closed year draft required
POST /v1/entities/{entity}/appropriations/{appropriation_id}/reverse Reverse an appropriation draft required
GET /v1/entities/{entity}/fiscal-years/{year}/close Get the year-end close of a year read
POST /v1/entities/{entity}/fiscal-years/{year}/close Propose the year-end close draft required
GET /v1/entities/{entity}/fiscal-years/{year}/close-preview Preview the year-end close read
POST /v1/entities/{entity}/fiscal-years/{year}/close/cancel Cancel a proposed year-end close draft
GET /v1/entities/{entity}/fiscal-years/{year}/opening-balances Get the opening balances of a fiscal year read
POST /v1/entities/{entity}/fiscal-years/{year}/reopen-close Reopen a closed fiscal year approve
POST /v1/entities/{entity}/year-close/catch-up Close the years booked before the books were closed draft required