JUMP TOAPI IntroductionGetting started with APIAuthentication and authorizationError codes and messagesRetrieve documents from NitroboxQuery data using RSQLAPI lifecycle and versioningAPI MigrationsNotifications/WebhooksDocument archivedCustomer and Address NotificationsContract NotificationsOrder NotificationsPayment NotificationsOPOS Decision NotificationsDebtor APICustomersList customersgetCreate customerpostQuery customers addressesgetCreate addresspostRetrieve customergetUpdate customerputRetrieve addressgetUpdate addressputCustomer AddressesDebtorsDeprecated: List debtorsgetDeprecated: Create customerpostDeprecated: Retrieve customergetDeprecated: Update customerputDebtors AddressesDeprecated: Query customer addressesgetDeprecated: Create addresspostDeprecated: Retrieve addressgetDeprecated: Update addressputBilling APItenantGet tenant wide config for contract servicegetUpdate tenant configputBilling 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 orderpostAdd allowancespostQuery billable itemsgetCreate billable itempostRetrieve billable itemgetDeprecated: Cancel orderpatchCreate credit billable itempostAdd item to closing invoicepostQuery line itemsgetAdd line itempostCancel line itemspostPrepare document creation for certain itemspostSet items on holdpostRetrieve line itemgetEdit line itemputAdd agreed deposit to line itempostGenerate 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 planpostRetrieve plangetUpdate planputDelete plandeleteContractsStart billing runpostQuery contractsgetCreate contractpostCancel contractspostTerminate contractspostExtraordinary terminations.postRetry failed billable itemspostTerminate a contractpostExtraordinary terminationpostQuery line itemsgetAdd line itempostCancel line itemspostPrepare document creation for certain itemspostSet items on holdpostRetrieve line itemgetEdit line itemputAdd agreed deposit to line itempostAdd purchase itempostCancel purchase itemspostPrepare document creation for certain itemspostSet items on holdpostRetrieve purchase itemgetEdit purchase itemputAdd agreed deposit to purchase itempostTerminate contract by identpostRetrieve contractgetUpdate contractpatchActivate contractpatchQuery billable itemsgetCreate billable itempostRetrieve billable itemgetDeprecated: Cancel contractpatchCancel contract itemspostCreate credit billable itempostPerform invoice correctionpostCreate closing invoicepostTerminate contract by idpostAdd attachmentpostRetrieve attachmentgetDelete attachmentdeleteUsagesQuery usagesgetCreate usagepostRetrieve usagegetBillable ItemsQuery billable itemsgetInvoicesReissue invoicepostData Access APIInvoicesQuery invoicesgetTax APITax Rule ConfigurationsQuery tax rulesgetCreate tax rulepostRetrieve tax rulegetUpdate tax ruleputAdd variant to tax rulepostRetrieve tax rule variantgetGet whether tax provider credentials are storedgetCreate or update tax provider credentialspostDelete tax provider credentials configurationdeleteTax CalculationsCalculate tax for an itempostCalculate tax for a documentpostPayment APIMerchant Payment GatewaysQuery MerchantPaymentGatewaygetCreate MerchantPaymentGateway.postUpdate MerchantPaymentGatewayputMerchant Payment AccountsQuery MerchantPaymentAccountgetCreate MerchantPaymentAccount.postRetrieve MerchantPaymentAccountgetUpdate MerchantPaymentAccountputDelete MerchantPaymentAccountdeletePayment ProviderList payment providers.getCreate payment provider.postRetrieve payment provider.getDelete payment provider.deleteCreate settlement source.postRetrieve settlement source.getUpdate settlement source.putDelete settlement source.deletePayment CategoriesQuery payment categories.getCreate payment categorypostRetrieve payment category.getUpdate attributes of payment category.patchList payment categoriesgetRetrieve global payment category configuration.getEnable or disable payment categorypatchPayment Categorization ConfigurationRetrieve categorization configuration.getCreate categorization configuration.postRetrieve categorization configuration.getUpdate categorization configuration.putDelete categorization configuration.deletePayment TransactionsQuery payment transactions for a merchant payment account.getCreate payment transaction.postQuery payment intentgetCreate PaymentIntentpostRetrieve PaymentIntentgetCancel PaymentIntentpostRetry PaymentIntentpostRetrieve payment transactiongetUpdate payment transaction.patchUpdate status of the payment transactionpostSettlementsQuery settlement items per merchant payment accountgetQuery settlement reports.getCreate settlement report.postRetrieve settlement report.getCreate settlement item.postUpload settlement reportpostQuery settlement itemsgetRetrieve settlement itemgetCustomer Payment AccountsQuery CustomerPaymentAccountgetCreate a CustomerPaymentAccountpostRetrieve a CustomerPaymentAccountgetUpdate a CustomerPaymentAccountputBookkeeping APIBooking AccountsRetrieve booking accountsgetCreate booking accountpostRetrieve booking accountsgetUpdate booking accountputRemove booking accountdeleteBooking EntriesQuery booking entriesgetClearingretrieve clearingsgetclear booking entriespostretrieve clearinggetdelete clearingdeleteInvoice APIDocument LabelsQuery LabelsgetAdd LabelpostRemove LabelpostAggregation ConfigurationsQuery AggregationgetCreate AggregationpostRetrieve AggregationgetUpdate AggregationputDelete AggregationdeleteOperating Site ConfigurationsQuery Operating SitegetCreate Operating SitepostRetrieve Operating SitegetUpdate Operating SiteputDelete Operating SitedeleteMake Operating Site DefaultpostSAF-T ConfigurationsQuery Saf-T configurationgetCreate Saf-T configurationpostRetrieve Saf-T configurationgetUpdate Saf-T configurationputDelete Saf-T configurationdeleteOPOS CasesQuery OPOS CasesgetRetrieve OPOS CasegetReevaluation of OposCasepostQuery Decisions for OPOS CasesgetAdd Decision for OPOS CasepostRetrieve Decision for OPOS CasegetRevert a Decision for OPOS CasepostDocument Output APITranslationsStore TranslationspostGet TranslationsgetDelete Translation KeydeleteUpdate TranslationpatchDelete TranslationdeleteTranslation ConfigurationsGet All TranslationsgetGet Configured LocalesgetDocument Creation ConfigurationsRetrieve configurationgetUpdate configurationputFilesRetrieve a filegetRetrieve attachmentsgetRetrieve attachmentgetRetrieve initial document filegetNotification 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 List payment providers.get https://api.nitrobox.io/v2/payment-providersList allpayment providers configured in the system.
