Skip to content

Rights catalogue

The Right column is the exact value you add to a role to grant it (the string you type when assigning rights in the Operations Portal). Endpoints reject calls with 403 ACCESS_DENIED when the principal is missing the required right.

3 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CreateAmlMonitoringEventsRecord anti-money laundering monitoring results.POST /events/aml-monitoring-result--
ManageTransactionMonitoringAdd notes and override AML transaction-monitoring hits.POST /aml/transaction-monitoring/<id_>/notes
POST /aml/transaction-monitoring/<id_>/override
AML -> Override hit status-
ViewTransactionMonitoringView and search AML transaction monitoring rules and hits.GET /aml/transaction-monitoring/<id_>
POST /aml/transaction-monitoring/events/search
POST /aml/transaction-monitoring/search
AML -> Search transaction monitoring
AML -> View monitoring events
-

6 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CreateArticleLabelsCreate labels for articles within an invoice.POST /invoices/<invoice_id>/article_labels--
ReadArticleView details of a reusable invoice line item.GET /articles/<id_>--
ReadArticlesList reusable invoice line items.GET /articles--
ReadArticleLabelsView labels for articles in an invoice.GET /invoices/<invoice_id>/article_labels--
SearchArticlesSearch articles.POST /articles/searchGlobal Settings -> Search articles-
UpdateArticlesUpdate reusable invoice line items individually or in bulk.PUT /articles/<id_>
PUT /articles/bulk-update
Global Settings -> Update articles-

14 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
BookkeepBillsRecord service bills issued by the platform to clients.PUT /bills/bookkeepDaily Routines -> Bookkeep bills-
BookkeepPaymentBatchesBookkeep grouped payment ingestion files.PUT /payment-batches/<id_>/bookkeepDaily Routines -> Bookkeep payment batches-
CalculateBalanceBookkeepingAccountsRecalculate balances for bookkeeping accounts.PUT /bookkeeping-accounts/<id_>/calculate-balance--
CreateBookkeepingAccountCreate a bookkeeping account.POST /bookkeeping-accountsAccounting -> Create bookkeeping account-
ExportBookkeepingFileExport a generated bookkeeping file.PUT /bookkeeping-files/<id_>/export--
GenerateBookkeepingFileGenerate bookkeeping files.PUT /bookkeeping-files/generate--
GenerateInternalBookkeepingFileGenerate internal bookkeeping files for accounting.PUT /bookkeeping-files/internal/generateAccounting -> Generate bookkeeping files-
ReadBookkeepingAccountView details of a bookkeeping account.GET /bookkeeping-accounts/<id_>Accounting -> View account-
ReadBookkeepingAccountsList bookkeeping accounts.GET /bookkeeping-accounts--
ReadBookkeepingFileView a generated bookkeeping file by ID.GET /bookkeeping-files/<id_>--
ReadBookkeepingFilesList generated bookkeeping files.GET /bookkeeping-files--
SearchBookkeepingAccountsSearch bookkeeping accounts.POST /bookkeeping-accounts/searchAccounting -> Search accountsConfigure -> Search accounts
SearchBookkeepingFilesSearch generated bookkeeping files.POST /bookkeeping-files/searchAccounting -> Search files-
UpdateBookkeepingAccountUpdate bookkeeping account settings.PUT /bookkeeping-accounts/<id_>Accounting -> Update bookkeepingConfigure -> Update bookkeeping

25 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
AddToArchiveBusinessLoansAdd a business loan record to the archive.PUT /business-loans/<id_>/archive/add--
CreateBusinessLoanCreate a business loan.POST /business-loans--
CreateBusinessLoanToDoPOST /business-loan/todo--
CreateBusinessLoanWithdrawalCreate a withdrawal request for a business loan that requires dual confirmation.PUT /business-loans/<id_>/withdraw--
CreateLoanProfileCreate and update loan profiles.POST /loan-profiles
PUT /loan-profiles/<loan_profile_id>
--
CreditDecisionApproveBusinessLoansApprove the credit decision for a business loan.PUT /business-loans/<id_>/credit-decision/approve--
CreditDecisionDenyBusinessLoansDeny the credit decision for a business loan.PUT /business-loans/<id_>/credit-decision/deny--
DeleteBusinessLoanToDoDelete a to-do item from a business loan.DELETE /business-loan/todo/<business_loan_id>/<id>--
GetBusinessLoanToDoGET /business-loan/todo/<business_loan_id>
GET /business-loan/todo/<business_loan_id>/<id>
--
InstallmentSummaryBusinessLoansUpdate installment summaries for business loans individually or in bulk.PUT /business-loans/<id_>/installment/summary
PUT /business-loans/installment/summary
--
ReadBusinessLoanGET /business-loans/<id_>
GET /business-loans/<id_>/fees
GET /business-loans/<id_>/guarantors
GET /business-loans/<id_>/profile
--
ReadBusinessLoanChangelogView change history for business loans.GET /changelog/business-loan
GET /changelog/business-loan/<id_>
--
ReadBusinessLoanEventView a single business loan event.GET /business-loans/events/<id_>--
ReadBusinessLoanEventsList business loan events.GET /business-loans/events--
ReadBusinessLoanFinancialEventsView financial events for business loans.GET /business-loans/<business_loan_id>/financial-events--
ReadBusinessLoanLedgerEventView a single business loan ledger event.GET /business-loans/events/ledger/<id_>--
ReadBusinessLoanLedgerEventsList business loan ledger events.GET /business-loans/events/ledger--
ReadLoanProfileSearch and view loan profile details.GET /loan-profiles/<loan_profile_id>
POST /loan-profiles/search
--
RemoveFromArchiveBusinessLoansRemove archived business loans.PUT /business-loans/<id_>/archive/remove--
SearchBusinessLoanToDoSearch business loan todos.POST /business-loan/todo/search--
SearchBusinessLoansSearch business loans.POST /business-loans/search--
SearchBusinessLoanEventsSearch business loan events.POST /business-loans/events/search--
SearchBusinessLoanLedgerEventsSearch business loan ledger events.POST /business-loans/events/ledger/search--
UpdateBusinessLoanUpdate business loans and loan profiles.PUT /business-loans/<id_>
PUT /business-loans/<id_>/profile
--
UpdateBusinessLoanToDoPUT /business-loan/todo/<business_loan_id>/<id>--

142 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
ApplyClientProductsApply a client product binding.PUT /client-products/<id_>/apply--
BookClientUnplacedPaymentPUT /unplaced-payments/client/<id_>/link/book
PUT /unplaced-payments/client/<id_>/link/<link_id>/book
Daily Routines -> Book unplaced payments-
CalculateBalanceClientAccountsRecalculate balances for client accounts.PUT /client-accounts/<id_>/calculate-balanceAccounting -> Calculate account balance-
ConnectClientToClientHandlerConnect or disconnect clients to client handlers.DELETE /client-handlers/<id_>/connect/<client_id>
PUT /client-handlers/<id_>/connect/<client_id>
Registry -> Connect to client handler-
ConnectClientToErpLink a client to an ERP integration.PUT /erps/<id_>/connect/<client_id>--
ConnectClientToGitLink a client to a Git repository.PUT /clients/<client_id>/connect-to-git--
ConnectErpToClientLink an ERP system to a client.PUT /clients/<id_>/erp-connectRegistry -> Connect ERP systemConfigure -> Connect ERP system
ConnectLogotypeToClientAttach a logo to a client.PUT /clients/<id_>/logotypeRegistry -> Attach client logo-
CreateClientAccountCreate a client account.POST /client-accounts--
CreateClientAccountTransactionCreate a client account transaction.POST /client-account-transactionsAccounting -> Create account transaction-
CreateClientArticlePOST /clients/articles-Configure -> Create article
CreateClientBankAccountCreate client bank account profiles and accounts.POST /client-bank-account
POST /client-bank-account-profile
Registry -> Manage bank accounts-
CreateClientDocumentSettingPOST /clients/<id_>/document-settingClientTransactionReports -> Configure document setting-
CreateClientEmailRecipientPOST /clients/<id_>/email-recipientsRegistry -> Manage email recipients-
CreateClientGroupsCreate a client group for shared settings and rollups.POST /client-groups--
CreateClientGroupClientsPOST /client-groups/<id_>/clients--
CreateClientHandlersCreate a client handler.POST /client-handlers--
CreateClientInvoiceRequestCreate a client invoice request.POST /client-invoice-request-Dashboard -> Request invoice
CreateClientInvoiceRequestCommentPOST /client-invoice-request/<id>/comment--
CreateClientInvoiceRequestDocumentUpload an attachment to a client invoice request.POST /client-invoice-request/<id>/documents--
CreateClientLabelsCreate labels for clients.POST /clients/<client_id>/labelsRegistry -> Create labels-
CreateClientPaymentReferenceSettingsCreate payment reference settings for client accounts, collection batches, and invoices.POST /client-account-payment-reference-settings
POST /collection-batch-payment-reference-settings
POST /invoice-payment-reference-settings
--
CreateClientSyncInvoicesTrigger an invoice sync for a client.POST /clients/<client_id>/sync/invoicesRegistry -> Sync invoicesSync -> Sync invoices
CreateClientToDoCreate todo items for clients.POST /client/todoRegistry -> Create todo-
CreateClientTransferTextCreate client transfer texts.POST /client-transfer-textRegistry -> Create transfer text-
CreateClientUserCreate client user accounts.POST /client-usersRegistry -> Create user-
CreateClientsCreate new clients.POST /clients--
CreatePaymentTransactionsClientRestrictedCreate inbound debtor payments and reconcile them to invoices.POST /payments
POST /payments/multiple
--
CreatePayoutForClientAccountsUpdate payout configuration for a client account.PUT /client-accounts/<id_>/payoutAccounting -> Configure payout-
DeclineMultipleClientInvoiceRequestDecline multiple client invoice requests in a single action.PUT /client-invoice-request/decline-multiple--
DeleteClientArticleDelete articles owned by a specific client.DELETE /clients/articles/<id_>-Configure -> Delete article
DeleteClientBankAccountDelete a client bank account.DELETE /client-bank-account/<id>Registry -> Delete bank account-
DeleteClientEmailRecipientDelete email recipients configured for a client.DELETE /clients/<id_>/email-recipients/<er_id_>Registry -> Remove email recipient-
DeleteClientGroupsDelete a client group.DELETE /client-groups/<id_>--
DeleteClientGroupClientsRemove clients from a client group.DELETE /client-groups/<id_>/clients/<client_id>--
DeleteClientLabelsDelete labels assigned to a client.DELETE /clients/<client_id>/labels/<id>Registry -> Delete client label-
DeleteClientUserDelete a client user account.DELETE /client-users/<id_>Environment -> Delete user-
DenyClientUnplacedPaymentDeny a client’s link to an unplaced payment.PUT /unplaced-payments/client/<id_>/link/deny
PUT /unplaced-payments/client/<id_>/link/<link_id>/deny
Daily Routines -> Import Payments -> Client Link Requests -> Deny payment link-
DisableClientSyncPUT /clients/<client_id>/sync/disable
PUT /clients/<client_id>/sync/reset
Registry -> Disable sync-
EnableClientSyncEnable external-system sync for a client.PUT /clients/<client_id>/sync/enableRegistry -> Enable syncConfigure -> Enable sync
GenerateClientTokenGenerate a token for a client.POST /token/client/generate-Configure -> Generate token
GetClientCreditDecisionStatusView factoring buy/sell decisions for clients.GET /factoring-decisions/clients/<id_>--
GetClientPaymentReferenceSettingsView payment reference settings for clients, invoices, and collection batches.GET /client-account-payment-reference-settings/<id_>
GET /client-account-payment-reference-settings/client-account/<client_account_id>
GET /collection-batch-payment-reference-settings/<id_>
GET /collection-batch-payment-reference-settings/client/<client_id>
GET /invoice-payment-reference-settings/<id_>
GET /invoice-payment-reference-settings/client/<client_id>
--
GetClientToDoGET /client/todo/<client_id>
GET /client/todo/<client_id>/<id>
--
IgnoreClientUnplacedPaymentMark an unplaced payment as ignored.PUT /unplaced-payments/client/<id_>/ignore-Unplaced payments -> Ignore payment
LinkClientUnplacedPaymentLink an unplaced payment to an invoice.PUT /unplaced-payments/client/<id_>/link-Unplaced payments -> Link payment
LinkUnplacedPaymentClientRestrictedAssign unmatched payments to invoices.PUT /unplaced-payments/<id_>/linkDaily Routines -> Link payment-
ManageClientSettingsView, update, and delete client configuration settings and flags.DELETE /settings/client/<client_id>/<setting_key>
GET /settings/client/<client_id>
GET /settings/client/flag/<client_id>
POST /settings/client/search
PUT /settings/client/<client_id>
PUT /settings/client/flag/<client_id>
Registry -> Manage settingsDashboard -> Manage settings
ManageOwnClientSettingsView and update client flag settings.GET /settings/client/flag
PUT /settings/client/flag
-Dashboard -> Manage settings
ReadClientView client company details and contact information.GET /clients/<id_>Registry -> View clientDashboard -> View client
ReadClientAccountView a client account by ID.GET /client-accounts/<id_>--
ReadClientAccountsView client accounts including balance and account configuration.GET /client-accounts--
ReadClientAccountTransactionView a client account transaction by ID.GET /client-account-transactions/<id_>--
ReadClientAccountTransactionsList client account transactions.GET /client-account-transactions--
ReadClientArticleView client articles.GET /clients/articles
GET /clients/articles/<id_>
--
ReadClientBankAccountView client bank account information and profiles.GET /client-bank-account-profile/<id>
GET /client-bank-account-profile/client/<client_id>
GET /client-bank-account/<id>
--
ReadClientBillingDetailsView client billing settings.GET /clients/<id_>/settings/billing--
ReadClientBookkeepingDetailsView client bookkeeping settings and configuration.GET /clients/<id_>/settings/bookkeeping--
ReadClientChangelogView change history for clients.GET /changelog/client
GET /changelog/client/<id_>
--
ReadSettingChangelogView change history for system settings.GET /changelog/system-setting
GET /changelog/system-setting/<key_>
System -> Settings-
ReadClientComplianceSettingView client compliance settings.GET /clients/<id_>/settings/compliance--
ReadClientCreditStatusView a credit status definition by ID.GET /credit-statuses/<id_>--
ReadClientCreditStatusesList credit status definitions.GET /credit-statuses--
ReadClientCreditStatusGlobalView a global credit status override by ID.GET /credit-status-global/<id_>--
ReadClientDocumentSettingView client document settings.GET /clients/<id_>/document-settingDaily Routines -> View document settings-
ReadClientEmailRecipientView email recipients configured for a client.GET /clients/<id_>/email-recipientsRegistry -> View email recipients-
ReadClientFinancingLimitsView consolidated financing limit breakdown for a client.GET /clients/<client_id>/financing-limits-Dashboard -> View financing limits
ReadClientGroupView a client group by ID.GET /client-groups/<id_>--
ReadClientGroupsList client groups.GET /client-groups--
ReadClientGroupClientsView clients within a specific client group.GET /client-groups/<id_>/clients--
ReadClientHandlerView details of a specific client handler.GET /client-handlers/<id_>--
ReadClientHandlersList all client handlers.GET /client-handlersRegistry -> View handlers-
ReadClientHandlerBillingDetailsView billing details for a client handler.GET /client-handlers/<id_>/billing-details--
ReadClientInvoiceDetailsView client invoice issuance settings.GET /clients/<client_id>/settings/invoiceRegistry -> View invoice settingsDashboard -> View invoice settings
ReadClientInvoiceRequestList and search client invoice requests.GET /client-invoice-request
GET /client-invoice-request/<id>
GET /client-invoice-request/enabled
POST /client-invoice-request/search
-Change requests -> View requests
ReadClientInvoiceTextSettingGET /clients/<id_>/settings/invoice-text
POST /clients/<id_>/settings/invoice-text
Registry -> View invoice text-
ReadClientLabelsView labels assigned to a client.GET /clients/<client_id>/labelsRegistry -> View labels-
ReadClientProductView details of a product binding for a client.GET /client-products/<id_>--
ReadClientProductsView product bindings (factoring, service, etc.) for clients.GET /client-products-Dashboard -> View products
ReadClientReminderProfilesView the default reminder profile for a client.GET /clients/<id_>/reminder-profiles/defaultRegistry -> View reminder profiles-
ReadDebtorReminderProfilesView the reminder profile set on a client debtor.GET /debtors/<id_>/reminder-profiles/default
GET /debtors/<id_>/reminder-profiles/effective
Registry -> View debtor reminder profiles-
ReadClientsList clients.GET /clients--
ReadClientSyncView client external-system sync status and last sync dates.GET /clients/<client_id>/syncRegistry -> View sync statusDashboard -> View sync status
ReadClientSyncInvoicesView and search synced invoices for a client.GET /clients/<client_id>/sync/invoices
POST /clients/<client_id>/sync/invoices/search
Registry -> View synced invoices-
ReadClientTransferTextSearch client transfer texts.POST /client-transfer-text/searchRegistry -> Search transfer text-
ReadClientUnplacedPaymentView a client-scoped unplaced payment by ID.GET /unplaced-payments/client/<id_>--
ReadClientUnplacedPaymentsList unplaced payments visible to clients.GET /unplaced-payments/client--
ReadClientUsersView client user accounts and details.GET /client-users
GET /client-users/<id_>
-Configure -> View users
ReadTemplateClientsView client financial price template engine rules and history.GET /client-financial-price-template/<id_>/clients/engine-rule
GET /client-financial-price-template/<id_>/clients/engine-rule/history
GET /client-financial-price-template/<id_>/clients/engine-rule/status
--
ReadUnplacedPaymentClientRestrictedView unplaced payments.GET /unplaced-payments/<unplaced_payment_id>Daily Routines -> View unplaced payments-
ReportStatusClientSyncPUT /clients/<client_id>/sync/status--
ReportSyncStatusClientInvoicesReport and manage invoice sync status for clients.PUT /clients/<client_id>/sync/invoices/status
PUT /clients/sync/invoices/status
--
ReturnClientUnplacedPaymentReturn unplaced payments to client.PUT /unplaced-payments/client/<unplaced_payment_id>/return-Invoices -> Return unplaced payment
ReturnUnplacedPaymentClientRestrictedReturn unplaced payments.PUT /unplaced-payments/<unplaced_payment_id>/returnDaily Routines -> Return unplaced-
SearchClientAccountsSearch client accounts.POST /client-accounts/searchAccounting -> Search client accounts-
SearchClientAccountTransactionsSearch client account transactions.POST /client-account-transactions/searchRegistry -> Search transactionsErrands -> Search transactions
SearchClientArticleSearch client articles.POST /clients/articles/search-Articles -> Search articles
SearchClientBankAccountSearch client bank accounts and profiles.POST /client-bank-account-profile/search
POST /client-bank-account/search
--
SearchClientChangelogSearch audit history for resource changes.POST /changelog/search--
SearchClientCreditDecisionStatusSearch client factoring decision status.POST /factoring-decisions/clients/daily/search
POST /factoring-decisions/clients/search
--
SearchClientCreditStatusesSearch credit status definitions.POST /credit-statuses/searchRegistry -> Search credit statuses-
SearchClientCreditStatusesGlobalSearch global credit status overrides.POST /credit-status-global/searchRegistry -> Search global credit statuses-
SearchClientGroupsSearch client groups.POST /client-groups/search--
SearchClientHandlersSearch client handlers.POST /client-handlers/search--
SearchClientPaymentReferenceSettingsSearch client account, collection batch, and invoice payment reference settings.POST /client-account-payment-reference-settings/search
POST /collection-batch-payment-reference-settings/search
POST /invoice-payment-reference-settings/search
--
SearchClientProductsSearch product bindings for clients.POST /client-products/searchRegistry -> Search products-
SearchClientToDoSearch client todos.POST /client/todo/searchEvents -> Search tasks-
SearchClientUnplacedPaymentsSearch unplaced payments.POST /unplaced-payments/client/search-Unplaced Payments -> Search payments
SearchClientUsersSearch client users.POST /client-users/searchEnvironment -> Search users-
SearchClientsSearch clients.POST /clients/searchRegistry -> Search clients-
SearchPreviousClientCollectionBatchPOST /collection-batches/previous-clients/search--
SearchUnplacedPaymentClientRestrictedView and search unplaced payments.GET /unplaced-payments
POST /unplaced-payments/search
Daily Routines -> Search unplaced payments-
ShowRestrictedSenderInformationForClientsWhen enabled, restricts (hides) sensitive sender information (account number, identification number, and address) on unplaced payments in the Client Portal. Without this right the full sender information is shown.--Unplaced Payments -> Restrict sender information
SupportAbortSyncClientInvoicesAbort invoice synchronization for a client.PUT /clients/<client_id>/sync/invoices/abortRegistry -> Abort sync-
ToggleClientProductsToggle product activation status for a client.PUT /client-products/<id_>/toggleRegistry -> Manage products-
TransferBetweenClientAccountsTransfer funds between client accounts.PUT /client-accounts/transferAccounting -> Transfer funds-
TransferBetweenClientAccountsFromTransactionTransfer funds between client accounts based on an existing client account transaction.PUT /client-accounts/transfer-from-transaction--
UpdateClientAccountUpdate a client account.PUT /client-accounts/<id_>Accounting -> Update account-
UpdateClientArticleUpdate client-owned articles.PUT /clients/articles/<id_>-Configure -> Update articles
UpdateClientBankAccountUpdate client bank account details and profiles.PUT /client-bank-account-profile/<id>
PUT /client-bank-account/<id>
Registry -> Update bank account-
UpdateClientBillingDetailsUpdate client billing details.PUT /clients/<id_>/settings/billingRegistry -> Update billing-
UpdateClientBookkeepingDetailsUpdate client bookkeeping settings and configuration.PUT /clients/<id_>/settings/bookkeepingRegistry -> Update client settingsConfigure -> Update bookkeeping settings
UpdateClientCollectionBatchUpdate the client assigned to a collection batch.PUT /collection-batches/<collection_batch_id>/update-client--
UpdateClientComplianceSettingsUpdate client compliance settings.PUT /clients/<id_>/settings/compliance--
UpdateClientCreditStatusesUpdate client credit statuses and global credit status overrides.PUT /credit-status-global/<id_>
PUT /credit-statuses/<id_>
PUT /credit-statuses/multiple-update
Registry -> Update credit statuses-
UpdateClientGroupsUpdate a client group.PUT /client-groups/<id_>--
UpdateClientHandlersUpdate a client handler.PUT /client-handlers/<id_>--
UpdateClientHandlerBillingDetailsUpdate billing details for a client handler.PUT /client-handlers/<id_>/billing-details--
UpdateClientInvoiceDetailsUpdate per-client invoice issuance settings.PUT /clients/<client_id>/settings/invoiceRegistry -> Update invoice settings-
UpdateClientInvoiceRequestUpdate a client invoice request.PUT /client-invoice-request/<id>--
UpdateClientInvoiceTextSettingsUpdate invoice text settings for a client.PUT /clients/<id_>/settings/invoice-text--
UpdateClientLabelsUpdate labels for a client.PUT /clients/<client_id>/labels/<id>Registry -> Update labels-
UpdateClientPaymentReferenceSettingsUpdate client account, collection batch, and invoice payment reference settings.PUT /client-account-payment-reference-settings/<id_>
PUT /collection-batch-payment-reference-settings/<id_>
PUT /invoice-payment-reference-settings/<id_>
--
UpdateClientPreferredLanguageUpdate a client’s preferred language.PUT /clients/<id_>/preferred-languageRegistry -> Update language-
UpdateClientProductsUpdate and manage client product bindings (factoring, service, etc.).PUT /client-products/<id_>
PUT /client-products/<id_>/default
Registry -> Manage product bindings-
UpdateClientReminderProfileUpdate the default reminder profile for a client.PUT /clients/<id_>/reminder-profiles/defaultRegistry -> Update reminder profile-
UpdateDebtorReminderProfileSet or remove the reminder profile on a client debtor.PUT /debtors/<id_>/reminder-profiles/default
DELETE /debtors/<id_>/reminder-profiles/default
Registry -> Update debtor reminder profile-
UpdateClientSyncReplace the external-system sync configuration for a client.PUT /clients/<client_id>/sync-Dashboard -> Configure sync
UpdateClientToDoUpdate and resolve client to-do items.PUT /client/todo/<client_id>/<id>
PUT /client/todo/resolve-multiple
Daily Routines -> Resolve to-do items-
UpdateClientTransferTextUpdate client transfer text.PUT /client-transfer-text/<id_>Registry -> Update transfer text-
UpdateClientsUpdate company details, contact information, and add-ons.PUT /clients/<id_>Registry -> Update client details-
UpdateTemplateClientsUpdate fee and interest template engine rules for clients.PUT /client-financial-price-template/<id_>/clients/engine-rule--

29 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CreateCreditDecisionStatusCreate credit decision statuses for the factoring kanban board.POST /credit-decision-status--
CreateCreditMonitoringCreate credit monitoring records for debtors and clients.POST /credit-monitoring/<identification_number_>--
CreateFactoringCountryAdd countries to the allowed list for factoring.POST /factoring-country--
CreateInstanceProviderCreditCheckSettingsCreate per-tenant credit-check settings.POST /instance-provider-credit-check-settings--
CreateServiceProviderCreditCheckSettingsCreate a credit-check policy record for a service provider.POST /service-provider-credit-check-settings--
CreditInsuranceCreate or update credit insurance agreements and view insurance history.GET /credit-insurance/history/<identification_number_>
POST /credit-insurance
--
CreditInsuranceSearchSearch credit insurance agreements and companies.POST /credit-insurance/company/search
POST /credit-insurance/search
--
DeleteCreditDecisionStatusDelete a credit decision status used to manage factoring kanban board columns.DELETE /credit-decision-status/<int:id>--
DeleteFactoringCountryDelete a factoring country configuration.DELETE /factoring-country/<code>--
GetFactoringManualControlView factoring manual control rules.GET /engine-rule/factoring-manual-control/<client_id>Registry -> View factoring rules-
PostCreditDataSubmit credit data for clients and debtors.POST /clients/<id_>/credit-data
POST /debtors/<id_>/credit-data
--
ReadCreditDataView credit data for system debtors, clients, and debtors.GET /clients/<id_>/credit-data
GET /debtors/<id_>/credit-data
GET /debtors/system-debtor/<identification_number_>/credit-data
GET /system-debtors/<identification_number>/credit-data
POST /debtors/system-debtor/credit-data/search
POST /system-debtors/credit-data/search
Registry -> View credit data-
ReadCreditDecisionStatusView and search credit decision statuses used to manage factoring workflow columns.GET /credit-decision-status
GET /credit-decision-status/<int:id>
POST /credit-decision-status/search
Factoring -> View decision statuses-
ReadCreditMonitoringView credit history monitoring data for clients and debtors.GET /clients/<identification_number_>/credit-history-monitoring
GET /credit-monitoring/<identification_number_>
GET /debtors/<identification_number_>/credit-history-monitoring
--
ReadFactoringCountryView and search factoring countries used for financing eligibility.GET /factoring-country
GET /factoring-country/<code>
POST /factoring-country/search
Factoring -> View countries-
ReadInstanceProviderCreditCheckSettingsView per-tenant credit check defaults and settings.GET /instance-provider-credit-check-settings
GET /instance-provider-credit-check-settings/<id_>
GET /instance-provider-credit-check-settings/instance-provider/<instance_provider_id>
--
ReadServiceProviderCreditCheckSettingsView service provider credit check policies and settings.GET /service-provider-credit-check-settings
GET /service-provider-credit-check-settings/<id_>
GET /service-provider-credit-check-settings/service-provider/<service_provider_id>
Environment -> View provider settings-
ReadStatisticFactoringRetrieve factoring portfolio financing rate statistics.POST /statistics/factoring/financing-rate/<client_id>-Dashboard -> View factoring stats
RemoveCreditMonitoringRemove a credit monitoring entry.PUT /credit-monitoring/<identification_number_>/remove--
SearchCreditMonitoringSearch credit monitoring data.POST /credit-monitoring/search--
SearchInstanceProviderCreditCheckSettingsSearch per-tenant credit-check default settings.POST /instance-provider-credit-check-settings/search--
SearchServiceProviderCreditCheckSettingsSearch credit-check policies for service providers.POST /service-provider-credit-check-settings/search--
SetFactoringManualControlSet manual control for factoring rules.PUT /engine-rule/factoring-manual-control/<client_id>Registry -> Configure factoring-
SingleCreditCheckCollectionBatchRequest a credit check for a debtor.POST /debtors/credit_check--
UpdateCreditDecisionStatusUpdate and move credit decision statuses for factoring decisions and business loans.PUT /business-loans/<id_>/credit-decision/move
PUT /credit-decision-status/<int:id>
PUT /credit-decision-status/bulk-update
PUT /factoring-decisions/<id_>/move
PUT /factoring-decisions/<invoice_id>/factoring
PUT /factoring-decisions/move
Registry -> Update credit decisions-
UpdateExternalFactoringDecisionPUT /factoring-decisions/<id_>/move-external--
UpdateFactoringCountryPUT /factoring-country/<code>--
UpdateInstanceProviderCreditCheckSettingsUpdate the credit check default settings for your tenant.PUT /instance-provider-credit-check-settings/<id_>--
UpdateServiceProviderCreditCheckSettingsUpdate credit-check policies for service providers.PUT /service-provider-credit-check-settings/<id_>Registry -> Configure credit checks-

82 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CalculateBalanceDebtorsRecalculate balances for debtors.PUT /debtors/<id_>/calculate-balance--
CreateClientDebtorPayoutAccountsCreate a payout account override for a specific client or debtor.POST /client-debtor-payout-accountsRegistry -> Configure payout-
CreateCreditInsuranceClientDebtorRequest and manage credit insurance limits for client debtors.POST /credit-insurance-client-debtor/manual
POST /credit-insurance-client-debtor/request-limit
--
CreateDebtorLabelsCreate labels for a debtor.POST /debtors/<debtor_id>/labelsRegistry -> Create labels-
CreateDebtorToDoCreate todo items for debtors.POST /debtor/todoRegistry -> Create todo-
CreateDebtorTypeCreate debtor subtype classifications.POST /debtor-subtypeGlobal Settings -> Create debtor type-
CreateSystemDebtorClientDedicatedLimitsCreate a dedicated limit for a system debtor and client pair.POST /system-debtor-client-dedicated-limitsRegistry -> Create debtor limit-
CreateSystemDebtorGroupsCreate groups of system debtors that share common rules.POST /system-debtor-groups--
CreateSystemDebtorGroupSystemDebtorsPOST /system-debtor-groups/<id_>/system-debtors--
CreateSystemDebtorLabelsAdd labels to a system debtor record.POST /system_debtors/<identification_number>/labelsRegistry -> Add debtor label-
CreateSystemDebtorToDoCreate a to-do item for a system debtor.POST /system-debtor/todoRegistry -> Create debtor to-do-
CreditcheckDebtorsRun credit checks on debtors and invoices.POST /debtors/<id_>/creditcheck
POST /debtors/creditcheck
POST /invoices/<id_>/creditcheck
--
CreditInsuranceClientDebtorSearchSearch for client and debtor pairings under a credit insurance policy.POST /credit-insurance-client-debtor/searchRegistry -> Search insurance coverage-
DebtorLookupCollectionBatchUpdate the debtor lookup for a collection batch.PUT /collection-batches/<id_>/debtor-lookup--
DeleteDebtorLabelsDelete labels assigned to a debtor.DELETE /debtors/<debtor_id>/labels/<id>Registry -> Delete debtor labels-
DeleteDebtorTypeDelete a debtor subtype classification.DELETE /debtor-subtype/<id_>Global Settings -> Debtor Types -> Delete debtor type-
DeleteSystemDebtorClientDedicatedLimitsDELETE /system-debtor-client-dedicated-limits/<id_>--
DeleteSystemDebtorGroupsDelete a grouping of system debtors for shared rules.DELETE /system-debtor-groups/<id_>--
DeleteSystemDebtorGroupSystemDebtorsDelete system debtors from a system-debtor group.DELETE /system-debtor-groups/<id_>/system-debtors/<system_debtor_id>--
DeleteSystemDebtorLabelsDelete a label assigned to a system debtor.DELETE /system_debtors/<identification_number>/labels/<id>--
GenerateDebtorTokenGenerate a token for a debtor.POST /token/debtor/generate--
GetCreditInsuranceClientDebtorFetch and refresh credit insurance client-debtor data from an external source, and view requests and history by debtor.GET /credit-insurance-client-debtor/history/<debtor_id>
GET /credit-insurance-client-debtor/requests/<debtor_id>
POST /credit-insurance-client-debtor
--
GetDebtorCreditDecisionStatusView factoring buy/sell decisions for debtors.GET /factoring-decisions/debtors/<id_>--
GetDebtorToDoGET /debtor/todo/<debtor_id>
GET /debtor/todo/<debtor_id>/<id>
--
GetSystemDebtorToDoGET /system-debtor/todo/<debtor_id>
GET /system-debtor/todo/<debtor_id>/<id>
--
ManageDebtorSettingsView and update debtor flag settings.GET /settings/debtor/flag/<debtor_id>
PUT /settings/debtor/flag/<debtor_id>
Registry -> Manage settings-
ManageSystemDebtorSettingsView and update system debtor flag settings.GET /settings/system-debtor/flag/<system_debtor_identification_number>
PUT /settings/system-debtor/flag/<system_debtor_identification_number>
SystemDebtorSingle -> Manage settings-
ReadClientDebtorPayoutAccountsView client and debtor payout account details and overrides.GET /client-debtor-payout-accounts/<id_>
GET /client-debtor-payout-accounts/debtor/<debtor_id>
Registry -> View payout accounts-
ReadDebtorView a debtor’s profile.GET /debtors/<debtor_id>Registry -> View debtor profile-
ReadDebtorsView the list of debtors.GET /debtors-Dashboard -> View debtors
ReadDebtorChangelogView debtor change history and audit logs.GET /changelog/debtor/<id_>
GET /changelog/system-debtor/<identification_number>
Registry -> View change history-
ReadDebtorFinancialEventsView all financial events belonging to a debtor.GET /debtors/<debtor_id>/financial-events
GET /system-debtors/<identification_number>/financial-events
Registry -> View debtor financial events-
ReadDebtorLabelsView labels assigned to a debtor.GET /debtors/<debtor_id>/labelsRegistry -> View labels-
ReadDebtorNotesView free-form notes attached to a debtor.GET /debtors/<debtor_id>/notes--
ReadDebtorPayoutAccountView details of a debtor payout or refund account.GET /debtor-payout-accounts/<id_>--
ReadDebtorSettingsGET /settings/debtor/flag/<debtor_id>Registry -> View settings-
ReadDebtorPayoutAccountsView debtor payout and refund accounts.GET /debtor-payout-accounts--
ReadDebtorTypeView debtor subtype classifications.GET /debtor-subtype
GET /debtor-subtype/<id_>
Global Settings -> View subtypes-
ReadInternalSystemDebtorGET /internal-system-debtors/<identification_number_>Registry -> View system debtor-
ReadInternalSystemDebtorsGET /internal-system-debtors--
ReadSystemDebtorView system debtor master records, their clients, and invoice summaries.GET /system-debtors/<identification_number>
GET /system-debtors/<identification_number>/clients
GET /system-debtors/<identification_number>/invoice-summary
Registry -> View debtors-
ReadSystemDebtorsList master debtor records used across clients.GET /system-debtors--
ReadSystemDebtorClientDedicatedLimitsView system debtor client dedicated limits.GET /system-debtor-client-dedicated-limits
GET /system-debtor-client-dedicated-limits/<id_>
POST /system-debtor-client-dedicated-limits/search
Registry -> View debtor limits-
ReadSystemDebtorCreditStatusView credit status information assigned to a system debtor.GET /system-debtor-credit-status/<id_>
GET /system-debtor-credit-status/currency-status/<id_>
GET /system-debtor-credit-status/currency-status/credit-status/<sdcs_id_>
GET /system-debtor-credit-status/system-debtor/<system_debtor_id>
Registry -> View debtor credit status-
ReadSystemDebtorSettingsView system debtor flag settings.GET /settings/system-debtor/flag/<system_debtor_identification_number>Registry -> View debtor settings-
ReadSystemDebtorEventRetrieve lifecycle events for a system debtor.GET /system-debtor/events/<id_>--
ReadSystemDebtorEventsView lifecycle events for system debtors.GET /system-debtor/events--
ReadSystemDebtorGroupRetrieve a system debtor group.GET /system-debtor-groups/<id_>--
ReadSystemDebtorGroupsList system debtor groups.GET /system-debtor-groups--
ReadSystemDebtorGroupSystemDebtorsList system debtors in a group.GET /system-debtor-groups/<id_>/system-debtors--
ReadSystemDebtorLabelsView labels assigned to a system debtor.GET /system_debtors/<identification_number>/labelsRegistry -> View debtor labels-
SearchDebtorsSearch debtors.POST /debtors/searchRegistry -> Search debtorsCustomers -> Search debtors
SearchDebtorCreditDecisionStatusSearch debtor factoring decisions, including daily history.POST /factoring-decisions/debtors/daily/search
POST /factoring-decisions/debtors/search
--
SearchDebtorFinancialEventsSearch all financial events belonging to a debtor.POST /debtors/<debtor_id>/financial-events/search
POST /system-debtors/<identification_number>/financial-events/search
Registry -> Filter debtor financial events-
SearchDebtorNotesSearch notes attached to a debtor.POST /debtors/<debtor_id>/notes/search--
SearchDebtorPayoutAccountsSearch debtor payout and refund accounts.POST /debtor-payout-accounts/search--
SearchDebtorToDoSearch to-do items for a debtor.POST /debtor/todo/searchRegistry -> Search tasks-
SearchInternalSystemDebtorsPOST /internal-system-debtors/searchRegistry -> Search debtors-
SearchSystemDebtorsSearch master debtor records used across clients.POST /system-debtors/searchRegistry -> Search debtors-
SearchSystemDebtorCreditStatusesSearch system debtor credit statuses across currencies.POST /system-debtor-credit-status/currency-status/search
POST /system-debtor-credit-status/search
--
SearchSystemDebtorEventsSearch system debtor lifecycle events and payments.POST /system-debtor/events/payments/search
POST /system-debtor/events/search
--
SearchSystemDebtorGroupsSearch groupings of debtors for shared rules.POST /system-debtor-groups/search--
SearchSystemDebtorToDoSearch system debtor to-do items.POST /system-debtor/todo/searchDaily Routines -> Search debtor tasks-
UpdateClientDebtorPayoutAccountsUpdate client/debtor payout account overrides.PUT /client-debtor-payout-accounts/<id_>Registry -> Update payout accounts-
UpdateCreditInsuranceClientDebtorSend an external request to update the credit insurance limit for a debtor-client pairing.POST /credit-insurance-client-debtor/update-limit--
UpdateDebtorsUpdate debtor information and distribution channel settings.PUT /debtors/<debtor_id>Registry -> Update debtor info-
UpdateDebtorClientUpdate the client associated with a debtor.PUT /debtors/<id_>/client-Customers -> Update client
UpdateDebtorLabelsUpdate debtor labels.PUT /debtors/<debtor_id>/labels/<id>Registry -> Update debtor labels-
UpdateDebtorPayoutAccountsUpdate a debtor payout account.PUT /debtor-payout-accounts/<id_>--
UpdateDebtorPreferredLanguageUpdate a debtor’s preferred language.PUT /debtors/<id_>/preferred-languageRegistry -> Update debtor language-
UpdateDebtorToDoUpdate and resolve debtor to-do items.PUT /debtor/todo/<debtor_id>/<id>
PUT /debtor/todo/resolve-multiple
Daily Routines -> Resolve to-do items-
UpdateDebtorTypeUpdate a debtor subtype classification.PUT /debtor-subtype/<id_>Global Settings -> Update debtor types-
UpdateSystemDebtorsUpdate master debtor records and manage debtor bankruptcy status.POST /system-debtors/<identification_number>/bankruptcy
PUT /system-debtors/<identification_number>
Registry -> Update debtor records-
UpdateSystemDebtorClientDedicatedLimitsUpdate credit limits for individual debtors per client.PUT /system-debtor-client-dedicated-limits
PUT /system-debtor-client-dedicated-limits/<id_>
Registry -> Update credit limits-
UpdateSystemDebtorCreditStatusUpdate system debtor credit status and currency status.PUT /system-debtor-credit-status/<id_>
PUT /system-debtor-credit-status/currency-status/<id_>
PUT /system-debtor-credit-status/system-debtor/<system_debtor_id>
Registry -> Update credit status-
UpdateSystemDebtorGroupsUpdate groups of system debtors with shared rules.PUT /system-debtor-groups/<id_>--
UpdateSystemDebtorLabelsUpdate labels on system debtor records.PUT /system_debtors/<identification_number>/labels/<id>Registry -> Update debtor labels-
UpdateSystemDebtorToDoUpdate and resolve to-do items for master debtor records.PUT /system-debtor/todo/<debtor_id>/<id>
PUT /system-debtor/todo/resolve-multiple
Events -> Resolve to-do items-
CreateDebtorBlockedBlock debtors by adding them to a blacklist.POST /debtor-blockedGlobal Settings -> Block debtor-
ReadDebtorBlockedView blocked or blacklisted debtors.GET /debtor-blocked
GET /debtor-blocked/<identification_number>
--
SearchDebtorBlockedSearch blocked or blacklisted debtors.POST /debtor-blocked/searchGlobal Settings -> Search blocked-
DeleteDebtorBlockedUnblock a debtor by identification number.DELETE /debtor-blocked/<identification_number>Global Settings -> Excluded Debtors -> Unblock debtor-

15 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CreateDistributionEventsDigitalMailboxCreate digital mailbox distribution events.POST /distribution-events/digital-mailbox--
CreateDistributionEventsLetterCreate letter distribution events.POST /distribution-events/letter--
ReadCollectionBatchLedgerEventDistributionSearch and view collection batch ledger event distributions.GET /distributions/distribution-collection-batch-ledger-event/<collection_batch_ledger_event_id>
POST /distributions/distribution-collection-batch-ledger-event/search
--
ReadDistributionView details of outbound document distributions.GET /distributions/<id_>Environment -> View distributions-
ReadDistributionsView outbound document distributions (email, post, e-invoice).GET /distributions
GET /distributions/ready-for-export
--
ReadDistributionEventView a single distribution lifecycle event by ID.GET /distribution-events/<id_>--
ReadDistributionEventsView distribution lifecycle events.GET /distribution-events--
ReadDistributionProfileView per-client distribution channel preferences.GET /distribution-profiles/<id_>--
ReadDistributionProfilesView distribution channel preferences for clients.GET /distribution-profiles--
RetryDistributionRetry document distributions.PUT /distributions/<id_>/retry--
SearchDistributionSearch document distributions via email, post, or e-invoice.POST /distributions/searchEnvironment -> Search distributions-
SearchDistributionEventsSearch lifecycle events for document distributions.POST /distribution-events/search--
SearchDistributionProfilesSearch client distribution channel preferences.POST /distribution-profiles/searchEnvironment -> Search distribution profiles-
UpdateDistributionProfilesUpdate per-client distribution channel preferences.PUT /distribution-profiles/<id_>Environment -> Update distribution-
UpdateDistributionStatusUpdate distribution status and distribute outbound documents.PUT /distributions/<id_>/distribute
PUT /distributions/update-status
Environment -> Distribute documents-

5 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CreateSignatureRequestSubmit a signature request for an invoice.POST /invoices/signature-request--
CreateSyncPaymentEventsReceive and process payment completion events from an ERP system.POST /events/sync-payment-complete--
DeleteSignatureRequestDelete a signature request associated with an invoice.DELETE /invoices/<invoice_id_>/signature-request/<id_>--
ReadSignatureRequestsRetrieve a signature request for an invoice.GET /invoices/<id_>/signature-request--
UpdateSignatureRequestPOST /events/signature/event--

122 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
ActivateInvoicesReset, activate, and set interest rates on invoices.PUT /invoices/<id_>/activate
PUT /invoices/<id_>/reset
PUT /invoices/<id_>/set-interest-rate
Registry -> Activate invoices-
ActivatePartInvoicesActivate sub-invoices generated by a part-payment plan.PUT /part-invoices/activateDaily Routines -> Activate part invoices-
AddToArchiveInvoicesArchive invoices.PUT /invoices/<id_>/archive/addRegistry -> Archive invoices-
AuthorizePartInvoicesAuthorize sub-invoices generated by a part-payment plan.PUT /part-invoices/authorizeDaily Routines -> Authorize part invoices-
BulkUpdateInvoiceBulk update invoices and retrieve total balance for bulk updates.POST /invoices/actions/bulk-update/get-total-balance
PUT /invoices/actions/bulk-update
Registry -> Bulk update invoices-
CalculateBalanceInvoicesRecalculate balances for invoices.PUT /invoices/<id_>/calculate-balance--
CalculateStatusInvoicesRecalculate statuses for invoices.PUT /invoices/<id_>/calculate-status--
ChangeExpirationInvoicesChange invoice expiration dates.PUT /invoices/actions/change-expire-date--
CreateCollectionBatchInvoiceAdd invoices to collection batches.POST /collection-batches/<collection_batch_id>/invoices/<invoice_id>--
CreateCollectionBatchWithSingleInvoicePOST /collection-batches/<invoice_id>/create-collection-batchRegistry -> Create collection-
CreateDistributionEventsElectronicInvoiceCreate electronic invoice distribution events.POST /distribution-events/electronic-invoice--
CreateElectronicInvoiceInvitesSend electronic invoice invitations.POST /electronic-invoices/invites--
CreateInvoicesCreate invoices.POST /invoicesRegistry -> Create invoices-
CreateInvoiceFilesUpload bulk invoice files for ingestion.POST /invoice-files--
CreateInvoiceGuarantorAttach a guarantor to an invoice.POST /invoices/<invoice_id>/guarantorsRegistry -> Create guarantor-
CreateInvoiceLabelsAdd labels to an invoice.POST /invoices/<invoice_id>/labelsRegistry -> Create labels-
CreateInvoiceToDoPOST /invoice/todo--
CreatePartPaymentAccountInvoiceCreate invoices funded through a part-payment account.POST /part-payment-accounts/invoices--
CreatePartPaymentPlanInvoiceCreate invoices from a part-payment plan.POST /part-payment-plans/invoices--
CreateSyncInvoiceEventsReceive and process invoice completion events from an ERP system.POST /events/sync-invoice-complete--
CreditInvoicesCreate a credit action on an invoice.PUT /invoices/<id_>/actions/credit--
DeleteCollectionBatchInvoiceDelete an invoice from a collection batch.DELETE /collection-batches/<collection_batch_id>/invoices/<invoice_id>--
DeleteInvoiceGuarantorDelete a guarantor attached to an invoice.DELETE /invoices/<invoice_id>/guarantors/<id_>Registry -> Delete guarantor-
DeleteInvoiceLabelsDelete labels assigned to an invoice.DELETE /invoices/<invoice_id>/labels/<id>Registry -> Invoices -> Delete invoice labels-
DeletePartInvoiceDelete a sub-invoice generated by a part-payment plan.DELETE /part-invoices/<id_>Daily Routines -> Part Invoices -> Delete part invoice-
DeletePartPaymentAccountInvoiceDelete an invoice currently funded by a part-payment account.DELETE /part-payment-accounts/invoices/<id_>--
DeletePartPaymentPlanInvoiceDelete an invoice originating from a part-payment plan.DELETE /part-payment-plans/invoices/<id_>--
DenyTaxReductionOnInvoicesDeny tax reduction on an invoice.PUT /invoices/<id_>/actions/deny-tax-reduction--
DisputeInvoicesDispute an invoice.PUT /invoices/<id_>/actions/disputeRegistry -> Dispute invoice-
DistributeInvoicesDistribute an invoice.POST /invoices/distribute--
ExternalRefinanceInvoiceRequest external refinancing for invoices individually or in bulk.POST /invoice-refinancing/<invoice_id>/external
PUT /invoice-refinancing/bulk-external
Registry -> Request refinancing-
FastForwardInvoiceFast forward an invoice through its collection stages by skipping a pending ledger event.PUT /invoices/<id_>/fast-forwardRegistry -> Fast forward invoice-
GeneratePartInvoicesGenerate part invoices from part-payment plans.PUT /part-invoices/generateDaily Routines -> Generate part invoices-
GetInvoiceArticlesRetrieve articles associated with invoices.POST /invoices/get-articles--
GetInvoiceCreditDecisionStatusView factoring buy or sell decisions for invoices.GET /factoring-decisions/invoice/<id_>--
GetInvoiceToDoGET /invoice/todo/<invoice_id>
GET /invoice/todo/<invoice_id>/<id>
--
ImportInvoiceFilesImport bulk invoice files for processing.PUT /invoice-files/<id_>/import--
InvoicePDFExtractCreateSubmit PDF files for invoice data extraction using OCR or AI processing.POST /invoices/<client_id>/extract
POST /invoices/<client_id>/extract/gemini
--
InvoicePDFExtractGeminiExtract invoice data from a PDF using Gemini.POST /invoices/<client_id>/extract/gemini--
InvoicePDFExtractReadRetrieve OCR extraction results for invoice PDFs.POST /invoices/<client_id>/extract/response--
InvoicePDFExtractReadAccessCheck whether invoice PDF OCR extraction is enabled.GET /invoices/<client_id>/extract/enabled--
LinkDocumentToInvoiceAttach documents to invoices.POST /documents/link-invoice--
LinkMultipleCreditDebitInvoicesLink multiple invoices individually or in bulk.PUT /invoices/link-multiple
PUT /invoices/link-multiple-bulk
Registry -> Link invoices-
PartPaymentStartInvoiceInitiate part payment arrangements for invoices.PUT /invoices/<id_>/part-payment/startRegistry -> Start part payment-
PartPaymentStopInvoiceEnd part payment arrangements for invoices.PUT /invoices/<id_>/part-payment/stopRegistry -> Stop part payment-
PauseInvoicesPause an invoice.PUT /invoices/<id_>/actions/pauseRegistry -> Pause invoice-
PreviewInvoicesPreview and update invoice previews.POST /invoices/preview
PUT /invoices/<id_>/preview
--
ReadElectronicInvoiceView and validate e-invoices in PEPPOL/Svefaktura format.GET /electronic-invoices/invoices/<invoice_id>/validate
GET /invoices/electronic/<id_>
Registry -> Validate e-invoices-
ReadInvoiceView invoices and their details, including credit-debit links, payment accounts, and collection status.GET /invoices/<id_>
GET /invoices/<id_>/external-collection
GET /invoices/<invoice_id>/payment-account
GET /invoices/<invoice_id_>/credit-debit-link-list
GET /invoices/requests/<id_>
GET /invoices/table/<id_>
Registry -> View invoicesErrands -> View invoices
ReadInvoicesList invoices and view related system settings.GET /invoices
GET /system-setting/hide-balance-details/enabled
-Dashboard -> View invoices
ReadInvoiceArticlesView articles (line items) for an invoice.GET /invoices/<invoice_id>/articles--
ReadInvoiceChangelogView invoice and user change history and audit logs.GET /changelog/invoice/<id_>
GET /changelog/user/<id_>
Registry -> View change history
Environment -> View change history
-
ReadInvoiceFileView a single bulk invoice file upload and its ingestion status.GET /invoice-files/<id_>--
ReadInvoiceFilesView bulk invoice file uploads and ingestion status.GET /invoice-files--
ReadInvoiceFinancialEventView a single invoice financial event by ID.GET /invoices/events/financial/<id_>--
ReadInvoiceFinancialEventsView invoice financial events.GET /invoices/events/financial--
ReadInvoiceGuarantorView guarantor details attached to an invoice.GET /invoices/<invoice_id>/guarantors/<id_>--
ReadInvoiceGuarantorsView guarantors attached to an invoice.GET /invoices/<invoice_id>/guarantorsRegistry -> View guarantors-
ReadInvoiceLabelsView invoice labels.GET /collection-batches/<collection_batch_id>/invoices/labels
GET /invoices/<invoice_id>/labels
Registry -> View labels-
ReadInvoiceLedgerEventView a specific invoice ledger event.GET /invoices/events/ledger/<id_>--
ReadInvoiceLedgerEventsView invoice ledger events.GET /invoices/events/ledger--
ReadInvoiceNotesView notes attached to an invoice.GET /invoices/<invoice_id>/notes--
ReadInvoiceOfferView a specific invoice purchase offer.GET /invoice-offers/<id_>--
ReadInvoiceOffersView invoice purchase offers.GET /invoice-offers--
ReadInvoicePaymentMethodsView available payment methods for an invoice.GET /invoices/<invoice_id>/payment-methods--
ReadInvoicePaymentMethodConfigurationsView payment method configurations for an invoice.GET /invoices/<invoice_id>/payment-method-configurations--
ReadInvoiceReasonCodesView the reason codes on an invoice, including ones that no longer apply.GET /invoices/<id_>/reason-codesDaily Routines -> Invoice -> Reason codes-
ReadPartInvoiceView a single sub-invoice generated by a part-payment plan.GET /part-invoices/<id_>--
ReadPartInvoicesList part-payment invoices.GET /part-invoices--
ReadPartPaymentAccountInvoiceView a specific invoice funded by a part-payment account.GET /part-payment-accounts/invoices/<id_>--
ReadPartPaymentAccountInvoicesList invoices funded by a part-payment account.GET /part-payment-accounts/invoices--
ReadPartPaymentPlanInvoiceView a specific invoice from a part-payment plan.GET /part-payment-plans/invoices/<id_>--
ReadPartPaymentPlanInvoicesList invoices from a part-payment plan.GET /part-payment-plans/invoices--
ReadRefinanceInvoiceView a refinancing request on an existing invoice.GET /invoice-refinancing/<invoice_id>Registry -> View refinancing-
ReadRefinanceInvoicesList refinancing requests on existing invoices.GET /invoice-refinancing--
ReadTransactionReportInvoiceRetrieve a transaction report invoice.GET /reports/transaction-report-invoices/<id_>--
ReadTransactionReportInvoicesList transaction report invoices.GET /reports/transaction-report-invoices--
RecallInvoiceFromCollectionExternalRecall an invoice from external collection.PUT /invoices/<id_>/external-collection/recallRegistry -> Recall from collection-
RecourseOnInvoicesUpdate recourse actions on invoices.PUT /invoices/<id_>/actions/recourseRegistry -> Update recourse-
RefinanceInvoiceRefinance invoices and manage recourse settings.PUT /invoice-refinancing/<invoice_id>
PUT /invoice-refinancing/<invoice_id>/use-recourse
Registry -> Refinance invoices-
RefundCreditInvoiceRefund credit invoices individually or in bulk.PUT /invoices/<id_>/actions/refund-credit-invoice
PUT /invoices/actions/bulk-refund-credit-invoice
Registry -> Refund credit invoices-
RefundInvoiceRefund invoices.PUT /invoices/<id_>/actions/refundRegistry -> Refund invoices-
RegisterDirectPaymentOnInvoicesRegister direct payments on invoices.PUT /invoices/<id_>/actions/direct-paymentRegistry -> Register direct payments-
RegisterPaymentOnInvoicesRegister payments on invoices.PUT /invoices/<id_>/actions/payment--
RemoveFromArchiveInvoicesUnarchive invoices.PUT /invoices/<id_>/archive/removeRegistry -> Unarchive invoices-
ResumeInvoicesResume invoices.PUT /invoices/<id_>/actions/resumeRegistry -> Resume invoices-
RetryPostActivateInvoicesPOST /invoices/<invoice_id>/retry-post-activate--
ReverseInvoiceFinancialEventReverse invoice financial events.PUT /invoices/events/financial/<id_>/reverseRegistry -> Reverse events-
ReversePaymentTransactionReverse or revert payment transactions and collection events.PUT /collection-batches/financial-events/<collection_batch_financial_event_id>/reverse
PUT /payments/links/<payment_transaction_link_id>/revert
--
RevertReminderOnInvoicesRevert reminder actions on invoices.PUT /invoices/<id_>/actions/revert-reminder--
RewindInvoiceRewind invoice ledger events.POST /invoices/<id_>/rewindRegistry -> Rewind invoice-
SearchElectronicInvoicePartiesSearch electronic invoice parties, validate party information, and confirm party validation.POST /electronic-invoices/parties/search
POST /electronic-invoices/validate-party
PUT /electronic-invoices/validate-party/confirm
Registry -> Search e-invoice parties-
SearchInvoicesSearch and filter invoices.POST /invoices/search
POST /invoices/table/search
Registry -> Search invoicesInvoices -> Search invoices
SearchInvoiceCreditDecisionStatusSearch factoring buy and sell decisions for invoices.POST /factoring-decisions/invoices/searchRegistry -> Search factoring decisions-
SearchInvoiceFilesSearch bulk invoice uploads and their ingestion status.POST /invoice-files/search--
SearchInvoiceFinancialEventsSearch financial events related to invoices.POST /invoices/events/financial/searchRegistry -> Search financial events-
SearchInvoiceGuarantorsSearch guarantors attached to an invoice.POST /invoices/<invoice_id>/guarantors/searchRegistry -> Search guarantors-
SearchInvoiceLedgerEventsSearch ledger events related to invoices.POST /invoices/events/ledger/searchRegistry -> Search ledger eventsErrands -> Search ledger events
SearchInvoiceNotesSearch notes attached to an invoice.POST /invoices/<invoice_id>/notes/search--
SearchInvoiceOffersSearch service-provider invoice purchase offers.POST /invoice-offers/search--
SearchInvoiceToDoPOST /invoice/todo/search--
SearchPartInvoicesSearch part invoices from payment plans.POST /part-invoices/searchDaily Routines -> Search part invoices-
SearchPartPaymentAccountInvoicesSearch invoices funded by part-payment accounts.POST /part-payment-accounts/invoices/searchRegistry -> Search account invoices-
SearchPartPaymentPlanInvoicesSearch invoices from part-payment plans.POST /part-payment-plans/invoices/searchRegistry -> Search plan invoices-
SearchTransactionReportInvoicesSearch invoices in transaction reports.POST /reports/transaction-report-invoices/search--
SendInvoicesSend invoices.PUT /invoices/<id_>/actions/sendRegistry -> Send invoices-
StopInvoicesStop an invoice.PUT /invoices/<id_>/actions/stopRegistry -> Stop invoices-
ToggleInvoicePaymentMethodToggle payment method availability for an invoice.PUT /invoices/<invoice_id>/payment-methods/toggle--
ToggleInvoicePaymentMethodConfigurationToggle payment method configurations for an invoice.PUT /invoices/<invoice_id>/payment-method-configurations/toggle--
UnlinkCreditInvoicePUT /invoices/events/financial/<id_>/unlink-creditRegistry -> Unlink credit-
UpdateInvoicesUpdate invoice details.PUT /invoices/<id_>Registry -> Update invoicesErrands -> Edit invoice details
UpdateInvoiceGuarantorUpdate guarantor details on an invoice.PUT /invoices/<invoice_id>/guarantors/<id_>Registry -> Manage guarantors-
UpdateInvoiceLabelsUpdate invoice labels.PUT /invoices/<invoice_id>/labels/<id>Registry -> Label invoices-
UpdateInvoiceLedgerEventsPUT /invoices/events/ledger/<id_>Registry -> Update ledger events-
UpdateInvoiceOfferUpdate an invoice purchase offer.PUT /invoice-offers/<id_>--
UpdateInvoiceToDoPUT /invoice/todo/<invoice_id>/<id>--
UpdatePartPaymentAccountInvoiceUpdate invoices funded by part-payment accounts.PUT /part-payment-accounts/invoices/<id_>--
UpdatePartPaymentPlanInvoiceUpdate invoices in a part-payment plan.PUT /part-payment-plans/invoices/<id_>--
ValidateEngineRuleInvoiceApply engine rule decisions to invoices for factoring, service, and refinance processing, individually or in bulk.POST /engine-rule/perform-decision-bulk/get-result
PUT /engine-rule/perform-decision-bulk/factoring-sell
PUT /engine-rule/perform-decision-bulk/refinance
PUT /engine-rule/perform-decision-bulk/service
PUT /engine-rule/perform-decision/factoring-sell/<invoice_id>
PUT /engine-rule/perform-decision/refinance/<invoice_id>
PUT /engine-rule/perform-decision/service/<invoice_id>
Registry -> Apply engine rules-
ValidateEngineRuleInvoiceFactoringSellTrigger batch factoring-sell decisions on invoices asynchronously.PUT /engine-rule/perform-decision-bulk/factoring-sellFactoring -> Apply factoring decisions-
WriteOffCapitalOnInvoicesWrite off capital amounts on invoices.PUT /invoices/<id_>/actions/writeoff-capitalRegistry -> Write off capital-
WriteOffReminderOnInvoicesWrite off reminder costs on invoices.PUT /invoices/<id_>/actions/writeoff-reminderRegistry -> Write off reminder costs-

320 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
AppendCollectionProfileAdd a collection profile to a collection batch.PUT /collection-batches/<collection_batch_id>/append-collection-profile--
AskQuestionAsk natural-language questions about platform data via FinBrain.POST /questions--
AuthorizeChargesAuthorize manual charges such as fees and interest.PUT /charges/authorize--
AuthorizePaymentTransactionReturnsAuthorize returned payment transactions.PUT /payment-transactions-returns/<id_>/authorizeDaily Routines -> Authorize transaction returns-
AutoDailyRoutineBillingPUT /bookkeeping-files/billing--
BulkUpdateCollectionBatchPerform bulk updates to collection batches including notes and postponements.PUT /collection-batches/actions/bulk-update
PUT /collection-batches/actions/bulk-update/create-note
PUT /collection-batches/actions/bulk-update/postpone-collection-batches
--
BIllChargesBill manual charges such as fees and interest.PUT /charges/bill--
CacheEditGET /cache/clear
POST /cache/clear
POST /cache/clear/all
--
ChangeCollectionProfileReplace the collection profile on a collection batch.PUT /collection-batches/<collection_batch_id>/replace-collection-profile--
CheckInsuranceLimitCheck the insurance limit for an invoice.GET /invoices/<invoice_id_>/check-insurance-limit--
CompleteCollectionExternalMark an external debt collection case as completed.PUT /collections/external/<id_>/complete--
CompleteIntegrationPUT /clients/<client_id>/sync/complete-integrationRegistry -> Complete integration-
CompletePartPaymentMark a part-payment installment as completed.PUT /part-payments/<part_payment_id>/completed--
CompletePartPaymentGroupMark all part-payment installments for an invoice or collection batch as completed.PUT /part-payment-groups/source/<source_id>/completed--
ReadPartPaymentGroupCreditInvoicesList activated credit invoices available to link for a given invoice.GET /part-payment-groups/invoice/<invoice_id>/credit-invoices--
ConnectFileToNoteAttach files to notes.PUT /notes/<note_id>/attach-fileDaily Routines -> Attach file to note-
ConnectFileToNoteCollectionBatchAttach files to notes on collection batch records.PUT /collection-batches/<collection_batch_id>/notes/<note_id>/attach-file--
ConnectFileToPaymentTransactionNoteAttach files to notes on payment transactions.PUT /payments/<id_>/notes/<note_id>/attach-file--
CreateAutomationCreate an automation, including its rules and the action it runs.POST /automation--
CreateAutomationRuleAdd a rule to an existing automation.POST /automation/<_id>/rules--
CreateChargesCreate manual charges such as fees, interest, and adjustments.POST /charges--
CreateCollectionBatchCreate collection batches, optionally grouping multiple invoices into a batch.POST /collection-batches
POST /collection-batches/invoices
--
CreateCollectionBatchDocumentGET /documents/settings/delivery_addresses
POST /documents/collection_batch/<collection_batch_id>
--
CreateCollectionBatchFinancialEventPOST /business-loans/<business_loan_id>/financial-events
POST /collection-batches/<collection_batch_id>/financial-events
--
CreateCollectionBatchGuarantorPOST /collection-batches/<collection_batch_id>/guarantors--
CreateCollectionBatchToDoCreate collection batch tasks pending operator action.POST /collection-batch/todo--
CreateCollectionFeeTypeCreate collection fee types.POST /fee/type--
CreateCollectionProfileCreate and manage collection profiles, levels, staged profiles, and segments.DELETE /collection-profile/levels/<collection_profile_level_id>
DELETE /collection-profile/levels/placeholders/<placeholder_id>
DELETE /collection-profile/staged-collection-profiles/<staged_collection_profile_id>
DELETE /collection-profile/system-collection-profiles/<system_collection_profile_id>
POST /collection-profile
POST /collection-profile/<collection_profile_id>/staged-collection-profiles
POST /collection-profile/levels
POST /collection-profile/levels/<collection_profile_level_id>/placeholders
POST /collection-profile/system-collection-profiles
POST /segments
PUT /collection-profile/<collection_profile_id>
PUT /collection-profile/levels/<collection_profile_level_id>
PUT /collection-profile/levels/placeholders/<placeholder_id>
PUT /collection-profile/system-collection-profiles/<system_collection_profile_id>
PUT /segments/<segment_id>
--
CreateContactCreate contact persons such as debtors and clients.POST /contactsRegistry -> Create contact-
CreateDeliveryPOST /enforcement/retry_delivery
PUT /enforcement/deliveries/create_deduction
PUT /enforcement/deliveries/create_recall
--
CreateDocumentsCreate and generate documents such as invoices, attachments, ads, and brand documents.POST /documents/ads/invoice
POST /documents/attachments/client
POST /documents/attachments/invoice
POST /documents/brand/instance-provider
POST /documents/connected-files
POST /documents/invoice
PUT /documents/<id_>/generate
Environment -> Create documents-
CreateEnforcementFinancialEventCreate a financial event enforcement action for debt enforcement.POST /enforcement/financial_event--
CreateEngineRulePOST /engine-rule
POST /engine-rule-advanced-module
POST /engine-rule-criteria
POST /engine-rule-criteria-group
POST /engine-rule-criteria/duplicate
Global Settings -> Create rule-
CreateEngineRuleSchedulerFilterPOST /engine-rule/scheduler-filters--
CreateErpsCreate ERP integrations.POST /erps--
CreateErpTypesCreate ERP types.POST /erp-types--
CreateInstanceProvidersPOST /instance-providers--
CreateLabelsCreate free-form labels for tagging resources.POST /labelsGlobal Settings -> Create labels-
CreateNoteAdd free-form notes attached to resources.POST /notesRegistry -> Create note-
CreateNoteCollectionBatchPOST /collection-batches/notes--
CreatePartPaymentPlanCollectionBatchCreate collection batches from part-payment plans.POST /part-payment-plans/collection-batches--
CreatePaymentAccountCreate payment accounts and configure their settings.POST /payment-accounts
POST /payment-accounts/settings
Accounting -> Create payment account-
CreatePaymentFilesUpload and ingest payment files (camt, BG/PG formats).POST /payment-filesDaily Routines -> Import payments-
CreatePaymentMatchingEnginePOST /payment-matching-engine--
CreatePaymentMethodConfigurationCreate payment method configurations for clients and service providers.POST /payment-methods/configurations
POST /payment-methods/configurations/client
POST /payment-methods/configurations/service-provider
Global Settings -> Configure payment method-
CreatePaymentRequestCreate outbound payment requests (e.g., Swish) to debtors.POST /payment-requests--
CreatePaymentTransactionsRecord inbound payments from debtors.POST /payments
POST /payments/multiple
--
CreatePaymentTransactionSpecificationPOST /payments/<id_>/payment-specification-fileDaily Routines -> Create payment specification-
CreateReasonCodeCreate reason codes used in payment matching and rejections.POST /reason-codeGlobal Settings -> Create reason code-
CreateSegmentCreate and update debtor segments.POST /segments
PUT /segments/<segment_id>
--
CreateServiceAccountCreate service accounts for server-to-server integrations.POST /service-accounts-Configure -> Create service account
CreateServiceProviderInsuranceAgreementsCreate insurance agreements tied to service providers.POST /service-provider-insurance-agreementRegistry -> Create insurance agreement-
CreateSettlementAccountTransactionsPOST /settlement-account-transactions--
CreateSniCodeCreate SNI codes in the global SNI Code Registry.POST /global-sni-registryGlobal Settings -> Create SNI code-
CreateWebhookCreate a webhook.POST /webhook--
DeleteAutomationDelete an automation together with its rules and its action.DELETE /automation/<_id>--
DeleteAutomationRuleDelete a single rule from an automation.DELETE /automation/rules/<_id>--
DeleteChargesDelete manual charges (fees, interest, adjustments).DELETE /charges/<id_>Daily Routines -> Delete charge-
DeleteCollectionBatchGuarantorRemove guarantors from collection batches.DELETE /collection-batches/<collection_batch_id>/guarantors/<guarantor_id>--
DeleteContactDelete contact persons (debtors, clients, etc.).DELETE /contacts/<id_>Registry -> Delete contact-
DeleteDocumentsDelete document attachments.DELETE /documents/<id_>Environment -> Documents -> Delete document-
DeleteEngineRuleDELETE /engine-rule-criteria/<id>Global Settings -> Matching Engines -> Delete rule-
DeleteEngineRuleSchedulerFilterDELETE /engine-rule/scheduler-filters/<id>--
DeleteInstanceProvidersDELETE /instance-providers/<id_>--
DeleteLabelsDelete free-form labels for tagging resources.DELETE /labels/<id>Global Settings -> Custom Attributes -> Delete labels-
DeleteNoteDelete free-form notes attached to resources.DELETE /notes/<id_>Registry -> Delete note-
DeletePartPaymentPlanCollectionBatchDelete collection batches from part-payment plans.DELETE /part-payment-plans/collection-batches/<id_>--
DeletePaymentBatchesAbort grouped payment ingestion files.PUT /payment-batches/<id_>/abortDaily Routines -> Import Payments -> Abort payment batch-
DeletePaymentFileDelete raw payment files ingested into the platform.DELETE /payment-files/<id_>Daily Routines -> Import Payments -> Delete payment file-
DeletePaymentMatchingEngineDelete a payment matching engine.DELETE /payment-matching-engine/<payment_matching_engine_id>--
DeletePaymentMethodConfigurationDelete payment method configurations for clients and service providers.DELETE /payment-methods/configurations/<id_>
DELETE /payment-methods/configurations/client/<payment_method_configuration_id>/<client_id>
DELETE /payment-methods/configurations/service-provider/<payment_method_configuration_id>/<service_provider_id>
Global Settings -> Payment Methods -> Delete method config-
DeletePaymentTransactionsDelete inbound payments received from debtors.DELETE /payments/<id_>--
DeletePaymentTransactionNoteDelete notes attached to payment transactions.DELETE /payments/<id_>/notes/<note_id>--
DeleteServiceProviderInsuranceAgreementDELETE /service-provider-insurance-agreement/<id_>--
DeleteSniCodeDelete SNI codes from the global registry.DELETE /global-sni-registry/<code>Global Settings -> SNI -> Delete SNI code-
DeleteUnplacedPaymentReturnsDelete returned (bounced) payment transactions.DELETE /payment-transactions-returns/<id_>Daily Routines -> Import Payments -> Payment Returns -> Delete payment return-
DeleteWebhookDelete webhooks.DELETE /webhook/<id_>--
DisputeCollectionBatchUpdate dispute status on collection batches.PUT /collection-batches/<collection_batch_id>/dispute--
ExportBillsPUT /bills/exportDaily Routines -> Export bills-
ExportCollectionExternalMark collections as exported to external collection agencies.PUT /collections/external/<id_>/export--
ExportExternalFinancedPaymentBatchesPUT /payment-batches/export-external-financedDaily Routines -> Export batches-
GenerateChargesGenerate manual charges such as fees, interest, and adjustments.PUT /charges/generate--
GeneratePusherTokenGET /pusher/generate-token
POST /pusher/test/send
--
GenerateTokenGenerate API and client portal authentication tokens.POST /token/client/portal/generate
POST /token/generate
Registry -> Generate token-
GenerateTokenServiceAccountGenerate integration tokens for server-to-server credentials.PUT /service-accounts/<id_>/generate-tokenEnvironment -> Generate tokenConfigure -> Generate token
GetCollectionBatchToDoView collection batch tasks pending operator action.GET /collection-batch/todo/<collection_batch_id>
GET /collection-batch/todo/<collection_batch_id>/<id>
--
GetEngineRuleSchedulerFilterGET /engine-rule/scheduler-filters
GET /engine-rule/scheduler-filters/<id>
--
ImportPaymentFileImport raw payment files into the platform.PUT /payment-files/<id_>/importDaily Routines -> Import payments-
ImportPurchaseFilesUpload and retry purchase collection files.POST /collection-batches/purchase/file
PUT /collection-batches/purchase/file/<_id>/retry
--
LinkUnplacedPaymentLink unmatched payments to invoices, part-payment plans, accounts, or other targets.PUT /unplaced-payments/<id_>/linkDaily Routines -> Link payment-
ManageEfakturaEnrollmentCreate and delete e-faktura (Nordic bank-channel invoicing) enrollments.DELETE /e-faktura/<efaktura_id>
POST /e-faktura
--
MarkIntegrationAsConnectedPUT /clients/<client_id>/sync/mark-integration-as-connected-Dashboard -> Connect integration
MatchPaymentBatchesTrigger matching of a payment batch.PUT /payment-batches/<id_>/matchDaily Routines -> Match payment batch-
ObtainOnboardingUrlPOST /clients/<client_id>/sync/obtain-onboarding-url-Dashboard -> Get onboarding URL
PartPaymentPlanRecalculateAnnuityRecalculate annuity schedules for part-payment plans.PUT /part-payment-plans/<part_payment_plan_id>/recalculate-annuity--
PartPaymentStartCollectionBatchStart part-payment collection for a batch.PUT /collection-batches/<collection_batch_id>/part-payment/start--
PartPaymentStopCollectionBatchStop part-payment collection for a batch.PUT /collection-batches/<collection_batch_id>/part-payment/stop--
PauseCollectionBatchPostpone ledger events for a collection batch.PUT /collection-batches/<collection_batch_id>/postpone-ledger-events--
ReadAdvancedLoginGET /users/advanced-login/enabled-Dashboard -> View login settings
ReadAnalyzeTopicsGET /reports/analyze-topics--
ReadAutomationView a single automation with its rules and action.GET /automation/<_id>--
ReadAutomationsList automations, and list the events and actions an automation can use.GET /automation
GET /automation/events
GET /automation/actions
--
ReadAutomationRulesList the rules that decide when an automation runs.GET /automation/<_id>/rules--
ReadBaseInterestRateView base interest rates, including active rates by currency.GET /base-interest-rates
GET /base-interest-rates/<currency_>/active
GET /base-interest-rates/<id_>
GET /base-interest-rates/active
--
ReadBaseInterestSettingsView base interest settings.GET /base-interest-settings/<target_id>Registry -> View interest settings-
ReadBillGET /bills/<id_>Daily Routines -> View bill-
ReadBillsGET /bills--
ReadChargeView a charge (fee, interest, or adjustment).GET /charges/<id_>--
ReadChargesList charges (fees, interest, and adjustments).GET /charges--
ReadCollectionBatchView collection batches, including invoices, reprieve, judgement, and payment account details.GET /collection-batches/<collection_batch_id>
GET /collection-batches/<collection_batch_id>/count-notes
GET /collection-batches/<collection_batch_id>/count-tasks
GET /collection-batches/<collection_batch_id>/history
POST /collection-batches/history/search
GET /collection-batches/<collection_batch_id>/judgement
GET /collection-batches/<collection_batch_id>/payment-account
GET /collection-batches/<collection_batch_id>/reprieve
GET /collection-batches/<id_>/invoices
GET /collection-batches/table/<collection_batch_id>
POST /collection-batch-invoice/search
--
ReadCollectionBatchChargeView a specific charge applied to a collection batch.GET /collection-batches/charges/<id_>--
ReadCollectionBatchChargesView charges applied to a collection batch.GET /collection-batches/charges--
ReadCollectionBatchEventView a specific lifecycle event from a collection batch.GET /collection-batches/events/<id_>--
ReadCollectionBatchEventsView lifecycle events from a collection batch.GET /collection-batches/events--
ReadCollectionBatchFinancialEventsView all financial events for a collection batch.GET /collection-batches/<collection_batch_id>/financial-events--
ReadCollectionBatchGuarantorView guarantor information for collection batches.GET /collection-batches/<collection_batch_id>/guarantors/<guarantor_id>
GET /debtors/<debtor_id>/collection-batches/guarantors
GET /system-debtors/<identification_number>/collection-batches/guarantors
--
ReadCollectionBatchGuarantorsView guarantors for a collection batch.GET /collection-batches/<collection_batch_id>/guarantors--
ReadCollectionFeeTypeView fee type definitions.GET /fee/type
GET /fee/type/<id>
--
ReadCollectionProfileView and search collection profiles, their levels, placeholders, and staged versions.GET /collection-profile/<collection_profile_id>
GET /collection-profile/<collection_profile_id>/is-live
GET /collection-profile/<collection_profile_id>/levels
GET /collection-profile/levels/<collection_profile_level_id>
GET /collection-profile/levels/placeholders/<placeholder_id>
GET /collection-profile/staged-collection-profiles/<staged_collection_profile_id>
GET /collection-profile/system-collection-profiles/<system_collection_profile_id>
GET /segments/<segment_id>
POST /collection-profile/levels/placeholders/search
POST /collection-profile/levels/search
POST /collection-profile/preview
POST /collection-profile/search
POST /collection-profile/staged-collection-profiles/search
POST /collection-profile/system-collection-profiles/search
POST /segments/search
PUT /collection-profile/<collection_profile_id>/copy
Global Settings -> View collection profiles-
ReadContactsView contact persons attached to a debtor.GET /debtors/<debtor_id>/contacts--
ReadDocumentView a stored document.GET /documents/<id_>-Invoices -> View documents
ReadDocumentsView and download invoices and other documents.GET /documents
GET /documents/invoices
-Invoices -> Download invoices
ReadEfakturaEnrollmentView and search e-faktura records for Nordic bank-channel invoice enrollment.GET /e-faktura
GET /e-faktura/fui/<fui>
POST /e-faktura/search
--
ReadEnforcementView enforcement actions and related deliveries, financial events, and history.GET /enforcement-view/<enforcement_id>
GET /enforcement/<enforcement_id>
GET /enforcement/<enforcement_id>/deliveries
GET /enforcement/<enforcement_id>/financial-events
GET /enforcement/<enforcement_id>/notes
GET /enforcement/deliveries/<enforcement_delivery_id>/api-logs
GET /enforcement/deliveries/<enforcement_delivery_id>/history
POST /enforcement-view/search
POST /enforcement/deliveries/api-logs/search
POST /enforcement/deliveries/history/search
POST /enforcement/deliveries/search
POST /enforcement/search
Debt Collection -> View enforcement-
ReadEngineRuleView and search engine rules, criteria, settings, and criteria groups.GET /engine-rule
GET /engine-rule-advanced-module/<id>
GET /engine-rule-advanced-module/<id>/criteria
GET /engine-rule-advanced-module/engine-rule/<engine_rule_id>
GET /engine-rule-criteria-group/<id>
GET /engine-rule-criteria-group/engine-rule/<engine_rule_id>
GET /engine-rule-criteria/<id>
GET /engine-rule-criteria/values
GET /engine-rule/<engine_rule_id>/settings
GET /engine-rule/<engine_rule_id>/settings/<id_>
GET /engine-rule/<id>
POST /engine-rule-advanced-module/search
POST /engine-rule-criteria-group/search
POST /engine-rule-criteria/search
POST /engine-rule-criteria/values/search
POST /engine-rule/search
Registry -> View engine rules-
ReadErpView a specific ERP integration.GET /erps/<id_>--
ReadErpsView ERP integrations.GET /erps--
ReadErpsShortView a compact list of ERP integrations.GET /erps-short--
ReadErpBillingSettingsView billing settings for ERP integrations.GET /erps/<id_>/settings/billing--
ReadErpShortView a compact summary of a specific ERP integration.GET /erps-short/<id_>--
ReadFinancingRuleView a financing rule by its identifier.GET /financing-rules/<id_>--
ReadFinancingRulesList financing rules for product financing configuration.GET /financing-rules--
ReadInstanceProvidersGET /instance-providers
GET /instance-providers/<id_>
Environment -> View providersDashboard -> View providers
ReadInternalRequestGET /internal-request
GET /internal-request/<id_>
GET /internal-request/topic/<topic>
POST /internal-request/topic
--
ReadInternalRequestChangelogView audit history of internal requests.GET /changelog/internal-request
GET /changelog/internal-request/<id_>
--
ReadLabelsList labels for tagging resources.GET /labelsGlobal Settings -> List labels-
ReadLocalesList supported locales and their date and currency formats.GET /localesGlobal Settings -> View localesDashboard -> View locales
ReadNoteRetrieve a note by its identifier.GET /notes/<id_>--
ReadNotesList notes attached to resources.GET /notes--
ReadNotesCollectionBatchView notes attached to a collection batch.GET /collection-batches/<collection_batch_id>/notes--
ReadPartPaymentRetrieve a part-payment installment by its identifier.GET /part-payments/<part_payment_id>--
ReadPartPaymentAccountView revolving credit accounts and their summaries.GET /part-payment-accounts/<id_>
GET /part-payment-accounts/<id_>/summary
Registry -> View credit accounts-
ReadPartPaymentAccountsList part-payment accounts for revolving credit.GET /part-payment-accounts--
ReadPartPaymentAccountEventRetrieve a lifecycle event for a part-payment account.GET /part-payment-accounts/events/<id_>--
ReadPartPaymentAccountEventsList lifecycle events for part-payment accounts.GET /part-payment-accounts/events--
ReadPartPaymentAccountFinancialEventRetrieve a financial movement record for a part-payment account.GET /part-payment-accounts/events/financial/<id_>--
ReadPartPaymentAccountFinancialEventsList financial movements on part-payment accounts.GET /part-payment-accounts/events/financial--
ReadPartPaymentAccountSettingView part-payment configuration for an account.GET /part-payment-accounts/settings/<id_>--
ReadPartPaymentAccountSettingsList part-payment account configurations.GET /part-payment-accounts/settings--
ReadPartPaymentCollectionBatchesList collection batches arising from part-payment plans.GET /part-payment-plans/collection-batches--
ReadPartPaymentPlanView part-payment plans and their summaries.GET /part-payment-plans/<id_>
GET /part-payment-plans/<part_payment_plan_id>/summary
Registry -> View payment plans-
ReadPartPaymentPlansList part-payment plans.GET /part-payment-plans--
ReadPartPaymentPlanCollectionBatchView a collection batch from a part-payment plan.GET /part-payment-plans/collection-batches/<id_>--
ReadPartPaymentPlanEventView a part-payment plan lifecycle event.GET /part-payment-plans/events/<id_>--
ReadPartPaymentPlanEventsList part-payment plan lifecycle events.GET /part-payment-plans/events--
ReadPartPaymentPlanFinancialEventView a financial event recorded against a part-payment plan.GET /part-payment-plans/events/financial/<id_>--
ReadPartPaymentPlanFinancialEventsList financial events recorded against part-payment plans.GET /part-payment-plans/events/financial--
ReadPartPaymentPlanLedgerEventView a ledger posting for a part-payment plan.GET /part-payment-plans/events/ledger/<id_>--
ReadPartPaymentPlanLedgerEventsList ledger postings for part-payment plans.GET /part-payment-plans/events/ledger--
ReadPartPaymentPlanSettingView part-payment plan configuration.GET /part-payment-plans/settings/<id_>
PUT /part-payment-plans/settings/<id_>/summary
--
ReadPartPaymentPlanSettingsList part-payment plan configuration settings.GET /part-payment-plans/settings--
ReadPaymentAccountView bank accounts and their payment settings.GET /payment-accounts/<id_>
GET /payment-accounts/<id_>/settings
Accounting -> View bank accounts-
ReadPaymentAccountsList bank accounts where payments are received.GET /payment-accounts--
ReadPaymentBatchView a grouped payment ingestion batch.GET /payment-batches/<id_>Daily Routines -> View batch-
ReadPaymentBatchesList payment ingestion batches.GET /payment-batches--
ReadPaymentFileView a payment file.GET /payment-files/<id_>--
ReadPaymentFilesList ingested payment files.GET /payment-files--
ReadPaymentMatchingEngineView payment matching engines and simulate matching rules without creating links.GET /payment-matching-engine
GET /payment-matching-engine/<payment_matching_engine_id>
GET /payment-matching-engine/match-fields
POST /payment-matching-engine/simulate
--
ReadPaymentMethodView payment methods like Swish, autogiro, and card.GET /payment-methods/<id_>Global Settings -> View payment methods-
ReadPaymentMethodsView available payment methods.GET /payment-methods--
ReadPaymentMethodConfigurationView payment method configuration and credentials.GET /payment-methods/configurations/<id_>--
ReadPaymentMethodConfigurationsView payment method configurations and credentials.GET /payment-methods/configurations--
ReadPaymentReconciliationView a manual reconciliation record for an unplaced payment.GET /payment-reconciliations/<reconciliation_id>--
ReadPaymentRequestView an outbound payment request.GET /payment-requests/<id_>--
ReadPaymentRequestsView outbound payment requests.GET /payment-requests--
ReadPaymentTransactionView payment transactions and their reconciliation links.GET /payments/<id_>
GET /payments/<payment_transaction_id>/links
POST /payments/links/search
Daily Routines -> View transactions-
ReadPaymentTransactionsList inbound payments received from debtors and reconciled to invoices.GET /payments--
ReadPaymentTransactionNoteView a single note attached to a payment transaction.GET /payments/<id_>/notes/<note_id>--
ReadPaymentTransactionNotesView notes attached to a payment.GET /payments/<id_>/notes--
ReadPriceBracketView a single price bracket by ID.GET /price-brackets/<id_>--
ReadPriceBracketsList price brackets within a price list.GET /price-brackets--
ReadPriceListView pricing-tier definitions.GET /price-lists/<id_>
GET /price-lists/target/<target_id>
Global Settings -> View price lists-
ReadPriceListsView pricing-tier definitions.GET /price-lists--
ReadPurchaseFilesGET /collection-batches/purchase/file--
ReadReasonCodeView reason codes used in payment matching and rejections.GET /reason-code/<code_>
GET /reason-code/type/<type_>
--
ReadReasonCodesView reason codes used in payment matching and rejections.GET /reason-codeGlobal Settings -> View reason codes-
ReadSegmentGET /segments/<segment_id>
POST /segments/search
--
ReadServiceAccountView a service account used for server-to-server integrations.GET /service-accounts/<id_>--
ReadServiceAccountsView service accounts used for server-to-server integrations.GET /service-accounts--
ReadServiceProvidersView external service providers such as credit bureaus and distribution channels.GET /service-providers
GET /service-providers/<id_>
Environment -> View service providers-
ReadServiceProviderInsuranceAgreementView insurance agreements tied to a service provider.GET /service-provider-insurance-agreement/<id_>--
ReadServiceProviderInsuranceAgreementsView insurance agreements tied to service providers.GET /service-provider-insurance-agreement
GET /service-provider-insurance-agreement/service-provider/<service_provider_id>
Environment -> View insurance agreements-
ReadSettlementAccountView a settlement account.GET /settlement-accounts/<id_>--
ReadSettlementAccountsList settlement accounts.GET /settlement-accounts--
ReadSettlementAccountTransactionView a settlement account transaction.GET /settlement-account-transactions/<id_>--
ReadSettlementAccountTransactionsList transactions on settlement accounts.GET /settlement-account-transactions--
ReadSniCodeLook up and search SNI industry classification codes.GET /global-sni-registry
GET /global-sni-registry/<code>
POST /global-sni-registry/search
Global Settings -> Search SNI codes-
ReadStatisticCountView resource counters for a client.GET /statistics/counts/<client_id>-Dashboard -> View counters
ReadStatisticCountsList resource counters.GET /statistics/counts--
ReadUnplacedPaymentView a payment that the matching engine could not auto-place.GET /unplaced-payments/<unplaced_payment_id>Daily Routines -> View unplaced payments-
ReadUnplacedPaymentsList payments that the matching engine could not auto-place.GET /unplaced-payments--
ReadUnplacedPaymentReturnView a returned (bounced) payment transaction.GET /payment-transactions-returns/<id_>Daily Routines -> View payment returns-
ReadUnplacedPaymentReturnsList returned (bounced) payment transactions.GET /payment-transactions-returns--
ReadWebhookView configured webhooks.GET /webhook
GET /webhook/<id_>
--
ReadWebhookRequestLogSearch and view webhook request logs.GET /webhook/log/<id_>
POST /webhook/log/search
--
RemovePaymentRequestDelete an outbound payment request (Swish, etc.).DELETE /payment-requests/<id_>--
ReprieveCollectionBatchSet and close reprieve periods on collection batches.PUT /collection-batches/<collection_batch_id>/close-reprieve
PUT /collection-batches/<collection_batch_id>/reprieve
--
ReprieveCollectionBatchJobPOST /collection-batches/run-reprieve-job--
ResumeCollectionBatchPUT /collection-batches/<collection_batch_id>/resume--
RetryWebhookEventsRetry failed webhook event deliveries.PUT /webhook/log/retry/<id_>--
ReturnPaymentTransactionReturnsUpdate the return of a bounced payment transaction.PUT /payment-transactions-returns/<id_>/returnDaily Routines -> Return transactions-
ReturnUnplacedPaymentUpdate the return of an unplaced payment.PUT /unplaced-payments/<unplaced_payment_id>/returnDaily Routines -> Return unplaced-
RotateSecretServiceAccountRotate API secrets for service account integrations.PUT /service-accounts/<id_>/rotate-secretEnvironment -> Rotate secretsConfigure -> Rotate secrets
RunEngineRulePUT /engine-rule/run-validation--
SearchAutomationsSearch automation rules.POST /automation/search--
SearchBaseInterestRateSearch base interest rates.POST /base-interest-rates/searchGlobal Settings -> Search rates-
SearchBillsSearch service bills issued to your account.POST /bills/searchDaily Routines -> Search bills-
SearchChargesSearch charges including fees, interest, and adjustments.POST /charges/searchDaily Routines -> Search charges-
SearchCollectionBatchesSearch collection batches.POST /collection-batches/searchDebt Collection -> Search batches-
SearchCollectionBatchChargesSearch charges applied to a collection batch.POST /collection-batches/charges/search--
SearchCollectionBatchEventsSearch lifecycle events for a collection batch.POST /collection-batches/events/search--
SearchCollectionBatchGuarantorsSearch guarantors in a collection batch.POST /collection-batches/<collection_batch_id>/guarantors/search--
SearchCollectionBatchToDoSearch pending collection batch tasks.POST /collection-batch/todo/searchDebt Collection -> Search tasks-
SearchContactsSearch contact persons attached to a debtor.POST /debtors/<debtor_id>/contacts/searchRegistry -> Search contacts-
SearchDocumentSearch stored documents.POST /documents/search
POST /documents/search_extended
Environment -> Search documents-
SearchErpsSearch ERP integrations.POST /erps/searchRegistry -> Search ERP integrations-
SearchFinancingRulesSearch financing rule configurations.POST /financing-rules/searchRegistry -> Search financing rules-
SearchInstanceProvidersSearch instance provider tenants.POST /instance-providers/searchEnvironment -> Search providers-
SearchInternalRequestSearch internal requests in the dual confirmation workflow.POST /internal-request/searchRegistry -> Search requests-
SearchLabelsSearch labels for tagging resources.POST /labels/searchRegistry -> Search labels-
SearchNotesSearch free-form notes attached to resources.POST /notes/client-invoice-notes/search
POST /notes/search
Registry -> Search notes-
SearchPartPaymentSearch part-payment installments.POST /part-payments/search--
SearchPartPaymentGroupsSearch part-payment plan groupings for reporting.POST /part-payment-groups/search--
SearchPartPaymentAccountsSearch revolving credit part-payment accounts.POST /part-payment-accounts/searchRegistry -> Search payment accounts-
SearchPartPaymentAccountEventsSearch lifecycle events for part-payment accounts.POST /part-payment-accounts/events/searchRegistry -> Search account events-
SearchPartPaymentAccountFinancialEventsSearch financial movements on part-payment accounts.POST /part-payment-accounts/events/financial/search--
SearchPartPaymentAccountSettingsSearch per-account part-payment configuration.POST /part-payment-accounts/settings/search--
SearchPartPaymentPlansSearch part-payment plans bound to invoices.POST /part-payment-plans/searchRegistry -> Search payment plans-
SearchPartPaymentPlanCollectionBatchesSearch collection batches from part-payment plans.POST /part-payment-plans/collection-batches/searchRegistry -> Search collection batches-
SearchPartPaymentPlanEventsSearch part-payment plan lifecycle events.POST /part-payment-plans/events/searchRegistry -> Search plan events-
SearchPartPaymentPlanFinancialEventsSearch financial events recorded against a part-payment plan.POST /part-payment-plans/events/financial/search--
SearchPartPaymentPlanLedgerEventsSearch ledger-level postings for a part-payment plan.POST /part-payment-plans/events/ledger/searchRegistry -> Search ledger postings-
SearchPartPaymentPlanSettingsSearch plan-level configuration settings.POST /part-payment-plans/settings/search--
SearchPaymentAccountsSearch payment accounts and their settings.POST /payment-accounts/search
POST /payment-accountssettings/search
Accounting -> Search bank accounts-
SearchPaymentBatchesSearch grouped payment ingestion files.POST /payment-batches/searchDaily Routines -> Search payment batches-
SearchPaymentFilesSearch raw payment files ingested into the platform.POST /payment-files/searchDaily Routines -> Search payment files-
SearchPaymentMatchingEnginePOST /payment-matching-engine/search--
SearchPaymentMethodsSearch payment methods (Swish, autogiro, card, etc.).POST /payment-methods/searchGlobal Settings -> Search payment methods-
SearchPaymentMethodConfigurationsSearch and filter payment method configurations.POST /payment-methods/configurations/client/search
POST /payment-methods/configurations/search
POST /payment-methods/configurations/service-provider/search
Global Settings -> Search payment methods-
SearchPaymentReconciliationSearch unplaced payments for manual reconciliation.POST /payment-reconciliations/search--
SearchPaymentRequestsSearch outbound payment requests (Swish, etc.).POST /payment-requests/search--
SearchPaymentTransactionsSearch inbound payments received from debtors and reconciled to invoices.POST /payments/searchDaily Routines -> Search inbound payments-
SearchPaymentTransactionReturnsSearch returned (bounced) payment transactions.POST /payment-transactions-returns/searchDaily Routines -> Search returned payments-
SearchPriceBracketsSearch volume or amount brackets within a price list.POST /price-brackets/searchGlobal Settings -> Search price brackets-
SearchPriceListsSearch pricing-tier definitions.POST /price-lists/searchGlobal Settings -> Search price lists-
SearchPurchaseFilesSearch purchase files and purchases in collection batches.POST /collection-batches/purchase/file/search
POST /collection-batches/purchase/search
--
SearchReasonCodesSearch reason codes used in payment matching and rejections.POST /reason-code/searchGlobal Settings -> Search reason codes-
SearchServiceAccountsSearch server-to-server credentials and integrations.POST /service-accounts/searchEnvironment -> Search service accountsConfigure -> Integrations
SearchServiceProvidersSearch external service providers.POST /service-providers/searchRegistry -> Search service providers-
SearchServiceProviderInsuranceAgreementsSearch insurance agreements tied to service providers.POST /service-provider-insurance-agreement/search--
SearchSettlementAccountsSearch settlement accounts.POST /settlement-accounts/search--
SearchSettlementAccountTransactionsSearch transactions on settlement accounts.POST /settlement-account-transactions/search--
SearchStatisticCountSearch resource counters displayed in the operator dashboard.POST /statistics/counts/search--
SearchUnplacedPaymentsSearch unplaced payments and view matching helpers.GET /unplaced-payments/categories
POST /client-match-payments/search
POST /unplaced-payments/search
Daily Routines -> Search payments
Registry -> View debtor
-
SquidInvalidatePaymentsInvalidate vouchers by IDs.PUT /squidd/invalidate-payment-Errands -> Invalidate payments
StopCollectionBatchStop a collection batch.PUT /collection-batches/<collection_batch_id>/stop--
ToggleServiceAccountActivate or deactivate service accounts for integrations.PUT /service-accounts/<id_>/toggleEnvironment -> Toggle service accountsConfigure -> Toggle service account
TriggerCollectionBatchEventTrigger lifecycle events for collection batches.PUT /collection-batches/events/<collection_batch_id>/trigger--
TriggerDeliveryPOST /enforcement/deliveries/updates
POST /enforcement/retry_delivery
PUT /enforcement/api-logs/<api_log_id>/retry
PUT /enforcement/confirm_submission
PUT /enforcement/deliveries/create_deduction
PUT /enforcement/deliveries/create_recall
PUT /enforcement/deliveries/export_deduction
PUT /enforcement/deliveries/export_execution_deduction
PUT /enforcement/deliveries/export_recall
PUT /enforcement/deliveries/export_recall/<enforcement_number>
PUT /enforcement/deliveries/pull
PUT /enforcement/deliveries/push
PUT /enforcement/deliveries/ready_for_export
PUT /enforcement/deliveries/ready_for_export/<enforcement_number>
PUT /enforcement/report_closing_execution
PUT /enforcement/report_deduction
PUT /enforcement/report_execution_annual_fee
PUT /enforcement/report_execution_confirmation
PUT /enforcement/report_execution_distraint_salary
PUT /enforcement/report_execution_partial_disclosure
PUT /enforcement/report_recall
PUT /enforcement/report_verdict
PUT /enforcement/update_delivery
--
UnplacedPaymentMarkAsRevenueMark unplaced payments as revenue or revert the designation.PUT /unplaced-payments/<id_>/revenue-revert
PUT /unplaced-payments/<unplaced_payment_id>/revenue
Daily Routines -> Mark as revenue-
UnplacedPaymentWriteOffMark unplaced payments as write-offs or revert the write-off.PUT /unplaced-payments/<id_>/write-off
PUT /unplaced-payments/<id_>/write-off-revert
Daily Routines -> Write off payments-
UpdateAutomationChange an automation, including the event it reacts to, whether it is active, and the action it runs.PUT /automation/<_id>--
UpdateAutomationRuleChange a rule that decides when an automation runs.PUT /automation/rules/<_id>--
UpdateBaseInterestRateUpdate base interest rates and set active rates by currency.POST /base-interest-rates/<currency_>/active
PUT /base-interest-rates
PUT /base-interest-rates/<id_>
Global Settings -> Update interest rates-
UpdateBaseInterestSettingsUpdate base interest settings.PUT /base-interest-settings/<target_id>Registry -> Update interest settings-
UpdateChargesUpdate manual charges such as fees and interest.PUT /charges/<id_>--
UpdateCofaceRequestPOST /events/coface/event--
UpdateCollectionBatchPUT /collection-batches/<collection_batch_id>
PUT /collection-batches/<collection_batch_id>/judgement
--
UpdateCollectionBatchGuarantorUpdate guarantors assigned to collection batches.PUT /collection-batches/<collection_batch_id>/guarantors/<guarantor_id>--
UpdateCollectionBatchToDoUpdate collection batch tasks pending operator action.PUT /collection-batch/todo/<collection_batch_id>/<id>Daily Routines -> Resolve batch tasks-
UpdateCollectionFeeTypeConfigure collection fee types and their order.PUT /fee/type/<id>
PUT /fee/type/order
--
UpdateContactUpdate contact person details.PUT /contacts/<id_>Registry -> Update contacts-
UpdateEnforcementUpdate enforcement actions including recalling, closing cases, sending to execution, and adding notes.POST /enforcement/<enforcement_id>/create-execution-deduction
POST /enforcement/<enforcement_id>/notes
POST /enforcement/<enforcement_id>/send-to-execution
PUT /enforcement/<enforcement_id>/close-rejected-case
PUT /enforcement/<enforcement_id>/complete-closing-execution
PUT /enforcement/<enforcement_id>/recall
--
UpdateEngineRuleUpdate engine rules, criteria, criteria groups, settings, and advanced modules.DELETE /engine-rule-criteria-group/<id>
PUT /engine-rule-advanced-module/<id>
PUT /engine-rule-criteria-group/<id>
PUT /engine-rule-criteria/<id>
PUT /engine-rule/<engine_rule_id>/settings/<id_>
PUT /engine-rule/<id>
EngineRules -> Modify engine rules-
UpdateEngineRuleSchedulerFilterPUT /engine-rule/scheduler-filters/<id>--
UpdateErpsUpdate ERP integrations.PUT /erps/<id_>--
UpdateErpBillingSettingsUpdate ERP billing settings.PUT /erps/<id_>/settings/billing--
UpdateFinancingRulesModify per-product financing rule configurations.PUT /financing-rules/<id_>Registry -> Configure financing-
UpdateInstanceProvidersPUT /instance-providers/<id_>Environment -> Update providers-
UpdateInternalRequestPUT /internal-request/<id_>
PUT /internal-request/bulk-update
--
UpdateLabelsModify free-form labels used to tag resources.PUT /labels/<id>Global Settings -> Edit labels-
UpdateMultiplePriceListsPUT /price-lists/updateGlobal Settings -> Update price lists-
UpdateMultiplePriceListPricesUpdate multiple prices and price brackets across pricing tiers.PUT /price-lists/update-multiple-brackets
PUT /price-lists/update-multiple-prices
Global Settings -> Adjust prices-
UpdateNoteEdit free-form notes attached to resources.PUT /notes/<id_>Registry -> Edit notes-
UpdatePartPaymentAccountModify long-running part-payment accounts for revolving credit.PUT /part-payment-accounts/<id_>--
UpdatePartPaymentAccountSettingConfigure per-account part-payment settings.PUT /part-payment-accounts/settings/<id_>--
UpdatePartPaymentPlanModify closed-end part-payment plans bound to an invoice.PUT /part-payment-plans/<id_>--
UpdatePartPaymentPlanCollectionBatchUpdate collection batches arising from part-payment plans.PUT /part-payment-plans/collection-batches/<id_>--
UpdatePartPaymentPlanSettingUpdate plan-level part-payment settings.PUT /part-payment-plans/settings/<id_>--
UpdatePaymentAccountsUpdate bank account details and payment account settings.PUT /payment-accounts/<id_>
PUT /payment-accounts/<id_>/settings
Accounting -> Configure accounts-
UpdatePaymentMatchingEngineUpdate payment matching engines and connect or disconnect clients from them.DELETE /payment-matching-engine/<id_>/clients
DELETE /payment-matching-engine/<payment_matching_engine_id>/clients/<client_id>
POST /payment-matching-engine/<id_>/clients
PUT /payment-matching-engine/<payment_matching_engine_id>
--
UpdatePaymentMethodEdit payment methods (Swish, autogiro, card, etc.).PUT /payment-methods/<id_>Global Settings -> Edit methods-
UpdatePaymentMethodConfigurationUpdate payment method configuration and credentials.PUT /payment-methods/configurations/<id_>--
UpdatePaymentRequestUpdate payment request status, sync provider status, and retry payouts.GET /payment-requests/status/<id_>
POST /payment-requests/status
PUT /payment-requests/retry-payout/<payment_request_id>
--
UpdatePaymentRequestStatusPUT /events/payment-request-complete--
UpdatePaymentTransactionUpdate inbound payments received from debtors and reconciled to invoices.PUT /payments/<id_>Daily Routines -> Edit payments-
UpdatePaymentTransactionNoteUpdate notes on inbound payments.PUT /payments/<id_>/notes/<note_id>--
UpdatePaymentTransactionReturnsUpdate returned or bounced payment transactions.PUT /payment-transactions-returns/<id_>Daily Routines -> Update returns-
UpdatePriceBracketUpdate a volume or amount bracket within a price list.PUT /price-brackets/<id_>--
UpdatePriceBracketsReplace all price brackets within a price list.PUT /price-bracketsGlobal Settings -> Set brackets-
UpdatePriceListPricesUpdate prices within a pricing-tier definition.PUT /price-lists/<price_list_id>/pricesGlobal Settings -> Edit prices-
UpdateReasonCodeUpdate reason codes used in payment matching and rejections.PUT /reason-code/<code_>Global Settings -> Update codes-
UpdateServiceProviderInsuranceAgreementUpdate insurance agreements tied to a service provider.PUT /service-provider-insurance-agreement/<id_>Registry -> Manage insurance-
UpdateSetDefaultInstanceProvidersPUT /instance-providers/<id_>/defaultEnvironment -> Set defaults-
UpdateSniCodePUT /global-sni-registry/<code>Global Settings -> Update SNI code-
UpdateUnplacedPaymentUpdate payments that the matching engine could not auto-place.PUT /unplaced-payments/<unplaced_payment_id>Daily Routines -> Update unplaced payments-
UpdateWebhookUpdate webhook configurations.PUT /webhook/<id_>--
ValidatePaymentReferenceValidate a payment reference number against inbound payments.POST /payments/validate-payment-reference--
WriteOffOnCollectionBatchWrite off a collection batch.PUT /collection-batches/<collection_batch_id>/writeoff--
WriteOffOnPartPaymentPlanWrite off a part-payment plan.PUT /part-payment-plans/<id_>/write-off--

22 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
AuthorizePayoutBatchesAuthorize a payout batch awaiting bank submission.PUT /payout-batches/<id_>/authorizeDaily Routines -> Authorize payout batches-
BookkeepPayoutBatchesBookkeep batched payout files awaiting bank submission.PUT /payout-batches/<id_>/bookkeepDaily Routines -> Bookkeep payout batches-
CreatePayoutAccountsCreate bank accounts that payouts are sent from.POST /payout-accountsAccounting -> Create payout account-
CreatePayoutBatchReportGenerate a payout batch report document.POST /documents/payout-batch-reportDaily Routines -> Generate payout report-
DeletePayoutsDelete an outbound payout to clients or debtors.DELETE /payouts/<id_>--
DeletePayoutBatchesDelete a batched payout file awaiting bank submission.DELETE /payout-batches/<id_>Daily Routines -> Payouts -> Delete payout batch-
ExportPayoutBatchesExport a payout batch.PUT /payout-batches/<id_>/exportDaily Routines -> Export payouts-
GeneratePayoutBatchesGenerate payout batches for bank submission.PUT /payout-batches/generateDaily Routines -> Generate payouts-
ReadPayoutView payout and blocked payout details.GET /blocked-payouts/<id_>
GET /payouts/<id_>
--
ReadPayoutsView lists of payouts and blocked payouts.GET /blocked-payouts
GET /payouts
--
ReadPayoutSettlementsExternalExportExport per-payout settlement accounting for external systems.GET /payout-settlements
GET /payout-settlements/<id_>
--
ReadPayoutAccountView a payout account.GET /payout-accounts/<id_>Registry -> View payout account-
ReadPayoutAccountsView bank accounts used for sending payouts.GET /payout-accountsAccounting -> View bank accounts-
ReadPayoutBatchView a payout batch.GET /payout-batches/<id_>Daily Routines -> View payouts-
ReadPayoutBatchesList payout batches awaiting bank submission.GET /payout-batches--
ReadPayoutFileRetrieve a generated payout file in formats like SEPA XML or BG.GET /payout-files/<id_>--
ReadPayoutFilesList generated payout files in formats like SEPA XML or BG.GET /payout-files--
SearchPayoutsSearch payouts and blocked payouts.POST /blocked-payouts/search
POST /payouts/search
Daily Routines -> Search payouts-
SearchPayoutAccountsSearch bank accounts payouts are sent from.POST /payout-accounts/searchRegistry -> Search payout accounts-
SearchPayoutBatchesSearch payout batches awaiting bank submission.POST /payout-batches/searchDaily Routines -> Search payout batches-
SearchPayoutFilesSearch generated payout files in various formats.POST /payout-files/search--
UpdatePayoutAccountsUpdate bank account information for payouts.PUT /payout-accounts/<id_>Accounting -> Manage payout accounts-

19 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
AuthorizeRemindersAuthorize payment reminders.PUT /reminders/authorizeDaily Routines -> Authorize reminders-
BookkeepRemindersPUT /reminders/bookkeepDaily Routines -> Bookkeep reminders-
DeleteRemindersDelete reminders individually or in bulk.DELETE /reminders/<id_>
POST /reminders/bulk-delete
Daily Routines -> Reminders -> Delete reminder-
GenerateRemindersGenerate payment reminders.PUT /reminders/generateDaily Routines -> Generate reminders-
ReadReminderRetrieve a reminder by its ID.GET /reminders/<id_>--
ReadRemindersList reminders and their issuance history.GET /reminders--
ReadReminderProfileRetrieve a reminder profile template by its ID.GET /reminder-profiles/<id_>Global Settings -> View reminder profiles-
ReadReminderProfilesGET /reminder-profiles
PUT /reminder-profiles/<id_>/copy
Global Settings -> View reminder profiles-
CreateReminderProfileLevelsCreate individual reminder steps within a profile.POST /reminder-profile-levelsGlobal Settings -> View reminder profiles-
ReadReminderProfileLevelRetrieve an individual reminder step within a profile.GET /reminder-profile-levels/<id_>--
ReadReminderProfileLevelsList individual reminder steps within a profile.GET /reminder-profile-levels--
RemoveReminderProfileLevelsDelete reminder profile levels.DELETE /reminder-profile-levels/<id_>Global Settings -> Delete reminder levels-
ReportInvalidAddressRemindersMark reminders as having invalid addresses.PUT /reminders/<id_>/invalid-address--
SearchRemindersSearch reminder issuance and history.POST /reminders/searchDaily Routines -> Search reminders-
SearchReminderProfilesSearch reminder templates for cadence and content.POST /reminder-profiles/searchGlobal Settings -> Search reminder profiles-
SearchReminderProfileLevelsSearch individual reminder steps within profiles.POST /reminder-profile-levels/searchGlobal Settings -> Search reminder steps-
SetDefaultReminderProfilesMark a reminder profile as default.PUT /reminder-profiles/<id_>/default--
UpdateReminderProfilesUpdate reminder profile templates for cadence and content.PUT /reminder-profiles/<id_>Global Settings -> Update profiles-
UpdateReminderProfileLevelsUpdate individual reminder steps within a profile.PUT /reminder-profile-levels/<id_>Global Settings -> Manage levels-

20 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
AuthorizeTransactionReportsAuthorize generated transaction reports for compliance.PUT /reports/transaction-reports/authorizeDaily Routines -> Authorize transaction reports-
CreateQueryReportSchedulerCreate recurring schedules for custom query reports.POST /scheduler/query-report-Reports -> Schedule report
DeleteQueryReportSchedulerDelete scheduled custom query reports.DELETE /scheduler/query-report/<id_>-Reports -> Delete scheduled report
SearchQueryReportSchedulerSearch scheduled query reports.POST /scheduler/query-report/search--
UpdateQueryReportSchedulerConfigure recurring custom query reports and manage recipients.DELETE /scheduler/query-report/<id_>/recipient/<email>
POST /scheduler/query-report/<id_>/recipients
PUT /scheduler/query-report/<id_>
-Reports -> Configure delivery
ReadQueryReportSchedulerView scheduled custom query reports.GET /scheduler/query-report
GET /scheduler/query-report/<id_>
--
CreateBookkeepingFileSchedulerSet up recurring exports of bookkeeping files.POST /scheduler/bookkeeping-file--
ReadBookkeepingFileSchedulerView scheduled bookkeeping file exports.GET /scheduler/bookkeeping-file
GET /scheduler/bookkeeping-file/<id_>
--
UpdateBookkeepingFileSchedulerConfigure recurring bookkeeping file exports and manage recipients.DELETE /scheduler/bookkeeping-file/<id_>/recipient/<email>
POST /scheduler/bookkeeping-file/<id_>/recipients
PUT /scheduler/bookkeeping-file/<id_>
--
DeleteBookkeepingFileSchedulerDelete scheduled bookkeeping file exports.DELETE /scheduler/bookkeeping-file/<id_>--
SearchBookkeepingFileSchedulerSearch scheduled bookkeeping file exports.POST /scheduler/bookkeeping-file/search--
ExportTransactionReportsExport generated transaction reports.PUT /reports/transaction-reports/exportDaily Routines -> Export reports-
GenerateTransactionReportsGenerate transaction reports.PUT /reports/transaction-reports/generateDaily Routines -> Generate reports-
QueryReportQuery custom SQL-style report definitions and runs.POST /reports/query-reports/<id_>/queryAccounting -> Query report
Registry -> Query report
Daily Routines -> Query report
Reports -> Query report
ReadQueryReportView a custom SQL-style report definition by ID.GET /reports/query-reports/<id_>Reports -> View report-
ReadQueryReportsView custom SQL-style report definitions and runs.GET /reports/query-reports-Reports -> View reports
ReadTransactionReportView a generated transaction report for compliance.GET /reports/transaction-reports/<id_>--
ReadTransactionReportsView generated transaction reports for compliance.GET /reports/transaction-reports--
SearchQueryReportsSearch custom SQL-style report definitions and runs.POST /reports/query-reports/searchReports -> Search query reports-
SearchTransactionReportsSearch generated transaction reports for compliance.POST /reports/transaction-reports/searchDaily Routines -> Search transaction reports-

1 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
ReadModulesGET /modules
GET /modules/<id_>
Environment -> View modules-

2 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
ReadProductStatisticsPOST /statistics/product/<client_id>/ledger-snapshot
POST /statistics/product/<client_id>/open-balance
-Dashboard -> View statistics
ReadOverdueStatisticsView overdue-receivables statistics.POST /statistics/overdue/<client_id>/ledger-snapshot
POST /statistics/overdue/<client_id>/open-balance
-Dashboard -> View overdue stats

22 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CalculateStatusSystemErrandsTrigger a status recalculation on a system-generated errand.PUT /errands/system/<id_>/calculate-status--
CloseCeleryTasksPUT /celery-task/close--
CloseSystemErrandsMark system-generated operational tasks as completed.PUT /errands/system/<id_>/close-Errands -> Close errand
ForceCloseSystemErrandsForce close system-generated errands.PUT /errands/system/<id_>/force-close-Errands -> Close errands
CreateSystemBankAccountCreate and manage system bank accounts.POST /system-bank-accounts
PUT /system-bank-accounts/<id_>
--
CreateValidationErrorErrandsPOST /errands/system/invoice-validation-errors/<invoice_id>--
GetCeleryTaskIdRetrieve the latest Celery task ID for background jobs across pricing, charges, reminders, and engine rules.GET /celery-task/latest-task-id/<task_name>
GET /charges/authorize/latest-task-id
GET /charges/bill/latest-task-id
GET /charges/generate/latest-task-id
GET /engine-rule/run-validation/latest-task-id
GET /payment-batches/bookkeep/latest-task-id
GET /payment-batches/match/latest-task-id
GET /payment-files/import/latest-task-id
GET /price-lists/update-multiple-brackets/latest-task-id
GET /price-lists/update-multiple-prices/latest-task-id
GET /reminders/authorize/latest-task-id
GET /reminders/bookkeep/latest-task-id
GET /reminders/generate/latest-task-id
Daily Routines -> View task status-
GetCeleryTaskStatusGET /celery-task/<task_id>Daily Routines -> View task status-
GetValidationErrorErrandsGET /errands/system/invoice-validation-errors-Errands -> View errors
PerformSystemErrandsPerform system-generated errands requiring operator action.PUT /errands/system/<id_>/performSystemErrandList -> Perform errand-
ReadSystemBankAccountSearch system bank accounts.POST /system-bank-accounts/search--
ReadSystemErrandView system-generated errands and their events.GET /errands/system/<id_>
GET /errands/system/<id_>/events
Daily Routines -> View errandsErrands -> View errands
ReadSystemErrandsView system-generated errands requiring operator action.GET /errands/system--
ReadSystemErrandCountsView pending system errand counters.GET /reports/system-errand-counts-Dashboard -> View errand counts
ReadSystemExchangeRatesView daily exchange rate snapshots.GET /system/exchange-ratesDaily Routines -> View exchange rates-
ReadSystemSettingView tenant-wide system settings.GET /system-setting
GET /system-setting/<key_>
Environment -> View settings-
ResolveSystemErrandsResolve system-generated errands requiring operator attention.PUT /errands/system/<id_>/resolveRegistry -> Resolve errandsErrands -> Resolve system errands
SearchSystemErrandsSearch system-generated errands requiring operator action.POST /errands/system/searchDaily Routines -> Search errands-
SearchSystemErrandCountsSearch counters of pending system errands.POST /reports/system-errand-counts/search--
UpdateErrandSuggestionUpdate monitoring suggestions for system-generated errands.PUT /errands/system/<errand_system_id>/update-monitoring-suggestion--
UpdateSystemSettingUpdate tenant-wide system settings.PUT /system-setting/<key_>--
ViewDeveloperToolsAccess the admin Developer Tools / Developer Mode drawer (live API and webhook logs, cache, access and environment panels). UI capability only.-Developer Mode (user menu)-

15 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
ConnectLogotypeToTemplateAdd a logo to a fee or interest template.PUT /client-financial-price-template/<id_>/logotype--
CreateDocumentTemplateCreate templated documents such as invoices and reminders.POST /document-templatesGlobal Settings -> Create templateDashboard -> Create template
CreateDocumentTemplatePlaceholdersAdd placeholders to document templates.POST /document-templates/<id_>/placeholdersGlobal Settings -> Add placeholders-
CreateTemplateCreate fee and interest templates for client accounts.POST /client-financial-price-template--
DeleteDocumentTemplateDelete document templates (invoices, reminders, etc.).DELETE /document-templates/<id_>Global Settings -> Collection Settings -> Delete document template-
DeleteDocumentTemplatePlaceholdersDelete placeholders from document templates.DELETE /document-templates/<id_>/placeholders/<pc_id>--
EditTemplateEnable or disable fee and interest templates for clients.PUT /client-financial-price-template/<id_>/enabled--
ReadDocumentTemplateView templated documents like invoices and reminders.GET /document-templates/<id_>--
ReadDocumentTemplatesView document templates for invoices, reminders, and other documents.GET /document-templates--
ReadTemplateView and search client fee and interest templates.GET /client-financial-price-template
GET /client-financial-price-template/<id_>
GET /settings/client-financial-price-template/<template_id>
GET /settings/client-financial-price-template/flag/<template_id>
POST /settings/client-financial-price-template/search
Global Settings -> View price lists
Registry -> View client templates
-
SearchDocumentTemplatesSearch document templates for invoices and reminders.POST /document-templates/searchGlobal Settings -> Search templates-
UpdateDocumentTemplateUpdate document templates such as invoices and reminders.PUT /document-templates/<id_>Global Settings -> Update templates-
UpdateDocumentTemplatePlaceholdersUpdate placeholders in document templates such as invoices and reminders.PUT /document-templates/<id_>/placeholders/<pc_id>Global Settings -> Update placeholders-
UpdateSetDefaultDocumentTemplatesMark a document template as the default.PUT /document-templates/<id_>/default--
UpdateTemplateUpdate client financial price templates and their settings.DELETE /settings/client-financial-price-template/<template_id>/<setting_key>
PUT /client-financial-price-template/<id_>
PUT /settings/client-financial-price-template/<template_id>
PUT /settings/client-financial-price-template/flag/<template_id>
Global Settings -> Update price templates-

33 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
AddRoleRightAdd rights to a role definition.POST /roles/<id_>/rights/<right_id>--
ChangeMfaUsersChange multi-factor authentication settings for user accounts.PUT /users/<id_>/change-mfa--
ChangePasswordUsersChange user account passwords.PUT /users/<id_>/change-passwordEnvironment -> Change user passwordConfigure -> Change password
CreateContentUserSettingPOST /content-user-setting--
CreateRolesCreate roles with bundled rights.POST /roles--
CreateUsersCreate tenant users with default roles based on user type.POST /usersEnvironment -> Create userConfigure -> Add user
CreateUserGroupsCreate user groups for bulk role assignment and permission control.POST /user-groups--
CreateUserGroupUsersPOST /user-groups/<id_>/users--
CreateUserRolesPOST /users/<id_>/rolesEnvironment -> Assign user role-
DeleteContentUserSettingDELETE /content-user-setting/<id>--
DeleteRoleDelete role definitions and their bundled rights.DELETE /roles/<id_>--
DeleteUserGroupsDelete user groups used for bulk role and permission management.DELETE /user-groups/<id_>--
DeleteUserGroupUsersRemove users from a user group.DELETE /user-groups/<id_>/users/<user_id>--
DeleteUserRolesRemove roles from users (super-user only).DELETE /users/<id_>/roles/<role_id>Environment -> Roles -> Delete user role-
ReadContentUserSettingGET /content-user-setting/<type>--
ReadContentUserSettingsGET /content-user-setting--
ReadRoleView a role and the rights bundled into it.GET /roles/<id_>--
ReadRolesList all roles and their bundled rights.GET /roles--
ReadUserView a tenant user, including their roles and activation state.GET /users/<id_>Environment -> View usersConfigure -> View users
ReadUsersList and view user accounts and system users.GET /ping/secured
GET /users
GET /users/system
--
ReadUserGroupView a user group for role assignment and permission control.GET /user-groups/<id_>--
ReadUserGroupsList user groups for role assignment and permission control.GET /user-groupsRegistry -> View user groups-
ReadUserGroupUsersView users within a user group.GET /user-groups/<id_>/users--
ReadUserRolesView roles assigned to a tenant user.GET /users/<id_>/rolesEnvironment -> View user roles-
RemoveRoleRightRemove rights from a role definition.DELETE /roles/<id_>/rights/<right_id>--
ResetMfaUsersReset multi-factor authentication for a user and send enrollment.POST /users/reset-auth0-mfaEnvironment -> Reset MFA-
SearchUsersSearch tenant users.POST /users/searchRegistry -> Search users
Environment -> Search users
Configure -> Search users
SearchUserGroupsSearch user groups.POST /user-groups/searchRegistry -> Search groups-
ToggleSuperUsersToggle super-user status for tenant users.PUT /users/<id_>/toggle-super-user--
ToggleUsersActivate or deactivate tenant user accounts.PUT /users/<id_>/toggleEnvironment -> Toggle usersConfigure -> Activate or deactivate users
UpdateContentUserSettingPUT /content-user-setting/<id>--
UpdateUsersUpdate tenant user accounts.PUT /users/<id_>Environment -> Update usersConfigure -> Update user accounts
UpdateUserGroupsUpdate user groups for bulk role assignment and permission control.PUT /user-groups/<id_>--

20 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
CreateSyncVoucherEventsReceive and process voucher completion events from an ERP system.POST /events/sync-voucher-complete--
CreateVouchersCreate a voucher.POST /vouchersAccounting -> Create voucher-
ExportExternalVouchersMark vouchers as exported to external systems.PUT /vouchers/<id_>/external/export--
ExportVouchersMark vouchers as exported.PUT /vouchers/<id_>/export--
ExternalBookkeepVouchersMark vouchers as bookept in an external system.PUT /vouchers/<id_>/external/bookkeep--
ExternalFailVouchersMark vouchers as failed in external systems.PUT /vouchers/<id_>/external/fail--
ReadVoucherView vouchers and their summaries.GET /vouchers/<id_>
GET /vouchers/summary/<relation>/<topic>/<id_>
Accounting -> View vouchers-
ReadVouchersList vouchers.GET /vouchers--
ReadVouchersExternalExportPaymentsGET /vouchers/external/export/payments--
ReadVouchersExternalExportVouchersGET /vouchers/external/export/vouchers--
ReadVoucherPostingRetrieve a voucher posting.GET /voucher-postings/<id_>--
ReadVoucherPostingsList voucher postings.GET /voucher-postings--
ReadVoucherSettingsLockedPeriodView voucher locked period settings.GET /vouchers/settings/locked-periodAccounting -> View locked periods-
RetryVoucherPostingCreateRetry voucher requests.POST /voucher-request/<id_>/retry--
ReverseVouchersReverse vouchers.PUT /vouchers/<id_>/reverseAccounting -> Reverse vouchers-
SearchVouchersSearch vouchers.POST /vouchers/searchAccounting -> Search vouchers
Registry -> View invoices
-
SearchVoucherPostingsSearch individual posting rows on vouchers.POST /voucher-postings/searchAccounting -> View postings-
SupportResendVoucherResend vouchers externally and send individual historic vouchers via webhook.POST /vouchers/<id_>/webhook-export
PUT /vouchers/<id_>/external/resend
--
SupportUpdateVoucherStatusUpdate the external status of a voucher.PUT /vouchers/<id_>/external/status--
UpdateVoucherSettingsLockedPeriodPUT /vouchers/settings/locked-periodAccounting -> Update voucher settings-

3 rights.

RightDescriptionAPI endpointsOperations PortalClient UI
StrawbayOnboardingManage the Strawbay ERP integration onboarding flow, including starting, cancelling, and completing the connection.GET /strawbay
GET /strawbay/onboarding
POST /strawbay/onboarding/complete
POST /strawbay/onboarding/error
POST /strawbay/onboarding/start
PUT /strawbay/connection/linking-retry
PUT /strawbay/onboarding/cancel
--
StrawbayConnectionGET /strawbay
GET /strawbay/connection
PUT /strawbay/connection/linking-retry
PUT /strawbay/connection/stop
--
StrawbayFlowGET /strawbay/flow--