JUMP TOGetting startedOpenAPI Specification (OAS)Customer APIpreviewAnonymize customerpostDeprecated: Anonymize customerpostCustomersCreate customerpostQuery customersgetRetrieve customergetUpdate customerputCreate addresspostQuery customer addressesgetRetrieve addressgetUpdate addressputConfigurationsCheck validation of all addressespostGet all address validation configsgetCreate or update address validation configpostGet address validation configgetDelete address validation configdeleteCustomers (deprecated)Query customers (unpaged)getQuery customer addresses (unpaged)getDebtors (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 segmentsgetOrdersRetrieve billable itemgetCreate orderpostCancel orderspostQuery ordersgetAdd attachmentpostRetrieve attachmentgetDelete 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 itemsgetQuery 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 itemdeletePlans and OptionsGet a page of all plan optionsgetCreate optionpostRetrieve optiongetUpdate optionputDelete optiondeleteQuery plansgetCreate planpostQuery plansgetAdd option to a phase of a planpostRetrieve plangetUpdate planputDelete plandeleteContractsRetrieve billable itemgetStart billing runpostCreate contractpostCancel contractspostTerminate contractspostPrepare document creation for certain itemspostQuery attachmentsgetCreate credit billable itempostExtraordinary terminations.postSet items on holdpostQuery contractsgetActivate contractpostEnable additional options for a contract.postRetry failed billable itemspostTerminate a contractpostExtraordinary terminationpostTermination adaptionpostQuery allowancesgetCreate allowancepostRetrieve allowancegetUpdate allowanceputDelete allowancedeleteQuery line itemsgetAdd line itempostCancel line itemspostRetrieve line itemgetEdit line itemputquery related contractsgetadd related contracts to contractpostremove related contracts from contractpostget contract termsgetRetrieve contractgetUpdate contractpatchQuery billable itemsgetQuery attachmentsgetAdd attachmentpostRetrieve attachmentgetDelete attachmentdeleteUsagesQuery usagesgetCreate usagepostDelete usagesdeleteCancel usagespostQuery usagesgetRetrieve usagegetBillable ItemsQuery billable itemsgetQuery billable itemsgetInvoicesReissue documentpostReissue invoicepostPrice AdaptationsQuery price adaptationgetCreate price adaptationpostRetrieve price adaptationgetDelete price adaptationdeleteQuery price adaptation valuesgetCreate price adaptation valuepostRetrieve price adaptations valuegetUpdate price adaptations valueputDelete price adaptations valuedeleteOrders (deprecated)Query orders (unpaged)getCreate billable itempostCancel orderpatchCreate credit billable itempostGenerate closing invoicepostContracts (deprecated)Query contracts (unpaged)getCreate billable itempostTerminate contract by identpostCancel contractpatchCreate closing invoicepostTerminate contract by idpostPrepare document creation for certain itemspostSet items on holdpostUsage APIRated usagesQuery rated usagesgetCreate rated usagepostRetrieve rated usagegetCancel rated usagepostRetry or reactivate rated usagepostRated usage aggregationsQuery rated usage aggregationsgetRetrieve rated usage aggregationgetClose rated usage aggregationpostData Access APIInvoicesQuery invoicesgetRetrieve invoicegetInvoice APIDocumentsQuery documentsgetCreate credit memopostRetrieve credit memogetCreate deposit invoice correctionpostRetrieve deposit invoice correctiongetCreate deposit invoicepostRetrieve deposit invoicegetCreate invoicepostRetrieve invoicegetRetrieve document processing status by requestIdgetCreate self billing invoice correctionpostRetrieve self billing invoice correctiongetCreate self billing invoicepostRetrieve self billing invoicegetRetrieve documentgetRetrieve document aggregationsgetDocument LabelsQuery LabelsgetAdd LabelpostRemove LabelpostAggregation ConfigurationsQuery AggregationgetCreate AggregationpostRetrieve AggregationgetUpdate AggregationputDelete AggregationdeleteDocument Number ConfigurationsQuery countersgetCreate counterpostUpdate counterputDelete counterdeleteSearch billing group number strategiesgetCreate billing group number strategypostUpdate billing group number strategyputDelete billing group number strategydeleteGet default number strategygetCreate default number strategypostDelete default number strategydeleteQuery document type number strategiesgetCreate document type number strategypostUpdate document type number strategyputDelete document type number strategydeleteSearch service country number strategiesgetCreate service country number strategypostUpdate service country number strategyputDelete service country number strategydeleteDocument number strategygetSelect document number strategypostDunning ConfigurationsRetrieve dunning configurationgetCreate dunning configurationpostDunning Status AggregationsRetrieve dunning status aggregationgetLists dunning status aggregation documentsgetOperating Site ConfigurationsQuery Operating SitegetCreate Operating SitepostRetrieve Operating SitegetUpdate Operating SiteputDelete Operating SitedeleteMake Operating Site DefaultpostQuery tax registrationsgetCreate tax registrationspostDelete tax registrationsdeleteOPOS CasesQuery DecisionsgetQuery OPOS CasesgetRetrieve OPOS CasegetEnable OposCase payment collectionpostRecalculation and Reevaluation of OposCasepostReevaluation of OposCasepostQuery Decisions for OPOS CasesgetAdd Decision for OPOS CasepostRetrieve Decision for OPOS CasegetRevert a Decision for OPOS CasepostUpdate OposCase Dunning Block stateputOPOS Case Clearing RunsQuery Clearing RungetAdd Clearing RunpostRetrieve Clearing RungetReverse Clearing RunpostQuery Clearing Run ItemsgetRetrieve Clearing Run ItemgetSAF-T ConfigurationsQuery Saf-T configurationgetCreate Saf-T configurationpostRetrieve Saf-T configurationgetUpdate Saf-T configurationputDelete Saf-T configurationdeleteTenant ConfigurationsGet polish credit memo flaggetSet polish credit memo flagpostDocument Output APITranslationsStore TranslationspostGet TranslationsgetDelete Translation KeydeleteUpdate TranslationpatchDelete TranslationdeleteTranslation ConfigurationsGet All TranslationsgetGet Configured LocalesgetDocument Creation ConfigurationsRetrieve configurationgetUpdate configurationputFilesRetrieve a filegetRetrieve attachmentsgetRetrieve attachmentgetTax APITax CalculationCalculate tax for a documentpostTax Rules ConfigurationRetrieve tax rulegetUpdate tax ruleputRetrieve tax rule variantgetQuery tax rulesgetCreate tax rulepostAdd variant to tax rulepostTax Provider ConfigurationGet the tax provider configurationsgetCreate or update the tax provider configuration for a countrypostDelete the tax provider configuration for a countrydeleteDelete the tax provider configuration for a country and billing groupdeleteGet 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 tenantgetTax Service Tenant ConfigurationGet the tax service configuration for a tenant.getCreate or update the tax service configuration for a tenant.postTax Service Billing Group ConfigurationGet the tax service configuration for a billing group.getCreate or update the tax service configuration for a billing group.postPayment APICustomer Payment AccountsQuery CustomerPaymentAccountgetCreate a CustomerPaymentAccountpostRetrieve a CustomerPaymentAccountgetUpdate a CustomerPaymentAccountputChange health statuspostMerchant Payment AccountsQuery MerchantPaymentAccountgetCreate MerchantPaymentAccountpostRetrieve MerchantPaymentAccountgetUpdate MerchantPaymentAccountputDelete MerchantPaymentAccountdeleteMerchant Payment GatewaysQuery MerchantPaymentGatewaygetCreate MerchantPaymentGatewaypostUpdate MerchantPaymentGatewayputPayment ProvidersList payment providersgetCreate payment providerpostRetrieve payment providergetDelete payment providerdeleteCreate settlement sourcepostRetrieve settlement sourcegetUpdate settlement sourceputDelete settlement sourcedeletePayment CategoriesList payment categoriesgetCreate payment categorypostRetrieve global payment category configurationgetDelete payment categorydeleteEnable or disable payment categorypatchPayment 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 IntentsQuery payment intentgetCreate PaymentIntentpostEnable payment intentpostGet processing enabled status.getRetrieve PaymentIntentgetCancel PaymentIntentpostRetry PaymentIntentpostPayment Intent TasksQuery Payment Intent TaskgetEnable payment intent taskspostRetrieve Payment Intent TaskgetUpdate Payment Intent TaskpatchCancel PaymentIntentTaskpostSettlementsQuery 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 itemgetPayment Assignment APIAssignmentsQuery payment assignmentsgetAssign PaymentpostRetrieve payment assignmentgetReverse payment assignmentpostAssignment ConfigurationRetrieve payment account's assignment configurationgetCreate or update payment account's assignment configurationspostDelete payment account assignment configurationsdeleteQuery regex matching strategiesgetCreate regex matching strategypostUpdate regex matching strategyputDelete regex matching strategydeleteBookkeeping APIpreviewList accounting document number configurationsgetCreate accounting document number configurationpostQuery accounting document number configurationsgetCreate booking entriespostList booking entries (csv format)getList booking periodsgetCreate a booking periodpostClose booking periodpostReopen booking periodpostBooking AccountsRetrieve booking accountsgetCreate booking accountpostRetrieve booking accountsgetUpdate booking accountputRemove booking accountdeleteBooking EntriesQuery booking entriesgetClearingQuery clearingsgetClear booking entriespostRetrieve clearinggetDelete clearingdeleteBooking Engine APIpreviewCreate payment settled rulepostCreate payment invoice assignment reversed rulepostCreate payment transaction categorized rulepostCreate payment assignment processed rulepostCreate opos case decision rulepostCreate opos case decision reversed rulepostFetch document rules using businessSegment, country and tenantIdgetCreate document rulepostCreate deposit rulepostRetrigger the processing of stored events of a specific event typepostFetching payment settled rule's scriptsgetDelete payment settled ruledeleteFetch all payment settled rules for tenantIdgetFetch currently used active rule for tenantgetFetching payment invoice assignment reversed rule's scriptsgetDelete payment invoice assignment reversed ruledeleteFetch all payment invoice assignment reversed rules for tenantgetFetch currently used active rule for tenantgetFetching payment transaction categorized rule's scriptsgetDelete payment transaction categorized ruledeleteFetch all payment transaction categorized rules for tenantIdgetFetch currently used active rule for tenantgetFetching payment assignment processed rule's scriptsgetDelete payment assignment processed ruledeleteFetch all payment assignment processed rules for tenantgetFetch currently used active rule for tenantgetFetching opos case decision rule's scriptsgetDelete opos case decision ruledeleteFetching opos case decision reversed rule's scriptsgetDelete opos case decision reversed ruledeleteFetch all opos case decision reversed rules for tenantgetFetch currently used active rule for tenantgetFetch all opos case decision rules for tenantgetFetch currently used active rule for tenantgetFetching document rule's scriptsgetDelete document ruledeleteFetch all document rules for tenantgetFetch currently used active rule for tenantgetFetching deposit rule's scriptsgetDelete deposit ruledeleteFetch all deposit rules for tenantIdgetFetch currently used active rule for tenantgetCurrency Converter APICurrency ConverterGet exchange ratesgetPost self provided exchange ratespostRetrieve tenant configurationgetUpdate tenant configurationputConvert currencypostReport 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 workflowpostUpdate recipient code and resend workflowpostBasware enumsGet used enumerationsgetBilling Preparation APIBilling Group ConfigurationGet billing preparation billing group configgetUpdate billing preparation billing group configpostPowered by Retrieve PaymentIntentget https://api.nbx-stage-westeurope.nitrobox.io/v2/payment-intents/{paymentIntentIdent}Get a PaymentIntent by its ident.
