Jump to Content

Home Documentation Recipes API Reference Changelog

Platform Overview Demo Contact Imprint Log In

API Reference

Platform Overview Demo Contact Imprint Log In

Home Documentation Recipes API Reference Changelog

Getting started

OpenAPI Specification (OAS)

Customer API

preview
- Anonymize customerpost
- Deprecated: Anonymize customerpost
Customers
Configurations
Customers (deprecated)
- Query customers (unpaged)get
- Query customer addresses (unpaged)get
Debtors (deprecated)
Debtors Addresses (deprecated)

Billing API

Billing Groups
Orders
Plans and Options
Contracts
Usages
Billable Items
- Query billable itemsget
- Query billable itemsget
Invoices
- Reissue documentpost
Price Adaptations
Orders (deprecated)
Contracts (deprecated)

Usage API

Rated usages
Rated usage aggregations

Data Access API

Invoices
- Query invoicesget
- Retrieve invoiceget

Invoice API

Documents
Document Labels
Aggregation Configurations
Document Number Configurations
Dunning Configurations
- Retrieve dunning configurationget
- Create dunning configurationpost
Dunning Status Aggregations
- Retrieve dunning status aggregationget
- Lists dunning status aggregation documentsget
Operating Site Configurations
OPOS Cases
OPOS Case Clearing Runs
SAF-T Configurations
Tenant Configurations
- Get polish credit memo flagget
- Set polish credit memo flagpost

Document Output API

Translations
Translation Configurations
- Get All Translationsget
- Get Configured Localesget
Document Creation Configurations
- Retrieve configurationget
- Update configurationput
Files

Tax API

Tax Calculation
- Calculate tax for a documentpost
Tax Rules Configuration
Tax Provider Configuration
Tax Service Tenant Configuration
- Get the tax service configuration for a tenant.get
- Create or update the tax service configuration for a tenant.post
Tax Service Billing Group Configuration
- Get the tax service configuration for a billing group.get
- Create or update the tax service configuration for a billing group.post

Payment API

Customer Payment Accounts
Merchant Payment Accounts
Merchant Payment Gateways
Payment Providers
Payment Categories
Payment Transactions
Payment Categorization Rules
Payment Intents
Payment Intent Tasks
Settlements

Payment Assignment API

Assignments
Assignment Configuration

Bookkeeping API

preview
Booking Accounts
Booking Entries
- Query booking entriesget
Clearing

Booking Engine API

preview

Currency Converter API

Currency Converter

Report API

Report Files

Notification API

Notifications
Notification Configuration

Basware Adapter API

Basware country configuration
Basware forward route configuration
Basware credential configuration
Basware forward route resolver
- Resolve Routeget
Basware workflows
Basware enums
- Get used enumerationsget

Billing Preparation API

Billing Group Configuration
- Get billing preparation billing group configget
- Update billing preparation billing group configpost

Powered by

Retrieve plan

get https://api.nbx-stage-westeurope.nitrobox.io/v2/plans/{planId}

Get a specific plan by it´s id.

Language

Credentials

OAuth2

Bearer