Getting started

OpenAPI Specification (OAS)

Customer API

preview
- Anonymize customerpost
- Deprecated: Anonymize customerpost
Customers
Configurations
Customers (deprecated)
- Query customers (unpaged)get
- Query customer addresses (unpaged)get
Debtors (deprecated)
Debtors Addresses (deprecated)

Billing API

Billing Groups
Orders
Plans and Options
Contracts
Usages
Billable Items
- Query billable itemsget
- Query billable itemsget
Invoices
- Reissue documentpost
- Reissue invoicepost
Price Adaptations
Orders (deprecated)
Contracts (deprecated)

Usage API

Rated usages
Rated usage aggregations

Data Access API

Invoices
- Query invoicesget
- Retrieve invoiceget

Invoice API

Documents
Document Labels
Aggregation Configurations
Document Number Configurations
Dunning Configurations
- Retrieve dunning configurationget
- Create dunning configurationpost
Dunning Status Aggregations
- Retrieve dunning status aggregationget
- Lists dunning status aggregation documentsget
Operating Site Configurations
OPOS Cases
OPOS Case Clearing Runs
SAF-T Configurations
Tenant Configurations
- Get polish credit memo flagget
- Set polish credit memo flagpost

Document Output API

Translations
Translation Configurations
- Get All Translationsget
- Get Configured Localesget
Document Creation Configurations
- Retrieve configurationget
- Update configurationput
Files

Tax API

Tax Calculation
- Calculate tax for a documentpost
Tax Rules Configuration
Tax Provider Configuration
Tax Service Tenant Configuration
- Get the tax service configuration for a tenant.get
- Create or update the tax service configuration for a tenant.post
Tax Service Billing Group Configuration
- Get the tax service configuration for a billing group.get
- Create or update the tax service configuration for a billing group.post

Payment API

Customer Payment Accounts
Merchant Payment Accounts
Merchant Payment Gateways
Payment Providers
Payment Categories
Payment Transactions
Payment Categorization Rules
Payment Intents
Payment Intent Tasks
Settlements

Payment Assignment API

Assignments
Assignment Configuration

Bookkeeping API

preview
Booking Accounts
Booking Entries
- Query booking entriesget
Clearing

Booking Engine API

preview

Currency Converter API

Currency Converter

Report API

Report Files

Notification API

Notifications
Notification Configuration

Basware Adapter API

Basware country configuration
Basware forward route configuration
Basware credential configuration
Basware forward route resolver
- Resolve Routeget
Basware workflows
Basware enums
- Get used enumerationsget

Billing Preparation API

Billing Group Configuration
- Get billing preparation billing group configget
- Update billing preparation billing group configpost

Getting started

OpenAPI Specification (OAS)

Customer API

preview
- Anonymize customerpost
- Deprecated: Anonymize customerpost
Customers
Configurations
Customers (deprecated)
- Query customers (unpaged)get
- Query customer addresses (unpaged)get
Debtors (deprecated)
Debtors Addresses (deprecated)

Billing API

Billing Groups
Orders
Plans and Options
Contracts
Usages
Billable Items
- Query billable itemsget
- Query billable itemsget
Invoices
- Reissue documentpost
- Reissue invoicepost
Price Adaptations
Orders (deprecated)
Contracts (deprecated)

Usage API

Rated usages
Rated usage aggregations

Data Access API

Invoices
- Query invoicesget
- Retrieve invoiceget

Invoice API

Documents
Document Labels
Aggregation Configurations
Document Number Configurations
Dunning Configurations
- Retrieve dunning configurationget
- Create dunning configurationpost
Dunning Status Aggregations
- Retrieve dunning status aggregationget
- Lists dunning status aggregation documentsget
Operating Site Configurations
OPOS Cases
OPOS Case Clearing Runs
SAF-T Configurations
Tenant Configurations
- Get polish credit memo flagget
- Set polish credit memo flagpost

Document Output API

Translations
Translation Configurations
- Get All Translationsget
- Get Configured Localesget
Document Creation Configurations
- Retrieve configurationget
- Update configurationput
Files

Tax API

Tax Calculation
- Calculate tax for a documentpost
Tax Rules Configuration
Tax Provider Configuration
Tax Service Tenant Configuration
- Get the tax service configuration for a tenant.get
- Create or update the tax service configuration for a tenant.post
Tax Service Billing Group Configuration
- Get the tax service configuration for a billing group.get
- Create or update the tax service configuration for a billing group.post

Payment API

Customer Payment Accounts
Merchant Payment Accounts
Merchant Payment Gateways
Payment Providers
Payment Categories
Payment Transactions
Payment Categorization Rules
Payment Intents
Payment Intent Tasks
Settlements

Payment Assignment API

Assignments
Assignment Configuration

Bookkeeping API

preview
Booking Accounts
Booking Entries
- Query booking entriesget
Clearing

Booking Engine API

preview

Currency Converter API

Currency Converter

Report API

Report Files

Notification API

Notifications
Notification Configuration

Basware Adapter API

Basware country configuration
Basware forward route configuration
Basware credential configuration
Basware forward route resolver
- Resolve Routeget
Basware workflows
Basware enums
- Get used enumerationsget

Billing Preparation API

Billing Group Configuration
- Get billing preparation billing group configget
- Update billing preparation billing group configpost

Create payment provider

post https://api.nbx-stage-westeurope.nitrobox.io/v2/payment-providers

Create payment provider of given type: CONTOWORKS, OPTILE, KLARNA, MHP_SBA, COMMERZBANK, OTHER.

Body Params

name

string

required

length between 0 and 255

Name of the payment service provider.
Must not be blank.
Size must be between 0 and 255.

type

string

required

Type of the payment service provider.
Must not be null.
Must be one of:

ADYEN

CONTOWORKS

COMMERZBANK

GOCARDLESS

KLARNA

MOLLIE

OPTILE

STRIPE

VWFS_SMARTPAY

WORLDLINE

OTHER

settlementSources

array

Settlement sources

settlementSources

Responses

Response body

object

int64

Id of the payment service provider

name

string

required

Name of the payment service provider.
Must not be blank.

type

string

Type of the payment service provider.
Must be one of:

ADYEN

CONTOWORKS

COMMERZBANK

GOCARDLESS

KLARNA

MOLLIE

OPTILE

STRIPE

VWFS_SMARTPAY

WORLDLINE

OTHER

settlementSources

array

Settlement sources

settlementSources

Response body

object

status

string

textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400

message

string

message describing the error

timestamp

date-time

timestamp in UTC when the error occurred

path

string

URL path where the error occurred

uuid

UUID generated by the server to identify the error occurred, should be stated in case of any inquiries

errors

array of objects

optional list of multiple errors occurred

errors

object

Response body

object

status

string

textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400

message

string

message describing the error

timestamp

date-time

timestamp in UTC when the error occurred

path

string

URL path where the error occurred

uuid

UUID generated by the server to identify the error occurred, should be stated in case of any inquiries

errors

array of objects

optional list of multiple errors occurred

errors

object

Updated 4 months ago

List payment providers

Retrieve payment provider

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.nbx-stage-westeurope.nitrobox.io/v2/payment-providers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

Updated 4 months ago

List payment providers

Retrieve payment provider

Did this page help you?

Getting started
OpenAPI Specification (OAS)

Customer API
preview
Deprecated: Anonymize customerpost
Anonymize customerpost
Customers
Update addressput
Retrieve addressget
Query customer addressesget
Create addresspost
Update customerput
Retrieve customerget
Query customersget
Create customerpost
Configurations
Delete address validation configdelete
Get address validation configget
Create or update address validation configpost
Get all address validation configsget
Check validation of all addressespost
Customers (deprecated)
Query customer addresses (unpaged)get
Query customers (unpaged)get
Debtors (deprecated)
Deprecated: Update customerput
Deprecated: Retrieve customerget
Deprecated: Create customerpost
Deprecated: List debtorsget
Debtors Addresses (deprecated)
Deprecated: Update addressput
Deprecated: Retrieve addressget
Deprecated: Create addresspost
Deprecated: Query customer addressesget

Billing API
Billing Groups
Query business segmentsget
Update splitting configput
Set as defaultpost
Delete business segmentdelete
Update business segmentput
Retrieve business segmentget
Create business segmentpost
Delete billing groupdelete
Update billing groupput
Retrieve billing groupget
Create billing grouppost
Get a paged result of all billing groupsget
Orders
Delete agreed deposit of line itemdelete
Update agreed deposit of line itemput
Add agreed deposit to line itempost
Query agreed deposits of line itemget
Edit line itemput
Retrieve line itemget
Cancel line itemspost
Add line itempost
Query line itemsget
Query billable itemsget
Update allowancesput
Cancel allowancespost
Add allowancespost
Delete an agreed deposit that is assigned to an orderdelete
Update an agreed deposit that is assigned to an orderput
Add multiple order agreed depositspost
Query agreed order depositsget
Retry failed billable itemspost
Prepare document creation for entire orderpost
Cancel orderpost
Update orderpatch
Retrieve orderget
Delete attachmentdelete
Retrieve attachmentget
Add attachmentpost
Query ordersget
Cancel orderspost
Create orderpost
Retrieve billable itemget
Plans and Options
Delete plandelete
Update planput
Retrieve planget
Add option to a phase of a planpost
Query plansget
Create planpost
Query plansget
Delete optiondelete
Update optionput
Retrieve optionget
Create optionpost
Get a page of all plan optionsget
Contracts
Delete attachmentdelete
Retrieve attachmentget
Add attachmentpost
Query attachmentsget
Query billable itemsget
Update contractpatch
Retrieve contractget
get contract termsget
remove related contracts from contractpost
add related contracts to contractpost
query related contractsget
Edit line itemput
Retrieve line itemget
Cancel line itemspost
Add line itempost
Query line itemsget
Delete allowancedelete
Update allowanceput
Retrieve allowanceget
Create allowancepost
Query allowancesget
Termination adaptionpost
Extraordinary terminationpost
Terminate a contractpost
Retry failed billable itemspost
Enable additional options for a contract.post
Activate contractpost
Query contractsget
Set items on holdpost
Extraordinary terminations.post
Create credit billable itempost
Query attachmentsget
Prepare document creation for certain itemspost
Terminate contractspost
Cancel contractspost
Create contractpost
Start billing runpost
Retrieve billable itemget
Usages
Retrieve usageget
Query usagesget
Cancel usagespost
Delete usagesdelete
Create usagepost
Query usagesget
Billable Items
Query billable itemsget
Query billable itemsget
Invoices
Reissue invoicepost
Reissue documentpost
Price Adaptations
Delete price adaptations valuedelete
Update price adaptations valueput
Retrieve price adaptations valueget
Create price adaptation valuepost
Query price adaptation valuesget
Delete price adaptationdelete
Retrieve price adaptationget
Create price adaptationpost
Query price adaptationget
Orders (deprecated)
Generate closing invoicepost
Create credit billable itempost
Cancel orderpatch
Create billable itempost
Query orders (unpaged)get
Contracts (deprecated)
Set items on holdpost
Prepare document creation for certain itemspost
Terminate contract by idpost
Create closing invoicepost
Cancel contractpatch
Terminate contract by identpost
Create billable itempost
Query contracts (unpaged)get

Usage API
Rated usages
Retry or reactivate rated usagepost
Cancel rated usagepost
Retrieve rated usageget
Create rated usagepost
Query rated usagesget
Rated usage aggregations
Close rated usage aggregationpost
Retrieve rated usage aggregationget
Query rated usage aggregationsget

Data Access API
Invoices
Retrieve invoiceget
Query invoicesget

Invoice API
Documents
Retrieve document aggregationsget
Retrieve documentget
Retrieve self billing invoiceget
Create self billing invoicepost
Retrieve self billing invoice correctionget
Create self billing invoice correctionpost
Retrieve document processing status by requestIdget
Retrieve invoiceget
Create invoicepost
Retrieve deposit invoiceget
Create deposit invoicepost
Retrieve deposit invoice correctionget
Create deposit invoice correctionpost
Retrieve credit memoget
Create credit memopost
Query documentsget
Document Labels
Remove Labelpost
Add Labelpost
Query Labelsget
Aggregation Configurations
Delete Aggregationdelete
Update Aggregationput
Retrieve Aggregationget
Create Aggregationpost
Query Aggregationget
Document Number Configurations
Select document number strategypost
Document number strategyget
Delete service country number strategydelete
Update service country number strategyput
Create service country number strategypost
Search service country number strategiesget
Delete document type number strategydelete
Update document type number strategyput
Create document type number strategypost
Query document type number strategiesget
Delete default number strategydelete
Create default number strategypost
Get default number strategyget
Delete billing group number strategydelete
Update billing group number strategyput
Create billing group number strategypost
Search billing group number strategiesget
Delete counterdelete
Update counterput
Create counterpost
Query countersget
Dunning Configurations
Create dunning configurationpost
Retrieve dunning configurationget
Dunning Status Aggregations
Lists dunning status aggregation documentsget
Retrieve dunning status aggregationget
Operating Site Configurations
Delete tax registrationsdelete
Create tax registrationspost
Query tax registrationsget
Make Operating Site Defaultpost
Delete Operating Sitedelete
Update Operating Siteput
Retrieve Operating Siteget
Create Operating Sitepost
Query Operating Siteget
OPOS Cases
Update OposCase Dunning Block stateput
Revert a Decision for OPOS Casepost
Retrieve Decision for OPOS Caseget
Add Decision for OPOS Casepost
Query Decisions for OPOS Casesget
Reevaluation of OposCasepost
Recalculation and Reevaluation of OposCasepost
Enable OposCase payment collectionpost
Retrieve OPOS Caseget
Query OPOS Casesget
Query Decisionsget
OPOS Case Clearing Runs
Retrieve Clearing Run Itemget
Query Clearing Run Itemsget
Reverse Clearing Runpost
Retrieve Clearing Runget
Add Clearing Runpost
Query Clearing Runget
SAF-T Configurations
Delete Saf-T configurationdelete
Update Saf-T configurationput
Retrieve Saf-T configurationget
Create Saf-T configurationpost
Query Saf-T configurationget
Tenant Configurations
Set polish credit memo flagpost
Get polish credit memo flagget

Document Output API
Translations
Delete Translationdelete
Update Translationpatch
Delete Translation Keydelete
Get Translationsget
Store Translationspost
Translation Configurations
Get Configured Localesget
Get All Translationsget
Document Creation Configurations
Update configurationput
Retrieve configurationget
Files
Retrieve attachmentget
Retrieve attachmentsget
Retrieve a fileget

Tax API
Tax Calculation
Calculate tax for a documentpost
Tax Rules Configuration
Add variant to tax rulepost
Create tax rulepost
Query tax rulesget
Retrieve tax rule variantget
Update tax ruleput
Retrieve tax ruleget
Tax Provider Configuration
Get all enabled tax providers for tenantget
Delete tax properties for a providerdelete
Get tax properties for a providerget
Create tax properties for a providerpost
Update tax properties for a providerput
Delete tax provider credentialsdelete
Get username of tax provider credentials if presentget
Create or update tax provider credentialspost
Get usernames of all present tax provider credentialsget
Delete the tax provider configuration for a countrydelete
Create or update the tax provider configuration for a countrypost
Get the tax provider configurationsget
Tax Service Tenant Configuration
Create or update the tax service configuration for a tenant.post
Get the tax service configuration for a tenant.get
Tax Service Billing Group Configuration
Create or update the tax service configuration for a billing group.post
Get the tax service configuration for a billing group.get

Payment API
Customer Payment Accounts
Change health statuspost
Update a CustomerPaymentAccountput
Retrieve a CustomerPaymentAccountget
Create a CustomerPaymentAccountpost
Query CustomerPaymentAccountget
Merchant Payment Accounts
Delete MerchantPaymentAccountdelete
Update MerchantPaymentAccountput
Retrieve MerchantPaymentAccountget
Create MerchantPaymentAccountpost
Query MerchantPaymentAccountget
Merchant Payment Gateways
Update MerchantPaymentGatewayput
Create MerchantPaymentGatewaypost
Query MerchantPaymentGatewayget
Payment Providers
Delete settlement sourcedelete
Update settlement sourceput
Retrieve settlement sourceget
Create settlement sourcepost
Delete payment providerdelete
Retrieve payment providerget
Create payment providerpost
List payment providersget
Payment Categories
Enable or disable payment categorypatch
Delete payment categorydelete
Retrieve global payment category configurationget
Create payment categorypost
List payment categoriesget
Payment Transactions
Update status of the payment transactionpost
Update payment transactionpatch
Retrieve payment transactionget
Create payment transactionpost
Query payment transactions for a merchant payment accountget
Payment Categorization Rules
Query payment categorization rulesget
delete a payment categorization ruledelete
Update a payment categorization ruleput
get a payment categorization ruleget
Create a payment categorization rulepost
Payment Intents
Retry PaymentIntentpost
Cancel PaymentIntentpost
Retrieve PaymentIntentget
Get processing enabled status.get
Enable payment intentpost
Create PaymentIntentpost
Query payment intentget
Payment Intent Tasks
Cancel PaymentIntentTaskpost
Update Payment Intent Taskpatch
Retrieve Payment Intent Taskget
Enable payment intent taskspost
Query Payment Intent Taskget
Settlements
Retrieve settlement itemget
Query settlement itemsget
Query settlement reportsget
Upload settlement reportpost
Create settlement itempost
Retrieve settlement reportget
Create settlement reportpost
Query settlement reports by merchant payment accountget
Query settlement items per merchant payment accountget

Payment Assignment API
Assignments
Reverse payment assignmentpost
Retrieve payment assignmentget
Assign Paymentpost
Query payment assignmentsget
Assignment Configuration
Delete regex matching strategydelete
Update regex matching strategyput
Create regex matching strategypost
Query regex matching strategiesget
Delete payment account assignment configurationsdelete
Create or update payment account's assignment configurationspost
Retrieve payment account's assignment configurationget

Bookkeeping API
preview
Reopen booking periodpost
Close booking periodpost
Create a booking periodpost
List booking periodsget
List booking entries (csv format)get
Create booking entriespost
Query accounting document number configurationsget
Create accounting document number configurationpost
List accounting document number configurationsget
Booking Accounts
Remove booking accountdelete
Update booking accountput
Retrieve booking accountsget
Create booking accountpost
Retrieve booking accountsget
Booking Entries
Query booking entriesget
Clearing
Delete clearingdelete
Retrieve clearingget
Clear booking entriespost
Query clearingsget

Booking Engine API
preview
Fetch currently used active rule for tenantget
Fetch all deposit rules for tenantIdget
Delete deposit ruledelete
Fetching deposit rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all document rules for tenantget
Delete document ruledelete
Fetching document rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all opos case decision rules for tenantget
Fetch currently used active rule for tenantget
Fetch all opos case decision reversed rules for tenantget
Delete opos case decision reversed ruledelete
Fetching opos case decision reversed rule's scriptsget
Delete opos case decision ruledelete
Fetching opos case decision rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment assignment processed rules for tenantget
Delete payment assignment processed ruledelete
Fetching payment assignment processed rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment transaction categorized rules for tenantIdget
Delete payment transaction categorized ruledelete
Fetching payment transaction categorized rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment invoice assignment reversed rules for tenantget
Delete payment invoice assignment reversed ruledelete
Fetching payment invoice assignment reversed rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment settled rules for tenantIdget
Delete payment settled ruledelete
Fetching payment settled rule's scriptsget
Retrigger the processing of stored events of a specific event typepost
Create deposit rulepost
Create document rulepost
Fetch document rules using businessSegment, country and tenantIdget
Create opos case decision reversed rulepost
Create opos case decision rulepost
Create payment assignment processed rulepost
Create payment transaction categorized rulepost
Create payment invoice assignment reversed rulepost
Create payment settled rulepost

Currency Converter API
Currency Converter
Convert currencypost
Update tenant configurationput
Retrieve tenant configurationget
Post self provided exchange ratespost
Get exchange ratesget

Report API
Report Files
Delete reportdelete
Download reportget
Query reportsget
Delete reports of perioddelete
Query reports for periodget

Notification API
Notifications
Resend notificationpost
Retrieve notificationget
Resend notificationspost
Query notificationsget
Notification Configuration
Delete Notification Configurationdelete
Create Notification Security Configurationpost
Update Notification Security Configurationput
Get Notification Security Configurationget
Delete Notification Routedelete
Get NotificationTypesget
Add Notification Route Configurationpost
Update Route for Notification Configurationput
Get Routesget

Basware Adapter API
Basware country configuration
Update Basware country configurationpost
Get Basware country configurationget
Get all Basware country configurationsget
Basware forward route configuration
Delete Forward Routedelete
Store Forward Routepost
Get All Forward Routesget
Basware credential configuration
Delete Basware credentials configurationdelete
Create or update Basware credentials configurationpost
Get Basware credentials configurationget
Basware forward route resolver
Resolve Routeget
Basware workflows
Update recipient code and resend workflowpost
Retrigger workflowpost
Retrieve workflowget
Query workflowsget
Basware enums
Get used enumerationsget

Billing Preparation API
Billing Group Configuration
Update billing preparation billing group configpost
Get billing preparation billing group configget

Getting started
OpenAPI Specification (OAS)

Customer API
preview
Deprecated: Anonymize customerpost
Anonymize customerpost
Customers
Update addressput
Retrieve addressget
Query customer addressesget
Create addresspost
Update customerput
Retrieve customerget
Query customersget
Create customerpost
Configurations
Delete address validation configdelete
Get address validation configget
Create or update address validation configpost
Get all address validation configsget
Check validation of all addressespost
Customers (deprecated)
Query customer addresses (unpaged)get
Query customers (unpaged)get
Debtors (deprecated)
Deprecated: Update customerput
Deprecated: Retrieve customerget
Deprecated: Create customerpost
Deprecated: List debtorsget
Debtors Addresses (deprecated)
Deprecated: Update addressput
Deprecated: Retrieve addressget
Deprecated: Create addresspost
Deprecated: Query customer addressesget

Billing API
Billing Groups
Query business segmentsget
Update splitting configput
Set as defaultpost
Delete business segmentdelete
Update business segmentput
Retrieve business segmentget
Create business segmentpost
Delete billing groupdelete
Update billing groupput
Retrieve billing groupget
Create billing grouppost
Get a paged result of all billing groupsget
Orders
Delete agreed deposit of line itemdelete
Update agreed deposit of line itemput
Add agreed deposit to line itempost
Query agreed deposits of line itemget
Edit line itemput
Retrieve line itemget
Cancel line itemspost
Add line itempost
Query line itemsget
Query billable itemsget
Update allowancesput
Cancel allowancespost
Add allowancespost
Delete an agreed deposit that is assigned to an orderdelete
Update an agreed deposit that is assigned to an orderput
Add multiple order agreed depositspost
Query agreed order depositsget
Retry failed billable itemspost
Prepare document creation for entire orderpost
Cancel orderpost
Update orderpatch
Retrieve orderget
Delete attachmentdelete
Retrieve attachmentget
Add attachmentpost
Query ordersget
Cancel orderspost
Create orderpost
Retrieve billable itemget
Plans and Options
Delete plandelete
Update planput
Retrieve planget
Add option to a phase of a planpost
Query plansget
Create planpost
Query plansget
Delete optiondelete
Update optionput
Retrieve optionget
Create optionpost
Get a page of all plan optionsget
Contracts
Delete attachmentdelete
Retrieve attachmentget
Add attachmentpost
Query attachmentsget
Query billable itemsget
Update contractpatch
Retrieve contractget
get contract termsget
remove related contracts from contractpost
add related contracts to contractpost
query related contractsget
Edit line itemput
Retrieve line itemget
Cancel line itemspost
Add line itempost
Query line itemsget
Delete allowancedelete
Update allowanceput
Retrieve allowanceget
Create allowancepost
Query allowancesget
Termination adaptionpost
Extraordinary terminationpost
Terminate a contractpost
Retry failed billable itemspost
Enable additional options for a contract.post
Activate contractpost
Query contractsget
Set items on holdpost
Extraordinary terminations.post
Create credit billable itempost
Query attachmentsget
Prepare document creation for certain itemspost
Terminate contractspost
Cancel contractspost
Create contractpost
Start billing runpost
Retrieve billable itemget
Usages
Retrieve usageget
Query usagesget
Cancel usagespost
Delete usagesdelete
Create usagepost
Query usagesget
Billable Items
Query billable itemsget
Query billable itemsget
Invoices
Reissue invoicepost
Reissue documentpost
Price Adaptations
Delete price adaptations valuedelete
Update price adaptations valueput
Retrieve price adaptations valueget
Create price adaptation valuepost
Query price adaptation valuesget
Delete price adaptationdelete
Retrieve price adaptationget
Create price adaptationpost
Query price adaptationget
Orders (deprecated)
Generate closing invoicepost
Create credit billable itempost
Cancel orderpatch
Create billable itempost
Query orders (unpaged)get
Contracts (deprecated)
Set items on holdpost
Prepare document creation for certain itemspost
Terminate contract by idpost
Create closing invoicepost
Cancel contractpatch
Terminate contract by identpost
Create billable itempost
Query contracts (unpaged)get

Usage API
Rated usages
Retry or reactivate rated usagepost
Cancel rated usagepost
Retrieve rated usageget
Create rated usagepost
Query rated usagesget
Rated usage aggregations
Close rated usage aggregationpost
Retrieve rated usage aggregationget
Query rated usage aggregationsget

Data Access API
Invoices
Retrieve invoiceget
Query invoicesget

Invoice API
Documents
Retrieve document aggregationsget
Retrieve documentget
Retrieve self billing invoiceget
Create self billing invoicepost
Retrieve self billing invoice correctionget
Create self billing invoice correctionpost
Retrieve document processing status by requestIdget
Retrieve invoiceget
Create invoicepost
Retrieve deposit invoiceget
Create deposit invoicepost
Retrieve deposit invoice correctionget
Create deposit invoice correctionpost
Retrieve credit memoget
Create credit memopost
Query documentsget
Document Labels
Remove Labelpost
Add Labelpost
Query Labelsget
Aggregation Configurations
Delete Aggregationdelete
Update Aggregationput
Retrieve Aggregationget
Create Aggregationpost
Query Aggregationget
Document Number Configurations
Select document number strategypost
Document number strategyget
Delete service country number strategydelete
Update service country number strategyput
Create service country number strategypost
Search service country number strategiesget
Delete document type number strategydelete
Update document type number strategyput
Create document type number strategypost
Query document type number strategiesget
Delete default number strategydelete
Create default number strategypost
Get default number strategyget
Delete billing group number strategydelete
Update billing group number strategyput
Create billing group number strategypost
Search billing group number strategiesget
Delete counterdelete
Update counterput
Create counterpost
Query countersget
Dunning Configurations
Create dunning configurationpost
Retrieve dunning configurationget
Dunning Status Aggregations
Lists dunning status aggregation documentsget
Retrieve dunning status aggregationget
Operating Site Configurations
Delete tax registrationsdelete
Create tax registrationspost
Query tax registrationsget
Make Operating Site Defaultpost
Delete Operating Sitedelete
Update Operating Siteput
Retrieve Operating Siteget
Create Operating Sitepost
Query Operating Siteget
OPOS Cases
Update OposCase Dunning Block stateput
Revert a Decision for OPOS Casepost
Retrieve Decision for OPOS Caseget
Add Decision for OPOS Casepost
Query Decisions for OPOS Casesget
Reevaluation of OposCasepost
Recalculation and Reevaluation of OposCasepost
Enable OposCase payment collectionpost
Retrieve OPOS Caseget
Query OPOS Casesget
Query Decisionsget
OPOS Case Clearing Runs
Retrieve Clearing Run Itemget
Query Clearing Run Itemsget
Reverse Clearing Runpost
Retrieve Clearing Runget
Add Clearing Runpost
Query Clearing Runget
SAF-T Configurations
Delete Saf-T configurationdelete
Update Saf-T configurationput
Retrieve Saf-T configurationget
Create Saf-T configurationpost
Query Saf-T configurationget
Tenant Configurations
Set polish credit memo flagpost
Get polish credit memo flagget

Document Output API
Translations
Delete Translationdelete
Update Translationpatch
Delete Translation Keydelete
Get Translationsget
Store Translationspost
Translation Configurations
Get Configured Localesget
Get All Translationsget
Document Creation Configurations
Update configurationput
Retrieve configurationget
Files
Retrieve attachmentget
Retrieve attachmentsget
Retrieve a fileget

Tax API
Tax Calculation
Calculate tax for a documentpost
Tax Rules Configuration
Add variant to tax rulepost
Create tax rulepost
Query tax rulesget
Retrieve tax rule variantget
Update tax ruleput
Retrieve tax ruleget
Tax Provider Configuration
Get all enabled tax providers for tenantget
Delete tax properties for a providerdelete
Get tax properties for a providerget
Create tax properties for a providerpost
Update tax properties for a providerput
Delete tax provider credentialsdelete
Get username of tax provider credentials if presentget
Create or update tax provider credentialspost
Get usernames of all present tax provider credentialsget
Delete the tax provider configuration for a countrydelete
Create or update the tax provider configuration for a countrypost
Get the tax provider configurationsget
Tax Service Tenant Configuration
Create or update the tax service configuration for a tenant.post
Get the tax service configuration for a tenant.get
Tax Service Billing Group Configuration
Create or update the tax service configuration for a billing group.post
Get the tax service configuration for a billing group.get

Payment API
Customer Payment Accounts
Change health statuspost
Update a CustomerPaymentAccountput
Retrieve a CustomerPaymentAccountget
Create a CustomerPaymentAccountpost
Query CustomerPaymentAccountget
Merchant Payment Accounts
Delete MerchantPaymentAccountdelete
Update MerchantPaymentAccountput
Retrieve MerchantPaymentAccountget
Create MerchantPaymentAccountpost
Query MerchantPaymentAccountget
Merchant Payment Gateways
Update MerchantPaymentGatewayput
Create MerchantPaymentGatewaypost
Query MerchantPaymentGatewayget
Payment Providers
Delete settlement sourcedelete
Update settlement sourceput
Retrieve settlement sourceget
Create settlement sourcepost
Delete payment providerdelete
Retrieve payment providerget
Create payment providerpost
List payment providersget
Payment Categories
Enable or disable payment categorypatch
Delete payment categorydelete
Retrieve global payment category configurationget
Create payment categorypost
List payment categoriesget
Payment Transactions
Update status of the payment transactionpost
Update payment transactionpatch
Retrieve payment transactionget
Create payment transactionpost
Query payment transactions for a merchant payment accountget
Payment Categorization Rules
Query payment categorization rulesget
delete a payment categorization ruledelete
Update a payment categorization ruleput
get a payment categorization ruleget
Create a payment categorization rulepost
Payment Intents
Retry PaymentIntentpost
Cancel PaymentIntentpost
Retrieve PaymentIntentget
Get processing enabled status.get
Enable payment intentpost
Create PaymentIntentpost
Query payment intentget
Payment Intent Tasks
Cancel PaymentIntentTaskpost
Update Payment Intent Taskpatch
Retrieve Payment Intent Taskget
Enable payment intent taskspost
Query Payment Intent Taskget
Settlements
Retrieve settlement itemget
Query settlement itemsget
Query settlement reportsget
Upload settlement reportpost
Create settlement itempost
Retrieve settlement reportget
Create settlement reportpost
Query settlement reports by merchant payment accountget
Query settlement items per merchant payment accountget

Payment Assignment API
Assignments
Reverse payment assignmentpost
Retrieve payment assignmentget
Assign Paymentpost
Query payment assignmentsget
Assignment Configuration
Delete regex matching strategydelete
Update regex matching strategyput
Create regex matching strategypost
Query regex matching strategiesget
Delete payment account assignment configurationsdelete
Create or update payment account's assignment configurationspost
Retrieve payment account's assignment configurationget

Bookkeeping API
preview
Reopen booking periodpost
Close booking periodpost
Create a booking periodpost
List booking periodsget
List booking entries (csv format)get
Create booking entriespost
Query accounting document number configurationsget
Create accounting document number configurationpost
List accounting document number configurationsget
Booking Accounts
Remove booking accountdelete
Update booking accountput
Retrieve booking accountsget
Create booking accountpost
Retrieve booking accountsget
Booking Entries
Query booking entriesget
Clearing
Delete clearingdelete
Retrieve clearingget
Clear booking entriespost
Query clearingsget

Booking Engine API
preview
Fetch currently used active rule for tenantget
Fetch all deposit rules for tenantIdget
Delete deposit ruledelete
Fetching deposit rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all document rules for tenantget
Delete document ruledelete
Fetching document rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all opos case decision rules for tenantget
Fetch currently used active rule for tenantget
Fetch all opos case decision reversed rules for tenantget
Delete opos case decision reversed ruledelete
Fetching opos case decision reversed rule's scriptsget
Delete opos case decision ruledelete
Fetching opos case decision rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment assignment processed rules for tenantget
Delete payment assignment processed ruledelete
Fetching payment assignment processed rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment transaction categorized rules for tenantIdget
Delete payment transaction categorized ruledelete
Fetching payment transaction categorized rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment invoice assignment reversed rules for tenantget
Delete payment invoice assignment reversed ruledelete
Fetching payment invoice assignment reversed rule's scriptsget
Fetch currently used active rule for tenantget
Fetch all payment settled rules for tenantIdget
Delete payment settled ruledelete
Fetching payment settled rule's scriptsget
Retrigger the processing of stored events of a specific event typepost
Create deposit rulepost
Create document rulepost
Fetch document rules using businessSegment, country and tenantIdget
Create opos case decision reversed rulepost
Create opos case decision rulepost
Create payment assignment processed rulepost
Create payment transaction categorized rulepost
Create payment invoice assignment reversed rulepost
Create payment settled rulepost

Currency Converter API
Currency Converter
Convert currencypost
Update tenant configurationput
Retrieve tenant configurationget
Post self provided exchange ratespost
Get exchange ratesget

Report API
Report Files
Delete reportdelete
Download reportget
Query reportsget
Delete reports of perioddelete
Query reports for periodget

Notification API
Notifications
Resend notificationpost
Retrieve notificationget
Resend notificationspost
Query notificationsget
Notification Configuration
Delete Notification Configurationdelete
Create Notification Security Configurationpost
Update Notification Security Configurationput
Get Notification Security Configurationget
Delete Notification Routedelete
Get NotificationTypesget
Add Notification Route Configurationpost
Update Route for Notification Configurationput
Get Routesget

Basware Adapter API
Basware country configuration
Update Basware country configurationpost
Get Basware country configurationget
Get all Basware country configurationsget
Basware forward route configuration
Delete Forward Routedelete
Store Forward Routepost
Get All Forward Routesget
Basware credential configuration
Delete Basware credentials configurationdelete
Create or update Basware credentials configurationpost
Get Basware credentials configurationget
Basware forward route resolver
Resolve Routeget
Basware workflows
Update recipient code and resend workflowpost
Retrigger workflowpost
Retrieve workflowget
Query workflowsget
Basware enums
Get used enumerationsget

Billing Preparation API
Billing Group Configuration
Update billing preparation billing group configpost
Get billing preparation billing group configget

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX