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.
AML (Anti-Money Laundering)
Section titled “AML (Anti-Money Laundering)”3 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CreateAmlMonitoringEvents | Record anti-money laundering monitoring results. | POST /events/aml-monitoring-result | - | - |
ManageTransactionMonitoring | Add notes and override AML transaction-monitoring hits. | POST /aml/transaction-monitoring/<id_>/notesPOST /aml/transaction-monitoring/<id_>/override | AML -> Override hit status | - |
ViewTransactionMonitoring | View and search AML transaction monitoring rules and hits. | GET /aml/transaction-monitoring/<id_>POST /aml/transaction-monitoring/events/searchPOST /aml/transaction-monitoring/search | AML -> Search transaction monitoring AML -> View monitoring events | - |
Article Management
Section titled “Article Management”6 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CreateArticleLabels | Create labels for articles within an invoice. | POST /invoices/<invoice_id>/article_labels | - | - |
ReadArticle | View details of a reusable invoice line item. | GET /articles/<id_> | - | - |
ReadArticles | List reusable invoice line items. | GET /articles | - | - |
ReadArticleLabels | View labels for articles in an invoice. | GET /invoices/<invoice_id>/article_labels | - | - |
SearchArticles | Search articles. | POST /articles/search | Global Settings -> Search articles | - |
UpdateArticles | Update reusable invoice line items individually or in bulk. | PUT /articles/<id_>PUT /articles/bulk-update | Global Settings -> Update articles | - |
Bookkeeping
Section titled “Bookkeeping”14 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
BookkeepBills | Record service bills issued by the platform to clients. | PUT /bills/bookkeep | Daily Routines -> Bookkeep bills | - |
BookkeepPaymentBatches | Bookkeep grouped payment ingestion files. | PUT /payment-batches/<id_>/bookkeep | Daily Routines -> Bookkeep payment batches | - |
CalculateBalanceBookkeepingAccounts | Recalculate balances for bookkeeping accounts. | PUT /bookkeeping-accounts/<id_>/calculate-balance | - | - |
CreateBookkeepingAccount | Create a bookkeeping account. | POST /bookkeeping-accounts | Accounting -> Create bookkeeping account | - |
ExportBookkeepingFile | Export a generated bookkeeping file. | PUT /bookkeeping-files/<id_>/export | - | - |
GenerateBookkeepingFile | Generate bookkeeping files. | PUT /bookkeeping-files/generate | - | - |
GenerateInternalBookkeepingFile | Generate internal bookkeeping files for accounting. | PUT /bookkeeping-files/internal/generate | Accounting -> Generate bookkeeping files | - |
ReadBookkeepingAccount | View details of a bookkeeping account. | GET /bookkeeping-accounts/<id_> | Accounting -> View account | - |
ReadBookkeepingAccounts | List bookkeeping accounts. | GET /bookkeeping-accounts | - | - |
ReadBookkeepingFile | View a generated bookkeeping file by ID. | GET /bookkeeping-files/<id_> | - | - |
ReadBookkeepingFiles | List generated bookkeeping files. | GET /bookkeeping-files | - | - |
SearchBookkeepingAccounts | Search bookkeeping accounts. | POST /bookkeeping-accounts/search | Accounting -> Search accounts | Configure -> Search accounts |
SearchBookkeepingFiles | Search generated bookkeeping files. | POST /bookkeeping-files/search | Accounting -> Search files | - |
UpdateBookkeepingAccount | Update bookkeeping account settings. | PUT /bookkeeping-accounts/<id_> | Accounting -> Update bookkeeping | Configure -> Update bookkeeping |
Business Loan Management
Section titled “Business Loan Management”25 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
AddToArchiveBusinessLoans | Add a business loan record to the archive. | PUT /business-loans/<id_>/archive/add | - | - |
CreateBusinessLoan | Create a business loan. | POST /business-loans | - | - |
CreateBusinessLoanToDo | POST /business-loan/todo | - | - | |
CreateBusinessLoanWithdrawal | Create a withdrawal request for a business loan that requires dual confirmation. | PUT /business-loans/<id_>/withdraw | - | - |
CreateLoanProfile | Create and update loan profiles. | POST /loan-profilesPUT /loan-profiles/<loan_profile_id> | - | - |
CreditDecisionApproveBusinessLoans | Approve the credit decision for a business loan. | PUT /business-loans/<id_>/credit-decision/approve | - | - |
CreditDecisionDenyBusinessLoans | Deny the credit decision for a business loan. | PUT /business-loans/<id_>/credit-decision/deny | - | - |
DeleteBusinessLoanToDo | Delete a to-do item from a business loan. | DELETE /business-loan/todo/<business_loan_id>/<id> | - | - |
GetBusinessLoanToDo | GET /business-loan/todo/<business_loan_id>GET /business-loan/todo/<business_loan_id>/<id> | - | - | |
InstallmentSummaryBusinessLoans | Update installment summaries for business loans individually or in bulk. | PUT /business-loans/<id_>/installment/summaryPUT /business-loans/installment/summary | - | - |
ReadBusinessLoan | GET /business-loans/<id_>GET /business-loans/<id_>/feesGET /business-loans/<id_>/guarantorsGET /business-loans/<id_>/profile | - | - | |
ReadBusinessLoanChangelog | View change history for business loans. | GET /changelog/business-loanGET /changelog/business-loan/<id_> | - | - |
ReadBusinessLoanEvent | View a single business loan event. | GET /business-loans/events/<id_> | - | - |
ReadBusinessLoanEvents | List business loan events. | GET /business-loans/events | - | - |
ReadBusinessLoanFinancialEvents | View financial events for business loans. | GET /business-loans/<business_loan_id>/financial-events | - | - |
ReadBusinessLoanLedgerEvent | View a single business loan ledger event. | GET /business-loans/events/ledger/<id_> | - | - |
ReadBusinessLoanLedgerEvents | List business loan ledger events. | GET /business-loans/events/ledger | - | - |
ReadLoanProfile | Search and view loan profile details. | GET /loan-profiles/<loan_profile_id>POST /loan-profiles/search | - | - |
RemoveFromArchiveBusinessLoans | Remove archived business loans. | PUT /business-loans/<id_>/archive/remove | - | - |
SearchBusinessLoanToDo | Search business loan todos. | POST /business-loan/todo/search | - | - |
SearchBusinessLoans | Search business loans. | POST /business-loans/search | - | - |
SearchBusinessLoanEvents | Search business loan events. | POST /business-loans/events/search | - | - |
SearchBusinessLoanLedgerEvents | Search business loan ledger events. | POST /business-loans/events/ledger/search | - | - |
UpdateBusinessLoan | Update business loans and loan profiles. | PUT /business-loans/<id_>PUT /business-loans/<id_>/profile | - | - |
UpdateBusinessLoanToDo | PUT /business-loan/todo/<business_loan_id>/<id> | - | - |
Client Management
Section titled “Client Management”142 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
ApplyClientProducts | Apply a client product binding. | PUT /client-products/<id_>/apply | - | - |
BookClientUnplacedPayment | PUT /unplaced-payments/client/<id_>/link/bookPUT /unplaced-payments/client/<id_>/link/<link_id>/book | Daily Routines -> Book unplaced payments | - | |
CalculateBalanceClientAccounts | Recalculate balances for client accounts. | PUT /client-accounts/<id_>/calculate-balance | Accounting -> Calculate account balance | - |
ConnectClientToClientHandler | Connect 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 | - |
ConnectClientToErp | Link a client to an ERP integration. | PUT /erps/<id_>/connect/<client_id> | - | - |
ConnectClientToGit | Link a client to a Git repository. | PUT /clients/<client_id>/connect-to-git | - | - |
ConnectErpToClient | Link an ERP system to a client. | PUT /clients/<id_>/erp-connect | Registry -> Connect ERP system | Configure -> Connect ERP system |
ConnectLogotypeToClient | Attach a logo to a client. | PUT /clients/<id_>/logotype | Registry -> Attach client logo | - |
CreateClientAccount | Create a client account. | POST /client-accounts | - | - |
CreateClientAccountTransaction | Create a client account transaction. | POST /client-account-transactions | Accounting -> Create account transaction | - |
CreateClientArticle | POST /clients/articles | - | Configure -> Create article | |
CreateClientBankAccount | Create client bank account profiles and accounts. | POST /client-bank-accountPOST /client-bank-account-profile | Registry -> Manage bank accounts | - |
CreateClientDocumentSetting | POST /clients/<id_>/document-setting | ClientTransactionReports -> Configure document setting | - | |
CreateClientEmailRecipient | POST /clients/<id_>/email-recipients | Registry -> Manage email recipients | - | |
CreateClientGroups | Create a client group for shared settings and rollups. | POST /client-groups | - | - |
CreateClientGroupClients | POST /client-groups/<id_>/clients | - | - | |
CreateClientHandlers | Create a client handler. | POST /client-handlers | - | - |
CreateClientInvoiceRequest | Create a client invoice request. | POST /client-invoice-request | - | Dashboard -> Request invoice |
CreateClientInvoiceRequestComment | POST /client-invoice-request/<id>/comment | - | - | |
CreateClientInvoiceRequestDocument | Upload an attachment to a client invoice request. | POST /client-invoice-request/<id>/documents | - | - |
CreateClientLabels | Create labels for clients. | POST /clients/<client_id>/labels | Registry -> Create labels | - |
CreateClientPaymentReferenceSettings | Create payment reference settings for client accounts, collection batches, and invoices. | POST /client-account-payment-reference-settingsPOST /collection-batch-payment-reference-settingsPOST /invoice-payment-reference-settings | - | - |
CreateClientSyncInvoices | Trigger an invoice sync for a client. | POST /clients/<client_id>/sync/invoices | Registry -> Sync invoices | Sync -> Sync invoices |
CreateClientToDo | Create todo items for clients. | POST /client/todo | Registry -> Create todo | - |
CreateClientTransferText | Create client transfer texts. | POST /client-transfer-text | Registry -> Create transfer text | - |
CreateClientUser | Create client user accounts. | POST /client-users | Registry -> Create user | - |
CreateClients | Create new clients. | POST /clients | - | - |
CreatePaymentTransactionsClientRestricted | Create inbound debtor payments and reconcile them to invoices. | POST /paymentsPOST /payments/multiple | - | - |
CreatePayoutForClientAccounts | Update payout configuration for a client account. | PUT /client-accounts/<id_>/payout | Accounting -> Configure payout | - |
DeclineMultipleClientInvoiceRequest | Decline multiple client invoice requests in a single action. | PUT /client-invoice-request/decline-multiple | - | - |
DeleteClientArticle | Delete articles owned by a specific client. | DELETE /clients/articles/<id_> | - | Configure -> Delete article |
DeleteClientBankAccount | Delete a client bank account. | DELETE /client-bank-account/<id> | Registry -> Delete bank account | - |
DeleteClientEmailRecipient | Delete email recipients configured for a client. | DELETE /clients/<id_>/email-recipients/<er_id_> | Registry -> Remove email recipient | - |
DeleteClientGroups | Delete a client group. | DELETE /client-groups/<id_> | - | - |
DeleteClientGroupClients | Remove clients from a client group. | DELETE /client-groups/<id_>/clients/<client_id> | - | - |
DeleteClientLabels | Delete labels assigned to a client. | DELETE /clients/<client_id>/labels/<id> | Registry -> Delete client label | - |
DeleteClientUser | Delete a client user account. | DELETE /client-users/<id_> | Environment -> Delete user | - |
DenyClientUnplacedPayment | Deny a client’s link to an unplaced payment. | PUT /unplaced-payments/client/<id_>/link/denyPUT /unplaced-payments/client/<id_>/link/<link_id>/deny | Daily Routines -> Import Payments -> Client Link Requests -> Deny payment link | - |
DisableClientSync | PUT /clients/<client_id>/sync/disablePUT /clients/<client_id>/sync/reset | Registry -> Disable sync | - | |
EnableClientSync | Enable external-system sync for a client. | PUT /clients/<client_id>/sync/enable | Registry -> Enable sync | Configure -> Enable sync |
GenerateClientToken | Generate a token for a client. | POST /token/client/generate | - | Configure -> Generate token |
GetClientCreditDecisionStatus | View factoring buy/sell decisions for clients. | GET /factoring-decisions/clients/<id_> | - | - |
GetClientPaymentReferenceSettings | View 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> | - | - |
GetClientToDo | GET /client/todo/<client_id>GET /client/todo/<client_id>/<id> | - | - | |
IgnoreClientUnplacedPayment | Mark an unplaced payment as ignored. | PUT /unplaced-payments/client/<id_>/ignore | - | Unplaced payments -> Ignore payment |
LinkClientUnplacedPayment | Link an unplaced payment to an invoice. | PUT /unplaced-payments/client/<id_>/link | - | Unplaced payments -> Link payment |
LinkUnplacedPaymentClientRestricted | Assign unmatched payments to invoices. | PUT /unplaced-payments/<id_>/link | Daily Routines -> Link payment | - |
ManageClientSettings | View, 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/searchPUT /settings/client/<client_id>PUT /settings/client/flag/<client_id> | Registry -> Manage settings | Dashboard -> Manage settings |
ManageOwnClientSettings | View and update client flag settings. | GET /settings/client/flagPUT /settings/client/flag | - | Dashboard -> Manage settings |
ReadClient | View client company details and contact information. | GET /clients/<id_> | Registry -> View client | Dashboard -> View client |
ReadClientAccount | View a client account by ID. | GET /client-accounts/<id_> | - | - |
ReadClientAccounts | View client accounts including balance and account configuration. | GET /client-accounts | - | - |
ReadClientAccountTransaction | View a client account transaction by ID. | GET /client-account-transactions/<id_> | - | - |
ReadClientAccountTransactions | List client account transactions. | GET /client-account-transactions | - | - |
ReadClientArticle | View client articles. | GET /clients/articlesGET /clients/articles/<id_> | - | - |
ReadClientBankAccount | View 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> | - | - |
ReadClientBillingDetails | View client billing settings. | GET /clients/<id_>/settings/billing | - | - |
ReadClientBookkeepingDetails | View client bookkeeping settings and configuration. | GET /clients/<id_>/settings/bookkeeping | - | - |
ReadClientChangelog | View change history for clients. | GET /changelog/clientGET /changelog/client/<id_> | - | - |
ReadSettingChangelog | View change history for system settings. | GET /changelog/system-settingGET /changelog/system-setting/<key_> | System -> Settings | - |
ReadClientComplianceSetting | View client compliance settings. | GET /clients/<id_>/settings/compliance | - | - |
ReadClientCreditStatus | View a credit status definition by ID. | GET /credit-statuses/<id_> | - | - |
ReadClientCreditStatuses | List credit status definitions. | GET /credit-statuses | - | - |
ReadClientCreditStatusGlobal | View a global credit status override by ID. | GET /credit-status-global/<id_> | - | - |
ReadClientDocumentSetting | View client document settings. | GET /clients/<id_>/document-setting | Daily Routines -> View document settings | - |
ReadClientEmailRecipient | View email recipients configured for a client. | GET /clients/<id_>/email-recipients | Registry -> View email recipients | - |
ReadClientFinancingLimits | View consolidated financing limit breakdown for a client. | GET /clients/<client_id>/financing-limits | - | Dashboard -> View financing limits |
ReadClientGroup | View a client group by ID. | GET /client-groups/<id_> | - | - |
ReadClientGroups | List client groups. | GET /client-groups | - | - |
ReadClientGroupClients | View clients within a specific client group. | GET /client-groups/<id_>/clients | - | - |
ReadClientHandler | View details of a specific client handler. | GET /client-handlers/<id_> | - | - |
ReadClientHandlers | List all client handlers. | GET /client-handlers | Registry -> View handlers | - |
ReadClientHandlerBillingDetails | View billing details for a client handler. | GET /client-handlers/<id_>/billing-details | - | - |
ReadClientInvoiceDetails | View client invoice issuance settings. | GET /clients/<client_id>/settings/invoice | Registry -> View invoice settings | Dashboard -> View invoice settings |
ReadClientInvoiceRequest | List and search client invoice requests. | GET /client-invoice-requestGET /client-invoice-request/<id>GET /client-invoice-request/enabledPOST /client-invoice-request/search | - | Change requests -> View requests |
ReadClientInvoiceTextSetting | GET /clients/<id_>/settings/invoice-textPOST /clients/<id_>/settings/invoice-text | Registry -> View invoice text | - | |
ReadClientLabels | View labels assigned to a client. | GET /clients/<client_id>/labels | Registry -> View labels | - |
ReadClientProduct | View details of a product binding for a client. | GET /client-products/<id_> | - | - |
ReadClientProducts | View product bindings (factoring, service, etc.) for clients. | GET /client-products | - | Dashboard -> View products |
ReadClientReminderProfiles | View the default reminder profile for a client. | GET /clients/<id_>/reminder-profiles/default | Registry -> View reminder profiles | - |
ReadDebtorReminderProfiles | View the reminder profile set on a client debtor. | GET /debtors/<id_>/reminder-profiles/defaultGET /debtors/<id_>/reminder-profiles/effective | Registry -> View debtor reminder profiles | - |
ReadClients | List clients. | GET /clients | - | - |
ReadClientSync | View client external-system sync status and last sync dates. | GET /clients/<client_id>/sync | Registry -> View sync status | Dashboard -> View sync status |
ReadClientSyncInvoices | View and search synced invoices for a client. | GET /clients/<client_id>/sync/invoicesPOST /clients/<client_id>/sync/invoices/search | Registry -> View synced invoices | - |
ReadClientTransferText | Search client transfer texts. | POST /client-transfer-text/search | Registry -> Search transfer text | - |
ReadClientUnplacedPayment | View a client-scoped unplaced payment by ID. | GET /unplaced-payments/client/<id_> | - | - |
ReadClientUnplacedPayments | List unplaced payments visible to clients. | GET /unplaced-payments/client | - | - |
ReadClientUsers | View client user accounts and details. | GET /client-usersGET /client-users/<id_> | - | Configure -> View users |
ReadTemplateClients | View client financial price template engine rules and history. | GET /client-financial-price-template/<id_>/clients/engine-ruleGET /client-financial-price-template/<id_>/clients/engine-rule/historyGET /client-financial-price-template/<id_>/clients/engine-rule/status | - | - |
ReadUnplacedPaymentClientRestricted | View unplaced payments. | GET /unplaced-payments/<unplaced_payment_id> | Daily Routines -> View unplaced payments | - |
ReportStatusClientSync | PUT /clients/<client_id>/sync/status | - | - | |
ReportSyncStatusClientInvoices | Report and manage invoice sync status for clients. | PUT /clients/<client_id>/sync/invoices/statusPUT /clients/sync/invoices/status | - | - |
ReturnClientUnplacedPayment | Return unplaced payments to client. | PUT /unplaced-payments/client/<unplaced_payment_id>/return | - | Invoices -> Return unplaced payment |
ReturnUnplacedPaymentClientRestricted | Return unplaced payments. | PUT /unplaced-payments/<unplaced_payment_id>/return | Daily Routines -> Return unplaced | - |
SearchClientAccounts | Search client accounts. | POST /client-accounts/search | Accounting -> Search client accounts | - |
SearchClientAccountTransactions | Search client account transactions. | POST /client-account-transactions/search | Registry -> Search transactions | Errands -> Search transactions |
SearchClientArticle | Search client articles. | POST /clients/articles/search | - | Articles -> Search articles |
SearchClientBankAccount | Search client bank accounts and profiles. | POST /client-bank-account-profile/searchPOST /client-bank-account/search | - | - |
SearchClientChangelog | Search audit history for resource changes. | POST /changelog/search | - | - |
SearchClientCreditDecisionStatus | Search client factoring decision status. | POST /factoring-decisions/clients/daily/searchPOST /factoring-decisions/clients/search | - | - |
SearchClientCreditStatuses | Search credit status definitions. | POST /credit-statuses/search | Registry -> Search credit statuses | - |
SearchClientCreditStatusesGlobal | Search global credit status overrides. | POST /credit-status-global/search | Registry -> Search global credit statuses | - |
SearchClientGroups | Search client groups. | POST /client-groups/search | - | - |
SearchClientHandlers | Search client handlers. | POST /client-handlers/search | - | - |
SearchClientPaymentReferenceSettings | Search client account, collection batch, and invoice payment reference settings. | POST /client-account-payment-reference-settings/searchPOST /collection-batch-payment-reference-settings/searchPOST /invoice-payment-reference-settings/search | - | - |
SearchClientProducts | Search product bindings for clients. | POST /client-products/search | Registry -> Search products | - |
SearchClientToDo | Search client todos. | POST /client/todo/search | Events -> Search tasks | - |
SearchClientUnplacedPayments | Search unplaced payments. | POST /unplaced-payments/client/search | - | Unplaced Payments -> Search payments |
SearchClientUsers | Search client users. | POST /client-users/search | Environment -> Search users | - |
SearchClients | Search clients. | POST /clients/search | Registry -> Search clients | - |
SearchPreviousClientCollectionBatch | POST /collection-batches/previous-clients/search | - | - | |
SearchUnplacedPaymentClientRestricted | View and search unplaced payments. | GET /unplaced-paymentsPOST /unplaced-payments/search | Daily Routines -> Search unplaced payments | - |
ShowRestrictedSenderInformationForClients | When 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 |
SupportAbortSyncClientInvoices | Abort invoice synchronization for a client. | PUT /clients/<client_id>/sync/invoices/abort | Registry -> Abort sync | - |
ToggleClientProducts | Toggle product activation status for a client. | PUT /client-products/<id_>/toggle | Registry -> Manage products | - |
TransferBetweenClientAccounts | Transfer funds between client accounts. | PUT /client-accounts/transfer | Accounting -> Transfer funds | - |
TransferBetweenClientAccountsFromTransaction | Transfer funds between client accounts based on an existing client account transaction. | PUT /client-accounts/transfer-from-transaction | - | - |
UpdateClientAccount | Update a client account. | PUT /client-accounts/<id_> | Accounting -> Update account | - |
UpdateClientArticle | Update client-owned articles. | PUT /clients/articles/<id_> | - | Configure -> Update articles |
UpdateClientBankAccount | Update client bank account details and profiles. | PUT /client-bank-account-profile/<id>PUT /client-bank-account/<id> | Registry -> Update bank account | - |
UpdateClientBillingDetails | Update client billing details. | PUT /clients/<id_>/settings/billing | Registry -> Update billing | - |
UpdateClientBookkeepingDetails | Update client bookkeeping settings and configuration. | PUT /clients/<id_>/settings/bookkeeping | Registry -> Update client settings | Configure -> Update bookkeeping settings |
UpdateClientCollectionBatch | Update the client assigned to a collection batch. | PUT /collection-batches/<collection_batch_id>/update-client | - | - |
UpdateClientComplianceSettings | Update client compliance settings. | PUT /clients/<id_>/settings/compliance | - | - |
UpdateClientCreditStatuses | Update 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 | - |
UpdateClientGroups | Update a client group. | PUT /client-groups/<id_> | - | - |
UpdateClientHandlers | Update a client handler. | PUT /client-handlers/<id_> | - | - |
UpdateClientHandlerBillingDetails | Update billing details for a client handler. | PUT /client-handlers/<id_>/billing-details | - | - |
UpdateClientInvoiceDetails | Update per-client invoice issuance settings. | PUT /clients/<client_id>/settings/invoice | Registry -> Update invoice settings | - |
UpdateClientInvoiceRequest | Update a client invoice request. | PUT /client-invoice-request/<id> | - | - |
UpdateClientInvoiceTextSettings | Update invoice text settings for a client. | PUT /clients/<id_>/settings/invoice-text | - | - |
UpdateClientLabels | Update labels for a client. | PUT /clients/<client_id>/labels/<id> | Registry -> Update labels | - |
UpdateClientPaymentReferenceSettings | Update 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_> | - | - |
UpdateClientPreferredLanguage | Update a client’s preferred language. | PUT /clients/<id_>/preferred-language | Registry -> Update language | - |
UpdateClientProducts | Update and manage client product bindings (factoring, service, etc.). | PUT /client-products/<id_>PUT /client-products/<id_>/default | Registry -> Manage product bindings | - |
UpdateClientReminderProfile | Update the default reminder profile for a client. | PUT /clients/<id_>/reminder-profiles/default | Registry -> Update reminder profile | - |
UpdateDebtorReminderProfile | Set or remove the reminder profile on a client debtor. | PUT /debtors/<id_>/reminder-profiles/defaultDELETE /debtors/<id_>/reminder-profiles/default | Registry -> Update debtor reminder profile | - |
UpdateClientSync | Replace the external-system sync configuration for a client. | PUT /clients/<client_id>/sync | - | Dashboard -> Configure sync |
UpdateClientToDo | Update and resolve client to-do items. | PUT /client/todo/<client_id>/<id>PUT /client/todo/resolve-multiple | Daily Routines -> Resolve to-do items | - |
UpdateClientTransferText | Update client transfer text. | PUT /client-transfer-text/<id_> | Registry -> Update transfer text | - |
UpdateClients | Update company details, contact information, and add-ons. | PUT /clients/<id_> | Registry -> Update client details | - |
UpdateTemplateClients | Update fee and interest template engine rules for clients. | PUT /client-financial-price-template/<id_>/clients/engine-rule | - | - |
Credit & Risk
Section titled “Credit & Risk”29 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CreateCreditDecisionStatus | Create credit decision statuses for the factoring kanban board. | POST /credit-decision-status | - | - |
CreateCreditMonitoring | Create credit monitoring records for debtors and clients. | POST /credit-monitoring/<identification_number_> | - | - |
CreateFactoringCountry | Add countries to the allowed list for factoring. | POST /factoring-country | - | - |
CreateInstanceProviderCreditCheckSettings | Create per-tenant credit-check settings. | POST /instance-provider-credit-check-settings | - | - |
CreateServiceProviderCreditCheckSettings | Create a credit-check policy record for a service provider. | POST /service-provider-credit-check-settings | - | - |
CreditInsurance | Create or update credit insurance agreements and view insurance history. | GET /credit-insurance/history/<identification_number_>POST /credit-insurance | - | - |
CreditInsuranceSearch | Search credit insurance agreements and companies. | POST /credit-insurance/company/searchPOST /credit-insurance/search | - | - |
DeleteCreditDecisionStatus | Delete a credit decision status used to manage factoring kanban board columns. | DELETE /credit-decision-status/<int:id> | - | - |
DeleteFactoringCountry | Delete a factoring country configuration. | DELETE /factoring-country/<code> | - | - |
GetFactoringManualControl | View factoring manual control rules. | GET /engine-rule/factoring-manual-control/<client_id> | Registry -> View factoring rules | - |
PostCreditData | Submit credit data for clients and debtors. | POST /clients/<id_>/credit-dataPOST /debtors/<id_>/credit-data | - | - |
ReadCreditData | View credit data for system debtors, clients, and debtors. | GET /clients/<id_>/credit-dataGET /debtors/<id_>/credit-dataGET /debtors/system-debtor/<identification_number_>/credit-dataGET /system-debtors/<identification_number>/credit-dataPOST /debtors/system-debtor/credit-data/searchPOST /system-debtors/credit-data/search | Registry -> View credit data | - |
ReadCreditDecisionStatus | View and search credit decision statuses used to manage factoring workflow columns. | GET /credit-decision-statusGET /credit-decision-status/<int:id>POST /credit-decision-status/search | Factoring -> View decision statuses | - |
ReadCreditMonitoring | View credit history monitoring data for clients and debtors. | GET /clients/<identification_number_>/credit-history-monitoringGET /credit-monitoring/<identification_number_>GET /debtors/<identification_number_>/credit-history-monitoring | - | - |
ReadFactoringCountry | View and search factoring countries used for financing eligibility. | GET /factoring-countryGET /factoring-country/<code>POST /factoring-country/search | Factoring -> View countries | - |
ReadInstanceProviderCreditCheckSettings | View per-tenant credit check defaults and settings. | GET /instance-provider-credit-check-settingsGET /instance-provider-credit-check-settings/<id_>GET /instance-provider-credit-check-settings/instance-provider/<instance_provider_id> | - | - |
ReadServiceProviderCreditCheckSettings | View service provider credit check policies and settings. | GET /service-provider-credit-check-settingsGET /service-provider-credit-check-settings/<id_>GET /service-provider-credit-check-settings/service-provider/<service_provider_id> | Environment -> View provider settings | - |
ReadStatisticFactoring | Retrieve factoring portfolio financing rate statistics. | POST /statistics/factoring/financing-rate/<client_id> | - | Dashboard -> View factoring stats |
RemoveCreditMonitoring | Remove a credit monitoring entry. | PUT /credit-monitoring/<identification_number_>/remove | - | - |
SearchCreditMonitoring | Search credit monitoring data. | POST /credit-monitoring/search | - | - |
SearchInstanceProviderCreditCheckSettings | Search per-tenant credit-check default settings. | POST /instance-provider-credit-check-settings/search | - | - |
SearchServiceProviderCreditCheckSettings | Search credit-check policies for service providers. | POST /service-provider-credit-check-settings/search | - | - |
SetFactoringManualControl | Set manual control for factoring rules. | PUT /engine-rule/factoring-manual-control/<client_id> | Registry -> Configure factoring | - |
SingleCreditCheckCollectionBatch | Request a credit check for a debtor. | POST /debtors/credit_check | - | - |
UpdateCreditDecisionStatus | Update and move credit decision statuses for factoring decisions and business loans. | PUT /business-loans/<id_>/credit-decision/movePUT /credit-decision-status/<int:id>PUT /credit-decision-status/bulk-updatePUT /factoring-decisions/<id_>/movePUT /factoring-decisions/<invoice_id>/factoringPUT /factoring-decisions/move | Registry -> Update credit decisions | - |
UpdateExternalFactoringDecision | PUT /factoring-decisions/<id_>/move-external | - | - | |
UpdateFactoringCountry | PUT /factoring-country/<code> | - | - | |
UpdateInstanceProviderCreditCheckSettings | Update the credit check default settings for your tenant. | PUT /instance-provider-credit-check-settings/<id_> | - | - |
UpdateServiceProviderCreditCheckSettings | Update credit-check policies for service providers. | PUT /service-provider-credit-check-settings/<id_> | Registry -> Configure credit checks | - |
Debtor Management
Section titled “Debtor Management”82 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CalculateBalanceDebtors | Recalculate balances for debtors. | PUT /debtors/<id_>/calculate-balance | - | - |
CreateClientDebtorPayoutAccounts | Create a payout account override for a specific client or debtor. | POST /client-debtor-payout-accounts | Registry -> Configure payout | - |
CreateCreditInsuranceClientDebtor | Request and manage credit insurance limits for client debtors. | POST /credit-insurance-client-debtor/manualPOST /credit-insurance-client-debtor/request-limit | - | - |
CreateDebtorLabels | Create labels for a debtor. | POST /debtors/<debtor_id>/labels | Registry -> Create labels | - |
CreateDebtorToDo | Create todo items for debtors. | POST /debtor/todo | Registry -> Create todo | - |
CreateDebtorType | Create debtor subtype classifications. | POST /debtor-subtype | Global Settings -> Create debtor type | - |
CreateSystemDebtorClientDedicatedLimits | Create a dedicated limit for a system debtor and client pair. | POST /system-debtor-client-dedicated-limits | Registry -> Create debtor limit | - |
CreateSystemDebtorGroups | Create groups of system debtors that share common rules. | POST /system-debtor-groups | - | - |
CreateSystemDebtorGroupSystemDebtors | POST /system-debtor-groups/<id_>/system-debtors | - | - | |
CreateSystemDebtorLabels | Add labels to a system debtor record. | POST /system_debtors/<identification_number>/labels | Registry -> Add debtor label | - |
CreateSystemDebtorToDo | Create a to-do item for a system debtor. | POST /system-debtor/todo | Registry -> Create debtor to-do | - |
CreditcheckDebtors | Run credit checks on debtors and invoices. | POST /debtors/<id_>/creditcheckPOST /debtors/creditcheckPOST /invoices/<id_>/creditcheck | - | - |
CreditInsuranceClientDebtorSearch | Search for client and debtor pairings under a credit insurance policy. | POST /credit-insurance-client-debtor/search | Registry -> Search insurance coverage | - |
DebtorLookupCollectionBatch | Update the debtor lookup for a collection batch. | PUT /collection-batches/<id_>/debtor-lookup | - | - |
DeleteDebtorLabels | Delete labels assigned to a debtor. | DELETE /debtors/<debtor_id>/labels/<id> | Registry -> Delete debtor labels | - |
DeleteDebtorType | Delete a debtor subtype classification. | DELETE /debtor-subtype/<id_> | Global Settings -> Debtor Types -> Delete debtor type | - |
DeleteSystemDebtorClientDedicatedLimits | DELETE /system-debtor-client-dedicated-limits/<id_> | - | - | |
DeleteSystemDebtorGroups | Delete a grouping of system debtors for shared rules. | DELETE /system-debtor-groups/<id_> | - | - |
DeleteSystemDebtorGroupSystemDebtors | Delete system debtors from a system-debtor group. | DELETE /system-debtor-groups/<id_>/system-debtors/<system_debtor_id> | - | - |
DeleteSystemDebtorLabels | Delete a label assigned to a system debtor. | DELETE /system_debtors/<identification_number>/labels/<id> | - | - |
GenerateDebtorToken | Generate a token for a debtor. | POST /token/debtor/generate | - | - |
GetCreditInsuranceClientDebtor | Fetch 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 | - | - |
GetDebtorCreditDecisionStatus | View factoring buy/sell decisions for debtors. | GET /factoring-decisions/debtors/<id_> | - | - |
GetDebtorToDo | GET /debtor/todo/<debtor_id>GET /debtor/todo/<debtor_id>/<id> | - | - | |
GetSystemDebtorToDo | GET /system-debtor/todo/<debtor_id>GET /system-debtor/todo/<debtor_id>/<id> | - | - | |
ManageDebtorSettings | View and update debtor flag settings. | GET /settings/debtor/flag/<debtor_id>PUT /settings/debtor/flag/<debtor_id> | Registry -> Manage settings | - |
ManageSystemDebtorSettings | View 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 | - |
ReadClientDebtorPayoutAccounts | View 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 | - |
ReadDebtor | View a debtor’s profile. | GET /debtors/<debtor_id> | Registry -> View debtor profile | - |
ReadDebtors | View the list of debtors. | GET /debtors | - | Dashboard -> View debtors |
ReadDebtorChangelog | View debtor change history and audit logs. | GET /changelog/debtor/<id_>GET /changelog/system-debtor/<identification_number> | Registry -> View change history | - |
ReadDebtorFinancialEvents | View all financial events belonging to a debtor. | GET /debtors/<debtor_id>/financial-eventsGET /system-debtors/<identification_number>/financial-events | Registry -> View debtor financial events | - |
ReadDebtorLabels | View labels assigned to a debtor. | GET /debtors/<debtor_id>/labels | Registry -> View labels | - |
ReadDebtorNotes | View free-form notes attached to a debtor. | GET /debtors/<debtor_id>/notes | - | - |
ReadDebtorPayoutAccount | View details of a debtor payout or refund account. | GET /debtor-payout-accounts/<id_> | - | - |
ReadDebtorSettings | GET /settings/debtor/flag/<debtor_id> | Registry -> View settings | - | |
ReadDebtorPayoutAccounts | View debtor payout and refund accounts. | GET /debtor-payout-accounts | - | - |
ReadDebtorType | View debtor subtype classifications. | GET /debtor-subtypeGET /debtor-subtype/<id_> | Global Settings -> View subtypes | - |
ReadInternalSystemDebtor | GET /internal-system-debtors/<identification_number_> | Registry -> View system debtor | - | |
ReadInternalSystemDebtors | GET /internal-system-debtors | - | - | |
ReadSystemDebtor | View system debtor master records, their clients, and invoice summaries. | GET /system-debtors/<identification_number>GET /system-debtors/<identification_number>/clientsGET /system-debtors/<identification_number>/invoice-summary | Registry -> View debtors | - |
ReadSystemDebtors | List master debtor records used across clients. | GET /system-debtors | - | - |
ReadSystemDebtorClientDedicatedLimits | View system debtor client dedicated limits. | GET /system-debtor-client-dedicated-limitsGET /system-debtor-client-dedicated-limits/<id_>POST /system-debtor-client-dedicated-limits/search | Registry -> View debtor limits | - |
ReadSystemDebtorCreditStatus | View 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 | - |
ReadSystemDebtorSettings | View system debtor flag settings. | GET /settings/system-debtor/flag/<system_debtor_identification_number> | Registry -> View debtor settings | - |
ReadSystemDebtorEvent | Retrieve lifecycle events for a system debtor. | GET /system-debtor/events/<id_> | - | - |
ReadSystemDebtorEvents | View lifecycle events for system debtors. | GET /system-debtor/events | - | - |
ReadSystemDebtorGroup | Retrieve a system debtor group. | GET /system-debtor-groups/<id_> | - | - |
ReadSystemDebtorGroups | List system debtor groups. | GET /system-debtor-groups | - | - |
ReadSystemDebtorGroupSystemDebtors | List system debtors in a group. | GET /system-debtor-groups/<id_>/system-debtors | - | - |
ReadSystemDebtorLabels | View labels assigned to a system debtor. | GET /system_debtors/<identification_number>/labels | Registry -> View debtor labels | - |
SearchDebtors | Search debtors. | POST /debtors/search | Registry -> Search debtors | Customers -> Search debtors |
SearchDebtorCreditDecisionStatus | Search debtor factoring decisions, including daily history. | POST /factoring-decisions/debtors/daily/searchPOST /factoring-decisions/debtors/search | - | - |
SearchDebtorFinancialEvents | Search all financial events belonging to a debtor. | POST /debtors/<debtor_id>/financial-events/searchPOST /system-debtors/<identification_number>/financial-events/search | Registry -> Filter debtor financial events | - |
SearchDebtorNotes | Search notes attached to a debtor. | POST /debtors/<debtor_id>/notes/search | - | - |
SearchDebtorPayoutAccounts | Search debtor payout and refund accounts. | POST /debtor-payout-accounts/search | - | - |
SearchDebtorToDo | Search to-do items for a debtor. | POST /debtor/todo/search | Registry -> Search tasks | - |
SearchInternalSystemDebtors | POST /internal-system-debtors/search | Registry -> Search debtors | - | |
SearchSystemDebtors | Search master debtor records used across clients. | POST /system-debtors/search | Registry -> Search debtors | - |
SearchSystemDebtorCreditStatuses | Search system debtor credit statuses across currencies. | POST /system-debtor-credit-status/currency-status/searchPOST /system-debtor-credit-status/search | - | - |
SearchSystemDebtorEvents | Search system debtor lifecycle events and payments. | POST /system-debtor/events/payments/searchPOST /system-debtor/events/search | - | - |
SearchSystemDebtorGroups | Search groupings of debtors for shared rules. | POST /system-debtor-groups/search | - | - |
SearchSystemDebtorToDo | Search system debtor to-do items. | POST /system-debtor/todo/search | Daily Routines -> Search debtor tasks | - |
UpdateClientDebtorPayoutAccounts | Update client/debtor payout account overrides. | PUT /client-debtor-payout-accounts/<id_> | Registry -> Update payout accounts | - |
UpdateCreditInsuranceClientDebtor | Send an external request to update the credit insurance limit for a debtor-client pairing. | POST /credit-insurance-client-debtor/update-limit | - | - |
UpdateDebtors | Update debtor information and distribution channel settings. | PUT /debtors/<debtor_id> | Registry -> Update debtor info | - |
UpdateDebtorClient | Update the client associated with a debtor. | PUT /debtors/<id_>/client | - | Customers -> Update client |
UpdateDebtorLabels | Update debtor labels. | PUT /debtors/<debtor_id>/labels/<id> | Registry -> Update debtor labels | - |
UpdateDebtorPayoutAccounts | Update a debtor payout account. | PUT /debtor-payout-accounts/<id_> | - | - |
UpdateDebtorPreferredLanguage | Update a debtor’s preferred language. | PUT /debtors/<id_>/preferred-language | Registry -> Update debtor language | - |
UpdateDebtorToDo | Update and resolve debtor to-do items. | PUT /debtor/todo/<debtor_id>/<id>PUT /debtor/todo/resolve-multiple | Daily Routines -> Resolve to-do items | - |
UpdateDebtorType | Update a debtor subtype classification. | PUT /debtor-subtype/<id_> | Global Settings -> Update debtor types | - |
UpdateSystemDebtors | Update master debtor records and manage debtor bankruptcy status. | POST /system-debtors/<identification_number>/bankruptcyPUT /system-debtors/<identification_number> | Registry -> Update debtor records | - |
UpdateSystemDebtorClientDedicatedLimits | Update credit limits for individual debtors per client. | PUT /system-debtor-client-dedicated-limitsPUT /system-debtor-client-dedicated-limits/<id_> | Registry -> Update credit limits | - |
UpdateSystemDebtorCreditStatus | Update 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 | - |
UpdateSystemDebtorGroups | Update groups of system debtors with shared rules. | PUT /system-debtor-groups/<id_> | - | - |
UpdateSystemDebtorLabels | Update labels on system debtor records. | PUT /system_debtors/<identification_number>/labels/<id> | Registry -> Update debtor labels | - |
UpdateSystemDebtorToDo | Update 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 | - |
CreateDebtorBlocked | Block debtors by adding them to a blacklist. | POST /debtor-blocked | Global Settings -> Block debtor | - |
ReadDebtorBlocked | View blocked or blacklisted debtors. | GET /debtor-blockedGET /debtor-blocked/<identification_number> | - | - |
SearchDebtorBlocked | Search blocked or blacklisted debtors. | POST /debtor-blocked/search | Global Settings -> Search blocked | - |
DeleteDebtorBlocked | Unblock a debtor by identification number. | DELETE /debtor-blocked/<identification_number> | Global Settings -> Excluded Debtors -> Unblock debtor | - |
Distribution
Section titled “Distribution”15 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CreateDistributionEventsDigitalMailbox | Create digital mailbox distribution events. | POST /distribution-events/digital-mailbox | - | - |
CreateDistributionEventsLetter | Create letter distribution events. | POST /distribution-events/letter | - | - |
ReadCollectionBatchLedgerEventDistribution | Search 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 | - | - |
ReadDistribution | View details of outbound document distributions. | GET /distributions/<id_> | Environment -> View distributions | - |
ReadDistributions | View outbound document distributions (email, post, e-invoice). | GET /distributionsGET /distributions/ready-for-export | - | - |
ReadDistributionEvent | View a single distribution lifecycle event by ID. | GET /distribution-events/<id_> | - | - |
ReadDistributionEvents | View distribution lifecycle events. | GET /distribution-events | - | - |
ReadDistributionProfile | View per-client distribution channel preferences. | GET /distribution-profiles/<id_> | - | - |
ReadDistributionProfiles | View distribution channel preferences for clients. | GET /distribution-profiles | - | - |
RetryDistribution | Retry document distributions. | PUT /distributions/<id_>/retry | - | - |
SearchDistribution | Search document distributions via email, post, or e-invoice. | POST /distributions/search | Environment -> Search distributions | - |
SearchDistributionEvents | Search lifecycle events for document distributions. | POST /distribution-events/search | - | - |
SearchDistributionProfiles | Search client distribution channel preferences. | POST /distribution-profiles/search | Environment -> Search distribution profiles | - |
UpdateDistributionProfiles | Update per-client distribution channel preferences. | PUT /distribution-profiles/<id_> | Environment -> Update distribution | - |
UpdateDistributionStatus | Update distribution status and distribute outbound documents. | PUT /distributions/<id_>/distributePUT /distributions/update-status | Environment -> Distribute documents | - |
External Integrations
Section titled “External Integrations”5 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CreateSignatureRequest | Submit a signature request for an invoice. | POST /invoices/signature-request | - | - |
CreateSyncPaymentEvents | Receive and process payment completion events from an ERP system. | POST /events/sync-payment-complete | - | - |
DeleteSignatureRequest | Delete a signature request associated with an invoice. | DELETE /invoices/<invoice_id_>/signature-request/<id_> | - | - |
ReadSignatureRequests | Retrieve a signature request for an invoice. | GET /invoices/<id_>/signature-request | - | - |
UpdateSignatureRequest | POST /events/signature/event | - | - |
Invoice Management
Section titled “Invoice Management”122 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
ActivateInvoices | Reset, activate, and set interest rates on invoices. | PUT /invoices/<id_>/activatePUT /invoices/<id_>/resetPUT /invoices/<id_>/set-interest-rate | Registry -> Activate invoices | - |
ActivatePartInvoices | Activate sub-invoices generated by a part-payment plan. | PUT /part-invoices/activate | Daily Routines -> Activate part invoices | - |
AddToArchiveInvoices | Archive invoices. | PUT /invoices/<id_>/archive/add | Registry -> Archive invoices | - |
AuthorizePartInvoices | Authorize sub-invoices generated by a part-payment plan. | PUT /part-invoices/authorize | Daily Routines -> Authorize part invoices | - |
BulkUpdateInvoice | Bulk update invoices and retrieve total balance for bulk updates. | POST /invoices/actions/bulk-update/get-total-balancePUT /invoices/actions/bulk-update | Registry -> Bulk update invoices | - |
CalculateBalanceInvoices | Recalculate balances for invoices. | PUT /invoices/<id_>/calculate-balance | - | - |
CalculateStatusInvoices | Recalculate statuses for invoices. | PUT /invoices/<id_>/calculate-status | - | - |
ChangeExpirationInvoices | Change invoice expiration dates. | PUT /invoices/actions/change-expire-date | - | - |
CreateCollectionBatchInvoice | Add invoices to collection batches. | POST /collection-batches/<collection_batch_id>/invoices/<invoice_id> | - | - |
CreateCollectionBatchWithSingleInvoice | POST /collection-batches/<invoice_id>/create-collection-batch | Registry -> Create collection | - | |
CreateDistributionEventsElectronicInvoice | Create electronic invoice distribution events. | POST /distribution-events/electronic-invoice | - | - |
CreateElectronicInvoiceInvites | Send electronic invoice invitations. | POST /electronic-invoices/invites | - | - |
CreateInvoices | Create invoices. | POST /invoices | Registry -> Create invoices | - |
CreateInvoiceFiles | Upload bulk invoice files for ingestion. | POST /invoice-files | - | - |
CreateInvoiceGuarantor | Attach a guarantor to an invoice. | POST /invoices/<invoice_id>/guarantors | Registry -> Create guarantor | - |
CreateInvoiceLabels | Add labels to an invoice. | POST /invoices/<invoice_id>/labels | Registry -> Create labels | - |
CreateInvoiceToDo | POST /invoice/todo | - | - | |
CreatePartPaymentAccountInvoice | Create invoices funded through a part-payment account. | POST /part-payment-accounts/invoices | - | - |
CreatePartPaymentPlanInvoice | Create invoices from a part-payment plan. | POST /part-payment-plans/invoices | - | - |
CreateSyncInvoiceEvents | Receive and process invoice completion events from an ERP system. | POST /events/sync-invoice-complete | - | - |
CreditInvoices | Create a credit action on an invoice. | PUT /invoices/<id_>/actions/credit | - | - |
DeleteCollectionBatchInvoice | Delete an invoice from a collection batch. | DELETE /collection-batches/<collection_batch_id>/invoices/<invoice_id> | - | - |
DeleteInvoiceGuarantor | Delete a guarantor attached to an invoice. | DELETE /invoices/<invoice_id>/guarantors/<id_> | Registry -> Delete guarantor | - |
DeleteInvoiceLabels | Delete labels assigned to an invoice. | DELETE /invoices/<invoice_id>/labels/<id> | Registry -> Invoices -> Delete invoice labels | - |
DeletePartInvoice | Delete a sub-invoice generated by a part-payment plan. | DELETE /part-invoices/<id_> | Daily Routines -> Part Invoices -> Delete part invoice | - |
DeletePartPaymentAccountInvoice | Delete an invoice currently funded by a part-payment account. | DELETE /part-payment-accounts/invoices/<id_> | - | - |
DeletePartPaymentPlanInvoice | Delete an invoice originating from a part-payment plan. | DELETE /part-payment-plans/invoices/<id_> | - | - |
DenyTaxReductionOnInvoices | Deny tax reduction on an invoice. | PUT /invoices/<id_>/actions/deny-tax-reduction | - | - |
DisputeInvoices | Dispute an invoice. | PUT /invoices/<id_>/actions/dispute | Registry -> Dispute invoice | - |
DistributeInvoices | Distribute an invoice. | POST /invoices/distribute | - | - |
ExternalRefinanceInvoice | Request external refinancing for invoices individually or in bulk. | POST /invoice-refinancing/<invoice_id>/externalPUT /invoice-refinancing/bulk-external | Registry -> Request refinancing | - |
FastForwardInvoice | Fast forward an invoice through its collection stages by skipping a pending ledger event. | PUT /invoices/<id_>/fast-forward | Registry -> Fast forward invoice | - |
GeneratePartInvoices | Generate part invoices from part-payment plans. | PUT /part-invoices/generate | Daily Routines -> Generate part invoices | - |
GetInvoiceArticles | Retrieve articles associated with invoices. | POST /invoices/get-articles | - | - |
GetInvoiceCreditDecisionStatus | View factoring buy or sell decisions for invoices. | GET /factoring-decisions/invoice/<id_> | - | - |
GetInvoiceToDo | GET /invoice/todo/<invoice_id>GET /invoice/todo/<invoice_id>/<id> | - | - | |
ImportInvoiceFiles | Import bulk invoice files for processing. | PUT /invoice-files/<id_>/import | - | - |
InvoicePDFExtractCreate | Submit PDF files for invoice data extraction using OCR or AI processing. | POST /invoices/<client_id>/extractPOST /invoices/<client_id>/extract/gemini | - | - |
InvoicePDFExtractGemini | Extract invoice data from a PDF using Gemini. | POST /invoices/<client_id>/extract/gemini | - | - |
InvoicePDFExtractRead | Retrieve OCR extraction results for invoice PDFs. | POST /invoices/<client_id>/extract/response | - | - |
InvoicePDFExtractReadAccess | Check whether invoice PDF OCR extraction is enabled. | GET /invoices/<client_id>/extract/enabled | - | - |
LinkDocumentToInvoice | Attach documents to invoices. | POST /documents/link-invoice | - | - |
LinkMultipleCreditDebitInvoices | Link multiple invoices individually or in bulk. | PUT /invoices/link-multiplePUT /invoices/link-multiple-bulk | Registry -> Link invoices | - |
PartPaymentStartInvoice | Initiate part payment arrangements for invoices. | PUT /invoices/<id_>/part-payment/start | Registry -> Start part payment | - |
PartPaymentStopInvoice | End part payment arrangements for invoices. | PUT /invoices/<id_>/part-payment/stop | Registry -> Stop part payment | - |
PauseInvoices | Pause an invoice. | PUT /invoices/<id_>/actions/pause | Registry -> Pause invoice | - |
PreviewInvoices | Preview and update invoice previews. | POST /invoices/previewPUT /invoices/<id_>/preview | - | - |
ReadElectronicInvoice | View and validate e-invoices in PEPPOL/Svefaktura format. | GET /electronic-invoices/invoices/<invoice_id>/validateGET /invoices/electronic/<id_> | Registry -> Validate e-invoices | - |
ReadInvoice | View invoices and their details, including credit-debit links, payment accounts, and collection status. | GET /invoices/<id_>GET /invoices/<id_>/external-collectionGET /invoices/<invoice_id>/payment-accountGET /invoices/<invoice_id_>/credit-debit-link-listGET /invoices/requests/<id_>GET /invoices/table/<id_> | Registry -> View invoices | Errands -> View invoices |
ReadInvoices | List invoices and view related system settings. | GET /invoicesGET /system-setting/hide-balance-details/enabled | - | Dashboard -> View invoices |
ReadInvoiceArticles | View articles (line items) for an invoice. | GET /invoices/<invoice_id>/articles | - | - |
ReadInvoiceChangelog | View invoice and user change history and audit logs. | GET /changelog/invoice/<id_>GET /changelog/user/<id_> | Registry -> View change history Environment -> View change history | - |
ReadInvoiceFile | View a single bulk invoice file upload and its ingestion status. | GET /invoice-files/<id_> | - | - |
ReadInvoiceFiles | View bulk invoice file uploads and ingestion status. | GET /invoice-files | - | - |
ReadInvoiceFinancialEvent | View a single invoice financial event by ID. | GET /invoices/events/financial/<id_> | - | - |
ReadInvoiceFinancialEvents | View invoice financial events. | GET /invoices/events/financial | - | - |
ReadInvoiceGuarantor | View guarantor details attached to an invoice. | GET /invoices/<invoice_id>/guarantors/<id_> | - | - |
ReadInvoiceGuarantors | View guarantors attached to an invoice. | GET /invoices/<invoice_id>/guarantors | Registry -> View guarantors | - |
ReadInvoiceLabels | View invoice labels. | GET /collection-batches/<collection_batch_id>/invoices/labelsGET /invoices/<invoice_id>/labels | Registry -> View labels | - |
ReadInvoiceLedgerEvent | View a specific invoice ledger event. | GET /invoices/events/ledger/<id_> | - | - |
ReadInvoiceLedgerEvents | View invoice ledger events. | GET /invoices/events/ledger | - | - |
ReadInvoiceNotes | View notes attached to an invoice. | GET /invoices/<invoice_id>/notes | - | - |
ReadInvoiceOffer | View a specific invoice purchase offer. | GET /invoice-offers/<id_> | - | - |
ReadInvoiceOffers | View invoice purchase offers. | GET /invoice-offers | - | - |
ReadInvoicePaymentMethods | View available payment methods for an invoice. | GET /invoices/<invoice_id>/payment-methods | - | - |
ReadInvoicePaymentMethodConfigurations | View payment method configurations for an invoice. | GET /invoices/<invoice_id>/payment-method-configurations | - | - |
ReadInvoiceReasonCodes | View the reason codes on an invoice, including ones that no longer apply. | GET /invoices/<id_>/reason-codes | Daily Routines -> Invoice -> Reason codes | - |
ReadPartInvoice | View a single sub-invoice generated by a part-payment plan. | GET /part-invoices/<id_> | - | - |
ReadPartInvoices | List part-payment invoices. | GET /part-invoices | - | - |
ReadPartPaymentAccountInvoice | View a specific invoice funded by a part-payment account. | GET /part-payment-accounts/invoices/<id_> | - | - |
ReadPartPaymentAccountInvoices | List invoices funded by a part-payment account. | GET /part-payment-accounts/invoices | - | - |
ReadPartPaymentPlanInvoice | View a specific invoice from a part-payment plan. | GET /part-payment-plans/invoices/<id_> | - | - |
ReadPartPaymentPlanInvoices | List invoices from a part-payment plan. | GET /part-payment-plans/invoices | - | - |
ReadRefinanceInvoice | View a refinancing request on an existing invoice. | GET /invoice-refinancing/<invoice_id> | Registry -> View refinancing | - |
ReadRefinanceInvoices | List refinancing requests on existing invoices. | GET /invoice-refinancing | - | - |
ReadTransactionReportInvoice | Retrieve a transaction report invoice. | GET /reports/transaction-report-invoices/<id_> | - | - |
ReadTransactionReportInvoices | List transaction report invoices. | GET /reports/transaction-report-invoices | - | - |
RecallInvoiceFromCollectionExternal | Recall an invoice from external collection. | PUT /invoices/<id_>/external-collection/recall | Registry -> Recall from collection | - |
RecourseOnInvoices | Update recourse actions on invoices. | PUT /invoices/<id_>/actions/recourse | Registry -> Update recourse | - |
RefinanceInvoice | Refinance invoices and manage recourse settings. | PUT /invoice-refinancing/<invoice_id>PUT /invoice-refinancing/<invoice_id>/use-recourse | Registry -> Refinance invoices | - |
RefundCreditInvoice | Refund credit invoices individually or in bulk. | PUT /invoices/<id_>/actions/refund-credit-invoicePUT /invoices/actions/bulk-refund-credit-invoice | Registry -> Refund credit invoices | - |
RefundInvoice | Refund invoices. | PUT /invoices/<id_>/actions/refund | Registry -> Refund invoices | - |
RegisterDirectPaymentOnInvoices | Register direct payments on invoices. | PUT /invoices/<id_>/actions/direct-payment | Registry -> Register direct payments | - |
RegisterPaymentOnInvoices | Register payments on invoices. | PUT /invoices/<id_>/actions/payment | - | - |
RemoveFromArchiveInvoices | Unarchive invoices. | PUT /invoices/<id_>/archive/remove | Registry -> Unarchive invoices | - |
ResumeInvoices | Resume invoices. | PUT /invoices/<id_>/actions/resume | Registry -> Resume invoices | - |
RetryPostActivateInvoices | POST /invoices/<invoice_id>/retry-post-activate | - | - | |
ReverseInvoiceFinancialEvent | Reverse invoice financial events. | PUT /invoices/events/financial/<id_>/reverse | Registry -> Reverse events | - |
ReversePaymentTransaction | Reverse or revert payment transactions and collection events. | PUT /collection-batches/financial-events/<collection_batch_financial_event_id>/reversePUT /payments/links/<payment_transaction_link_id>/revert | - | - |
RevertReminderOnInvoices | Revert reminder actions on invoices. | PUT /invoices/<id_>/actions/revert-reminder | - | - |
RewindInvoice | Rewind invoice ledger events. | POST /invoices/<id_>/rewind | Registry -> Rewind invoice | - |
SearchElectronicInvoiceParties | Search electronic invoice parties, validate party information, and confirm party validation. | POST /electronic-invoices/parties/searchPOST /electronic-invoices/validate-partyPUT /electronic-invoices/validate-party/confirm | Registry -> Search e-invoice parties | - |
SearchInvoices | Search and filter invoices. | POST /invoices/searchPOST /invoices/table/search | Registry -> Search invoices | Invoices -> Search invoices |
SearchInvoiceCreditDecisionStatus | Search factoring buy and sell decisions for invoices. | POST /factoring-decisions/invoices/search | Registry -> Search factoring decisions | - |
SearchInvoiceFiles | Search bulk invoice uploads and their ingestion status. | POST /invoice-files/search | - | - |
SearchInvoiceFinancialEvents | Search financial events related to invoices. | POST /invoices/events/financial/search | Registry -> Search financial events | - |
SearchInvoiceGuarantors | Search guarantors attached to an invoice. | POST /invoices/<invoice_id>/guarantors/search | Registry -> Search guarantors | - |
SearchInvoiceLedgerEvents | Search ledger events related to invoices. | POST /invoices/events/ledger/search | Registry -> Search ledger events | Errands -> Search ledger events |
SearchInvoiceNotes | Search notes attached to an invoice. | POST /invoices/<invoice_id>/notes/search | - | - |
SearchInvoiceOffers | Search service-provider invoice purchase offers. | POST /invoice-offers/search | - | - |
SearchInvoiceToDo | POST /invoice/todo/search | - | - | |
SearchPartInvoices | Search part invoices from payment plans. | POST /part-invoices/search | Daily Routines -> Search part invoices | - |
SearchPartPaymentAccountInvoices | Search invoices funded by part-payment accounts. | POST /part-payment-accounts/invoices/search | Registry -> Search account invoices | - |
SearchPartPaymentPlanInvoices | Search invoices from part-payment plans. | POST /part-payment-plans/invoices/search | Registry -> Search plan invoices | - |
SearchTransactionReportInvoices | Search invoices in transaction reports. | POST /reports/transaction-report-invoices/search | - | - |
SendInvoices | Send invoices. | PUT /invoices/<id_>/actions/send | Registry -> Send invoices | - |
StopInvoices | Stop an invoice. | PUT /invoices/<id_>/actions/stop | Registry -> Stop invoices | - |
ToggleInvoicePaymentMethod | Toggle payment method availability for an invoice. | PUT /invoices/<invoice_id>/payment-methods/toggle | - | - |
ToggleInvoicePaymentMethodConfiguration | Toggle payment method configurations for an invoice. | PUT /invoices/<invoice_id>/payment-method-configurations/toggle | - | - |
UnlinkCreditInvoice | PUT /invoices/events/financial/<id_>/unlink-credit | Registry -> Unlink credit | - | |
UpdateInvoices | Update invoice details. | PUT /invoices/<id_> | Registry -> Update invoices | Errands -> Edit invoice details |
UpdateInvoiceGuarantor | Update guarantor details on an invoice. | PUT /invoices/<invoice_id>/guarantors/<id_> | Registry -> Manage guarantors | - |
UpdateInvoiceLabels | Update invoice labels. | PUT /invoices/<invoice_id>/labels/<id> | Registry -> Label invoices | - |
UpdateInvoiceLedgerEvents | PUT /invoices/events/ledger/<id_> | Registry -> Update ledger events | - | |
UpdateInvoiceOffer | Update an invoice purchase offer. | PUT /invoice-offers/<id_> | - | - |
UpdateInvoiceToDo | PUT /invoice/todo/<invoice_id>/<id> | - | - | |
UpdatePartPaymentAccountInvoice | Update invoices funded by part-payment accounts. | PUT /part-payment-accounts/invoices/<id_> | - | - |
UpdatePartPaymentPlanInvoice | Update invoices in a part-payment plan. | PUT /part-payment-plans/invoices/<id_> | - | - |
ValidateEngineRuleInvoice | Apply engine rule decisions to invoices for factoring, service, and refinance processing, individually or in bulk. | POST /engine-rule/perform-decision-bulk/get-resultPUT /engine-rule/perform-decision-bulk/factoring-sellPUT /engine-rule/perform-decision-bulk/refinancePUT /engine-rule/perform-decision-bulk/servicePUT /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 | - |
ValidateEngineRuleInvoiceFactoringSell | Trigger batch factoring-sell decisions on invoices asynchronously. | PUT /engine-rule/perform-decision-bulk/factoring-sell | Factoring -> Apply factoring decisions | - |
WriteOffCapitalOnInvoices | Write off capital amounts on invoices. | PUT /invoices/<id_>/actions/writeoff-capital | Registry -> Write off capital | - |
WriteOffReminderOnInvoices | Write off reminder costs on invoices. | PUT /invoices/<id_>/actions/writeoff-reminder | Registry -> Write off reminder costs | - |
320 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
AppendCollectionProfile | Add a collection profile to a collection batch. | PUT /collection-batches/<collection_batch_id>/append-collection-profile | - | - |
AskQuestion | Ask natural-language questions about platform data via FinBrain. | POST /questions | - | - |
AuthorizeCharges | Authorize manual charges such as fees and interest. | PUT /charges/authorize | - | - |
AuthorizePaymentTransactionReturns | Authorize returned payment transactions. | PUT /payment-transactions-returns/<id_>/authorize | Daily Routines -> Authorize transaction returns | - |
AutoDailyRoutineBilling | PUT /bookkeeping-files/billing | - | - | |
BulkUpdateCollectionBatch | Perform bulk updates to collection batches including notes and postponements. | PUT /collection-batches/actions/bulk-updatePUT /collection-batches/actions/bulk-update/create-notePUT /collection-batches/actions/bulk-update/postpone-collection-batches | - | - |
BIllCharges | Bill manual charges such as fees and interest. | PUT /charges/bill | - | - |
CacheEdit | GET /cache/clearPOST /cache/clearPOST /cache/clear/all | - | - | |
ChangeCollectionProfile | Replace the collection profile on a collection batch. | PUT /collection-batches/<collection_batch_id>/replace-collection-profile | - | - |
CheckInsuranceLimit | Check the insurance limit for an invoice. | GET /invoices/<invoice_id_>/check-insurance-limit | - | - |
CompleteCollectionExternal | Mark an external debt collection case as completed. | PUT /collections/external/<id_>/complete | - | - |
CompleteIntegration | PUT /clients/<client_id>/sync/complete-integration | Registry -> Complete integration | - | |
CompletePartPayment | Mark a part-payment installment as completed. | PUT /part-payments/<part_payment_id>/completed | - | - |
CompletePartPaymentGroup | Mark all part-payment installments for an invoice or collection batch as completed. | PUT /part-payment-groups/source/<source_id>/completed | - | - |
ReadPartPaymentGroupCreditInvoices | List activated credit invoices available to link for a given invoice. | GET /part-payment-groups/invoice/<invoice_id>/credit-invoices | - | - |
ConnectFileToNote | Attach files to notes. | PUT /notes/<note_id>/attach-file | Daily Routines -> Attach file to note | - |
ConnectFileToNoteCollectionBatch | Attach files to notes on collection batch records. | PUT /collection-batches/<collection_batch_id>/notes/<note_id>/attach-file | - | - |
ConnectFileToPaymentTransactionNote | Attach files to notes on payment transactions. | PUT /payments/<id_>/notes/<note_id>/attach-file | - | - |
CreateAutomation | Create an automation, including its rules and the action it runs. | POST /automation | - | - |
CreateAutomationRule | Add a rule to an existing automation. | POST /automation/<_id>/rules | - | - |
CreateCharges | Create manual charges such as fees, interest, and adjustments. | POST /charges | - | - |
CreateCollectionBatch | Create collection batches, optionally grouping multiple invoices into a batch. | POST /collection-batchesPOST /collection-batches/invoices | - | - |
CreateCollectionBatchDocument | GET /documents/settings/delivery_addressesPOST /documents/collection_batch/<collection_batch_id> | - | - | |
CreateCollectionBatchFinancialEvent | POST /business-loans/<business_loan_id>/financial-eventsPOST /collection-batches/<collection_batch_id>/financial-events | - | - | |
CreateCollectionBatchGuarantor | POST /collection-batches/<collection_batch_id>/guarantors | - | - | |
CreateCollectionBatchToDo | Create collection batch tasks pending operator action. | POST /collection-batch/todo | - | - |
CreateCollectionFeeType | Create collection fee types. | POST /fee/type | - | - |
CreateCollectionProfile | Create 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-profilePOST /collection-profile/<collection_profile_id>/staged-collection-profilesPOST /collection-profile/levelsPOST /collection-profile/levels/<collection_profile_level_id>/placeholdersPOST /collection-profile/system-collection-profilesPOST /segmentsPUT /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> | - | - |
CreateContact | Create contact persons such as debtors and clients. | POST /contacts | Registry -> Create contact | - |
CreateDelivery | POST /enforcement/retry_deliveryPUT /enforcement/deliveries/create_deductionPUT /enforcement/deliveries/create_recall | - | - | |
CreateDocuments | Create and generate documents such as invoices, attachments, ads, and brand documents. | POST /documents/ads/invoicePOST /documents/attachments/clientPOST /documents/attachments/invoicePOST /documents/brand/instance-providerPOST /documents/connected-filesPOST /documents/invoicePUT /documents/<id_>/generate | Environment -> Create documents | - |
CreateEnforcementFinancialEvent | Create a financial event enforcement action for debt enforcement. | POST /enforcement/financial_event | - | - |
CreateEngineRule | POST /engine-rulePOST /engine-rule-advanced-modulePOST /engine-rule-criteriaPOST /engine-rule-criteria-groupPOST /engine-rule-criteria/duplicate | Global Settings -> Create rule | - | |
CreateEngineRuleSchedulerFilter | POST /engine-rule/scheduler-filters | - | - | |
CreateErps | Create ERP integrations. | POST /erps | - | - |
CreateErpTypes | Create ERP types. | POST /erp-types | - | - |
CreateInstanceProviders | POST /instance-providers | - | - | |
CreateLabels | Create free-form labels for tagging resources. | POST /labels | Global Settings -> Create labels | - |
CreateNote | Add free-form notes attached to resources. | POST /notes | Registry -> Create note | - |
CreateNoteCollectionBatch | POST /collection-batches/notes | - | - | |
CreatePartPaymentPlanCollectionBatch | Create collection batches from part-payment plans. | POST /part-payment-plans/collection-batches | - | - |
CreatePaymentAccount | Create payment accounts and configure their settings. | POST /payment-accountsPOST /payment-accounts/settings | Accounting -> Create payment account | - |
CreatePaymentFiles | Upload and ingest payment files (camt, BG/PG formats). | POST /payment-files | Daily Routines -> Import payments | - |
CreatePaymentMatchingEngine | POST /payment-matching-engine | - | - | |
CreatePaymentMethodConfiguration | Create payment method configurations for clients and service providers. | POST /payment-methods/configurationsPOST /payment-methods/configurations/clientPOST /payment-methods/configurations/service-provider | Global Settings -> Configure payment method | - |
CreatePaymentRequest | Create outbound payment requests (e.g., Swish) to debtors. | POST /payment-requests | - | - |
CreatePaymentTransactions | Record inbound payments from debtors. | POST /paymentsPOST /payments/multiple | - | - |
CreatePaymentTransactionSpecification | POST /payments/<id_>/payment-specification-file | Daily Routines -> Create payment specification | - | |
CreateReasonCode | Create reason codes used in payment matching and rejections. | POST /reason-code | Global Settings -> Create reason code | - |
CreateSegment | Create and update debtor segments. | POST /segmentsPUT /segments/<segment_id> | - | - |
CreateServiceAccount | Create service accounts for server-to-server integrations. | POST /service-accounts | - | Configure -> Create service account |
CreateServiceProviderInsuranceAgreements | Create insurance agreements tied to service providers. | POST /service-provider-insurance-agreement | Registry -> Create insurance agreement | - |
CreateSettlementAccountTransactions | POST /settlement-account-transactions | - | - | |
CreateSniCode | Create SNI codes in the global SNI Code Registry. | POST /global-sni-registry | Global Settings -> Create SNI code | - |
CreateWebhook | Create a webhook. | POST /webhook | - | - |
DeleteAutomation | Delete an automation together with its rules and its action. | DELETE /automation/<_id> | - | - |
DeleteAutomationRule | Delete a single rule from an automation. | DELETE /automation/rules/<_id> | - | - |
DeleteCharges | Delete manual charges (fees, interest, adjustments). | DELETE /charges/<id_> | Daily Routines -> Delete charge | - |
DeleteCollectionBatchGuarantor | Remove guarantors from collection batches. | DELETE /collection-batches/<collection_batch_id>/guarantors/<guarantor_id> | - | - |
DeleteContact | Delete contact persons (debtors, clients, etc.). | DELETE /contacts/<id_> | Registry -> Delete contact | - |
DeleteDocuments | Delete document attachments. | DELETE /documents/<id_> | Environment -> Documents -> Delete document | - |
DeleteEngineRule | DELETE /engine-rule-criteria/<id> | Global Settings -> Matching Engines -> Delete rule | - | |
DeleteEngineRuleSchedulerFilter | DELETE /engine-rule/scheduler-filters/<id> | - | - | |
DeleteInstanceProviders | DELETE /instance-providers/<id_> | - | - | |
DeleteLabels | Delete free-form labels for tagging resources. | DELETE /labels/<id> | Global Settings -> Custom Attributes -> Delete labels | - |
DeleteNote | Delete free-form notes attached to resources. | DELETE /notes/<id_> | Registry -> Delete note | - |
DeletePartPaymentPlanCollectionBatch | Delete collection batches from part-payment plans. | DELETE /part-payment-plans/collection-batches/<id_> | - | - |
DeletePaymentBatches | Abort grouped payment ingestion files. | PUT /payment-batches/<id_>/abort | Daily Routines -> Import Payments -> Abort payment batch | - |
DeletePaymentFile | Delete raw payment files ingested into the platform. | DELETE /payment-files/<id_> | Daily Routines -> Import Payments -> Delete payment file | - |
DeletePaymentMatchingEngine | Delete a payment matching engine. | DELETE /payment-matching-engine/<payment_matching_engine_id> | - | - |
DeletePaymentMethodConfiguration | Delete 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 | - |
DeletePaymentTransactions | Delete inbound payments received from debtors. | DELETE /payments/<id_> | - | - |
DeletePaymentTransactionNote | Delete notes attached to payment transactions. | DELETE /payments/<id_>/notes/<note_id> | - | - |
DeleteServiceProviderInsuranceAgreement | DELETE /service-provider-insurance-agreement/<id_> | - | - | |
DeleteSniCode | Delete SNI codes from the global registry. | DELETE /global-sni-registry/<code> | Global Settings -> SNI -> Delete SNI code | - |
DeleteUnplacedPaymentReturns | Delete returned (bounced) payment transactions. | DELETE /payment-transactions-returns/<id_> | Daily Routines -> Import Payments -> Payment Returns -> Delete payment return | - |
DeleteWebhook | Delete webhooks. | DELETE /webhook/<id_> | - | - |
DisputeCollectionBatch | Update dispute status on collection batches. | PUT /collection-batches/<collection_batch_id>/dispute | - | - |
ExportBills | PUT /bills/export | Daily Routines -> Export bills | - | |
ExportCollectionExternal | Mark collections as exported to external collection agencies. | PUT /collections/external/<id_>/export | - | - |
ExportExternalFinancedPaymentBatches | PUT /payment-batches/export-external-financed | Daily Routines -> Export batches | - | |
GenerateCharges | Generate manual charges such as fees, interest, and adjustments. | PUT /charges/generate | - | - |
GeneratePusherToken | GET /pusher/generate-tokenPOST /pusher/test/send | - | - | |
GenerateToken | Generate API and client portal authentication tokens. | POST /token/client/portal/generatePOST /token/generate | Registry -> Generate token | - |
GenerateTokenServiceAccount | Generate integration tokens for server-to-server credentials. | PUT /service-accounts/<id_>/generate-token | Environment -> Generate token | Configure -> Generate token |
GetCollectionBatchToDo | View collection batch tasks pending operator action. | GET /collection-batch/todo/<collection_batch_id>GET /collection-batch/todo/<collection_batch_id>/<id> | - | - |
GetEngineRuleSchedulerFilter | GET /engine-rule/scheduler-filtersGET /engine-rule/scheduler-filters/<id> | - | - | |
ImportPaymentFile | Import raw payment files into the platform. | PUT /payment-files/<id_>/import | Daily Routines -> Import payments | - |
ImportPurchaseFiles | Upload and retry purchase collection files. | POST /collection-batches/purchase/filePUT /collection-batches/purchase/file/<_id>/retry | - | - |
LinkUnplacedPayment | Link unmatched payments to invoices, part-payment plans, accounts, or other targets. | PUT /unplaced-payments/<id_>/link | Daily Routines -> Link payment | - |
ManageEfakturaEnrollment | Create and delete e-faktura (Nordic bank-channel invoicing) enrollments. | DELETE /e-faktura/<efaktura_id>POST /e-faktura | - | - |
MarkIntegrationAsConnected | PUT /clients/<client_id>/sync/mark-integration-as-connected | - | Dashboard -> Connect integration | |
MatchPaymentBatches | Trigger matching of a payment batch. | PUT /payment-batches/<id_>/match | Daily Routines -> Match payment batch | - |
ObtainOnboardingUrl | POST /clients/<client_id>/sync/obtain-onboarding-url | - | Dashboard -> Get onboarding URL | |
PartPaymentPlanRecalculateAnnuity | Recalculate annuity schedules for part-payment plans. | PUT /part-payment-plans/<part_payment_plan_id>/recalculate-annuity | - | - |
PartPaymentStartCollectionBatch | Start part-payment collection for a batch. | PUT /collection-batches/<collection_batch_id>/part-payment/start | - | - |
PartPaymentStopCollectionBatch | Stop part-payment collection for a batch. | PUT /collection-batches/<collection_batch_id>/part-payment/stop | - | - |
PauseCollectionBatch | Postpone ledger events for a collection batch. | PUT /collection-batches/<collection_batch_id>/postpone-ledger-events | - | - |
ReadAdvancedLogin | GET /users/advanced-login/enabled | - | Dashboard -> View login settings | |
ReadAnalyzeTopics | GET /reports/analyze-topics | - | - | |
ReadAutomation | View a single automation with its rules and action. | GET /automation/<_id> | - | - |
ReadAutomations | List automations, and list the events and actions an automation can use. | GET /automationGET /automation/eventsGET /automation/actions | - | - |
ReadAutomationRules | List the rules that decide when an automation runs. | GET /automation/<_id>/rules | - | - |
ReadBaseInterestRate | View base interest rates, including active rates by currency. | GET /base-interest-ratesGET /base-interest-rates/<currency_>/activeGET /base-interest-rates/<id_>GET /base-interest-rates/active | - | - |
ReadBaseInterestSettings | View base interest settings. | GET /base-interest-settings/<target_id> | Registry -> View interest settings | - |
ReadBill | GET /bills/<id_> | Daily Routines -> View bill | - | |
ReadBills | GET /bills | - | - | |
ReadCharge | View a charge (fee, interest, or adjustment). | GET /charges/<id_> | - | - |
ReadCharges | List charges (fees, interest, and adjustments). | GET /charges | - | - |
ReadCollectionBatch | View collection batches, including invoices, reprieve, judgement, and payment account details. | GET /collection-batches/<collection_batch_id>GET /collection-batches/<collection_batch_id>/count-notesGET /collection-batches/<collection_batch_id>/count-tasksGET /collection-batches/<collection_batch_id>/historyPOST /collection-batches/history/searchGET /collection-batches/<collection_batch_id>/judgementGET /collection-batches/<collection_batch_id>/payment-accountGET /collection-batches/<collection_batch_id>/reprieveGET /collection-batches/<id_>/invoicesGET /collection-batches/table/<collection_batch_id>POST /collection-batch-invoice/search | - | - |
ReadCollectionBatchCharge | View a specific charge applied to a collection batch. | GET /collection-batches/charges/<id_> | - | - |
ReadCollectionBatchCharges | View charges applied to a collection batch. | GET /collection-batches/charges | - | - |
ReadCollectionBatchEvent | View a specific lifecycle event from a collection batch. | GET /collection-batches/events/<id_> | - | - |
ReadCollectionBatchEvents | View lifecycle events from a collection batch. | GET /collection-batches/events | - | - |
ReadCollectionBatchFinancialEvents | View all financial events for a collection batch. | GET /collection-batches/<collection_batch_id>/financial-events | - | - |
ReadCollectionBatchGuarantor | View guarantor information for collection batches. | GET /collection-batches/<collection_batch_id>/guarantors/<guarantor_id>GET /debtors/<debtor_id>/collection-batches/guarantorsGET /system-debtors/<identification_number>/collection-batches/guarantors | - | - |
ReadCollectionBatchGuarantors | View guarantors for a collection batch. | GET /collection-batches/<collection_batch_id>/guarantors | - | - |
ReadCollectionFeeType | View fee type definitions. | GET /fee/typeGET /fee/type/<id> | - | - |
ReadCollectionProfile | View and search collection profiles, their levels, placeholders, and staged versions. | GET /collection-profile/<collection_profile_id>GET /collection-profile/<collection_profile_id>/is-liveGET /collection-profile/<collection_profile_id>/levelsGET /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/searchPOST /collection-profile/levels/searchPOST /collection-profile/previewPOST /collection-profile/searchPOST /collection-profile/staged-collection-profiles/searchPOST /collection-profile/system-collection-profiles/searchPOST /segments/searchPUT /collection-profile/<collection_profile_id>/copy | Global Settings -> View collection profiles | - |
ReadContacts | View contact persons attached to a debtor. | GET /debtors/<debtor_id>/contacts | - | - |
ReadDocument | View a stored document. | GET /documents/<id_> | - | Invoices -> View documents |
ReadDocuments | View and download invoices and other documents. | GET /documentsGET /documents/invoices | - | Invoices -> Download invoices |
ReadEfakturaEnrollment | View and search e-faktura records for Nordic bank-channel invoice enrollment. | GET /e-fakturaGET /e-faktura/fui/<fui>POST /e-faktura/search | - | - |
ReadEnforcement | View enforcement actions and related deliveries, financial events, and history. | GET /enforcement-view/<enforcement_id>GET /enforcement/<enforcement_id>GET /enforcement/<enforcement_id>/deliveriesGET /enforcement/<enforcement_id>/financial-eventsGET /enforcement/<enforcement_id>/notesGET /enforcement/deliveries/<enforcement_delivery_id>/api-logsGET /enforcement/deliveries/<enforcement_delivery_id>/historyPOST /enforcement-view/searchPOST /enforcement/deliveries/api-logs/searchPOST /enforcement/deliveries/history/searchPOST /enforcement/deliveries/searchPOST /enforcement/search | Debt Collection -> View enforcement | - |
ReadEngineRule | View and search engine rules, criteria, settings, and criteria groups. | GET /engine-ruleGET /engine-rule-advanced-module/<id>GET /engine-rule-advanced-module/<id>/criteriaGET /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/valuesGET /engine-rule/<engine_rule_id>/settingsGET /engine-rule/<engine_rule_id>/settings/<id_>GET /engine-rule/<id>POST /engine-rule-advanced-module/searchPOST /engine-rule-criteria-group/searchPOST /engine-rule-criteria/searchPOST /engine-rule-criteria/values/searchPOST /engine-rule/search | Registry -> View engine rules | - |
ReadErp | View a specific ERP integration. | GET /erps/<id_> | - | - |
ReadErps | View ERP integrations. | GET /erps | - | - |
ReadErpsShort | View a compact list of ERP integrations. | GET /erps-short | - | - |
ReadErpBillingSettings | View billing settings for ERP integrations. | GET /erps/<id_>/settings/billing | - | - |
ReadErpShort | View a compact summary of a specific ERP integration. | GET /erps-short/<id_> | - | - |
ReadFinancingRule | View a financing rule by its identifier. | GET /financing-rules/<id_> | - | - |
ReadFinancingRules | List financing rules for product financing configuration. | GET /financing-rules | - | - |
ReadInstanceProviders | GET /instance-providersGET /instance-providers/<id_> | Environment -> View providers | Dashboard -> View providers | |
ReadInternalRequest | GET /internal-requestGET /internal-request/<id_>GET /internal-request/topic/<topic>POST /internal-request/topic | - | - | |
ReadInternalRequestChangelog | View audit history of internal requests. | GET /changelog/internal-requestGET /changelog/internal-request/<id_> | - | - |
ReadLabels | List labels for tagging resources. | GET /labels | Global Settings -> List labels | - |
ReadLocales | List supported locales and their date and currency formats. | GET /locales | Global Settings -> View locales | Dashboard -> View locales |
ReadNote | Retrieve a note by its identifier. | GET /notes/<id_> | - | - |
ReadNotes | List notes attached to resources. | GET /notes | - | - |
ReadNotesCollectionBatch | View notes attached to a collection batch. | GET /collection-batches/<collection_batch_id>/notes | - | - |
ReadPartPayment | Retrieve a part-payment installment by its identifier. | GET /part-payments/<part_payment_id> | - | - |
ReadPartPaymentAccount | View revolving credit accounts and their summaries. | GET /part-payment-accounts/<id_>GET /part-payment-accounts/<id_>/summary | Registry -> View credit accounts | - |
ReadPartPaymentAccounts | List part-payment accounts for revolving credit. | GET /part-payment-accounts | - | - |
ReadPartPaymentAccountEvent | Retrieve a lifecycle event for a part-payment account. | GET /part-payment-accounts/events/<id_> | - | - |
ReadPartPaymentAccountEvents | List lifecycle events for part-payment accounts. | GET /part-payment-accounts/events | - | - |
ReadPartPaymentAccountFinancialEvent | Retrieve a financial movement record for a part-payment account. | GET /part-payment-accounts/events/financial/<id_> | - | - |
ReadPartPaymentAccountFinancialEvents | List financial movements on part-payment accounts. | GET /part-payment-accounts/events/financial | - | - |
ReadPartPaymentAccountSetting | View part-payment configuration for an account. | GET /part-payment-accounts/settings/<id_> | - | - |
ReadPartPaymentAccountSettings | List part-payment account configurations. | GET /part-payment-accounts/settings | - | - |
ReadPartPaymentCollectionBatches | List collection batches arising from part-payment plans. | GET /part-payment-plans/collection-batches | - | - |
ReadPartPaymentPlan | View part-payment plans and their summaries. | GET /part-payment-plans/<id_>GET /part-payment-plans/<part_payment_plan_id>/summary | Registry -> View payment plans | - |
ReadPartPaymentPlans | List part-payment plans. | GET /part-payment-plans | - | - |
ReadPartPaymentPlanCollectionBatch | View a collection batch from a part-payment plan. | GET /part-payment-plans/collection-batches/<id_> | - | - |
ReadPartPaymentPlanEvent | View a part-payment plan lifecycle event. | GET /part-payment-plans/events/<id_> | - | - |
ReadPartPaymentPlanEvents | List part-payment plan lifecycle events. | GET /part-payment-plans/events | - | - |
ReadPartPaymentPlanFinancialEvent | View a financial event recorded against a part-payment plan. | GET /part-payment-plans/events/financial/<id_> | - | - |
ReadPartPaymentPlanFinancialEvents | List financial events recorded against part-payment plans. | GET /part-payment-plans/events/financial | - | - |
ReadPartPaymentPlanLedgerEvent | View a ledger posting for a part-payment plan. | GET /part-payment-plans/events/ledger/<id_> | - | - |
ReadPartPaymentPlanLedgerEvents | List ledger postings for part-payment plans. | GET /part-payment-plans/events/ledger | - | - |
ReadPartPaymentPlanSetting | View part-payment plan configuration. | GET /part-payment-plans/settings/<id_>PUT /part-payment-plans/settings/<id_>/summary | - | - |
ReadPartPaymentPlanSettings | List part-payment plan configuration settings. | GET /part-payment-plans/settings | - | - |
ReadPaymentAccount | View bank accounts and their payment settings. | GET /payment-accounts/<id_>GET /payment-accounts/<id_>/settings | Accounting -> View bank accounts | - |
ReadPaymentAccounts | List bank accounts where payments are received. | GET /payment-accounts | - | - |
ReadPaymentBatch | View a grouped payment ingestion batch. | GET /payment-batches/<id_> | Daily Routines -> View batch | - |
ReadPaymentBatches | List payment ingestion batches. | GET /payment-batches | - | - |
ReadPaymentFile | View a payment file. | GET /payment-files/<id_> | - | - |
ReadPaymentFiles | List ingested payment files. | GET /payment-files | - | - |
ReadPaymentMatchingEngine | View payment matching engines and simulate matching rules without creating links. | GET /payment-matching-engineGET /payment-matching-engine/<payment_matching_engine_id>GET /payment-matching-engine/match-fieldsPOST /payment-matching-engine/simulate | - | - |
ReadPaymentMethod | View payment methods like Swish, autogiro, and card. | GET /payment-methods/<id_> | Global Settings -> View payment methods | - |
ReadPaymentMethods | View available payment methods. | GET /payment-methods | - | - |
ReadPaymentMethodConfiguration | View payment method configuration and credentials. | GET /payment-methods/configurations/<id_> | - | - |
ReadPaymentMethodConfigurations | View payment method configurations and credentials. | GET /payment-methods/configurations | - | - |
ReadPaymentReconciliation | View a manual reconciliation record for an unplaced payment. | GET /payment-reconciliations/<reconciliation_id> | - | - |
ReadPaymentRequest | View an outbound payment request. | GET /payment-requests/<id_> | - | - |
ReadPaymentRequests | View outbound payment requests. | GET /payment-requests | - | - |
ReadPaymentTransaction | View payment transactions and their reconciliation links. | GET /payments/<id_>GET /payments/<payment_transaction_id>/linksPOST /payments/links/search | Daily Routines -> View transactions | - |
ReadPaymentTransactions | List inbound payments received from debtors and reconciled to invoices. | GET /payments | - | - |
ReadPaymentTransactionNote | View a single note attached to a payment transaction. | GET /payments/<id_>/notes/<note_id> | - | - |
ReadPaymentTransactionNotes | View notes attached to a payment. | GET /payments/<id_>/notes | - | - |
ReadPriceBracket | View a single price bracket by ID. | GET /price-brackets/<id_> | - | - |
ReadPriceBrackets | List price brackets within a price list. | GET /price-brackets | - | - |
ReadPriceList | View pricing-tier definitions. | GET /price-lists/<id_>GET /price-lists/target/<target_id> | Global Settings -> View price lists | - |
ReadPriceLists | View pricing-tier definitions. | GET /price-lists | - | - |
ReadPurchaseFiles | GET /collection-batches/purchase/file | - | - | |
ReadReasonCode | View reason codes used in payment matching and rejections. | GET /reason-code/<code_>GET /reason-code/type/<type_> | - | - |
ReadReasonCodes | View reason codes used in payment matching and rejections. | GET /reason-code | Global Settings -> View reason codes | - |
ReadSegment | GET /segments/<segment_id>POST /segments/search | - | - | |
ReadServiceAccount | View a service account used for server-to-server integrations. | GET /service-accounts/<id_> | - | - |
ReadServiceAccounts | View service accounts used for server-to-server integrations. | GET /service-accounts | - | - |
ReadServiceProviders | View external service providers such as credit bureaus and distribution channels. | GET /service-providersGET /service-providers/<id_> | Environment -> View service providers | - |
ReadServiceProviderInsuranceAgreement | View insurance agreements tied to a service provider. | GET /service-provider-insurance-agreement/<id_> | - | - |
ReadServiceProviderInsuranceAgreements | View insurance agreements tied to service providers. | GET /service-provider-insurance-agreementGET /service-provider-insurance-agreement/service-provider/<service_provider_id> | Environment -> View insurance agreements | - |
ReadSettlementAccount | View a settlement account. | GET /settlement-accounts/<id_> | - | - |
ReadSettlementAccounts | List settlement accounts. | GET /settlement-accounts | - | - |
ReadSettlementAccountTransaction | View a settlement account transaction. | GET /settlement-account-transactions/<id_> | - | - |
ReadSettlementAccountTransactions | List transactions on settlement accounts. | GET /settlement-account-transactions | - | - |
ReadSniCode | Look up and search SNI industry classification codes. | GET /global-sni-registryGET /global-sni-registry/<code>POST /global-sni-registry/search | Global Settings -> Search SNI codes | - |
ReadStatisticCount | View resource counters for a client. | GET /statistics/counts/<client_id> | - | Dashboard -> View counters |
ReadStatisticCounts | List resource counters. | GET /statistics/counts | - | - |
ReadUnplacedPayment | View a payment that the matching engine could not auto-place. | GET /unplaced-payments/<unplaced_payment_id> | Daily Routines -> View unplaced payments | - |
ReadUnplacedPayments | List payments that the matching engine could not auto-place. | GET /unplaced-payments | - | - |
ReadUnplacedPaymentReturn | View a returned (bounced) payment transaction. | GET /payment-transactions-returns/<id_> | Daily Routines -> View payment returns | - |
ReadUnplacedPaymentReturns | List returned (bounced) payment transactions. | GET /payment-transactions-returns | - | - |
ReadWebhook | View configured webhooks. | GET /webhookGET /webhook/<id_> | - | - |
ReadWebhookRequestLog | Search and view webhook request logs. | GET /webhook/log/<id_>POST /webhook/log/search | - | - |
RemovePaymentRequest | Delete an outbound payment request (Swish, etc.). | DELETE /payment-requests/<id_> | - | - |
ReprieveCollectionBatch | Set and close reprieve periods on collection batches. | PUT /collection-batches/<collection_batch_id>/close-reprievePUT /collection-batches/<collection_batch_id>/reprieve | - | - |
ReprieveCollectionBatchJob | POST /collection-batches/run-reprieve-job | - | - | |
ResumeCollectionBatch | PUT /collection-batches/<collection_batch_id>/resume | - | - | |
RetryWebhookEvents | Retry failed webhook event deliveries. | PUT /webhook/log/retry/<id_> | - | - |
ReturnPaymentTransactionReturns | Update the return of a bounced payment transaction. | PUT /payment-transactions-returns/<id_>/return | Daily Routines -> Return transactions | - |
ReturnUnplacedPayment | Update the return of an unplaced payment. | PUT /unplaced-payments/<unplaced_payment_id>/return | Daily Routines -> Return unplaced | - |
RotateSecretServiceAccount | Rotate API secrets for service account integrations. | PUT /service-accounts/<id_>/rotate-secret | Environment -> Rotate secrets | Configure -> Rotate secrets |
RunEngineRule | PUT /engine-rule/run-validation | - | - | |
SearchAutomations | Search automation rules. | POST /automation/search | - | - |
SearchBaseInterestRate | Search base interest rates. | POST /base-interest-rates/search | Global Settings -> Search rates | - |
SearchBills | Search service bills issued to your account. | POST /bills/search | Daily Routines -> Search bills | - |
SearchCharges | Search charges including fees, interest, and adjustments. | POST /charges/search | Daily Routines -> Search charges | - |
SearchCollectionBatches | Search collection batches. | POST /collection-batches/search | Debt Collection -> Search batches | - |
SearchCollectionBatchCharges | Search charges applied to a collection batch. | POST /collection-batches/charges/search | - | - |
SearchCollectionBatchEvents | Search lifecycle events for a collection batch. | POST /collection-batches/events/search | - | - |
SearchCollectionBatchGuarantors | Search guarantors in a collection batch. | POST /collection-batches/<collection_batch_id>/guarantors/search | - | - |
SearchCollectionBatchToDo | Search pending collection batch tasks. | POST /collection-batch/todo/search | Debt Collection -> Search tasks | - |
SearchContacts | Search contact persons attached to a debtor. | POST /debtors/<debtor_id>/contacts/search | Registry -> Search contacts | - |
SearchDocument | Search stored documents. | POST /documents/searchPOST /documents/search_extended | Environment -> Search documents | - |
SearchErps | Search ERP integrations. | POST /erps/search | Registry -> Search ERP integrations | - |
SearchFinancingRules | Search financing rule configurations. | POST /financing-rules/search | Registry -> Search financing rules | - |
SearchInstanceProviders | Search instance provider tenants. | POST /instance-providers/search | Environment -> Search providers | - |
SearchInternalRequest | Search internal requests in the dual confirmation workflow. | POST /internal-request/search | Registry -> Search requests | - |
SearchLabels | Search labels for tagging resources. | POST /labels/search | Registry -> Search labels | - |
SearchNotes | Search free-form notes attached to resources. | POST /notes/client-invoice-notes/searchPOST /notes/search | Registry -> Search notes | - |
SearchPartPayment | Search part-payment installments. | POST /part-payments/search | - | - |
SearchPartPaymentGroups | Search part-payment plan groupings for reporting. | POST /part-payment-groups/search | - | - |
SearchPartPaymentAccounts | Search revolving credit part-payment accounts. | POST /part-payment-accounts/search | Registry -> Search payment accounts | - |
SearchPartPaymentAccountEvents | Search lifecycle events for part-payment accounts. | POST /part-payment-accounts/events/search | Registry -> Search account events | - |
SearchPartPaymentAccountFinancialEvents | Search financial movements on part-payment accounts. | POST /part-payment-accounts/events/financial/search | - | - |
SearchPartPaymentAccountSettings | Search per-account part-payment configuration. | POST /part-payment-accounts/settings/search | - | - |
SearchPartPaymentPlans | Search part-payment plans bound to invoices. | POST /part-payment-plans/search | Registry -> Search payment plans | - |
SearchPartPaymentPlanCollectionBatches | Search collection batches from part-payment plans. | POST /part-payment-plans/collection-batches/search | Registry -> Search collection batches | - |
SearchPartPaymentPlanEvents | Search part-payment plan lifecycle events. | POST /part-payment-plans/events/search | Registry -> Search plan events | - |
SearchPartPaymentPlanFinancialEvents | Search financial events recorded against a part-payment plan. | POST /part-payment-plans/events/financial/search | - | - |
SearchPartPaymentPlanLedgerEvents | Search ledger-level postings for a part-payment plan. | POST /part-payment-plans/events/ledger/search | Registry -> Search ledger postings | - |
SearchPartPaymentPlanSettings | Search plan-level configuration settings. | POST /part-payment-plans/settings/search | - | - |
SearchPaymentAccounts | Search payment accounts and their settings. | POST /payment-accounts/searchPOST /payment-accountssettings/search | Accounting -> Search bank accounts | - |
SearchPaymentBatches | Search grouped payment ingestion files. | POST /payment-batches/search | Daily Routines -> Search payment batches | - |
SearchPaymentFiles | Search raw payment files ingested into the platform. | POST /payment-files/search | Daily Routines -> Search payment files | - |
SearchPaymentMatchingEngine | POST /payment-matching-engine/search | - | - | |
SearchPaymentMethods | Search payment methods (Swish, autogiro, card, etc.). | POST /payment-methods/search | Global Settings -> Search payment methods | - |
SearchPaymentMethodConfigurations | Search and filter payment method configurations. | POST /payment-methods/configurations/client/searchPOST /payment-methods/configurations/searchPOST /payment-methods/configurations/service-provider/search | Global Settings -> Search payment methods | - |
SearchPaymentReconciliation | Search unplaced payments for manual reconciliation. | POST /payment-reconciliations/search | - | - |
SearchPaymentRequests | Search outbound payment requests (Swish, etc.). | POST /payment-requests/search | - | - |
SearchPaymentTransactions | Search inbound payments received from debtors and reconciled to invoices. | POST /payments/search | Daily Routines -> Search inbound payments | - |
SearchPaymentTransactionReturns | Search returned (bounced) payment transactions. | POST /payment-transactions-returns/search | Daily Routines -> Search returned payments | - |
SearchPriceBrackets | Search volume or amount brackets within a price list. | POST /price-brackets/search | Global Settings -> Search price brackets | - |
SearchPriceLists | Search pricing-tier definitions. | POST /price-lists/search | Global Settings -> Search price lists | - |
SearchPurchaseFiles | Search purchase files and purchases in collection batches. | POST /collection-batches/purchase/file/searchPOST /collection-batches/purchase/search | - | - |
SearchReasonCodes | Search reason codes used in payment matching and rejections. | POST /reason-code/search | Global Settings -> Search reason codes | - |
SearchServiceAccounts | Search server-to-server credentials and integrations. | POST /service-accounts/search | Environment -> Search service accounts | Configure -> Integrations |
SearchServiceProviders | Search external service providers. | POST /service-providers/search | Registry -> Search service providers | - |
SearchServiceProviderInsuranceAgreements | Search insurance agreements tied to service providers. | POST /service-provider-insurance-agreement/search | - | - |
SearchSettlementAccounts | Search settlement accounts. | POST /settlement-accounts/search | - | - |
SearchSettlementAccountTransactions | Search transactions on settlement accounts. | POST /settlement-account-transactions/search | - | - |
SearchStatisticCount | Search resource counters displayed in the operator dashboard. | POST /statistics/counts/search | - | - |
SearchUnplacedPayments | Search unplaced payments and view matching helpers. | GET /unplaced-payments/categoriesPOST /client-match-payments/searchPOST /unplaced-payments/search | Daily Routines -> Search payments Registry -> View debtor | - |
SquidInvalidatePayments | Invalidate vouchers by IDs. | PUT /squidd/invalidate-payment | - | Errands -> Invalidate payments |
StopCollectionBatch | Stop a collection batch. | PUT /collection-batches/<collection_batch_id>/stop | - | - |
ToggleServiceAccount | Activate or deactivate service accounts for integrations. | PUT /service-accounts/<id_>/toggle | Environment -> Toggle service accounts | Configure -> Toggle service account |
TriggerCollectionBatchEvent | Trigger lifecycle events for collection batches. | PUT /collection-batches/events/<collection_batch_id>/trigger | - | - |
TriggerDelivery | POST /enforcement/deliveries/updatesPOST /enforcement/retry_deliveryPUT /enforcement/api-logs/<api_log_id>/retryPUT /enforcement/confirm_submissionPUT /enforcement/deliveries/create_deductionPUT /enforcement/deliveries/create_recallPUT /enforcement/deliveries/export_deductionPUT /enforcement/deliveries/export_execution_deductionPUT /enforcement/deliveries/export_recallPUT /enforcement/deliveries/export_recall/<enforcement_number>PUT /enforcement/deliveries/pullPUT /enforcement/deliveries/pushPUT /enforcement/deliveries/ready_for_exportPUT /enforcement/deliveries/ready_for_export/<enforcement_number>PUT /enforcement/report_closing_executionPUT /enforcement/report_deductionPUT /enforcement/report_execution_annual_feePUT /enforcement/report_execution_confirmationPUT /enforcement/report_execution_distraint_salaryPUT /enforcement/report_execution_partial_disclosurePUT /enforcement/report_recallPUT /enforcement/report_verdictPUT /enforcement/update_delivery | - | - | |
UnplacedPaymentMarkAsRevenue | Mark unplaced payments as revenue or revert the designation. | PUT /unplaced-payments/<id_>/revenue-revertPUT /unplaced-payments/<unplaced_payment_id>/revenue | Daily Routines -> Mark as revenue | - |
UnplacedPaymentWriteOff | Mark unplaced payments as write-offs or revert the write-off. | PUT /unplaced-payments/<id_>/write-offPUT /unplaced-payments/<id_>/write-off-revert | Daily Routines -> Write off payments | - |
UpdateAutomation | Change an automation, including the event it reacts to, whether it is active, and the action it runs. | PUT /automation/<_id> | - | - |
UpdateAutomationRule | Change a rule that decides when an automation runs. | PUT /automation/rules/<_id> | - | - |
UpdateBaseInterestRate | Update base interest rates and set active rates by currency. | POST /base-interest-rates/<currency_>/activePUT /base-interest-ratesPUT /base-interest-rates/<id_> | Global Settings -> Update interest rates | - |
UpdateBaseInterestSettings | Update base interest settings. | PUT /base-interest-settings/<target_id> | Registry -> Update interest settings | - |
UpdateCharges | Update manual charges such as fees and interest. | PUT /charges/<id_> | - | - |
UpdateCofaceRequest | POST /events/coface/event | - | - | |
UpdateCollectionBatch | PUT /collection-batches/<collection_batch_id>PUT /collection-batches/<collection_batch_id>/judgement | - | - | |
UpdateCollectionBatchGuarantor | Update guarantors assigned to collection batches. | PUT /collection-batches/<collection_batch_id>/guarantors/<guarantor_id> | - | - |
UpdateCollectionBatchToDo | Update collection batch tasks pending operator action. | PUT /collection-batch/todo/<collection_batch_id>/<id> | Daily Routines -> Resolve batch tasks | - |
UpdateCollectionFeeType | Configure collection fee types and their order. | PUT /fee/type/<id>PUT /fee/type/order | - | - |
UpdateContact | Update contact person details. | PUT /contacts/<id_> | Registry -> Update contacts | - |
UpdateEnforcement | Update enforcement actions including recalling, closing cases, sending to execution, and adding notes. | POST /enforcement/<enforcement_id>/create-execution-deductionPOST /enforcement/<enforcement_id>/notesPOST /enforcement/<enforcement_id>/send-to-executionPUT /enforcement/<enforcement_id>/close-rejected-casePUT /enforcement/<enforcement_id>/complete-closing-executionPUT /enforcement/<enforcement_id>/recall | - | - |
UpdateEngineRule | Update 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 | - |
UpdateEngineRuleSchedulerFilter | PUT /engine-rule/scheduler-filters/<id> | - | - | |
UpdateErps | Update ERP integrations. | PUT /erps/<id_> | - | - |
UpdateErpBillingSettings | Update ERP billing settings. | PUT /erps/<id_>/settings/billing | - | - |
UpdateFinancingRules | Modify per-product financing rule configurations. | PUT /financing-rules/<id_> | Registry -> Configure financing | - |
UpdateInstanceProviders | PUT /instance-providers/<id_> | Environment -> Update providers | - | |
UpdateInternalRequest | PUT /internal-request/<id_>PUT /internal-request/bulk-update | - | - | |
UpdateLabels | Modify free-form labels used to tag resources. | PUT /labels/<id> | Global Settings -> Edit labels | - |
UpdateMultiplePriceLists | PUT /price-lists/update | Global Settings -> Update price lists | - | |
UpdateMultiplePriceListPrices | Update multiple prices and price brackets across pricing tiers. | PUT /price-lists/update-multiple-bracketsPUT /price-lists/update-multiple-prices | Global Settings -> Adjust prices | - |
UpdateNote | Edit free-form notes attached to resources. | PUT /notes/<id_> | Registry -> Edit notes | - |
UpdatePartPaymentAccount | Modify long-running part-payment accounts for revolving credit. | PUT /part-payment-accounts/<id_> | - | - |
UpdatePartPaymentAccountSetting | Configure per-account part-payment settings. | PUT /part-payment-accounts/settings/<id_> | - | - |
UpdatePartPaymentPlan | Modify closed-end part-payment plans bound to an invoice. | PUT /part-payment-plans/<id_> | - | - |
UpdatePartPaymentPlanCollectionBatch | Update collection batches arising from part-payment plans. | PUT /part-payment-plans/collection-batches/<id_> | - | - |
UpdatePartPaymentPlanSetting | Update plan-level part-payment settings. | PUT /part-payment-plans/settings/<id_> | - | - |
UpdatePaymentAccounts | Update bank account details and payment account settings. | PUT /payment-accounts/<id_>PUT /payment-accounts/<id_>/settings | Accounting -> Configure accounts | - |
UpdatePaymentMatchingEngine | Update payment matching engines and connect or disconnect clients from them. | DELETE /payment-matching-engine/<id_>/clientsDELETE /payment-matching-engine/<payment_matching_engine_id>/clients/<client_id>POST /payment-matching-engine/<id_>/clientsPUT /payment-matching-engine/<payment_matching_engine_id> | - | - |
UpdatePaymentMethod | Edit payment methods (Swish, autogiro, card, etc.). | PUT /payment-methods/<id_> | Global Settings -> Edit methods | - |
UpdatePaymentMethodConfiguration | Update payment method configuration and credentials. | PUT /payment-methods/configurations/<id_> | - | - |
UpdatePaymentRequest | Update payment request status, sync provider status, and retry payouts. | GET /payment-requests/status/<id_>POST /payment-requests/statusPUT /payment-requests/retry-payout/<payment_request_id> | - | - |
UpdatePaymentRequestStatus | PUT /events/payment-request-complete | - | - | |
UpdatePaymentTransaction | Update inbound payments received from debtors and reconciled to invoices. | PUT /payments/<id_> | Daily Routines -> Edit payments | - |
UpdatePaymentTransactionNote | Update notes on inbound payments. | PUT /payments/<id_>/notes/<note_id> | - | - |
UpdatePaymentTransactionReturns | Update returned or bounced payment transactions. | PUT /payment-transactions-returns/<id_> | Daily Routines -> Update returns | - |
UpdatePriceBracket | Update a volume or amount bracket within a price list. | PUT /price-brackets/<id_> | - | - |
UpdatePriceBrackets | Replace all price brackets within a price list. | PUT /price-brackets | Global Settings -> Set brackets | - |
UpdatePriceListPrices | Update prices within a pricing-tier definition. | PUT /price-lists/<price_list_id>/prices | Global Settings -> Edit prices | - |
UpdateReasonCode | Update reason codes used in payment matching and rejections. | PUT /reason-code/<code_> | Global Settings -> Update codes | - |
UpdateServiceProviderInsuranceAgreement | Update insurance agreements tied to a service provider. | PUT /service-provider-insurance-agreement/<id_> | Registry -> Manage insurance | - |
UpdateSetDefaultInstanceProviders | PUT /instance-providers/<id_>/default | Environment -> Set defaults | - | |
UpdateSniCode | PUT /global-sni-registry/<code> | Global Settings -> Update SNI code | - | |
UpdateUnplacedPayment | Update payments that the matching engine could not auto-place. | PUT /unplaced-payments/<unplaced_payment_id> | Daily Routines -> Update unplaced payments | - |
UpdateWebhook | Update webhook configurations. | PUT /webhook/<id_> | - | - |
ValidatePaymentReference | Validate a payment reference number against inbound payments. | POST /payments/validate-payment-reference | - | - |
WriteOffOnCollectionBatch | Write off a collection batch. | PUT /collection-batches/<collection_batch_id>/writeoff | - | - |
WriteOffOnPartPaymentPlan | Write off a part-payment plan. | PUT /part-payment-plans/<id_>/write-off | - | - |
Payout Management
Section titled “Payout Management”22 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
AuthorizePayoutBatches | Authorize a payout batch awaiting bank submission. | PUT /payout-batches/<id_>/authorize | Daily Routines -> Authorize payout batches | - |
BookkeepPayoutBatches | Bookkeep batched payout files awaiting bank submission. | PUT /payout-batches/<id_>/bookkeep | Daily Routines -> Bookkeep payout batches | - |
CreatePayoutAccounts | Create bank accounts that payouts are sent from. | POST /payout-accounts | Accounting -> Create payout account | - |
CreatePayoutBatchReport | Generate a payout batch report document. | POST /documents/payout-batch-report | Daily Routines -> Generate payout report | - |
DeletePayouts | Delete an outbound payout to clients or debtors. | DELETE /payouts/<id_> | - | - |
DeletePayoutBatches | Delete a batched payout file awaiting bank submission. | DELETE /payout-batches/<id_> | Daily Routines -> Payouts -> Delete payout batch | - |
ExportPayoutBatches | Export a payout batch. | PUT /payout-batches/<id_>/export | Daily Routines -> Export payouts | - |
GeneratePayoutBatches | Generate payout batches for bank submission. | PUT /payout-batches/generate | Daily Routines -> Generate payouts | - |
ReadPayout | View payout and blocked payout details. | GET /blocked-payouts/<id_>GET /payouts/<id_> | - | - |
ReadPayouts | View lists of payouts and blocked payouts. | GET /blocked-payoutsGET /payouts | - | - |
ReadPayoutSettlementsExternalExport | Export per-payout settlement accounting for external systems. | GET /payout-settlementsGET /payout-settlements/<id_> | - | - |
ReadPayoutAccount | View a payout account. | GET /payout-accounts/<id_> | Registry -> View payout account | - |
ReadPayoutAccounts | View bank accounts used for sending payouts. | GET /payout-accounts | Accounting -> View bank accounts | - |
ReadPayoutBatch | View a payout batch. | GET /payout-batches/<id_> | Daily Routines -> View payouts | - |
ReadPayoutBatches | List payout batches awaiting bank submission. | GET /payout-batches | - | - |
ReadPayoutFile | Retrieve a generated payout file in formats like SEPA XML or BG. | GET /payout-files/<id_> | - | - |
ReadPayoutFiles | List generated payout files in formats like SEPA XML or BG. | GET /payout-files | - | - |
SearchPayouts | Search payouts and blocked payouts. | POST /blocked-payouts/searchPOST /payouts/search | Daily Routines -> Search payouts | - |
SearchPayoutAccounts | Search bank accounts payouts are sent from. | POST /payout-accounts/search | Registry -> Search payout accounts | - |
SearchPayoutBatches | Search payout batches awaiting bank submission. | POST /payout-batches/search | Daily Routines -> Search payout batches | - |
SearchPayoutFiles | Search generated payout files in various formats. | POST /payout-files/search | - | - |
UpdatePayoutAccounts | Update bank account information for payouts. | PUT /payout-accounts/<id_> | Accounting -> Manage payout accounts | - |
Reminder Management
Section titled “Reminder Management”19 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
AuthorizeReminders | Authorize payment reminders. | PUT /reminders/authorize | Daily Routines -> Authorize reminders | - |
BookkeepReminders | PUT /reminders/bookkeep | Daily Routines -> Bookkeep reminders | - | |
DeleteReminders | Delete reminders individually or in bulk. | DELETE /reminders/<id_>POST /reminders/bulk-delete | Daily Routines -> Reminders -> Delete reminder | - |
GenerateReminders | Generate payment reminders. | PUT /reminders/generate | Daily Routines -> Generate reminders | - |
ReadReminder | Retrieve a reminder by its ID. | GET /reminders/<id_> | - | - |
ReadReminders | List reminders and their issuance history. | GET /reminders | - | - |
ReadReminderProfile | Retrieve a reminder profile template by its ID. | GET /reminder-profiles/<id_> | Global Settings -> View reminder profiles | - |
ReadReminderProfiles | GET /reminder-profilesPUT /reminder-profiles/<id_>/copy | Global Settings -> View reminder profiles | - | |
CreateReminderProfileLevels | Create individual reminder steps within a profile. | POST /reminder-profile-levels | Global Settings -> View reminder profiles | - |
ReadReminderProfileLevel | Retrieve an individual reminder step within a profile. | GET /reminder-profile-levels/<id_> | - | - |
ReadReminderProfileLevels | List individual reminder steps within a profile. | GET /reminder-profile-levels | - | - |
RemoveReminderProfileLevels | Delete reminder profile levels. | DELETE /reminder-profile-levels/<id_> | Global Settings -> Delete reminder levels | - |
ReportInvalidAddressReminders | Mark reminders as having invalid addresses. | PUT /reminders/<id_>/invalid-address | - | - |
SearchReminders | Search reminder issuance and history. | POST /reminders/search | Daily Routines -> Search reminders | - |
SearchReminderProfiles | Search reminder templates for cadence and content. | POST /reminder-profiles/search | Global Settings -> Search reminder profiles | - |
SearchReminderProfileLevels | Search individual reminder steps within profiles. | POST /reminder-profile-levels/search | Global Settings -> Search reminder steps | - |
SetDefaultReminderProfiles | Mark a reminder profile as default. | PUT /reminder-profiles/<id_>/default | - | - |
UpdateReminderProfiles | Update reminder profile templates for cadence and content. | PUT /reminder-profiles/<id_> | Global Settings -> Update profiles | - |
UpdateReminderProfileLevels | Update individual reminder steps within a profile. | PUT /reminder-profile-levels/<id_> | Global Settings -> Manage levels | - |
Reports & Analytics
Section titled “Reports & Analytics”20 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
AuthorizeTransactionReports | Authorize generated transaction reports for compliance. | PUT /reports/transaction-reports/authorize | Daily Routines -> Authorize transaction reports | - |
CreateQueryReportScheduler | Create recurring schedules for custom query reports. | POST /scheduler/query-report | - | Reports -> Schedule report |
DeleteQueryReportScheduler | Delete scheduled custom query reports. | DELETE /scheduler/query-report/<id_> | - | Reports -> Delete scheduled report |
SearchQueryReportScheduler | Search scheduled query reports. | POST /scheduler/query-report/search | - | - |
UpdateQueryReportScheduler | Configure recurring custom query reports and manage recipients. | DELETE /scheduler/query-report/<id_>/recipient/<email>POST /scheduler/query-report/<id_>/recipientsPUT /scheduler/query-report/<id_> | - | Reports -> Configure delivery |
ReadQueryReportScheduler | View scheduled custom query reports. | GET /scheduler/query-reportGET /scheduler/query-report/<id_> | - | - |
CreateBookkeepingFileScheduler | Set up recurring exports of bookkeeping files. | POST /scheduler/bookkeeping-file | - | - |
ReadBookkeepingFileScheduler | View scheduled bookkeeping file exports. | GET /scheduler/bookkeeping-fileGET /scheduler/bookkeeping-file/<id_> | - | - |
UpdateBookkeepingFileScheduler | Configure recurring bookkeeping file exports and manage recipients. | DELETE /scheduler/bookkeeping-file/<id_>/recipient/<email>POST /scheduler/bookkeeping-file/<id_>/recipientsPUT /scheduler/bookkeeping-file/<id_> | - | - |
DeleteBookkeepingFileScheduler | Delete scheduled bookkeeping file exports. | DELETE /scheduler/bookkeeping-file/<id_> | - | - |
SearchBookkeepingFileScheduler | Search scheduled bookkeeping file exports. | POST /scheduler/bookkeeping-file/search | - | - |
ExportTransactionReports | Export generated transaction reports. | PUT /reports/transaction-reports/export | Daily Routines -> Export reports | - |
GenerateTransactionReports | Generate transaction reports. | PUT /reports/transaction-reports/generate | Daily Routines -> Generate reports | - |
QueryReport | Query custom SQL-style report definitions and runs. | POST /reports/query-reports/<id_>/query | Accounting -> Query report Registry -> Query report Daily Routines -> Query report | Reports -> Query report |
ReadQueryReport | View a custom SQL-style report definition by ID. | GET /reports/query-reports/<id_> | Reports -> View report | - |
ReadQueryReports | View custom SQL-style report definitions and runs. | GET /reports/query-reports | - | Reports -> View reports |
ReadTransactionReport | View a generated transaction report for compliance. | GET /reports/transaction-reports/<id_> | - | - |
ReadTransactionReports | View generated transaction reports for compliance. | GET /reports/transaction-reports | - | - |
SearchQueryReports | Search custom SQL-style report definitions and runs. | POST /reports/query-reports/search | Reports -> Search query reports | - |
SearchTransactionReports | Search generated transaction reports for compliance. | POST /reports/transaction-reports/search | Daily Routines -> Search transaction reports | - |
Module Management
Section titled “Module Management”1 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
ReadModules | GET /modulesGET /modules/<id_> | Environment -> View modules | - |
Statistics
Section titled “Statistics”2 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
ReadProductStatistics | POST /statistics/product/<client_id>/ledger-snapshotPOST /statistics/product/<client_id>/open-balance | - | Dashboard -> View statistics | |
ReadOverdueStatistics | View overdue-receivables statistics. | POST /statistics/overdue/<client_id>/ledger-snapshotPOST /statistics/overdue/<client_id>/open-balance | - | Dashboard -> View overdue stats |
System & Administration
Section titled “System & Administration”22 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CalculateStatusSystemErrands | Trigger a status recalculation on a system-generated errand. | PUT /errands/system/<id_>/calculate-status | - | - |
CloseCeleryTasks | PUT /celery-task/close | - | - | |
CloseSystemErrands | Mark system-generated operational tasks as completed. | PUT /errands/system/<id_>/close | - | Errands -> Close errand |
ForceCloseSystemErrands | Force close system-generated errands. | PUT /errands/system/<id_>/force-close | - | Errands -> Close errands |
CreateSystemBankAccount | Create and manage system bank accounts. | POST /system-bank-accountsPUT /system-bank-accounts/<id_> | - | - |
CreateValidationErrorErrands | POST /errands/system/invoice-validation-errors/<invoice_id> | - | - | |
GetCeleryTaskId | Retrieve 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-idGET /charges/bill/latest-task-idGET /charges/generate/latest-task-idGET /engine-rule/run-validation/latest-task-idGET /payment-batches/bookkeep/latest-task-idGET /payment-batches/match/latest-task-idGET /payment-files/import/latest-task-idGET /price-lists/update-multiple-brackets/latest-task-idGET /price-lists/update-multiple-prices/latest-task-idGET /reminders/authorize/latest-task-idGET /reminders/bookkeep/latest-task-idGET /reminders/generate/latest-task-id | Daily Routines -> View task status | - |
GetCeleryTaskStatus | GET /celery-task/<task_id> | Daily Routines -> View task status | - | |
GetValidationErrorErrands | GET /errands/system/invoice-validation-errors | - | Errands -> View errors | |
PerformSystemErrands | Perform system-generated errands requiring operator action. | PUT /errands/system/<id_>/perform | SystemErrandList -> Perform errand | - |
ReadSystemBankAccount | Search system bank accounts. | POST /system-bank-accounts/search | - | - |
ReadSystemErrand | View system-generated errands and their events. | GET /errands/system/<id_>GET /errands/system/<id_>/events | Daily Routines -> View errands | Errands -> View errands |
ReadSystemErrands | View system-generated errands requiring operator action. | GET /errands/system | - | - |
ReadSystemErrandCounts | View pending system errand counters. | GET /reports/system-errand-counts | - | Dashboard -> View errand counts |
ReadSystemExchangeRates | View daily exchange rate snapshots. | GET /system/exchange-rates | Daily Routines -> View exchange rates | - |
ReadSystemSetting | View tenant-wide system settings. | GET /system-settingGET /system-setting/<key_> | Environment -> View settings | - |
ResolveSystemErrands | Resolve system-generated errands requiring operator attention. | PUT /errands/system/<id_>/resolve | Registry -> Resolve errands | Errands -> Resolve system errands |
SearchSystemErrands | Search system-generated errands requiring operator action. | POST /errands/system/search | Daily Routines -> Search errands | - |
SearchSystemErrandCounts | Search counters of pending system errands. | POST /reports/system-errand-counts/search | - | - |
UpdateErrandSuggestion | Update monitoring suggestions for system-generated errands. | PUT /errands/system/<errand_system_id>/update-monitoring-suggestion | - | - |
UpdateSystemSetting | Update tenant-wide system settings. | PUT /system-setting/<key_> | - | - |
ViewDeveloperTools | Access the admin Developer Tools / Developer Mode drawer (live API and webhook logs, cache, access and environment panels). UI capability only. | - | Developer Mode (user menu) | - |
Template Management
Section titled “Template Management”15 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
ConnectLogotypeToTemplate | Add a logo to a fee or interest template. | PUT /client-financial-price-template/<id_>/logotype | - | - |
CreateDocumentTemplate | Create templated documents such as invoices and reminders. | POST /document-templates | Global Settings -> Create template | Dashboard -> Create template |
CreateDocumentTemplatePlaceholders | Add placeholders to document templates. | POST /document-templates/<id_>/placeholders | Global Settings -> Add placeholders | - |
CreateTemplate | Create fee and interest templates for client accounts. | POST /client-financial-price-template | - | - |
DeleteDocumentTemplate | Delete document templates (invoices, reminders, etc.). | DELETE /document-templates/<id_> | Global Settings -> Collection Settings -> Delete document template | - |
DeleteDocumentTemplatePlaceholders | Delete placeholders from document templates. | DELETE /document-templates/<id_>/placeholders/<pc_id> | - | - |
EditTemplate | Enable or disable fee and interest templates for clients. | PUT /client-financial-price-template/<id_>/enabled | - | - |
ReadDocumentTemplate | View templated documents like invoices and reminders. | GET /document-templates/<id_> | - | - |
ReadDocumentTemplates | View document templates for invoices, reminders, and other documents. | GET /document-templates | - | - |
ReadTemplate | View and search client fee and interest templates. | GET /client-financial-price-templateGET /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 | - |
SearchDocumentTemplates | Search document templates for invoices and reminders. | POST /document-templates/search | Global Settings -> Search templates | - |
UpdateDocumentTemplate | Update document templates such as invoices and reminders. | PUT /document-templates/<id_> | Global Settings -> Update templates | - |
UpdateDocumentTemplatePlaceholders | Update placeholders in document templates such as invoices and reminders. | PUT /document-templates/<id_>/placeholders/<pc_id> | Global Settings -> Update placeholders | - |
UpdateSetDefaultDocumentTemplates | Mark a document template as the default. | PUT /document-templates/<id_>/default | - | - |
UpdateTemplate | Update 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 | - |
User & Access Management
Section titled “User & Access Management”33 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
AddRoleRight | Add rights to a role definition. | POST /roles/<id_>/rights/<right_id> | - | - |
ChangeMfaUsers | Change multi-factor authentication settings for user accounts. | PUT /users/<id_>/change-mfa | - | - |
ChangePasswordUsers | Change user account passwords. | PUT /users/<id_>/change-password | Environment -> Change user password | Configure -> Change password |
CreateContentUserSetting | POST /content-user-setting | - | - | |
CreateRoles | Create roles with bundled rights. | POST /roles | - | - |
CreateUsers | Create tenant users with default roles based on user type. | POST /users | Environment -> Create user | Configure -> Add user |
CreateUserGroups | Create user groups for bulk role assignment and permission control. | POST /user-groups | - | - |
CreateUserGroupUsers | POST /user-groups/<id_>/users | - | - | |
CreateUserRoles | POST /users/<id_>/roles | Environment -> Assign user role | - | |
DeleteContentUserSetting | DELETE /content-user-setting/<id> | - | - | |
DeleteRole | Delete role definitions and their bundled rights. | DELETE /roles/<id_> | - | - |
DeleteUserGroups | Delete user groups used for bulk role and permission management. | DELETE /user-groups/<id_> | - | - |
DeleteUserGroupUsers | Remove users from a user group. | DELETE /user-groups/<id_>/users/<user_id> | - | - |
DeleteUserRoles | Remove roles from users (super-user only). | DELETE /users/<id_>/roles/<role_id> | Environment -> Roles -> Delete user role | - |
ReadContentUserSetting | GET /content-user-setting/<type> | - | - | |
ReadContentUserSettings | GET /content-user-setting | - | - | |
ReadRole | View a role and the rights bundled into it. | GET /roles/<id_> | - | - |
ReadRoles | List all roles and their bundled rights. | GET /roles | - | - |
ReadUser | View a tenant user, including their roles and activation state. | GET /users/<id_> | Environment -> View users | Configure -> View users |
ReadUsers | List and view user accounts and system users. | GET /ping/securedGET /usersGET /users/system | - | - |
ReadUserGroup | View a user group for role assignment and permission control. | GET /user-groups/<id_> | - | - |
ReadUserGroups | List user groups for role assignment and permission control. | GET /user-groups | Registry -> View user groups | - |
ReadUserGroupUsers | View users within a user group. | GET /user-groups/<id_>/users | - | - |
ReadUserRoles | View roles assigned to a tenant user. | GET /users/<id_>/roles | Environment -> View user roles | - |
RemoveRoleRight | Remove rights from a role definition. | DELETE /roles/<id_>/rights/<right_id> | - | - |
ResetMfaUsers | Reset multi-factor authentication for a user and send enrollment. | POST /users/reset-auth0-mfa | Environment -> Reset MFA | - |
SearchUsers | Search tenant users. | POST /users/search | Registry -> Search users Environment -> Search users | Configure -> Search users |
SearchUserGroups | Search user groups. | POST /user-groups/search | Registry -> Search groups | - |
ToggleSuperUsers | Toggle super-user status for tenant users. | PUT /users/<id_>/toggle-super-user | - | - |
ToggleUsers | Activate or deactivate tenant user accounts. | PUT /users/<id_>/toggle | Environment -> Toggle users | Configure -> Activate or deactivate users |
UpdateContentUserSetting | PUT /content-user-setting/<id> | - | - | |
UpdateUsers | Update tenant user accounts. | PUT /users/<id_> | Environment -> Update users | Configure -> Update user accounts |
UpdateUserGroups | Update user groups for bulk role assignment and permission control. | PUT /user-groups/<id_> | - | - |
Voucher Management
Section titled “Voucher Management”20 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
CreateSyncVoucherEvents | Receive and process voucher completion events from an ERP system. | POST /events/sync-voucher-complete | - | - |
CreateVouchers | Create a voucher. | POST /vouchers | Accounting -> Create voucher | - |
ExportExternalVouchers | Mark vouchers as exported to external systems. | PUT /vouchers/<id_>/external/export | - | - |
ExportVouchers | Mark vouchers as exported. | PUT /vouchers/<id_>/export | - | - |
ExternalBookkeepVouchers | Mark vouchers as bookept in an external system. | PUT /vouchers/<id_>/external/bookkeep | - | - |
ExternalFailVouchers | Mark vouchers as failed in external systems. | PUT /vouchers/<id_>/external/fail | - | - |
ReadVoucher | View vouchers and their summaries. | GET /vouchers/<id_>GET /vouchers/summary/<relation>/<topic>/<id_> | Accounting -> View vouchers | - |
ReadVouchers | List vouchers. | GET /vouchers | - | - |
ReadVouchersExternalExportPayments | GET /vouchers/external/export/payments | - | - | |
ReadVouchersExternalExportVouchers | GET /vouchers/external/export/vouchers | - | - | |
ReadVoucherPosting | Retrieve a voucher posting. | GET /voucher-postings/<id_> | - | - |
ReadVoucherPostings | List voucher postings. | GET /voucher-postings | - | - |
ReadVoucherSettingsLockedPeriod | View voucher locked period settings. | GET /vouchers/settings/locked-period | Accounting -> View locked periods | - |
RetryVoucherPostingCreate | Retry voucher requests. | POST /voucher-request/<id_>/retry | - | - |
ReverseVouchers | Reverse vouchers. | PUT /vouchers/<id_>/reverse | Accounting -> Reverse vouchers | - |
SearchVouchers | Search vouchers. | POST /vouchers/search | Accounting -> Search vouchers Registry -> View invoices | - |
SearchVoucherPostings | Search individual posting rows on vouchers. | POST /voucher-postings/search | Accounting -> View postings | - |
SupportResendVoucher | Resend vouchers externally and send individual historic vouchers via webhook. | POST /vouchers/<id_>/webhook-exportPUT /vouchers/<id_>/external/resend | - | - |
SupportUpdateVoucherStatus | Update the external status of a voucher. | PUT /vouchers/<id_>/external/status | - | - |
UpdateVoucherSettingsLockedPeriod | PUT /vouchers/settings/locked-period | Accounting -> Update voucher settings | - |
Strawbay
Section titled “Strawbay”3 rights.
| Right | Description | API endpoints | Operations Portal | Client UI |
|---|---|---|---|---|
StrawbayOnboarding | Manage the Strawbay ERP integration onboarding flow, including starting, cancelling, and completing the connection. | GET /strawbayGET /strawbay/onboardingPOST /strawbay/onboarding/completePOST /strawbay/onboarding/errorPOST /strawbay/onboarding/startPUT /strawbay/connection/linking-retryPUT /strawbay/onboarding/cancel | - | - |
StrawbayConnection | GET /strawbayGET /strawbay/connectionPUT /strawbay/connection/linking-retryPUT /strawbay/connection/stop | - | - | |
StrawbayFlow | GET /strawbay/flow | - | - |