JUMP TOAPI IntroductionGetting started with APIAuthentication and authorizationError codes and messagesRetrieve documents from NitroboxQuery data using RSQLAPI lifecycle and versioningAPI MigrationsNotifications/WebhooksCustomer and Address NotificationsOrder NotificationsContract NotificationsDocument archivedPayment NotificationsOPOS Decision NotificationsCustomer APICustomersList customersgetCreate customerpostQuery customers addressesgetCreate addresspostRetrieve customergetUpdate customerputRetrieve addressgetUpdate addressputDebtorsDeprecated: List debtorsgetDeprecated: Create customerpostDeprecated: Retrieve customergetDeprecated: Update customerputDebtors AddressesDeprecated: Query customer addressesgetDeprecated: Create addresspostDeprecated: Retrieve addressgetDeprecated: Update addressputConfigurationsGet all address validation configsgetCreate or update address validation configpostGet address validation configgetDelete address validation configdeleteBilling APIBilling GroupGet 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 segmentsgetOrdersQuery ordersgetCreate orderpostCancel orderspostAdd attachmentpostRetrieve attachmentgetDelete attachmentdeleteRetrieve ordergetUpdate orderpatchCancel orderpostPrepare document creation for entire orderpostRetry failed billable itemspostAdd allowancespostCancel allowancespostUpdate allowancesputQuery billable itemsgetCreate billable itempostRetrieve billable itemgetQuery line itemsgetAdd line itempostCancel line itemspostPrepare document creation for certain itemspostSet items on holdpostRetrieve line itemgetEdit line itemputQuery agreed deposits of line itemgetAdd agreed deposit to line itempostOrders (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 contractspostTerminate contractspostExtraordinary terminations.postActivate contractpostRetry failed billable itemspostTerminate a contractpostExtraordinary terminationpostQuery 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 credit billable itempostCreate closing invoicepostTerminate contract by idpostUsagesQuery usagesgetCreate usagepostRetrieve usagegetBillable ItemsQuery billable itemsgetInvoicesPerform invoice correctionpostReissue invoicepostData Access APIInvoicesQuery invoicesgetInvoice APIDocument LabelsQuery LabelsgetAdd LabelpostRemove LabelpostBillingAggregation ConfigurationsQuery AggregationgetCreate AggregationpostRetrieve AggregationgetUpdate AggregationputDelete AggregationdeleteDunning ConfigurationsRetrieve dunning configurationgetCreate dunning configurationpostOperating Site ConfigurationsQuery Operating SitegetCreate Operating SitepostRetrieve Operating SitegetUpdate Operating SiteputDelete Operating SitedeleteMake Operating Site DefaultpostOPOS CasesQuery OPOS CasesgetRetrieve OPOS CasegetReevaluation of OposCasepostQuery Decisions for OPOS CasesgetAdd Decision for OPOS CasepostRetrieve Decision for OPOS CasegetRevert a Decision for OPOS CasepostSAF-T ConfigurationsQuery Saf-T configurationgetCreate Saf-T configurationpostRetrieve Saf-T configurationgetUpdate Saf-T configurationputDelete Saf-T configurationdeleteDocument Output APITranslationsStore TranslationspostGet TranslationsgetDelete Translation KeydeleteUpdate TranslationpatchDelete TranslationdeleteTranslation ConfigurationsGet All TranslationsgetGet Configured LocalesgetConfigurationDocument Creation ConfigurationsRetrieve configurationgetUpdate configurationputFilesRetrieve a filegetRetrieve attachmentgetRetrieve attachmentsgetRetrieve initial document filegetDocumentTax APITax 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 credentialsdeleteGet all enabled tax providers for tenantgetTax Rule ConfigurationsQuery tax rulesgetCreate tax rulepostRetrieve tax rulegetUpdate tax ruleputAdd variant to tax rulepostRetrieve tax rule variantgetTax CalculationsCalculate tax for an itempostCalculate tax for a documentpostThis endpoint is temporary available for internal demonstration purposes only.postPayment APIMerchant 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 transactionpostQuery payment intentgetCreate PaymentIntentpostRetrieve PaymentIntentgetCancel PaymentIntentpostRetry PaymentIntentpostRetrieve payment transactiongetUpdate payment transactionpatchUpdate status of the payment transactionpostSettlementsQuery 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 itemgetCustomer Payment AccountsQuery CustomerPaymentAccountgetCreate a CustomerPaymentAccountpostRetrieve a CustomerPaymentAccountgetUpdate a CustomerPaymentAccountputChange health statuspostBookkeeping APIBooking AccountsRetrieve booking accountsgetCreate booking accountpostRetrieve booking accountsgetUpdate booking accountputRemove booking accountdeleteBooking EntriesQuery booking entriesgetClearingretrieve clearingsgetclear booking entriespostretrieve clearinggetdelete clearingdeleteNotification APINotification ConfigurationGet RoutesgetUpdate Route for Notification ConfigurationputAdd Notification Route ConfigurationpostGet NotificationTypesgetDelete Notification RoutedeleteGet Notification Security ConfigurationgetUpdate Notification Security ConfigurationputCreate Notification Security ConfigurationpostDelete Notification ConfigurationdeletePowered by Getting started with APIHere you can find all OpenAPI files to download: Debtor API Billing API Data Access API Tax API Payment API Bookkeeping API Invoice API Document Output API Notification API
