Features and methods
This is the index of the platform's features. Each section covers one feature and its table lists the methods that expose it, the surface where they are available (Server, Browser or both) and a link to that module's API documentation.
Conventions: nothing means the call resolves without a body (Promise<void>); — means the SDK does not type the response (Promise<unknown>). Each method is called from the module property on the client, for example client.companies.list().
ai
| Method | Returns | Surfaces |
|---|---|---|
generate | the AI text-generation response | Server + Browser |
getConsumption | the AI consumption for the current cycle | Server + Browser |
getOverageStatus | the overage switch status and its balance | Server + Browser |
setOverageSwitch | the overage status after enabling or disabling the switch | Server + Browser |
API documentation: AI module.
apiKeys
| Method | Returns | Surfaces |
|---|---|---|
list | the page of API keys | Server + Browser |
get | the requested key | Server + Browser |
create | the created key | Server + Browser |
rotate | the rotated key | Server + Browser |
revoke | the revoked key | Server + Browser |
delete | nothing | Server + Browser |
API documentation: API Keys.
appData
| Method | Returns | Surfaces |
|---|---|---|
collection | a handle exposing list, get, create and update over one application collection | Server + Browser |
No API page of its own: the instances are documented under Entity Manager and in the corresponding SDK guide.
applicationDsl
| Method | Returns | Surfaces |
|---|---|---|
get | the application's DSL definition | Server + Browser |
list | the available DSL definitions | Server + Browser |
createDraft | the definition created as a draft | Server + Browser |
rename | the definition with its new name | Server + Browser |
putDocument | the definition with the stored document | Server + Browser |
publish | the published definition | Server + Browser |
createVersion | the new version created on top of the published one | Server + Browser |
retireVersion | the definition after retiring the version | Server + Browser |
getEagerDocument | the application's complete (eager) document | Server + Browser |
getChunk | one chunk of the application's document | Server + Browser |
followApplication | the follow of the platform application | Server + Browser |
listFollows | the tenant's application follows | Server + Browser |
acceptFollow | the follow updated to the accepted version | Server + Browser |
forkFollow | the definition's independent copy in the tenant | Server + Browser |
assignRole | the created role assignment | Server + Browser |
listRoleAssignments | the application's role assignments | Server + Browser |
revokeRole | nothing | Server + Browser |
createFormInstance | the created form instance | Server + Browser |
updateFormInstance | the updated form instance | Server + Browser |
listViewInstances | the page of instances for the form | Server + Browser |
getViewInstance | the requested instance with its view data | Server + Browser |
processFormSubmit | the result of processing the form submission | Server + Browser |
setRuntimeContext | nothing. Sets or clears the project and environment used by runtime calls (synchronous) | Server + Browser |
setRuntimeSessionToken | nothing. Keeps the runtime session token in memory only (synchronous) | Browser |
createRuntimeArtifactMountOptions | the artifact mount options for the browser runtime adapter | Browser |
API documentation: Application DSL.
assistants
| Method | Returns | Surfaces |
|---|---|---|
list | the tenant's assistants | Server + Browser |
get | the assistant with its assigned skills | Server + Browser |
create | the created assistant | Server + Browser |
update | the updated assistant | Server + Browser |
delete | nothing | Server + Browser |
getPresentation | the assistant's presentation for authenticated chat | Server + Browser |
listSkills | the tenant's skills | Server + Browser |
getSkill | the requested skill | Server + Browser |
createSkill | the created skill | Server + Browser |
updateSkill | the updated skill | Server + Browser |
deleteSkill | nothing | Server + Browser |
listShareableCatalogSkills | the platform-catalog skills shareable with the tenant | Server + Browser |
assignSkills | the assistant with its skill allowlist replaced | Server + Browser |
chat | the chat response; a skill may be left pending confirmation | Server + Browser |
confirmPendingSkill | the response after confirming and running the pending skill | Server + Browser |
rejectPendingSkill | the response after rejecting the pending skill | Server + Browser |
interactWithChoice | the chat response after picking one of the offered choices | Browser |
getConversation | the history of an authenticated conversation | Server + Browser |
listConversations | the authenticated user's own conversations | Browser |
listCapabilities | the assistant's available capabilities (descriptive only) | Browser |
setPublicWidget | the assistant after publishing or unpublishing the widget | Server + Browser |
getPublicWidget | the status of the published public widget | Server + Browser |
publicWidgetChat | the anonymous chat response through the public widget | Server + Browser |
listPublicWidgetConversations | the conversations received through the public widget | Server + Browser |
getPublicWidgetConversation | a public-widget conversation with its messages | Server + Browser |
No API page of its own: the matching HTTP surface is documented under AI module.
authorizedClients
| Method | Returns | Surfaces |
|---|---|---|
list | the tenant's authorized clients | Browser |
create | the created authorized client | Browser |
rotate | the authorized client with its renewed secret | Browser |
delete | nothing | Browser |
listCompanies | the companies linked to the client | Browser |
addCompany | the created company link | Browser |
removeCompany | nothing | Browser |
linkActiveCompany | the active company's link | Server + Browser |
unlinkActiveCompany | nothing | Server + Browser |
No API page of its own: the authorization flow is documented under OAuth 2.0 Authorization Server.
backups
| Method | Returns | Surfaces |
|---|---|---|
listDestinations | the known backup destinations | Server + Browser |
listSnapshots | the snapshots of one destination | Server + Browser |
createSnapshot | the snapshot created now | Server + Browser |
restoreSnapshot | the started restore operation | Server + Browser |
listRestoreOperations | the restore-operation history | Server + Browser |
migrateToProvider | the result of migrating local snapshots to the storage provider | Server + Browser |
getConfig | the destination's schedule and retention config | Server + Browser |
updateConfig | the updated backup config | Server + Browser |
API documentation: Database backups.
billing
| Method | Returns | Surfaces |
|---|---|---|
getSubscription | the tenant's subscription, or null if it has none | Server + Browser |
createSubscription | the created subscription | Server + Browser |
cancelSubscription | the canceled subscription | Server + Browser |
listInvoices | the tenant's invoices | Server + Browser |
listEntitlements | the tenant's entitlements | Server + Browser |
checkEntitlement | whether the queried feature is enabled | Server + Browser |
createCheckout | a checkout URL | Server + Browser |
createPortal | a customer-portal URL | Server + Browser |
getPublicPlans | the plans visible on the public landing page | Server + Browser |
listPlans | the platform billing plans with their prices | Server + Browser |
getPlan | the requested plan | Server + Browser |
createPlan | the created plan | Server + Browser |
updatePlan | the updated plan | Server + Browser |
addPlanPrice | the price added to the plan | Server + Browser |
getByokStatus | the BYOK status without exposing secrets | Server + Browser |
listByok | the BYOK credential sets, without secrets | Server + Browser |
getByok | one BYOK credential set, without secrets | Server + Browser |
registerByok | the registered BYOK credential | Server + Browser |
updateByok | the updated BYOK credential | Server + Browser |
removeByok | nothing | Server + Browser |
activateByok | the activated BYOK credential | Server + Browser |
deactivateByok | the deactivated BYOK credential | Server + Browser |
getConnectStatus | the Connect account status, without secrets | Server + Browser |
startConnectOnboarding | the Connect status after starting onboarding | Server + Browser |
disconnectConnect | the Connect status after disconnecting | Server + Browser |
getChargeMechanismStatus | the usable charge mechanisms and which one is active | Server + Browser |
setActiveChargeMechanism | the charge mechanism left active | Server + Browser |
listCustomerCharges | the page of tenant-to-end-customer charges | Server + Browser |
createCustomerCharge | the created end-customer charge | Server + Browser |
getCustomerCharge | the requested end-customer charge | Server + Browser |
refundCustomerCharge | the refunded end-customer charge | Server + Browser |
createCustomerSubscription | the created end-customer subscription | Server + Browser |
updateCustomerSubscription | the updated end-customer subscription | Server + Browser |
cancelCustomerSubscription | the canceled end-customer subscription | Server + Browser |
getPlatformProviderStatus | the platform billing provider connection status | Server + Browser |
connectPlatformProvider | the status after connecting the platform provider | Server + Browser |
disconnectPlatformProvider | the status after disconnecting the platform provider | Server + Browser |
listPlatformCharges | the page of platform-to-tenant charges | Server + Browser |
createPlatformCharge | the created platform-to-tenant charge | Server + Browser |
getPlatformCharge | the requested platform-to-tenant charge | Server + Browser |
refundPlatformCharge | the refunded platform-to-tenant charge | Server + Browser |
createPlatformSubscription | — | Server + Browser |
updatePlatformSubscription | — | Server + Browser |
API documentation: Billing and subscriptions.
catalog
| Method | Returns | Surfaces |
|---|---|---|
listSystemOptions | the system options, which cannot be archived | Server + Browser |
listCustomOptions | the platform-scope custom options | Server + Browser |
createCustomOption | the created custom option | Server + Browser |
archiveCustomOption | the archived custom option | Server + Browser |
unarchiveCustomOption | the unarchived custom option | Server + Browser |
listCompanyCustomOptions | the company's own custom catalog options | Server + Browser |
createCompanyCustomOption | the created company-scope custom option | Server + Browser |
archiveCompanyCustomOption | the archived company option | Server + Browser |
unarchiveCompanyCustomOption | the unarchived company option | Server + Browser |
No API page of its own: catalog options feed the plans documented under Billing and subscriptions.
clients
| Method | Returns | Surfaces |
|---|---|---|
list | the page of clients | Server + Browser |
get | the requested client | Server + Browser |
create | the created client | Server + Browser |
update | the updated client | Server + Browser |
delete | nothing | Server + Browser |
API documentation: Clients (commercial billing).
companies
| Method | Returns | Surfaces |
|---|---|---|
list | the page of companies | Server + Browser |
get | the requested company | Server + Browser |
create | the created company | Server + Browser |
update | the updated company | Server + Browser |
delete | nothing | Server + Browser |
listMembers | the users who are members of the company | Server + Browser |
addMember | the user added to the company | Server + Browser |
removeMember | nothing | Server + Browser |
API documentation: Companies.
documentTypes
| Method | Returns | Surfaces |
|---|---|---|
list | the document types | Server + Browser |
get | the requested document type | Server + Browser |
create | the created document type | Server + Browser |
update | the updated document type | Server + Browser |
delete | nothing | Server + Browser |
addSeries | the series added to the type | Server + Browser |
updateSeries | the updated series | Server + Browser |
deleteSeries | nothing | Server + Browser |
API documentation: Document types, series and sequential numbers.
documents
| Method | Returns | Surfaces |
|---|---|---|
listProducts | the company's reusable invoice products | Server + Browser |
getProductTaxOptions | the tax rates applicable to the company's fiscal country | Server + Browser |
searchProducts | the products matching the search | Server + Browser |
createProduct | the created product | Server + Browser |
updateProduct | the updated product | Server + Browser |
quickCreateProduct | the on-the-fly created product | Server + Browser |
updateQuickCreatedProductPrice | nothing | Server + Browser |
getSettings | the document auto-generation settings | Server + Browser |
updateSettings | the updated auto-generation settings | Server + Browser |
listAutoGenFailures | the page of auto-generation failures | Server + Browser |
list | the page of commercial documents | Server + Browser |
get | the requested document | Server + Browser |
create | the document created as a draft | Server + Browser |
update | the updated draft document | Server + Browser |
delete | nothing | Server + Browser |
emit | the emitted document, with frozen snapshots and its allocated number | Server + Browser |
convert | the document converted from proforma/quote into an invoice | Server + Browser |
getVerifactu | the Verifactu record and its QR for Spanish fiscal documents | Server + Browser |
exportFacturae | the generated, XSD-validated Facturae artifact | Server + Browser |
downloadFacturae | the Facturae XML as text | Server + Browser |
API documentation: Commercial documents.
entityManager
| Method | Returns | Surfaces |
|---|---|---|
createDefinition | the entity definition created as a draft | Server + Browser |
listDefinitions | the entity definitions in the actor's catalog | Server + Browser |
getDefinition | the entity definition with its versions | Server + Browser |
updateDefinition | the updated definition, or its new version if it was published | Server + Browser |
publishDefinition | the published entity definition | Server + Browser |
createDefinitionVersion | the new draft version on top of the published one | Server + Browser |
followEntity | the follow of the platform-published entity | Server + Browser |
listEntityFollows | the tenant's entity follows | Server + Browser |
acceptEntityFollow | the follow updated to the accepted version | Server + Browser |
forkEntityFollow | the entity's copy into the tenant catalog | Server + Browser |
retireEntityVersion | the retired entity version | Server + Browser |
createApplication | the application definition created as a draft | Server + Browser |
listApplications | the application definitions in the actor's catalog | Server + Browser |
getApplication | the application definition with its versions | Server + Browser |
updateApplication | the updated application, or its new version if it was published | Server + Browser |
publishApplication | the published application | Server + Browser |
createApplicationVersion | the application's new draft version | Server + Browser |
retireApplicationVersion | the retired application version | Server + Browser |
followApplication | the follow of the platform application | Server + Browser |
listApplicationFollows | the tenant's application follows | Server + Browser |
acceptApplicationFollow | the follow updated to the accepted version | Server + Browser |
createInstance | the created instance | Server + Browser |
listInstances | the page of instances | Server + Browser |
getInstance | the requested instance | Server + Browser |
updateInstance | the updated instance | Server + Browser |
deleteInstance | nothing | Server + Browser |
restoreInstance | the restored instance | Server + Browser |
associateRelation | the created relation link | Server + Browser |
disassociateRelation | nothing | Server + Browser |
listGrants | the granted panel permissions | Server + Browser |
grant | the granted permission | Server + Browser |
revoke | nothing | Server + Browser |
API documentation: Entity Manager.
eventLogger
| Method | Returns | Surfaces |
|---|---|---|
createProjectId | the analytics project with its opaque instrumentation ID | Server + Browser |
listProjectIds | the authenticated company's project IDs | Server + Browser |
revokeProjectId | the revoked project | Server + Browser |
saveEvent | nothing | Server + Browser |
getStats | the company's ranking of top buttons, components and pages | Server + Browser |
API documentation: Event logger (UI click analytics).
feedback
| Method | Returns | Surfaces |
|---|---|---|
create | the created feedback report | Server + Browser |
list | the feedback reports | Server + Browser |
markAsRead | the report marked as read | Server + Browser |
API documentation: Feedback (beta tester widget).
invitations
| Method | Returns | Surfaces |
|---|---|---|
list | the issued invitations | Server + Browser |
create | the created invitation | Server + Browser |
revoke | nothing | Server + Browser |
accept | — (public endpoint, untyped response) | Server + Browser |
API documentation: Invitations.
notifications
| Method | Returns | Surfaces |
|---|---|---|
list | the page of notifications in the user's inbox | Server + Browser |
markRead | the notification marked as read | Server + Browser |
markAllRead | nothing | Server + Browser |
send | the acceptance acknowledgement of the send | Server + Browser |
schedule | the created scheduled send | Server + Browser |
listScheduled | the page of pending scheduled sends | Server + Browser |
cancelScheduled | the canceled scheduled send | Server + Browser |
listSends | the page of the user's own send history | Server + Browser |
listTenantNotifications | the page of the tenant's in-app notifications | Server + Browser |
registerDevice | the registered push device | Server + Browser |
listDevices | the registered push devices | Server + Browser |
unregisterDevice | nothing | Server + Browser |
listPreferences | the explicit notification preferences | Server + Browser |
setPreference | the saved preference | Server + Browser |
listTemplates | the tenant's own templates | Server + Browser |
listAvailableTemplates | the templates available to compose a send (system and tenant) | Server + Browser |
getTemplate | the requested template | Server + Browser |
createTemplate | the created template | Server + Browser |
updateTemplate | the updated template | Server + Browser |
deleteTemplate | nothing | Server + Browser |
createRealtimeTicket | a single-use ticket for opening the live channel | Server |
subscribe | a function to stop listening to live events (synchronous) | Server + Browser |
unsubscribe | nothing (synchronous) | Server + Browser |
isSubscribed | whether at least one live listener is registered (synchronous) | Server + Browser |
handleSessionLifecycle | nothing. SDK-internal: authentication session hooks (synchronous) | Browser |
API documentation: Notifications.
objectStorage
| Method | Returns | Surfaces |
|---|---|---|
list | the objects and folders under a path within the space | Server + Browser |
upload | the uploaded object | Server + Browser |
download | the file bytes | Server + Browser |
downloadBlob | the file as a Blob | Browser |
delete | the deletion result | Server + Browser |
move | the moved or renamed object | Server + Browser |
createFolder | the created folder | Server + Browser |
createTempLink | the issued public temporary link | Server + Browser |
revokeTempLink | nothing | Server + Browser |
downloadPublicTempLink | the file bytes via the public token, with no session | Server + Browser |
downloadPublicTempLinkBlob | the file as a Blob via the public token, with no session | Browser |
listGrants | the tenant's operate permissions | Server + Browser |
grant | the granted operate permission | Server + Browser |
revoke | nothing | Server + Browser |
getLimits | the tenant's effective limits | Server + Browser |
API documentation: Object storage.
ownerPlans
| Method | Returns | Surfaces |
|---|---|---|
list | the owner resale plans | Server + Browser |
create | the created owner plan | Server + Browser |
update | the updated owner plan | Server + Browser |
assign | the plan assignment to a company | Server + Browser |
listAssignments | the plan-to-company assignments | Server + Browser |
getOwnAssignment | the active company's assignment, or null if it has none | Server + Browser |
API documentation: Owner resale plans (Owner Plans).
providers
| Method | Returns | Surfaces |
|---|---|---|
getCatalog | the closed provider catalog | Server + Browser |
getFamily | one provider family's catalog | Server + Browser |
getType | one provider type's catalog | Server + Browser |
peekResolution | the provider resolution that would be applied | Server + Browser |
listTenant | the tenant's provider instances | Server + Browser |
getTenant | the tenant's provider instance | Server + Browser |
createTenant | the created tenant instance | Server + Browser |
updateTenant | the updated tenant instance | Server + Browser |
deleteTenant | nothing | Server + Browser |
activateTenant | the activated tenant instance | Server + Browser |
deactivateTenant | the deactivated tenant instance | Server + Browser |
listPlatform | the platform provider instances | Browser |
getPlatform | the platform provider instance | Browser |
createPlatform | the created platform instance | Browser |
updatePlatform | the updated platform instance | Browser |
deletePlatform | nothing | Browser |
markPlatformBuiltIn | the instance marked as built-in | Browser |
unmarkPlatformBuiltIn | the instance unmarked as built-in | Browser |
API documentation: Providers (closed catalogue + vault + platform + BYOK).
rag
| Method | Returns | Surfaces |
|---|---|---|
listCorpusLinks | the files linked to the assistant's corpus | Server + Browser |
linkCorpusFile | the file's link into the corpus | Server + Browser |
unlinkCorpusFile | nothing | Server + Browser |
reindexCorpusFile | the reindexed file | Server + Browser |
getConfig | the assistant's widget and citations config | Server + Browser |
updateConfig | the updated config | Server + Browser |
API documentation: Document RAG for assistants.
settings
| Method | Returns | Surfaces |
|---|---|---|
list | every system settings key | Server + Browser |
get | one key's value | Server + Browser |
set | the save confirmation with its status code | Server + Browser |
reload | the reload confirmation with its status code | Server + Browser |
API documentation: System settings.
tax
| Method | Returns | Surfaces |
|---|---|---|
listJurisdictions | the tax jurisdictions | Server + Browser |
getJurisdiction | the jurisdiction with its published rates | Server + Browser |
getApplicableRates | the rates applicable for invoicing in the jurisdiction | Server + Browser |
listVersions | the jurisdiction's rate-version history | Server + Browser |
listAudits | the fiscal-catalog audit trail | Server + Browser |
incorporate | the jurisdiction incorporated via a provider | Server + Browser |
refresh | the rate version refreshed from the provider | Server + Browser |
publishVersion | the published rate version | Server + Browser |
overrideRate | the overridden published rate | Server + Browser |
createAiProposal | the AI-created rate proposal, which never publishes itself | Server + Browser |
buildSnapshot | the immutable tax-line snapshot for emission | Server + Browser |
validateVies | the VIES VAT-ID validation result | Server + Browser |
listCustomRates | the tenant's custom rates for OTROS | Server + Browser |
createCustomRate | the created custom rate | Server + Browser |
updateCustomRate | the updated custom rate | Server + Browser |
deleteCustomRate | nothing | Server + Browser |
API documentation: Fiscal catalogue / tax engine.
users
| Method | Returns | Surfaces |
|---|---|---|
list | the page of users | Server + Browser |
get | the requested user | Server + Browser |
create | the created user | Server + Browser |
update | the updated user | Server + Browser |
delete | nothing | Server + Browser |
API documentation: Users.
featureFlags
This module only exists in the browser SDK: every row is a Browser surface.
| Method | Returns | Surfaces |
|---|---|---|
ensureClient | the evaluation client ID, created if it did not exist | Browser |
list | the feature flags | Browser |
get | the requested flag | Browser |
create | the created flag | Browser |
update | the updated flag | Browser |
delete | nothing | Browser |
API documentation: Native feature flags.
systemNotificationTemplates
This module manages the system template catalogue and only exists in the browser SDK: every row is a Browser surface. Your company's own templates are a different resource and are available on the server through notifications.getTemplate, createTemplate, updateTemplate and deleteTemplate.
| Method | Returns | Surfaces |
|---|---|---|
list | the system notification templates | Browser |
get | the requested system template | Browser |
create | the created system template | Browser |
update | the updated system template | Browser |
delete | nothing | Browser |
No API page of its own: these templates are read and managed through the Notifications routes.