Jump to Content
Home
Documentation
Recipes
API Reference
Changelog
v1
v2-preview
v2
Platform Overview
Demo
Contact
Imprint
Log In
API Reference
Search
Platform Overview
Demo
Contact
Imprint
Log In
v2 - Production Environment
Home
Documentation
Recipes
API Reference
Changelog
Retrieve usage
All
Pages
Start typing to search…
JUMP TO
API Introduction
Getting started with the Nitrobox API
Authentication and authorization
Error codes and messages
Object relationship model
Retrieve documents from Nitrobox
Query data using RSQL
Rate Limiting
OpenAPI Specification (OAS)
API Lifecycle Management
API Migration Guide
Notifications/Webhooks
Customer and Address Notifications
Order Notifications
Contract Notifications
Payment Notifications
OPOS Decision Notifications
Document Notifications
Dunning Notifications
Report Notifications
Further Notifications
E-Invoicing Notification
Customer API
Customers
Create customer
post
Query customers
get
Retrieve customer
get
Update customer
put
Create address
post
Query customer addresses
get
Retrieve address
get
Update address
put
Update customer dunning block
put
Sellers
Query seller operating sites
get
Create a new seller operating site
post
Retrieve an existing seller operating site
get
Update an existing seller operating site
put
Query sellers
get
Create a new seller
post
Retrieve an existing seller
get
Update an existing seller
put
Tax Classifications
Query tax classifications
get
Create tax classification
post
Update tax classification
put
Configurations
Check validation of all addresses
post
Get all address validation configs
get
Create or update address validation config
post
Get address validation config
get
Delete address validation config
del
Billing API
Orders
Retrieve billable item
get
Create order
post
Cancel orders
post
Query orders
get
Add attachment
post
Retrieve attachment
get
Delete attachment
del
Retrieve order
get
Update order
patch
Cancel order
post
Prepare document creation for certain items
post
Retry failed billable items
post
Query agreed order deposits
get
Add multiple order agreed deposits
post
Update an agreed deposit that is assigned to an order
put
Delete an agreed deposit that is assigned to an order
del
Add allowances
post
Cancel allowances
post
Update allowances
put
Query billable items
get
Query line items
get
Add line item
post
Cancel line items
post
Retrieve line item
get
Edit line item
put
Query agreed deposits of line item
get
Add agreed deposit to line item
post
Update agreed deposit of line item
put
Delete agreed deposit of line item
del
Prepare document creation for entire order
post
Billing Groups
Get a paged result of all billing groups
get
Create billing group
post
Retrieve billing group
get
Update billing group
put
Delete billing group
del
Create business segment
post
Retrieve business segment
get
Update business segment
put
Delete business segment
del
Set as default
post
Update splitting config
put
Query business segments
get
Plans and Options
Get a page of all plan options
get
Create option
post
Retrieve option
get
Update option
put
Delete option
del
Create plan
post
Query plans
get
Add options to a phase of a plan
post
Retrieve plan
get
Update plan
put
Delete plan
del
Contracts
Retrieve billable item
get
Start billing run
post
Create contract
post
Cancel contracts
post
Terminate contracts
post
Query attachments
get
Extraordinary terminations.
post
Query contracts
get
Activate contract
post
Enable additional options for a contract.
post
Retry failed billable items
post
Terminate a contract
post
Extraordinary termination
post
Termination adaption
post
Query allowances
get
Create allowance
post
Retrieve allowance
get
Correct a billable item
post
Update allowance
put
Delete allowance
del
Retry recalculation
post
Query line items
get
Add line item
post
Cancel line items
post
Retrieve line item
get
Edit line item
put
Set items on hold
post
Prepare document creation for certain items
post
query related contracts
get
add related contracts to contract
post
remove related contracts from contract
post
Retrieve contract
get
Update contract
patch
Query billable items
get
Query attachments
get
Add attachment
post
Retrieve attachment
get
Delete attachment
del
Set items on hold
post
Cancel a billable item
post
Usages
Create usage
post
Delete usages
del
Cancel usages
post
Query usages
get
Retrieve usage
get
Invoices
Reissue document
post
Billable Items
Query billable items
get
Query billable items
get
Price Adaptations
Query price adaptation
get
Create price adaptation
post
Retrieve price adaptation
get
Delete price adaptation
del
Query price adaptation values
get
Create price adaptation value
post
Retrieve price adaptations value
get
Update price adaptations value
put
Delete price adaptations value
del
Customers
Retrieve all customer configs for the tenant
get
Retrieve customer config for a specific customer
get
Update customer config for a specific customer
put
Contracts (deprecated)
Create credit billable item
post
Usage API
Rated usages
Query rated usages
get
Create rated usage
post
Retrieve rated usage
get
Cancel rated usage
post
Retry or reactivate rated usage
post
Rated usage aggregations
Query rated usage aggregations
get
Retrieve rated usage aggregation
get
Close rated usage aggregation
post
Billing Group
Get billing group by ident
get
Update billing group
put
Data Access API
Invoices
Query invoices
get
Retrieve invoice
get
Invoice API
Documents
Query documents
get
Create credit memo
post
Retrieve credit memo
get
Create deposit invoice correction
post
Retrieve deposit invoice correction
get
Create deposit invoice
post
Retrieve deposit invoice
get
Create invoice
post
Retrieve invoice
get
Retrieve document processing status by requestId
get
Create self billing invoice correction
post
Retrieve self billing invoice correction
get
Create self billing invoice
post
Retrieve self billing invoice
get
Retrieve document
get
Retrieve document aggregations
get
Document Labels
Query Labels
get
Add Label
post
Remove Label
post
Aggregation Configurations
Query Aggregation
get
Create Aggregation
post
Retrieve Aggregation
get
Update Aggregation
put
Delete Aggregation
del
Document Number Configurations
Query counters
get
Create counter
post
Update counter
put
Delete counter
del
Search billing group number strategies
get
Create billing group number strategy
post
Update billing group number strategy
put
Delete billing group number strategy
del
Get default number strategy
get
Create default number strategy
post
Delete default number strategy
del
Query document type number strategies
get
Create document type number strategy
post
Update document type number strategy
put
Delete document type number strategy
del
Search service country number strategies
get
Create service country number strategy
post
Update service country number strategy
put
Delete service country number strategy
del
Document number strategy
get
Select document number strategy
post
Dunning Configurations
Retrieve dunning configuration
get
Create dunning configuration
post
Dunning Status Aggregations
Retrieve dunning status aggregation
get
Lists dunning status aggregation documents
get
Operating Site Configurations
Query Operating Site
get
Create Operating Site
post
Retrieve Operating Site
get
Update Operating Site
put
Delete Operating Site
del
Make Operating Site Default
post
Query tax registrations
get
Create tax registrations
post
Delete tax registrations
del
OPOS Cases
Query Decisions
get
Query OPOS Cases
get
Retrieve OPOS Case
get
Enable OposCase payment collection
post
Recalculation and Reevaluation of OposCase
post
Reevaluation of OposCase
post
Query Decisions for OPOS Cases
get
Add Decision for OPOS Case
post
Retrieve Decision for OPOS Case
get
Revert a Decision for OPOS Case
post
Update OposCase Dunning Block state
put
OPOS Case Clearing Runs
Query Clearing Run
get
Add Clearing Run
post
Retrieve Clearing Run
get
Reverse Clearing Run
post
Query Clearing Run Items
get
Retrieve Clearing Run Item
get
SAF-T Configurations
Query Saf-T configuration
get
Create Saf-T configuration
post
Retrieve Saf-T configuration
get
Update Saf-T configuration
put
Delete Saf-T configuration
del
Tenant Configurations
Get polish credit memo flag
get
Set polish credit memo flag
post
Document Output API
Translations
Store Translations
post
Get Translations
get
Delete Translation Key
del
Update Translation
patch
Delete Translation
del
Translation Configurations
Get All Translations
get
Get Configured Locales
get
Files
Retrieve a file
get
Retrieve attachments
get
Retrieve attachment
get
Tax API
Tax Calculation
Calculate tax for a document
post
Tax Rules Configuration
Retrieve tax rule
get
Update tax rule
put
Retrieve tax rule variant
get
Query tax rules
get
Create tax rule
post
Add variant to tax rule
post
Tax Provider Configuration
Get the tax provider configurations
get
Create or update the tax provider configuration for a country
post
Delete the tax provider configuration for a country
del
Delete the tax provider configuration for a country and billing group
del
Get usernames of all present tax provider credentials
get
Create or update tax provider credentials
post
Get username of tax provider credentials if present
get
Delete tax provider credentials
del
Update tax properties for a provider
put
Create tax properties for a provider
post
Get tax properties for a provider
get
Delete tax properties for a provider
del
Get all enabled tax providers for tenant
get
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
Query CustomerPaymentAccount
get
Create a CustomerPaymentAccount
post
Retrieve a CustomerPaymentAccount
get
Update a CustomerPaymentAccount
put
Change health status
post
Merchant Payment Accounts
Query MerchantPaymentAccount
get
Create MerchantPaymentAccount
post
Retrieve MerchantPaymentAccount
get
Update MerchantPaymentAccount
put
Delete MerchantPaymentAccount
del
Merchant Payment Gateways
Query MerchantPaymentGateway
get
Create MerchantPaymentGateway
post
Update MerchantPaymentGateway
put
Payment Providers
List payment providers
get
Create payment provider
post
Retrieve payment provider
get
Delete payment provider
del
Create settlement source
post
Retrieve settlement source
get
Update settlement source
put
Delete settlement source
del
Payment Categories
List payment categories
get
Create payment category
post
Retrieve payment category
get
Delete payment category
del
Enable or disable payment category
patch
Payment Transactions
Query payment transactions for a merchant payment account
get
Create payment transaction
post
Retrieve payment transaction
get
Update payment transaction
patch
Update status of the payment transaction
post
Update batch items of payment transactions.
put
Payment Categorization Rules
Create a payment categorization rule
post
get a payment categorization rule
get
Update a payment categorization rule
put
delete a payment categorization rule
del
Query payment categorization rules
get
Payment Intents
Query payment intent
get
Create PaymentIntent
post
Enable payment intent
post
Get processing enabled status.
get
Retrieve PaymentIntent
get
Cancel PaymentIntent
post
Retry PaymentIntent
post
Payment Intent Tasks
Query Payment Intent Task
get
Enable payment intent tasks
post
Retrieve Payment Intent Task
get
Update Payment Intent Task
patch
Cancel PaymentIntentTask
post
Settlements
Query settlement items per merchant payment account
get
Query settlement reports by merchant payment account
get
Create settlement report
post
Retrieve settlement report
get
Create settlement item
post
Query settlement reports
get
Query settlement items
get
Retrieve settlement item
get
Payment Assignment API
Assignment Configuration
Retrieve payment account's assignment configuration
get
Create or update payment account's assignment configurations
post
Delete payment account assignment configurations
del
Query regex matching strategies
get
Create regex matching strategy
post
Update regex matching strategy
put
Delete regex matching strategy
del
Assignments
Query payment assignments
get
Assign Payment
post
Retrieve payment assignment
get
Reverse payment assignment
post
Bookkeeping API
Booking Accounts
Retrieve booking accounts
get
Create booking account
post
Retrieve booking accounts
get
Update booking account
put
Remove booking account
del
Booking Entries
Query booking entries
get
Clearing
Query clearings
get
Clear booking entries
post
Retrieve clearing
get
Delete clearing
del
Tenants
Get gain loss configuration
get
Report API
Report Files
Query reports for period
get
Delete reports of period
del
Query reports
get
Download report
get
Delete report
del
Notification API
Notifications
Query notifications
get
Resend notifications
post
Retrieve notification
get
Resend notification
post
Notification Configuration
Get Routes
get
Update Route for Notification Configuration
put
Add Notification Route Configuration
post
Get NotificationTypes
get
Delete Notification Route
del
Get Notification Security Configuration
get
Update Notification Security Configuration
put
Create Notification Security Configuration
post
Delete Notification Configuration
del
Verify Notification Security Configuration
post
Currency Converter API
Currency Converter
Get exchange rates
get
Post self provided exchange rates
post
Electronic Invoice API
Electronic Invoicing Workflows
Query workflows
get
Retrieve workflow
get
Resend workflow
post
Retrieve eInvoicing File
get
Powered by
Retrieve usage
Ask AI
get
https://api.nitrobox.io/v2/usages/
{usageId}
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
Client
Scopes
Missing 1 required scope
