Skip to content

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 ​

MethodReturnsSurfaces
generatethe AI text-generation responseServer + Browser
getConsumptionthe AI consumption for the current cycleServer + Browser
getOverageStatusthe overage switch status and its balanceServer + Browser
setOverageSwitchthe overage status after enabling or disabling the switchServer + Browser

API documentation: AI module.

apiKeys ​

MethodReturnsSurfaces
listthe page of API keysServer + Browser
getthe requested keyServer + Browser
createthe created keyServer + Browser
rotatethe rotated keyServer + Browser
revokethe revoked keyServer + Browser
deletenothingServer + Browser

API documentation: API Keys.

appData ​

MethodReturnsSurfaces
collectiona handle exposing list, get, create and update over one application collectionServer + Browser

No API page of its own: the instances are documented under Entity Manager and in the corresponding SDK guide.

applicationDsl ​

MethodReturnsSurfaces
getthe application's DSL definitionServer + Browser
listthe available DSL definitionsServer + Browser
createDraftthe definition created as a draftServer + Browser
renamethe definition with its new nameServer + Browser
putDocumentthe definition with the stored documentServer + Browser
publishthe published definitionServer + Browser
createVersionthe new version created on top of the published oneServer + Browser
retireVersionthe definition after retiring the versionServer + Browser
getEagerDocumentthe application's complete (eager) documentServer + Browser
getChunkone chunk of the application's documentServer + Browser
followApplicationthe follow of the platform applicationServer + Browser
listFollowsthe tenant's application followsServer + Browser
acceptFollowthe follow updated to the accepted versionServer + Browser
forkFollowthe definition's independent copy in the tenantServer + Browser
assignRolethe created role assignmentServer + Browser
listRoleAssignmentsthe application's role assignmentsServer + Browser
revokeRolenothingServer + Browser
createFormInstancethe created form instanceServer + Browser
updateFormInstancethe updated form instanceServer + Browser
listViewInstancesthe page of instances for the formServer + Browser
getViewInstancethe requested instance with its view dataServer + Browser
processFormSubmitthe result of processing the form submissionServer + Browser
setRuntimeContextnothing. Sets or clears the project and environment used by runtime calls (synchronous)Server + Browser
setRuntimeSessionTokennothing. Keeps the runtime session token in memory only (synchronous)Browser
createRuntimeArtifactMountOptionsthe artifact mount options for the browser runtime adapterBrowser

API documentation: Application DSL.

assistants ​

MethodReturnsSurfaces
listthe tenant's assistantsServer + Browser
getthe assistant with its assigned skillsServer + Browser
createthe created assistantServer + Browser
updatethe updated assistantServer + Browser
deletenothingServer + Browser
getPresentationthe assistant's presentation for authenticated chatServer + Browser
listSkillsthe tenant's skillsServer + Browser
getSkillthe requested skillServer + Browser
createSkillthe created skillServer + Browser
updateSkillthe updated skillServer + Browser
deleteSkillnothingServer + Browser
listShareableCatalogSkillsthe platform-catalog skills shareable with the tenantServer + Browser
assignSkillsthe assistant with its skill allowlist replacedServer + Browser
chatthe chat response; a skill may be left pending confirmationServer + Browser
confirmPendingSkillthe response after confirming and running the pending skillServer + Browser
rejectPendingSkillthe response after rejecting the pending skillServer + Browser
interactWithChoicethe chat response after picking one of the offered choicesBrowser
getConversationthe history of an authenticated conversationServer + Browser
listConversationsthe authenticated user's own conversationsBrowser
listCapabilitiesthe assistant's available capabilities (descriptive only)Browser
setPublicWidgetthe assistant after publishing or unpublishing the widgetServer + Browser
getPublicWidgetthe status of the published public widgetServer + Browser
publicWidgetChatthe anonymous chat response through the public widgetServer + Browser
listPublicWidgetConversationsthe conversations received through the public widgetServer + Browser
getPublicWidgetConversationa public-widget conversation with its messagesServer + Browser

No API page of its own: the matching HTTP surface is documented under AI module.

authorizedClients ​

MethodReturnsSurfaces
listthe tenant's authorized clientsBrowser
createthe created authorized clientBrowser
rotatethe authorized client with its renewed secretBrowser
deletenothingBrowser
listCompaniesthe companies linked to the clientBrowser
addCompanythe created company linkBrowser
removeCompanynothingBrowser
linkActiveCompanythe active company's linkServer + Browser
unlinkActiveCompanynothingServer + Browser

No API page of its own: the authorization flow is documented under OAuth 2.0 Authorization Server.

backups ​

MethodReturnsSurfaces
listDestinationsthe known backup destinationsServer + Browser
listSnapshotsthe snapshots of one destinationServer + Browser
createSnapshotthe snapshot created nowServer + Browser
restoreSnapshotthe started restore operationServer + Browser
listRestoreOperationsthe restore-operation historyServer + Browser
migrateToProviderthe result of migrating local snapshots to the storage providerServer + Browser
getConfigthe destination's schedule and retention configServer + Browser
updateConfigthe updated backup configServer + Browser

API documentation: Database backups.

billing ​

MethodReturnsSurfaces
getSubscriptionthe tenant's subscription, or null if it has noneServer + Browser
createSubscriptionthe created subscriptionServer + Browser
cancelSubscriptionthe canceled subscriptionServer + Browser
listInvoicesthe tenant's invoicesServer + Browser
listEntitlementsthe tenant's entitlementsServer + Browser
checkEntitlementwhether the queried feature is enabledServer + Browser
createCheckouta checkout URLServer + Browser
createPortala customer-portal URLServer + Browser
getPublicPlansthe plans visible on the public landing pageServer + Browser
listPlansthe platform billing plans with their pricesServer + Browser
getPlanthe requested planServer + Browser
createPlanthe created planServer + Browser
updatePlanthe updated planServer + Browser
addPlanPricethe price added to the planServer + Browser
getByokStatusthe BYOK status without exposing secretsServer + Browser
listByokthe BYOK credential sets, without secretsServer + Browser
getByokone BYOK credential set, without secretsServer + Browser
registerByokthe registered BYOK credentialServer + Browser
updateByokthe updated BYOK credentialServer + Browser
removeByoknothingServer + Browser
activateByokthe activated BYOK credentialServer + Browser
deactivateByokthe deactivated BYOK credentialServer + Browser
getConnectStatusthe Connect account status, without secretsServer + Browser
startConnectOnboardingthe Connect status after starting onboardingServer + Browser
disconnectConnectthe Connect status after disconnectingServer + Browser
getChargeMechanismStatusthe usable charge mechanisms and which one is activeServer + Browser
setActiveChargeMechanismthe charge mechanism left activeServer + Browser
listCustomerChargesthe page of tenant-to-end-customer chargesServer + Browser
createCustomerChargethe created end-customer chargeServer + Browser
getCustomerChargethe requested end-customer chargeServer + Browser
refundCustomerChargethe refunded end-customer chargeServer + Browser
createCustomerSubscriptionthe created end-customer subscriptionServer + Browser
updateCustomerSubscriptionthe updated end-customer subscriptionServer + Browser
cancelCustomerSubscriptionthe canceled end-customer subscriptionServer + Browser
getPlatformProviderStatusthe platform billing provider connection statusServer + Browser
connectPlatformProviderthe status after connecting the platform providerServer + Browser
disconnectPlatformProviderthe status after disconnecting the platform providerServer + Browser
listPlatformChargesthe page of platform-to-tenant chargesServer + Browser
createPlatformChargethe created platform-to-tenant chargeServer + Browser
getPlatformChargethe requested platform-to-tenant chargeServer + Browser
refundPlatformChargethe refunded platform-to-tenant chargeServer + Browser
createPlatformSubscription—Server + Browser
updatePlatformSubscription—Server + Browser

API documentation: Billing and subscriptions.

catalog ​

MethodReturnsSurfaces
listSystemOptionsthe system options, which cannot be archivedServer + Browser
listCustomOptionsthe platform-scope custom optionsServer + Browser
createCustomOptionthe created custom optionServer + Browser
archiveCustomOptionthe archived custom optionServer + Browser
unarchiveCustomOptionthe unarchived custom optionServer + Browser
listCompanyCustomOptionsthe company's own custom catalog optionsServer + Browser
createCompanyCustomOptionthe created company-scope custom optionServer + Browser
archiveCompanyCustomOptionthe archived company optionServer + Browser
unarchiveCompanyCustomOptionthe unarchived company optionServer + Browser

No API page of its own: catalog options feed the plans documented under Billing and subscriptions.

clients ​

MethodReturnsSurfaces
listthe page of clientsServer + Browser
getthe requested clientServer + Browser
createthe created clientServer + Browser
updatethe updated clientServer + Browser
deletenothingServer + Browser

API documentation: Clients (commercial billing).

companies ​

MethodReturnsSurfaces
listthe page of companiesServer + Browser
getthe requested companyServer + Browser
createthe created companyServer + Browser
updatethe updated companyServer + Browser
deletenothingServer + Browser
listMembersthe users who are members of the companyServer + Browser
addMemberthe user added to the companyServer + Browser
removeMembernothingServer + Browser

API documentation: Companies.

documentTypes ​

MethodReturnsSurfaces
listthe document typesServer + Browser
getthe requested document typeServer + Browser
createthe created document typeServer + Browser
updatethe updated document typeServer + Browser
deletenothingServer + Browser
addSeriesthe series added to the typeServer + Browser
updateSeriesthe updated seriesServer + Browser
deleteSeriesnothingServer + Browser

API documentation: Document types, series and sequential numbers.

documents ​

MethodReturnsSurfaces
listProductsthe company's reusable invoice productsServer + Browser
getProductTaxOptionsthe tax rates applicable to the company's fiscal countryServer + Browser
searchProductsthe products matching the searchServer + Browser
createProductthe created productServer + Browser
updateProductthe updated productServer + Browser
quickCreateProductthe on-the-fly created productServer + Browser
updateQuickCreatedProductPricenothingServer + Browser
getSettingsthe document auto-generation settingsServer + Browser
updateSettingsthe updated auto-generation settingsServer + Browser
listAutoGenFailuresthe page of auto-generation failuresServer + Browser
listthe page of commercial documentsServer + Browser
getthe requested documentServer + Browser
createthe document created as a draftServer + Browser
updatethe updated draft documentServer + Browser
deletenothingServer + Browser
emitthe emitted document, with frozen snapshots and its allocated numberServer + Browser
convertthe document converted from proforma/quote into an invoiceServer + Browser
getVerifactuthe Verifactu record and its QR for Spanish fiscal documentsServer + Browser
exportFacturaethe generated, XSD-validated Facturae artifactServer + Browser
downloadFacturaethe Facturae XML as textServer + Browser

API documentation: Commercial documents.

entityManager ​

MethodReturnsSurfaces
createDefinitionthe entity definition created as a draftServer + Browser
listDefinitionsthe entity definitions in the actor's catalogServer + Browser
getDefinitionthe entity definition with its versionsServer + Browser
updateDefinitionthe updated definition, or its new version if it was publishedServer + Browser
publishDefinitionthe published entity definitionServer + Browser
createDefinitionVersionthe new draft version on top of the published oneServer + Browser
followEntitythe follow of the platform-published entityServer + Browser
listEntityFollowsthe tenant's entity followsServer + Browser
acceptEntityFollowthe follow updated to the accepted versionServer + Browser
forkEntityFollowthe entity's copy into the tenant catalogServer + Browser
retireEntityVersionthe retired entity versionServer + Browser
createApplicationthe application definition created as a draftServer + Browser
listApplicationsthe application definitions in the actor's catalogServer + Browser
getApplicationthe application definition with its versionsServer + Browser
updateApplicationthe updated application, or its new version if it was publishedServer + Browser
publishApplicationthe published applicationServer + Browser
createApplicationVersionthe application's new draft versionServer + Browser
retireApplicationVersionthe retired application versionServer + Browser
followApplicationthe follow of the platform applicationServer + Browser
listApplicationFollowsthe tenant's application followsServer + Browser
acceptApplicationFollowthe follow updated to the accepted versionServer + Browser
createInstancethe created instanceServer + Browser
listInstancesthe page of instancesServer + Browser
getInstancethe requested instanceServer + Browser
updateInstancethe updated instanceServer + Browser
deleteInstancenothingServer + Browser
restoreInstancethe restored instanceServer + Browser
associateRelationthe created relation linkServer + Browser
disassociateRelationnothingServer + Browser
listGrantsthe granted panel permissionsServer + Browser
grantthe granted permissionServer + Browser
revokenothingServer + Browser

API documentation: Entity Manager.

eventLogger ​

MethodReturnsSurfaces
createProjectIdthe analytics project with its opaque instrumentation IDServer + Browser
listProjectIdsthe authenticated company's project IDsServer + Browser
revokeProjectIdthe revoked projectServer + Browser
saveEventnothingServer + Browser
getStatsthe company's ranking of top buttons, components and pagesServer + Browser

API documentation: Event logger (UI click analytics).

feedback ​

MethodReturnsSurfaces
createthe created feedback reportServer + Browser
listthe feedback reportsServer + Browser
markAsReadthe report marked as readServer + Browser

API documentation: Feedback (beta tester widget).

invitations ​

MethodReturnsSurfaces
listthe issued invitationsServer + Browser
createthe created invitationServer + Browser
revokenothingServer + Browser
accept— (public endpoint, untyped response)Server + Browser

API documentation: Invitations.

notifications ​

MethodReturnsSurfaces
listthe page of notifications in the user's inboxServer + Browser
markReadthe notification marked as readServer + Browser
markAllReadnothingServer + Browser
sendthe acceptance acknowledgement of the sendServer + Browser
schedulethe created scheduled sendServer + Browser
listScheduledthe page of pending scheduled sendsServer + Browser
cancelScheduledthe canceled scheduled sendServer + Browser
listSendsthe page of the user's own send historyServer + Browser
listTenantNotificationsthe page of the tenant's in-app notificationsServer + Browser
registerDevicethe registered push deviceServer + Browser
listDevicesthe registered push devicesServer + Browser
unregisterDevicenothingServer + Browser
listPreferencesthe explicit notification preferencesServer + Browser
setPreferencethe saved preferenceServer + Browser
listTemplatesthe tenant's own templatesServer + Browser
listAvailableTemplatesthe templates available to compose a send (system and tenant)Server + Browser
getTemplatethe requested templateServer + Browser
createTemplatethe created templateServer + Browser
updateTemplatethe updated templateServer + Browser
deleteTemplatenothingServer + Browser
createRealtimeTicketa single-use ticket for opening the live channelServer
subscribea function to stop listening to live events (synchronous)Server + Browser
unsubscribenothing (synchronous)Server + Browser
isSubscribedwhether at least one live listener is registered (synchronous)Server + Browser
handleSessionLifecyclenothing. SDK-internal: authentication session hooks (synchronous)Browser

API documentation: Notifications.

objectStorage ​

MethodReturnsSurfaces
listthe objects and folders under a path within the spaceServer + Browser
uploadthe uploaded objectServer + Browser
downloadthe file bytesServer + Browser
downloadBlobthe file as a BlobBrowser
deletethe deletion resultServer + Browser
movethe moved or renamed objectServer + Browser
createFolderthe created folderServer + Browser
createTempLinkthe issued public temporary linkServer + Browser
revokeTempLinknothingServer + Browser
downloadPublicTempLinkthe file bytes via the public token, with no sessionServer + Browser
downloadPublicTempLinkBlobthe file as a Blob via the public token, with no sessionBrowser
listGrantsthe tenant's operate permissionsServer + Browser
grantthe granted operate permissionServer + Browser
revokenothingServer + Browser
getLimitsthe tenant's effective limitsServer + Browser

API documentation: Object storage.

ownerPlans ​

MethodReturnsSurfaces
listthe owner resale plansServer + Browser
createthe created owner planServer + Browser
updatethe updated owner planServer + Browser
assignthe plan assignment to a companyServer + Browser
listAssignmentsthe plan-to-company assignmentsServer + Browser
getOwnAssignmentthe active company's assignment, or null if it has noneServer + Browser

API documentation: Owner resale plans (Owner Plans).

providers ​

MethodReturnsSurfaces
getCatalogthe closed provider catalogServer + Browser
getFamilyone provider family's catalogServer + Browser
getTypeone provider type's catalogServer + Browser
peekResolutionthe provider resolution that would be appliedServer + Browser
listTenantthe tenant's provider instancesServer + Browser
getTenantthe tenant's provider instanceServer + Browser
createTenantthe created tenant instanceServer + Browser
updateTenantthe updated tenant instanceServer + Browser
deleteTenantnothingServer + Browser
activateTenantthe activated tenant instanceServer + Browser
deactivateTenantthe deactivated tenant instanceServer + Browser
listPlatformthe platform provider instancesBrowser
getPlatformthe platform provider instanceBrowser
createPlatformthe created platform instanceBrowser
updatePlatformthe updated platform instanceBrowser
deletePlatformnothingBrowser
markPlatformBuiltInthe instance marked as built-inBrowser
unmarkPlatformBuiltInthe instance unmarked as built-inBrowser

API documentation: Providers (closed catalogue + vault + platform + BYOK).

rag ​

MethodReturnsSurfaces
listCorpusLinksthe files linked to the assistant's corpusServer + Browser
linkCorpusFilethe file's link into the corpusServer + Browser
unlinkCorpusFilenothingServer + Browser
reindexCorpusFilethe reindexed fileServer + Browser
getConfigthe assistant's widget and citations configServer + Browser
updateConfigthe updated configServer + Browser

API documentation: Document RAG for assistants.

settings ​

MethodReturnsSurfaces
listevery system settings keyServer + Browser
getone key's valueServer + Browser
setthe save confirmation with its status codeServer + Browser
reloadthe reload confirmation with its status codeServer + Browser

API documentation: System settings.

tax ​

MethodReturnsSurfaces
listJurisdictionsthe tax jurisdictionsServer + Browser
getJurisdictionthe jurisdiction with its published ratesServer + Browser
getApplicableRatesthe rates applicable for invoicing in the jurisdictionServer + Browser
listVersionsthe jurisdiction's rate-version historyServer + Browser
listAuditsthe fiscal-catalog audit trailServer + Browser
incorporatethe jurisdiction incorporated via a providerServer + Browser
refreshthe rate version refreshed from the providerServer + Browser
publishVersionthe published rate versionServer + Browser
overrideRatethe overridden published rateServer + Browser
createAiProposalthe AI-created rate proposal, which never publishes itselfServer + Browser
buildSnapshotthe immutable tax-line snapshot for emissionServer + Browser
validateViesthe VIES VAT-ID validation resultServer + Browser
listCustomRatesthe tenant's custom rates for OTROSServer + Browser
createCustomRatethe created custom rateServer + Browser
updateCustomRatethe updated custom rateServer + Browser
deleteCustomRatenothingServer + Browser

API documentation: Fiscal catalogue / tax engine.

users ​

MethodReturnsSurfaces
listthe page of usersServer + Browser
getthe requested userServer + Browser
createthe created userServer + Browser
updatethe updated userServer + Browser
deletenothingServer + Browser

API documentation: Users.

featureFlags ​

This module only exists in the browser SDK: every row is a Browser surface.

MethodReturnsSurfaces
ensureClientthe evaluation client ID, created if it did not existBrowser
listthe feature flagsBrowser
getthe requested flagBrowser
createthe created flagBrowser
updatethe updated flagBrowser
deletenothingBrowser

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.

MethodReturnsSurfaces
listthe system notification templatesBrowser
getthe requested system templateBrowser
createthe created system templateBrowser
updatethe updated system templateBrowser
deletenothingBrowser

No API page of its own: these templates are read and managed through the Notifications routes.