Due to an internal software update by the third-party provider we use to publicly publish our APIs, the way customers access the Open API specification (OAS) files will change slightly. The URL used to retrieve each of the specification files will be updated — transitioning from a purely technical identifier to a human-readable identifier and file name. The structure and content of the specification files remain unchanged.

The entry point for all OAS files remains unchanged as well at https://docs.nitrobox.io/v2/reference/openapi-specification-oas.

Please ensure that any integrations or tools relying on the previous URLs are updated accordingly for continued access and processing of these files. This change will take effect on Wednesday, 24th of September.

For your convenience, we have listed the mapping of changes for each API below:

Example

https://docs.nitrobox.io/v2/openapi/60b8f92103850600379a144c

will change to

https://docs.nitrobox.io/v2/openapi/customer-api.json

1. Avalara E-Invoicing
   We have made several improvements to Avalara E-Invoicing integration in Nitrobox, making it easier to manage credentials, configurations, and documents directly in the web portal:
   • You can now enter Avalara ELR credentials directly in the web portal and configure all Avalara settings there.
   • The document workflow has been extended so that PDF or XML files can be downloaded directly from a workflow step – no separate Avalara login is required anymore
   • In addition, we have implemented a validation that immediately checks the JSONata mapping for errors, helping to identify and fix issues faster.
2. Credit Card Type in Customer Payment Account
   You can now specify the credit card type used by your customers in the customer payment account. This can be used, for example, to print more specific information on your documents.
3. Cancellation of Payment Intents
   It is now possible to cancel payment intents before they are processed. This allows you to stop the transaction entirely, rather than charging the customer and then issuing a refund. The change helps avoid unnecessary payment processing steps, improves the overall customer experience, and reduces PSP costs.
4. API
   • You can now provide a sellerOperatingSiteIdent in the document v2 API. This allows you to specify a different seller on a document than your tenant, allowing for a basic marketplace setup.
   • We've added a new endpoint where invoiced recurring and one-time option items can be corrected. This should help handle support cases more easily. You can find the endpoint here: https://docs.nitrobox.io/reference/correctbillableitem
     We aim to soon enable this feature in the web portal as well.
   • Our notifications have been extended to include the timestamp when an API call to your system is being made. This can help you order and process the notifications in the correct order.
5. Bug Fixes
   • Fixed an issue in the voucher process via TalonOne where the character “/” in the documentIdent was not handled correctly. The system now fully supports this character, ensuring smoother voucher creation and redemption.
   • Fixed a bug where optional usage options were sometimes not displayed in the contract details page.
   • Fixed a bug where picking a different language during order creation didn't work correctly.
   • Fixed a bug where 0-value rated usages could not be sent via API.
6. Webportal
   • You can now change the correction mode (item-based vs document-based) on billing group level in the UI.
   • When adding new usage options to plans you can decide if you want to enable them automatically for all existing contracts or if you want to enable them later on a per contract basis.

1. Extended data available for our booking rules
   We are now consuming more information in our booking engine, which will allow for even more flexible booking rules and enhance our ability to provide more data in accounting reports.
2. Document-level corrections
   Until now, when an invoice contained multiple items and only one required correction, we would issue a credit note and a new invoice for just that specific item. However, we've found that this approach can lead to confusion—especially when invoices include hundreds of items. Reviewing and reconciling documents across a single month often requires combing through dozens of credit notes and partial invoices, which is time-consuming for both your support team and your customers.
   To address this, we’re introducing document-level corrections. Going forward, if any item on an invoice needs to be corrected, the entire original invoice will be credited, and a new invoice will be issued with the corrected data. Even if 99 out of 100 items remain unchanged, the revised invoice will reflect the complete and up-to-date version of the document.
   This change ensures there is always one clear, current invoice to refer to—simplifying communication and improving transparency for everyone involved.
   Changing this config, which is available on Billing Group level, can currently only be done by API, but we are looking forward to enabling this via webportal self-service.
3. Avalara E-Invoicing
   Avalara ELR workflows are now visible in the web portal. You can see the current processing status, status history, and detailed API logs (requests and responses) for each electronic invoice.
4. Payment Provider Extension
   You can now configure Stripe credentials (API keys) and retry settings directly in the web portal. This allows for faster and more flexible PSP integration without technical support.
5. API
   1. We've published the new "Seller Entity" to be used later for diverging sellers needed for marketplace functionality.
   2. We’ve added a new validation to the Document API v2: All items on an invoice must now have the same Tax Location Country to ensure accurate tax calculation.
6. Webportal
   1. The Billable Item details page was redesigned to improve the user experience. A card for the pricing structure was added to reflect how the price is calculated, for example, based on usage.
   2. Payment Intent details page was also redesigned to improve the grouping of information on the page.

1. Avalara E-Invoicing
   The Avalara integration for electronic invoicing is now available. Nitrobox enables the creation and transmission of e-invoices via Avalara ELR, supporting compliance with legal requirements for all supported countries.
   Further enhancements – including configuration options in the web portal – will be added soon.
2. E-Invoicing: Extended Recipient Code Parameters
   Recipient code settings have been extended based on the official Peppol specifications. The configuration now includes all countries with specific recipient code requirements. These codes can now be added directly in the customer configuration under E-Invoicing Parameters. A detailed guide is available here: E-Invoicing Recipient Codes
3. Payment Provider Stripe
   You can now set up and manage your Stripe integration without developer support – including activation, deactivation, and management of payment retry logic directly via the Nitrobox Webportal. This makes it easier to adjust payment behavior for different use cases, such as e-commerce or subscriptions.
4. Retire your plans
   You can now retire your plans. Contracts for retired plans continue functioning as usual, but you won't be able to create new contracts for retired plans. This feature should help you manage your plans better and see which ones are still relevant for your daily operations.
5. Improvement in notification retries
   We've updated our notification retry logic to allow for longer offsets (last notification retry will be attempted ~72 hours after the first) and are now also retrying other HTTP Error Codes, such as 429. This will improve the number of notification failures that the automated retry feature will catch.
6. API
   1. Removed an API description bug for our Customer API that insinuated that properties were mandatory.

1. Update to billable items when tax rule changes
   When using the NBX tax provider and changing a tax rule, all associated planned billable items will now be recalculated to reflect the tax change. Previously, the new tax rate was only applied at the time of final invoicing
   This allows for greater clarity of what will be invoiced in the future and allows you to provide more accurate information to your customers ahead of time.
2. Adding usage options to an active plan
   Previously, when adding a new usage option to a plan already in use, you had to additionally activate the usage option on all contracts as well. We've enabled you via API to enable the new option for all active contracts automatically. This improves the ease of managing and evolving your plans.
3. Webportal improvements:
   1. We reworked our manual billing flow. The feature, previously only available to users with "beta" rights, can now be accessed by all. You will now also see a list of billable items that will be invoiced when executing the billing run manually.
4. Bug Fixes
   1. Fixed a bug where contract renewal notifications were sometimes not published
   2. Fixed a bug in the web portal where creating a single-phased plan without autorenewal was no longer possible.

1. Audit Trail
   Admin users can now access a new Audit Trail in the web portal under Administration, providing visibility into changes made to user accounts and customer payment accounts.
   The trail shows who changed what and when, enhancing transparency and traceability across the system.
   Support for additional entity types will be added gradually.
2. Web portal improvements
   1. The customer email is now displayed in the contracts list view, making it easier to identify and filter contracts by customer.

1. Reverse Charge and gross prices for external tax provider
   We've improved our final document creation process to correctly handle scenarios where gross prices are agreed upon with customers who apply reverse charge. This now works as expected when using external tax providers. Support for the Nitrobox tax provider will follow in a future release.
2. Changing Payment Providers
   You can now change the payment provider for both merchant payment accounts and merchant payment gateways.
3. Line Item Updates During Ongoing Corrections
   Previously, once a correction was triggered for a line item (e.g., by adjusting its price), you had to wait until the correction was completed before making further changes. This often resulted in unnecessary documents if the update was incorrect.
   Now, you can immediately update the item again with the correct values.
   This change also enhances the rated usage feature, which relies on line item corrections.
4. Update Billing Delay on Active Plans
   You can now modify the billing delay on plans that already have active contracts. The updated delay will apply to all billable items created after the change.
5. Currency Converter API
   We've released the Currency Converter API, allowing you to provide and manage your own exchange rates via API.
6. Webportal improvements
   1. The "Document Aggregations" configuration page has been redesigned and renamed to "Document Subtotals" for improved clarity and usability.
7. Bugfixes
   1. Creating a payment intent now reliably shows the exact customer payment account (CPA) used for that transaction, rather than the currently stored CPA.
   2. Fixed an issue where only usage options from the first phase were shown when creating a new usage entry in the web portal.
   3. Resolved a bug where users with the "Order Manager" or "Customer Support" role couldn't create new customers.
   4. Fixed an issue in the plan creation workflow where single-phase contracts without auto-renewal could no longer be created.

1. Price Calculation Basis
   We now provide additional information on how the billed values were calculated. For example, for recurring elements, you can now view the base values for pro rata calculations in the Billable Item overview. Additionally, via API, you can also find more details for Usage calculation, which will be added to the webportal as well in the coming weeks.
2. Billable Item Recalculation Error
   Should billable item recalculation occur (for example, if the tax or performance location was changed that might impact pricing or taxation), but encounter an error, the billable item will now have a separate error status and new actions to retry the recalculation. A billable item where the recalculation failed will not be invoiced.
3. Webportal improvements:
   1. Price adaptation values applicable from a date can now be deleted, for example, if the value changed on the index or in case you misconfigured.
   2. The option selection in the "add usages modal" is now sorted alphabetically, with the first option being automatically selected for easier and quicker adding of usages manually.
   3. On the payment intent details page, the status and the message of the latest payment intent response are now directly visible.
   4. Ther payment intents and payment intent task pages have been merged to provide a more holistic view on each attempted payment intent.
   5. You will find two new widgets on the new payment intents page: planned and failed payment intents which provide more information on the processing. Additional detail pages are available.
   6. The email of your customers is now also available as a column in the contracts overview table.
   7. Additional small UI improvements were made about the size of information cards on several pages.
4. Bug Fixes
   1. Fixed a bug where monetary amounts of 100 million and larger couldn't be processed completely.
5. Removal of deprecated APIs
   We've removed several of our depcreated APIs that had reached their sunset date. We ensured those APIs haven't been used for the last few months.
   Namely
   1. /v2/orders/{orderIdent}/depositInvoice/purchaseItem
   2. /v2/orders/{orderIdent}/prepareInvoice
   3. /v2/contracts/{contractId}/prepareInvoice
   4. /v2/invoices/{invoiceIdent}/actions/reissue
   5. /v2/orders/{orderIdent}/cancel
   6. /v2/contracts/{contractId}/cancel
   7. /v2/contracts/{contractIdent}/terminateContract
   8. /v2/contracts/{contractId}/terminateContractId

1. Rated Usage Aggregations
   We've added detailed views for Rated Usage Aggregations in the Webportal. With this release, it's now easier to identify aggregations that require manual action—for example, those that need to be closed again after late usage data has arrived. This closing action can now also be performed directly via the Webportal.
2. Multi-Phase Plan Option Update
   We've removed a constraint preventing the update of Options belonging to Multi-Phase Plans.
3. Bugfixes
   1. Fixed an issue where certain properties in our API schema were unintentionally no longer marked as required, due to a problem introduced by a third-party library update.
   2. Fixed a Bug where the auto-renewal date wasn't recalculated after a renewal if the contract's underlying plan didn't have any recurring options.
4. Changes to our Billing API
   1. We have removed several unused operations from our Billing API specification as part of a planned deprecation. While these operations are no longer included in the published API schema, they remain available at runtime for a limited time before being fully sunsetted. For more details and migration guidance, please refer to our API Migration Guide.
5. Webportal improvements:
   1. CreatedAt and lastModifiedAt information can now be found at the bottom right of all details page that support this information.
   2. Order views have been redesigned to enhance the user experience.
   3. "Add Usage" window was restructured to improve the layout.
   4. Payment has received a small overhaul to improve UI/UX
   5. Improved the Plan creation flow to offer a tailored experience based on whether you're creating a single-phase or multi-phase plan.
   6. The plan column in the contract can now be filtered.
   7. Added informative tooltips to the Order and Contract update actions to help users better understand how these actions behave.
   8. The Billable Item detail page for recurring elements now includes a "Price Calculation Basis" section, providing additional insight into how the price was determined. Particularly useful in scenarios like pro rata calculations.
   9. Fixed a bug
      1. where Users were sometimes not shown
      2. where document numbers with a slash "/" in them didn't work properly.
      3. where tilde (~) character in idents caused problems in certain entities.

1. Tax-Provider determination
   The tax providers can now be additionally configured based on the billing group. This enables more flexible tax handling for multi-country, multi-billing-groups, and multi-provider setups.
2. Payment Intent Task now only created for document-based OPOS cases
   If an OPOS case is reopened by external factors, such as a direct refund with your PSP, then we won't create new payment intents for the now again open position. This helps to avoid unintended payment retries and ensures better control over automated collections.
3. Improved visibility for Not-Assignable payment transactions
   Transactions that cannot be assigned (e.g., cash pool transactions) now appear in a different status color to visually distinguish them from actual unassigned payments. This reduces confusion and helps finance teams identify real unassigned transactions faster.
4. Improved document caching
   We've improved the availability of all documents stored in Nitrobox, reducing the chances of technical delays.
5. Adding Rated Usage Options for running contracts now also available on earlier periods
   Previously, when adding new Rated Usages Options to existing contracts, the option could only be for later billing periods and not for the past. This is now improve,d so the new options can also be used for past rated usages.
6. Configurable Debtor Account Number
   You can now easily increase the debtor account number range start, which will help to ensure separate GL/Debtor Account number ranges.
7. Webportal
   1. Added rated usage aggregation details page, which is accessible from the rated usage aggregations tab on Contract details page.
8. Bug Fixes
   1. Fixed a bug where the credit item after the termination of a contract, followed by a complete cancellation, could have the wrong service period (while its value still being correctly calculated).
   2.