For AI agents: visit https://docs.instellix.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
instellix Platform Documentation
HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog Ininstellix Platform Documentation
API Reference
Platform OverviewDemoContactImprintLog In
HomeDocumentationRecipesAPI ReferenceChangelog

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 via HTTP Webhooks
    • Customer and Address Notifications
    • Order Notifications
    • Contract Notifications
    • Payment Notifications
    • OPOS Decision Notifications
    • Document Notifications
    • Dunning Notifications
    • Report Notifications
    • E-Invoicing Notification
    • Further Notifications

Customer API

  • Customers
    • Create customerpost
    • Query customersget
    • Retrieve customerget
    • Update customerput
    • Create addresspost
    • Query customer addressesget
    • Retrieve addressget
    • Update addressput
    • Update customer dunning blockput
  • Sellers
    • Query seller operating sitesget
    • Create a new seller operating sitepost
    • Retrieve an existing seller operating siteget
    • Update an existing seller operating siteput
    • Query sellersget
    • Create a new sellerpost
    • Retrieve an existing sellerget
    • Update an existing sellerput
  • Tax Classifications
    • Query tax classificationsget
    • Create tax classificationpost
    • Update tax classificationput
  • Configurations
    • Check validation of all addressespost
    • Get all address validation configsget
    • Create or update address validation configpost
    • Get address validation configget
    • Delete address validation configdel

Billing API

  • Billing Groups
    • Get a paged result of all billing groupsget
    • Create billing grouppost
    • Retrieve billing groupget
    • Update billing groupput
    • Delete billing groupdel
    • Create business segmentpost
    • Retrieve business segmentget
    • Update business segmentput
    • Delete business segmentdel
    • Set as defaultpost
    • Update splitting configput
    • Query business segmentsget
  • Orders
    • Retrieve billable itemget
    • Create orderpost
    • Cancel orderspost
    • Query ordersget
    • Add attachmentpost
    • Retrieve attachmentget
    • Delete attachmentdel
    • Retrieve orderget
    • Update orderpatch
    • Cancel orderpost
    • Retry failed billable itemspost
    • Query agreed order depositsget
    • Add multiple order agreed depositspost
    • Update an agreed deposit that is assigned to an orderput
    • Delete an agreed deposit that is assigned to an orderdel
    • Add allowancespost
    • Cancel allowancespost
    • Update allowancesput
    • Query billable itemsget
    • Query line itemsget
    • Add line itempost
    • Cancel line itemspost
    • Retrieve line itemget
    • Edit line itemput
    • Query agreed deposits of line itemget
    • Add agreed deposit to line itempost
    • Update agreed deposit of line itemput
    • Delete agreed deposit of line itemdel
    • Hold line items for orderpost
    • Prepare document creation for certain itemspost
    • Prepare document creation for entire orderpost
  • Plans and Options
    • Get a page of all plan optionsget
    • Create optionpost
    • Retrieve optionget
    • Update optionput
    • Delete optiondel
    • Create planpost
    • Query plansget
    • Add options to a phase of a planpost
    • Retrieve planget
    • Update planput
    • Delete plandel
  • Contracts
    • Retrieve billable itemget
    • Start billing runpost
    • Create contractpost
    • Cancel contractspost
    • Terminate contractspost
    • Query attachmentsget
    • Extraordinary terminations.post
    • Query contractsget
    • Activate contractpost
    • Enable additional options for a contract.post
    • Retry failed billable itemspost
    • Terminate a contractpost
    • Extraordinary terminationpost
    • Termination adaptionpost
    • Query allowancesget
    • Create allowancepost
    • Retrieve allowanceget
    • Correct a billable itempost
    • Update allowanceput
    • Delete allowancedel
    • Retry recalculationpost
    • Query line itemsget
    • Add line itempost
    • Cancel line itemspost
    • Retrieve line itemget
    • Edit line itemput
    • query related contractsget
    • add related contracts to contractpost
    • remove related contracts from contractpost
    • Retrieve contractget
    • Update contractpatch
    • Query billable itemsget
    • Query attachmentsget
    • Add attachmentpost
    • Retrieve attachmentget
    • Delete attachmentdel
    • Cancel a billable itempost
    • Prepare document creation for certain itemspost
    • Hold line items for contractpost
  • Usages
    • Create usagepost
    • Delete usagesdel
    • Cancel usagespost
    • Query usagesget
    • Retrieve usageget
  • Invoices
    • Reissue documentpost
    • Create a correction for a documentpost
    • Retrieve document correctionget
    • Retrieve correctionability for all document itemsget
  • Billable Items
    • Query billable itemsget
  • Price Adaptations
    • Query price adaptationget
    • Create price adaptationpost
    • Retrieve price adaptationget
    • Delete price adaptationdel
    • Query price adaptation valuesget
    • Create price adaptation valuepost
    • Retrieve price adaptations valueget
    • Update price adaptations valueput
    • Delete price adaptations valuedel
  • Customers
    • Retrieve all customer configs for the tenantget
    • Retrieve customer config for a specific customerget
    • Update customer configurationput
  • Contracts (deprecated)

Usage API

  • Rated usages
    • Query rated usagesget
    • Create rated usagepost
    • Retrieve rated usageget
    • Cancel rated usagepost
    • Retry or reactivate rated usagepost
  • Rated usage aggregations
    • Query rated usage aggregationsget
    • Retrieve rated usage aggregationget
    • Close rated usage aggregationpost
    • Create an empty rated used aggregationpost
    • Add rated usagepost
  • Billing Group
    • Get billing group by identget
    • Update billing groupput

Data Access API

  • Invoices
    • Query invoicesget
    • Retrieve invoiceget

Invoice API

  • Documents
    • Query documentsget
    • Create credit memopost
    • Retrieve credit memoget
    • Create deposit invoice correctionpost
    • Retrieve deposit invoice correctionget
    • Create deposit invoicepost
    • Retrieve deposit invoiceget
    • Create invoicepost
    • Retrieve invoiceget
    • Retrieve document processing status by requestIdget
    • Create self billing invoice correctionpost
    • Retrieve self billing invoice correctionget
    • Create self billing invoicepost
    • Retrieve self billing invoiceget
    • Retrieve documentget
    • Retrieve document aggregationsget
  • Document Labels
    • Query Labelsget
    • Add Labelpost
    • Remove Labelpost
  • Aggregation Configurations
    • Query Aggregationget
    • Create Aggregationpost
    • Retrieve Aggregationget
    • Update Aggregationput
    • Delete Aggregationdel
  • Document Number Configurations
    • Query countersget
    • Create counterpost
    • Update counter configurationput
    • Delete counterdel
    • Search billing group number strategiesget
    • Create billing group number strategypost
    • Delete billing group number strategydel
    • Get default number strategyget
    • Create default number strategypost
    • Delete default number strategydel
    • Search document type number strategiesget
    • Create document type number strategypost
    • Update document type number strategyput
    • Delete document type number strategydel
    • Search service country number strategiesget
    • Create service country number strategypost
    • Update service country number strategyput
    • Delete service country number strategydel
    • Document number strategyget
    • Select document number strategypost
    • Update billing group number strategyput
  • Dunning Configurations
    • Retrieve dunning configurationget
    • Create dunning configurationpost
  • Dunning Status Aggregations
    • Retrieve dunning status aggregationget
    • Lists dunning status aggregation documentsget
  • Operating Site Configurations
    • Query Operating Siteget
    • Create Operating Sitepost
    • Retrieve Operating Siteget
    • Update Operating Siteput
    • Delete Operating Sitedel
    • Make Operating Site Defaultpost
    • Query tax registrationsget
    • Create tax registrationspost
    • Delete tax registrationsdel
  • OPOS Cases
    • Query Decisionsget
    • Query OPOS Casesget
    • Retrieve OPOS Caseget
    • Enable OposCase payment collectionpost
    • Recalculation and Reevaluation of OposCasepost
    • Query Decisions for OPOS Casesget
    • Add Decision for OPOS Casepost
    • Retrieve Decision for OPOS Caseget
    • Revert a Decision for OPOS Casepost
    • Update OposCase Dunning Block stateput
  • OPOS Case Clearing Runs
    • Query Clearing Runget
    • Add Clearing Runpost
    • Retrieve Clearing Runget
    • Reverse Clearing Runpost
    • Query Clearing Run Itemsget
    • Retrieve Clearing Run Itemget
  • SAF-T Configurations
    • Query Saf-T configurationget
    • Create Saf-T configurationpost
    • Retrieve Saf-T configurationget
    • Update Saf-T configurationput
    • Delete Saf-T configurationdel
  • Tenant Configurations
    • Get polish credit memo flagget
    • Set polish credit memo flagpost

Document Output API

  • Translations
    • Store Translationspost
    • Get Translationsget
    • Delete Translation Keydel
    • Update Translationpatch
    • Delete Translationdel
  • Translation Configurations
    • Get All Translationsget
    • Get Configured Localesget
  • Files
    • Retrieve a fileget
    • Retrieve attachmentsget
    • Retrieve attachmentget

Tax API

  • Tax Calculation
    • Calculate tax for a documentpost
  • Tax Rules Configuration
    • Retrieve tax ruleget
    • Update tax ruleput
    • Retrieve tax rule variantget
    • Query tax rulesget
    • Create tax rulepost
    • Add variant to tax rulepost
  • Tax Provider Configuration
    • Get the tax provider configurationsget
    • Create or update the tax provider configuration for a countrypost
    • Delete the tax provider configuration for a countrydel
    • Delete the tax provider configuration for a country and billing groupdel
    • Get usernames of all present tax provider credentialsget
    • Create or update tax provider credentialspost
    • Get username of tax provider credentials if presentget
    • Delete tax provider credentialsdel
    • Update tax properties for a providerput
    • Create tax properties for a providerpost
    • Get tax properties for a providerget
    • Delete tax properties for a providerdel
    • Get all enabled tax providers for tenantget
  • 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 CustomerPaymentAccountget
    • Create a CustomerPaymentAccountpost
    • Retrieve a CustomerPaymentAccountget
    • Update a CustomerPaymentAccountput
    • Change health statuspost
  • Merchant Payment Accounts
    • Query MerchantPaymentAccountget
    • Create MerchantPaymentAccountpost
    • Retrieve MerchantPaymentAccountget
    • Update MerchantPaymentAccountput
    • Delete MerchantPaymentAccountdel
  • Merchant Payment Gateways
    • Query MerchantPaymentGatewayget
    • Create MerchantPaymentGatewaypost
    • Update MerchantPaymentGatewayput
  • Payment Categories
    • List payment categoriesget
    • Create payment categorypost
    • Retrieve payment categoryget
    • Delete payment categorydel
    • Enable or disable payment categorypatch
  • Payment Transactions
    • Query payment transactions for a merchant payment accountget
    • Create payment transactionpost
    • Retrieve payment transactionget
    • Update payment transactionpatch
    • Update status of the payment transactionpost
    • Update batch items of payment transactions.put
  • Payment Categorization Rules
    • Create a payment categorization rulepost
    • get a payment categorization ruleget
    • Update a payment categorization ruleput
    • delete a payment categorization ruledel
    • Query payment categorization rulesget
  • Payment Intents
    • Query payment intentget
    • Create PaymentIntentpost
    • Enable payment intentpost
    • Get processing enabled status.get
    • Retrieve PaymentIntentget
    • Cancel PaymentIntentpost
    • Retry PaymentIntentpost
  • Payment Intent Tasks
    • Query Payment Intent Taskget
    • Enable payment intent taskspost
    • Retrieve Payment Intent Taskget
    • Update Payment Intent Taskpatch
    • Cancel PaymentIntentTaskpost
  • Settlements
    • Query settlement items per merchant payment accountget
    • Query settlement reports by merchant payment accountget
    • Create settlement reportpost
    • Retrieve settlement reportget
    • Create settlement itempost
    • Query settlement reportsget
    • Query settlement itemsget
    • Retrieve settlement itemget

Payment Assignment API

  • Assignment Configuration
    • Retrieve payment account's assignment configurationget
    • Create or update payment account's assignment configurationspost
    • Delete payment account assignment configurationsdel
    • Query regex matching strategiesget
    • Create regex matching strategypost
    • Update regex matching strategyput
    • Delete regex matching strategydel
  • Assignments
    • Query payment assignmentsget
    • Assign Paymentpost
    • Retrieve payment assignmentget
    • Reverse payment assignmentpost

Bookkeeping API

  • Closings
    • List of all created monthly closings.get
    • List of all monthly closings created for the month.get
    • Recreate monthly closingpost
    • List of all created daily closings for the month.get
    • List of all daily closings created for a dayget
    • Recreate daily closingpost
    • Retrieve the latest completed daily closingget
    • List bookings of the latest completed daily closingget
    • A specific end of the dayget
    • List bookings of a daily closingget
    • Retrieve the latest completed monthly closingget
    • List bookings of the latest completed monthly closingget
    • A specific month-end closing.get
    • List bookings of a monthly closingget
  • Booking Accounts
    • Retrieve booking accountsget
    • Create booking accountpost
    • Retrieve booking accountsget
    • Update booking accountput
    • Remove booking accountdel
  • Booking Entries
    • Query booking entriesget
    • Query directional booking entries of an accountget
  • Clearing
    • Query clearingsget
    • Clear booking entriespost
    • Retrieve clearingget
    • Delete clearingdel
  • Tenants
    • Get gain loss configurationget

Report API

  • Report Files
    • Query reports for periodget
    • Delete reports of perioddel
    • Query reportsget
    • Download reportget
    • Delete reportdel
  • Reports
    • Query reportsget
    • Request standard report generationpost
    • Download report by identget
  • Scheduled Reports
    • Query scheduled reportsget
    • Create scheduled reportpost
    • Process due scheduled reportspost
    • Delete scheduled reportdel
    • Get scheduled reportget
    • Update scheduled reportput

Notification API

  • Notification Configuration
    • Get Routesget
    • Update Route for Notification Configurationput
    • Add Notification Route Configurationpost
    • Get NotificationTypesget
    • Delete Notification Routedel
    • Get Notification Security Configurationget
    • Update Notification Security Configurationput
    • Create Notification Security Configurationpost
    • Delete Notification Configurationdel
    • Verify Notification Security Configurationpost
  • Notifications
    • Query notificationsget
    • Resend notificationspost
    • Retrieve notificationget
    • Resend notificationpost

Currency Converter API

  • Currency Converter
    • Get exchange ratesget
    • Post self provided exchange ratespost

Electronic Invoice API

  • Electronic Invoicing Workflows
    • Query workflowsget
    • Retrieve workflowget
    • Resend workflowpost
    • Retrieve eInvoicing Fileget
    • Ignore workflowpost

Audit Trail API

  • Audit Trail Entry
    • Query audit trail entriesget
    • Retrieve audit trail entryget
  • Audit Trail Entity Name
    • Retrieve entity namesget

Authentication API

  • Token
    • Create a token.post
    • Refresh a token.post
    • Revoke a token.post
    • Validate token.post
  • Discovery
    • OAuth2 Authorization Server Metadata.get
    • JSON Web Key Set for a realm.get

Document Image API

  • Document Image
    • Retrieve imagesget
    • Create Imagepost
    • Delete an imagedel
    • Retrieve a single imageget
    • Retrieve image dataget
    • Retrieve imagesget
    • Create Imagepost
    • Delete an imagedel
    • Retrieve a single imageget
    • Retrieve image dataget
Powered by 

Contracts (deprecated)

Updated 10 months ago


Update customer configuration
Rated usages
Did this page help you?

Updated 10 months ago


Update customer configuration
Rated usages
Did this page help you?