JUMP TOAPI IntroductionGetting started with the Nitrobox APIAuthentication and authorizationError codes and messagesRetrieve documents from NitroboxQuery data using RSQLOpenAPI Specification (OAS)API versioning and lifecycleAPI Migration GuideNotifications/WebhooksCustomer and Address NotificationsOrder NotificationsContract NotificationsDocument archivedPayment NotificationsOPOS Decision NotificationsDebtor APICustomersQuery customersgetCreate customerpostRetrieve customergetUpdate customerputQuery customer addressesgetCreate addresspostRetrieve addressgetUpdate addressputConfigurationsCheck validation of all addressespostGet all address validation configsgetCreate or update address validation configpostGet address validation configgetDelete address validation configdeleteDebtors (deprecated)Deprecated: List debtorsgetDeprecated: Create customerpostDeprecated: Retrieve customergetDeprecated: Update customerputDebtors Addresses (deprecated)Deprecated: Query customer addressesgetDeprecated: Create addresspostDeprecated: Retrieve addressgetDeprecated: Update addressputBilling APIBilling GroupsGet a paged result of all billing groupsgetCreate billing grouppostRetrieve billing groupgetUpdate billing groupputDelete billing groupdeleteCreate business segmentpostRetrieve business segmentgetUpdate business segmentputDelete business segmentdeleteSet as defaultpostUpdate splitting configputQuery business segmentsgetOrdersCreate billable itempostQuery ordersgetCreate orderpostCancel orderspostAdd attachmentpostPrepare document creation for certain itemspostRetrieve attachmentgetSet items on holdpostDelete attachmentdeleteRetrieve ordergetUpdate orderpatchCancel orderpostPrepare document creation for entire orderpostRetry failed billable itemspostQuery agreed order depositsgetAdd multiple order agreed depositspostUpdate an agreed deposit that is assigned to an orderputDelete an agreed deposit that is assigned to an orderdeleteAdd allowancespostCancel allowancespostUpdate allowancesputQuery billable itemsgetRetrieve billable itemgetQuery line itemsgetAdd line itempostCancel line itemspostRetrieve line itemgetEdit line itemputQuery agreed deposits of line itemgetAdd agreed deposit to line itempostUpdate agreed deposit of line itemputDelete agreed deposit of line itemdeleteOrders (deprecated)Cancel orderpatchCreate credit billable itempostAdd item to closing invoicepostGenerate closing invoicepostAdd purchase itempostCancel purchase itemspostPrepare document creation for certain itemspostSet items on holdpostCancel purchase itempostRetrieve purchase itemgetEdit purchase itemputAdd agreed deposit to purchase itempostPlans and OptionsGet a page of all plan optionsgetCreate optionpostRetrieve optiongetUpdate optionputDelete optiondeleteQuery plansgetCreate planpostAdd option to a phase of a planpostRetrieve plangetUpdate planputDelete plandeleteContractsStart billing runpostQuery contractsgetCreate contractpostCancel contractspostQuery attachmentsgetTerminate contractspostExtraordinary terminations.postActivate contractpostRetry failed billable itemspostTerminate a contractpostExtraordinary terminationpostTermination adaptionpostQuery allowancesgetCreate allowancepostRetrieve allowancegetUpdate allowanceputDelete allowancedeleteQuery line itemsgetAdd line itempostCancel line itemspostPrepare document creation for certain itemspostSet items on holdpostRetrieve line itemgetEdit line itemputAdd agreed deposit to line itempostRetrieve contractgetUpdate contractpatchQuery billable itemsgetRetrieve billable itemgetQuery attachmentsgetAdd attachmentpostRetrieve attachmentgetDelete attachmentdeleteContracts (deprecated)Create billable itempostAdd purchase itempostCancel purchase itemspostPrepare document creation for certain itemspostSet items on holdpostRetrieve purchase itemgetEdit purchase itemputAdd agreed deposit to purchase itempostTerminate contract by identpostCancel contractpatchCancel contract itemspostCreate closing invoicepostTerminate contract by idpostCreate credit billable itempostUsagesQuery usagesgetCreate usagepostDelete usagesdeleteCancel usagespostRetrieve usagegetBillable ItemsQuery billable itemsgetInvoicesReissue invoicepostUsage APIRated usagesQuery rated usagesgetCreate rated usagepostRetrieve rated usagegetCancel rated usagepostRetry rated usagepostRated usage aggregationsQuery rated usage aggregationsgetClose rated usage aggregationpostData Access APIInvoicesQuery invoicesgetRetrieve invoicegetInvoice APIBillingQuery AggregationgetCreate AggregationpostRetrieve AggregationgetUpdate AggregationputDelete AggregationdeleteQuery Operating SitegetCreate Operating SitepostRetrieve Operating SitegetUpdate Operating SiteputDelete Operating SitedeleteMake Operating Site DefaultpostQuery tax registrationsgetCreate tax registrationspostDelete tax registrationsdeleteQuery Saf-T configurationgetCreate Saf-T configurationpostRetrieve Saf-T configurationgetUpdate Saf-T configurationputDelete Saf-T configurationdeleteQuery LabelsgetAdd LabelpostRemove LabelpostQuery OPOS CasesgetRetrieve OPOS CasegetReevaluation of OposCasepostQuery Decisions for OPOS CasesgetAdd Decision for OPOS CasepostRetrieve Decision for OPOS CasegetRevert a Decision for OPOS CasepostTenantGet polish credit memo flaggetSet polish credit memo flagpostDunning ConfigurationsRetrieve dunning configurationgetCreate dunning configurationpostDocument Output APITranslationsStore TranslationspostGet TranslationsgetDelete Translation KeydeleteUpdate TranslationpatchDelete TranslationdeleteTranslation ConfigurationsGet All TranslationsgetGet Configured LocalesgetFilesRetrieve a filegetRetrieve attachmentsgetRetrieve initial document filegetTax APITax CalculationCalculate tax for an itempostCalculate tax for a documentpostTax Rules ConfigurationQuery tax rulesgetCreate tax rulepostRetrieve tax rulegetUpdate tax ruleputAdd variant to tax rulepostRetrieve tax rule variantgetTax Provider ConfigurationGet the tax provider configurationsgetCreate or update the tax provider configuration for a countrypostDelete the tax provider configuration for a countrydeleteGet usernames of all present tax provider credentialsgetCreate or update tax provider credentialspostGet username of tax provider credentials if presentgetDelete tax provider credentialsdeleteUpdate tax properties for a providerputCreate tax properties for a providerpostGet tax properties for a providergetDelete tax properties for a providerdeleteGet all enabled tax providers for tenantgetPayment APIPaymentQuery CustomerPaymentAccountgetCreate a CustomerPaymentAccountpostRetrieve a CustomerPaymentAccountgetUpdate a CustomerPaymentAccountputChange health statuspostMerchant Payment GatewaysQuery MerchantPaymentGatewaygetCreate MerchantPaymentGatewaypostUpdate MerchantPaymentGatewayputMerchant Payment AccountsQuery MerchantPaymentAccountgetCreate MerchantPaymentAccountpostRetrieve MerchantPaymentAccountgetUpdate MerchantPaymentAccountputDelete MerchantPaymentAccountdeletePayment ProviderList payment providersgetCreate payment providerpostRetrieve payment providergetDelete payment providerdeleteCreate settlement sourcepostRetrieve settlement sourcegetUpdate settlement sourceputDelete settlement sourcedeletePayment CategoriesQuery payment categoriesgetCreate payment categorypostRetrieve payment categorygetUpdate attributes of payment categorypatchList payment categoriesgetRetrieve global payment category configurationgetEnable or disable payment categorypatchPayment Categorization ConfigurationRetrieve categorization configurationgetCreate categorization configurationpostRetrieve categorization configurationgetUpdate categorization configurationputDelete categorization configuration.deletePayment TransactionsQuery payment transactions for a merchant payment accountgetCreate payment transactionpostRetrieve payment transactiongetUpdate payment transactionpatchUpdate status of the payment transactionpostPayment Categorization RulesCreate a payment categorization rulepostget a payment categorization rulegetUpdate a payment categorization ruleputdelete a payment categorization ruledeleteQuery payment categorization rulesgetPayment IntentCreate PaymentIntentpostRetrieve PaymentIntentgetQuery payment intentgetEnable payment intentpostCancel PaymentIntentpostRetry PaymentIntentpostGet processing enabled status.getPayment Intent TaskQuery Payment Intent TaskgetEnable payment intent taskspostRetrieve Payment Intent TaskgetSettlementsQuery settlement items per merchant payment accountgetQuery settlement reports by merchant payment accountgetCreate settlement reportpostRetrieve settlement reportgetCreate settlement itempostUpload settlement reportpostQuery settlement reportsgetQuery settlement itemsgetRetrieve settlement itemgetBookkeeping APIBooking AccountsRetrieve booking accountsgetCreate booking accountpostRetrieve booking accountsgetUpdate booking accountputRemove booking accountdeleteBooking EntriesQuery booking entriesgetClearingQuery clearingsgetClear booking entriespostRetrieve clearinggetDelete clearingdeleteTenantsGet gain loss configurationgetUpdate gain loss configurationputReport APIReport FilesQuery reports for periodgetDelete reports of perioddeleteQuery reportsgetDownload reportgetDelete reportdeleteNotification APINotificationsQuery notificationsgetResend notificationspostRetrieve notificationgetResend notificationpostNotification ConfigurationGet RoutesgetUpdate Route for Notification ConfigurationputAdd Notification Route ConfigurationpostGet NotificationTypesgetDelete Notification RoutedeleteGet Notification Security ConfigurationgetUpdate Notification Security ConfigurationputCreate Notification Security ConfigurationpostDelete Notification ConfigurationdeleteBasware Adapter APIBasware country configurationGet all Basware country configurationsgetGet Basware country configurationgetUpdate Basware country configurationpostBasware forward route configurationGet All Forward RoutesgetStore Forward RoutepostDelete Forward RoutedeleteBasware credential configurationGet Basware credentials configurationgetCreate or update Basware credentials configurationpostDelete Basware credentials configurationdeleteBasware forward route resolverResolve RoutegetBasware workflowsQuery workflowsgetRetrieve workflowgetRetrigger workflowpostBasware enumsGet used enumerationsgetPowered by Clear booking entriespost https://api.nitrobox.io/v2/bookingAccounts/{accountNumber}/{accountCurrency}/clearingsClears a set of matching booking entries
