API keys and Scopes

⚠️
Existing API keys prior to 23 March 2026
Existing API keys remain unchanged. The roles previously assigned have been automatically converted into corresponding scopes.

General Information

An API key needs at least one Scope in order to be saved when it is created or edited.
An API key can have multiple Scopes, each Scope containing different access rights.
If you would like to find out which scope is required to access a specific endpoint, you can find this information in our API Reference documentation for each endpoint

Description of Scopes

Scope	Description
access-management-read	Read access to user and role management, including permissions and access control configurations.
access-management-write	Write access to manage users, roles, and access control settings.
accounting-clearing-read	Read access to accounting clearing data, including booking entries and clearing runs.
accounting-clearing-write	Write access to create and manage clearing entries and clearing runs in bookkeeping.
accounting-management-read	Read access to booking accounts, booking entries, booking periods, debtors, and accounting reports.
accounting-management-write	Write access to create and manage booking accounts, booking entries, booking periods, accounting closings and accounting settings.
accounts-receivable-management-read	Read access to OPOS (open items) cases, decisions, and receivables data.
accounts-receivable-management-write	Write access to manage OPOS cases, add decisions, and process accounts receivable.
beta-preview	Grants access to beta and preview features that are not yet generally available.
contract-order-management-read	Read access to contracts, orders, line items, billable items, and related billing data.
contract-order-management-write	Write access to create and manage contracts, orders, line items, and billing runs.
custom-payment-provider-write	Write access to configure and manage custom payment providers and their settings.
customer-management-read	Read access to customers, sellers, debtors, tax classifications, payment accounts and and configurations.
customer-management-write	Write access to create and manage customers, sellers, debtors, tax classifications, payment accounts and and configurations.
document-management-read	Read access to finalized documents such as invoices, credit memos, and deposit invoices.
document-management-write	Write access to create, reissue, and correct documents such as invoices and credit memos.
draft-document-management-read	Read access to draft documents that have not yet been finalized or issued.
draft-document-management-write	Write access to create and manage draft documents prior to finalization.
product-management-read	Read access to plans, options, price adaptations, and product catalog data.
product-management-write	Write access to create and manage plans, options, and price adaptations.
report-management-read	Read access to generated reports and report files.
report-management-write	Write access to manage and delete reports and reporting periods.
tax-management-read	Read access to tax rules, tax classifications, tax exemptions, tax provider configurations, and tax calculations.
tax-management-write	Write access to create and manage tax rules, classifications, tax exemptions, and provider configurations.
tenant-management-read	Read access to all configurations as billing, payment, accounting, reporting and global.
tenant-management-write	Write access to manage configurations as billing, payment, accounting, reporting and global.