Introduction

Invunion exposes a REST API over HTTPS. Requests and responses are JSON, at https://api.invunion.com.

Authenticate with a tenant API key from Settings (uk_live_…) in the Authorization: Bearer header. The key selects the tenant. Authentication lists scopes and auth errors.

This reference

One page per REST operation, grouped by resource in the sidebar. The tables, examples, and Markdown file are generated from the same spec, so the sample request matches the parameter list. Webhook destinations and deliveries are documented here but remain console / Firebase only for now — tenant API keys cannot call those routes.

• Method and path at the top.
• Path, query, and body parameters, with required fields marked, nested objects indented, allowed values for pick lists, and an example on each parameter.
• Error codes returned by that operation.
• Request examples in curl, Python, Ruby, JavaScript, Go, and Node, plus a success payload.
• A Markdown version of the same page.

Identify records by code

Counterparties, payment methods, transactions, and invoices are addressed by business code. Counterparties use account_code (CPT-042). Payment methods use code (PM-001). Transactions use transaction_code (TX-8891). Invoices use invoice_number (INV-2026-0042). Account code, payment method code, transaction code, and invoice number are unique in the tenant. Matches, ingest jobs, and webhook destinations have no business code and are addressed by UUID. The match UUID is not shown in the product: take it from List matches, Create match, Get invoice, Get transaction, or a match webhook. The Matches overview lists which call to use for each change. The Webhooks overview lists every event you can subscribe to and the JSON posted to your URL.