# Enso Docs ## Docs - [API Keys](https://docs.getenso.ai/api-reference/api-keys.md): To access the Enso API, you must first generate an API Token from the Enso dashboard. This token will allow you to authenticate your requests securely. - [Delete app](https://docs.getenso.ai/api-reference/endpoint/delete-apps-id.md): Remove an app integration. - [API to delete an attribute](https://docs.getenso.ai/api-reference/endpoint/delete-attributes-id.md): API to delete an attribute - [Delete billing plan](https://docs.getenso.ai/api-reference/endpoint/delete-billing-plans-id.md): Delete a billing plan (only if not attached to any contract). - [API to delete a billing plan item](https://docs.getenso.ai/api-reference/endpoint/delete-billing-plans-planid-items-id.md): API to delete a billing plan item - [Delete SKU group](https://docs.getenso.ai/api-reference/endpoint/delete-catalog-groups-id.md): Remove a SKU group (requires no associated SKUs). - [Delete SKU](https://docs.getenso.ai/api-reference/endpoint/delete-catalog-skus-skuid.md): Delete a catalog SKU. - [Delete contractPlanId](https://docs.getenso.ai/api-reference/endpoint/delete-contracts-contractid-plans-contractplanid.md): Delete plans - [Delete contractPlanItemMilestoneId](https://docs.getenso.ai/api-reference/endpoint/delete-contracts-contractid-plans-contractplanid-milestones-contractplanitemmilestoneid.md): Delete milestones - [Remove contract tax](https://docs.getenso.ai/api-reference/endpoint/delete-contracts-contractid-taxes-contracttaxid.md): Detach a tax from a contract. - [API to delete a customer](https://docs.getenso.ai/api-reference/endpoint/delete-customers-customerid.md): API to delete a customer - [Delete email template](https://docs.getenso.ai/api-reference/endpoint/delete-email-templates-name.md): Remove an email template by name. - [API to delete an entity](https://docs.getenso.ai/api-reference/endpoint/delete-entities-id.md): API to delete an entity - [Delete entity tax](https://docs.getenso.ai/api-reference/endpoint/delete-entities-id-taxes-taxid.md): Remove a tax registration from an entity. - [Delete events](https://docs.getenso.ai/api-reference/endpoint/delete-events.md): Delete events - [Delete event config](https://docs.getenso.ai/api-reference/endpoint/delete-events-config-id.md): Remove an event configuration. - [Delete filter](https://docs.getenso.ai/api-reference/endpoint/delete-filters-id.md): Remove a saved filter. - [Delete FX rate](https://docs.getenso.ai/api-reference/endpoint/delete-fx-rates-id.md): Remove an exchange rate record. - [Delete payment file](https://docs.getenso.ai/api-reference/endpoint/delete-invoices-id-payments-paymentid-files-fileid.md): Remove a file attachment from a payment record. - [Delete invoice file](https://docs.getenso.ai/api-reference/endpoint/delete-invoices-invoiceid-files-fileid.md): Remove an uploaded file attachment from an invoice. - [Delete invoice template](https://docs.getenso.ai/api-reference/endpoint/delete-invoices-templates-id.md): Remove an invoice template. - [API to delete job](https://docs.getenso.ai/api-reference/endpoint/delete-jobs-jobid.md): API to delete job - [API to delete a specific file attached to a job](https://docs.getenso.ai/api-reference/endpoint/delete-jobs-jobid-files-fileid.md): API to delete a specific file attached to a job - [Delete meter](https://docs.getenso.ai/api-reference/endpoint/delete-meters-id.md): Delete a usage meter. - [API to delete an organisation attribute](https://docs.getenso.ai/api-reference/endpoint/delete-organisation-attributes-id.md): API to delete an organisation attribute - [Delete payment source](https://docs.getenso.ai/api-reference/endpoint/delete-payment-sources-id.md): Remove a payment source. - [Delete schedule](https://docs.getenso.ai/api-reference/endpoint/delete-schedules-id.md): Remove a schedule. - [Delete setting](https://docs.getenso.ai/api-reference/endpoint/delete-settings-id.md): Remove an organisation configuration setting. - [Delete usage by id](https://docs.getenso.ai/api-reference/endpoint/delete-usage-id.md): Delete usage - [Delete workflow](https://docs.getenso.ai/api-reference/endpoint/delete-workflows-id.md): Remove a workflow. - [Get apps](https://docs.getenso.ai/api-reference/endpoint/get-apps.md): Get apps - [Get credentials](https://docs.getenso.ai/api-reference/endpoint/get-apps-credentials.md): Get all apps, optionally including credentials for a specific tenant - [Get credentials](https://docs.getenso.ai/api-reference/endpoint/get-apps-id-credentials.md): Get credentials - [Get attributes](https://docs.getenso.ai/api-reference/endpoint/get-attributes.md): Get attributes - [Get callback](https://docs.getenso.ai/api-reference/endpoint/get-auth-callback.md): Get callback - [Get type](https://docs.getenso.ai/api-reference/endpoint/get-auth-callback-type.md): Get callback - [Get plan item config schema](https://docs.getenso.ai/api-reference/endpoint/get-billing-items-config.md): Returns the JSON schema for plan item configuration objects per plan type. - [List plan types](https://docs.getenso.ai/api-reference/endpoint/get-billing-plan-types.md): Returns available pricing plan types: one_time_fee, recurring_fixed_fee, license_fee, usage_fee. - [List billing plans](https://docs.getenso.ai/api-reference/endpoint/get-billing-plans.md): Returns all billing plan templates. - [List plan items](https://docs.getenso.ai/api-reference/endpoint/get-billing-plans-planid-items.md): Returns all line items in a billing plan. - [API to get skus](https://docs.getenso.ai/api-reference/endpoint/get-catalog-skus.md): API to get skus - [API to get a sku by id](https://docs.getenso.ai/api-reference/endpoint/get-catalog-skus-skuid.md): API to get a sku by id - [Get chatbot capabilities](https://docs.getenso.ai/api-reference/endpoint/get-chatbot-capabilities.md): Returns the list of actions and data sources the Enso AI chatbot can operate on. - [Get collections](https://docs.getenso.ai/api-reference/endpoint/get-collections.md): Get collections - [Get contracts](https://docs.getenso.ai/api-reference/endpoint/get-contracts.md): Get contracts - [List contract plans](https://docs.getenso.ai/api-reference/endpoint/get-contracts-contractid-plans.md): Returns all billing plans attached to a contract. - [Get id](https://docs.getenso.ai/api-reference/endpoint/get-contracts-id.md): Get contracts - [API to get all currencies](https://docs.getenso.ai/api-reference/endpoint/get-currencies.md): API to get all currencies - [Get customers](https://docs.getenso.ai/api-reference/endpoint/get-customers.md): Get customers - [List email templates](https://docs.getenso.ai/api-reference/endpoint/get-email-templates.md): Returns custom email templates for the organisation. - [List entities](https://docs.getenso.ai/api-reference/endpoint/get-entities.md): Returns all entities for the organisation. - [API to get entities by type](https://docs.getenso.ai/api-reference/endpoint/get-entities-all.md): Get entities filtered by type, with optional keyword search on legal name or alias. - [List entity addresses](https://docs.getenso.ai/api-reference/endpoint/get-entities-id-addresses.md): Returns all addresses associated with an entity. - [List entity taxes](https://docs.getenso.ai/api-reference/endpoint/get-entities-id-taxes.md): Returns tax registrations on an entity. - [API to get entities by type with filters](https://docs.getenso.ai/api-reference/endpoint/get-entities-list.md): Get a paginated list of customer entities with selectable attributes, filtering, grouping, and sorting. - [Get events](https://docs.getenso.ai/api-reference/endpoint/get-events.md): Get events - [List filters](https://docs.getenso.ai/api-reference/endpoint/get-filters.md): Returns saved list filters for the organisation. - [Get fx rates](https://docs.getenso.ai/api-reference/endpoint/get-fx-rates.md): Get fx rates - [API to get all countries](https://docs.getenso.ai/api-reference/endpoint/get-geo-countries.md): API to get all countries - [API to get all states for a country](https://docs.getenso.ai/api-reference/endpoint/get-geo-countries-countryid-states.md): API to get all states for a country - [Get invoices](https://docs.getenso.ai/api-reference/endpoint/get-invoices.md): Get a list of invoices - [API to get invoice details by ID](https://docs.getenso.ai/api-reference/endpoint/get-invoices-invoiceid.md): API to get invoice details by ID - [List invoice templates](https://docs.getenso.ai/api-reference/endpoint/get-invoices-templates.md): Returns all invoice templates (HTML layouts used for PDF generation). - [Get jobs](https://docs.getenso.ai/api-reference/endpoint/get-jobs.md): Get jobs - [API to get job details](https://docs.getenso.ai/api-reference/endpoint/get-jobs-jobid.md): API to get job details - [API to get current user](https://docs.getenso.ai/api-reference/endpoint/get-me.md): API to get current user - [Get meters](https://docs.getenso.ai/api-reference/endpoint/get-meters.md): Get meters - [API to get state machines](https://docs.getenso.ai/api-reference/endpoint/get-objects-machines.md): API to get state machines - [Get objectName](https://docs.getenso.ai/api-reference/endpoint/get-objects-schema-objectname.md): Get schema - [API to get all actions for a model](https://docs.getenso.ai/api-reference/endpoint/get-objects-type-id-actions.md): API to get all actions for a model - [API to get all states for a model](https://docs.getenso.ai/api-reference/endpoint/get-objects-type-states.md): API to get all states for a model - [Get model?](https://docs.getenso.ai/api-reference/endpoint/get-organisation-attributes-model.md): Get organisation attributes - [List payment sources](https://docs.getenso.ai/api-reference/endpoint/get-payment-sources.md): Returns configured payment sources (bank accounts, payment rails) for the organisation. - [List all payments](https://docs.getenso.ai/api-reference/endpoint/get-payments.md): Returns all payment records across all invoices. - [Get my policies](https://docs.getenso.ai/api-reference/endpoint/get-policies.md): Returns the policy rules attached to the currently authenticated user. - [Get revenue](https://docs.getenso.ai/api-reference/endpoint/get-revenue.md): Get revenue - [Get revenue by invoice item](https://docs.getenso.ai/api-reference/endpoint/get-revenue-invoiceitemid.md): Returns revenue recognition records for a specific invoice line item. - [List roles](https://docs.getenso.ai/api-reference/endpoint/get-roles.md): Returns available user roles for the organisation (SuperAdmin, Admin, System user, Support user). - [List schedules](https://docs.getenso.ai/api-reference/endpoint/get-schedules.md): Returns all billing/invoice schedules for the organisation. - [Get schedule](https://docs.getenso.ai/api-reference/endpoint/get-schedules-id.md): Returns a single schedule by ID. - [Get settings](https://docs.getenso.ai/api-reference/endpoint/get-settings.md): Get settings - [Get setting schema](https://docs.getenso.ai/api-reference/endpoint/get-settings-schema-key.md): Returns the JSON schema for a specific setting key. - [List units](https://docs.getenso.ai/api-reference/endpoint/get-units.md): Returns all measurement units (e.g. users, GB, requests) available for SKU configuration. - [Get usage](https://docs.getenso.ai/api-reference/endpoint/get-usage.md): Get usage - [List users](https://docs.getenso.ai/api-reference/endpoint/get-users.md): Returns all users in the organisation. - [List audit versions](https://docs.getenso.ai/api-reference/endpoint/get-versions.md): Returns the version/audit history log for tracked models. - [List workflows](https://docs.getenso.ai/api-reference/endpoint/get-workflows.md): Returns all configured automation workflows. - [List workflow configs (AWS state machines)](https://docs.getenso.ai/api-reference/endpoint/get-workflows-config-all.md): Returns all available AWS Step Function state machine configurations. - [Get workflow](https://docs.getenso.ai/api-reference/endpoint/get-workflows-id.md): Returns a single workflow by ID. - [List workflow executions](https://docs.getenso.ai/api-reference/endpoint/get-workflows-id-executions.md): Returns execution history for a workflow. - [Create app](https://docs.getenso.ai/api-reference/endpoint/post-apps.md): Register a new third-party application integration definition. - [Connect app (get OAuth URL)](https://docs.getenso.ai/api-reference/endpoint/post-apps-id-connect.md): Initiate an OAuth flow for the given app. Returns an authorization URL. - [Create app credential](https://docs.getenso.ai/api-reference/endpoint/post-apps-id-credentials.md): Store credentials for an app integration. - [Create attributes](https://docs.getenso.ai/api-reference/endpoint/post-attributes.md): Create attributes - [Login with email/password](https://docs.getenso.ai/api-reference/endpoint/post-auth-login.md): Authenticate a regular user with email and password. Returns access and refresh tokens. - [Refresh an existing JWT access token before it expires](https://docs.getenso.ai/api-reference/endpoint/post-auth-refresh.md): Refresh an existing JWT access token before it expires. - [Exchange client credentials for a JWT access token. This is the entry-point for](https://docs.getenso.ai/api-reference/endpoint/post-auth-system-login.md): Exchange client credentials for a JWT access token. This is the entry-point for SystemUser API integrations. - [Create billing plan](https://docs.getenso.ai/api-reference/endpoint/post-billing-plans.md): Create a named billing plan template. - [API to create a billing plan item](https://docs.getenso.ai/api-reference/endpoint/post-billing-plans-planid-items.md): API to create a billing plan item - [Create SKU group](https://docs.getenso.ai/api-reference/endpoint/post-catalog-groups.md): Create a new product/service group to organise SKUs under. - [API to create a sku](https://docs.getenso.ai/api-reference/endpoint/post-catalog-skus.md): API to create a sku - [API to chat with the AI assistant](https://docs.getenso.ai/api-reference/endpoint/post-chatbot-chat.md): API to chat with the AI assistant - [Add plan to contract](https://docs.getenso.ai/api-reference/endpoint/post-contracts-contractid-plans.md): Attach a new (or existing) billing plan to a contract. - [Create milestones](https://docs.getenso.ai/api-reference/endpoint/post-contracts-contractid-plans-contractplanid-milestones.md): Create milestones - [Add taxes to contract](https://docs.getenso.ai/api-reference/endpoint/post-contracts-contractid-taxes.md): Attach tax registrations to a contract. Body: `{ taxes: ["tax_id", ...] }` - [Create customers](https://docs.getenso.ai/api-reference/endpoint/post-customers.md): Create a new customer - [API to create an entity](https://docs.getenso.ai/api-reference/endpoint/post-customers-customerid-entities.md): API to create an entity - [Create email template](https://docs.getenso.ai/api-reference/endpoint/post-email-templates.md): Upload a new HTML email template. - [Send a test email to verify SMTP settings](https://docs.getenso.ai/api-reference/endpoint/post-email-test.md): Send a test email to verify SMTP settings - [Create entities](https://docs.getenso.ai/api-reference/endpoint/post-entities.md): Create entities - [Create entity taxes](https://docs.getenso.ai/api-reference/endpoint/post-entities-id-taxes.md): Attach one or more tax registrations to an entity. - [Create events](https://docs.getenso.ai/api-reference/endpoint/post-events.md): API to create an event - [Create batch](https://docs.getenso.ai/api-reference/endpoint/post-events-batch.md): API to create events in batch - [Create event config](https://docs.getenso.ai/api-reference/endpoint/post-events-config.md): Define event configuration for a new event type. - [Create remove duplicates](https://docs.getenso.ai/api-reference/endpoint/post-events-remove-duplicates.md): Create remove duplicates - [Create filter](https://docs.getenso.ai/api-reference/endpoint/post-filters.md): Save a named filter for a list view. - [Create fx rates](https://docs.getenso.ai/api-reference/endpoint/post-fx-rates.md): Create fx rates - [Create invoices](https://docs.getenso.ai/api-reference/endpoint/post-invoices.md): Create a new invoice - [API to create a batch of invoices](https://docs.getenso.ai/api-reference/endpoint/post-invoices-batch.md): Create multiple invoices in batch - [API to create invoice item](https://docs.getenso.ai/api-reference/endpoint/post-invoices-invoiceid-items.md): API to create invoice item - [API to update invoice status and dates](https://docs.getenso.ai/api-reference/endpoint/post-invoices-invoiceid-pdf.md): API to update invoice status and dates - [Sync invoice revenue](https://docs.getenso.ai/api-reference/endpoint/post-invoices-invoiceid-revenue-sync.md): Recalculate and sync revenue recognition entries for an invoice. - [API to sync an invoice with usage data](https://docs.getenso.ai/api-reference/endpoint/post-invoices-invoiceid-sync.md): API to sync an invoice with usage data - [Create invoice template](https://docs.getenso.ai/api-reference/endpoint/post-invoices-templates.md): Upload an invoice HTML template with optional logo file. - [API to parse contract details for an existing job](https://docs.getenso.ai/api-reference/endpoint/post-jobs-jobid-parse-contract-details.md): API to parse contract details for an existing job - [API to retry job](https://docs.getenso.ai/api-reference/endpoint/post-jobs-jobid-retry.md): API to retry job - [Create meters](https://docs.getenso.ai/api-reference/endpoint/post-meters.md): Create meters - [API to create usage by meter](https://docs.getenso.ai/api-reference/endpoint/post-meters-id-usage.md): API to create usage by meter - [API to sync usage for all meters in the current organisation](https://docs.getenso.ai/api-reference/endpoint/post-meters-sync-all.md): API to sync usage for all meters in the current organisation - [API to create a state machine](https://docs.getenso.ai/api-reference/endpoint/post-objects-machines.md): API to create a state machine - [Create query](https://docs.getenso.ai/api-reference/endpoint/post-objects-query.md): Create query - [API to get all available actions for multiple model instances](https://docs.getenso.ai/api-reference/endpoint/post-objects-type-actions-bulk.md): API to get all available actions for multiple model instances - [API to undo the last transition on a model](https://docs.getenso.ai/api-reference/endpoint/post-objects-type-id-transition-undo.md): API to undo the last transition on a model - [API to enqueue a bulk transition job on multiple model instances](https://docs.getenso.ai/api-reference/endpoint/post-objects-type-transition-bulk.md): API to enqueue a bulk transition job on multiple model instances - [Create organisation attributes](https://docs.getenso.ai/api-reference/endpoint/post-organisation-attributes.md): Create organisation attributes - [Create payment source](https://docs.getenso.ai/api-reference/endpoint/post-payment-sources.md): Add a new payment source (e.g. bank account details). - [Create revenue](https://docs.getenso.ai/api-reference/endpoint/post-revenue.md): Create revenue - [Create schedule](https://docs.getenso.ai/api-reference/endpoint/post-schedules.md): Create a new billing schedule (e.g. monthly auto-invoicing for a contract plan). - [Create setting](https://docs.getenso.ai/api-reference/endpoint/post-settings.md): Create a new organisation-level configuration setting. - [Create usage](https://docs.getenso.ai/api-reference/endpoint/post-usage.md): Create usage - [Create user](https://docs.getenso.ai/api-reference/endpoint/post-users.md): Create a new human user with an email, name, and assigned role. - [Create system user](https://docs.getenso.ai/api-reference/endpoint/post-users-system.md): Generates a new system-user credential pair (clientKey + clientSecret). Use the returned credentials with POST /auth/system-login to obtain a bearer token for API integrations. - [Create workflow](https://docs.getenso.ai/api-reference/endpoint/post-workflows.md): Create a new automation workflow (e.g. invoice-sent trigger, Slack notifications). - [Retry workflow execution](https://docs.getenso.ai/api-reference/endpoint/post-workflows-executions-id.md): Re-trigger a failed workflow execution. - [Update credentialId](https://docs.getenso.ai/api-reference/endpoint/put-apps-id-credentials-credentialid.md): Update credentials - [API to update an attribute](https://docs.getenso.ai/api-reference/endpoint/put-attributes-id.md): API to update an attribute - [Update billing plan](https://docs.getenso.ai/api-reference/endpoint/put-billing-plans-id.md): Update a billing plan name or description. - [Update SKU group](https://docs.getenso.ai/api-reference/endpoint/put-catalog-groups-id.md): Update a SKU group name or description. - [API to update a sku](https://docs.getenso.ai/api-reference/endpoint/put-catalog-skus-skuid.md): API to update a sku - [Update contract plan](https://docs.getenso.ai/api-reference/endpoint/put-contracts-contractid-plans-contractplanid.md): Update dates, plan items, or renewal terms on a contract plan. - [Change contract plan](https://docs.getenso.ai/api-reference/endpoint/put-contracts-contractid-plans-contractplanid-change.md): Switch a contract to a new plan effective from a given date (mid-term plan change). Requires `startDate` and `endDate`. - [Update contract tax](https://docs.getenso.ai/api-reference/endpoint/put-contracts-contractid-taxes-contracttaxid.md): Update a tax line on a contract. - [Update contract](https://docs.getenso.ai/api-reference/endpoint/put-contracts-id.md): Update an existing contract's metadata, dates, or attached document. - [Update customer](https://docs.getenso.ai/api-reference/endpoint/put-customers-customerid.md): Update a customer's name or associated entity details. - [Update entity](https://docs.getenso.ai/api-reference/endpoint/put-entities-id.md): Update an entity's legal name, email, or custom attributes. - [Update entity address](https://docs.getenso.ai/api-reference/endpoint/put-entities-id-addresses-addressid.md): Update a specific address on an entity. - [Update entity tax](https://docs.getenso.ai/api-reference/endpoint/put-entities-id-taxes-taxid.md): Update a specific tax registration. - [Update event config](https://docs.getenso.ai/api-reference/endpoint/put-events-config-id.md): Update an event configuration. - [API to update an FX rate](https://docs.getenso.ai/api-reference/endpoint/put-fx-rates-id.md): API to update an FX rate - [Update invoice](https://docs.getenso.ai/api-reference/endpoint/put-invoices-invoiceid.md): Update an invoice's dates, notes, or status. Only draft invoices can have items modified. - [API to update invoice item](https://docs.getenso.ai/api-reference/endpoint/put-invoices-invoiceid-items-itemid.md): API to update invoice item - [Update invoice template](https://docs.getenso.ai/api-reference/endpoint/put-invoices-templates-id.md): Replace an invoice template's HTML or logo. - [Update meter](https://docs.getenso.ai/api-reference/endpoint/put-meters-id.md): Update a usage meter's name, aggregation, or filter config. - [API to update an organisation attribute](https://docs.getenso.ai/api-reference/endpoint/put-organisation-attributes-id.md): API to update an organisation attribute - [Update payment source](https://docs.getenso.ai/api-reference/endpoint/put-payment-sources-id.md): Update payment source details. - [Update schedule](https://docs.getenso.ai/api-reference/endpoint/put-schedules-id.md): Update a schedule's cron expression or active flag. - [Update id](https://docs.getenso.ai/api-reference/endpoint/put-settings-id.md): Update settings - [Update usage by id](https://docs.getenso.ai/api-reference/endpoint/put-usage-id.md): Update usage - [Update user](https://docs.getenso.ai/api-reference/endpoint/put-users-id.md): Update an existing user's name, email, or role. - [Update workflow](https://docs.getenso.ai/api-reference/endpoint/put-workflows-id.md): Update a workflow's trigger, steps, or active state. - [Getting started](https://docs.getenso.ai/api-reference/introduction.md): Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain. - [System User Permissions](https://docs.getenso.ai/api-reference/system-user-permissions.md): Complete reference of what a System User (API integration role) can access in the Enso API. - [Customers](https://docs.getenso.ai/docs/core-concepts/customers.md): Understand how customers and their entities are managed in Enso. - [Invoices & Credit Notes](https://docs.getenso.ai/docs/core-concepts/invoices.md): Learn how invoices and credit notes are managed in Enso. - [Metering](https://docs.getenso.ai/docs/core-concepts/metering.md): Understand the core concepts of metering in Enso, including events, meters, usage, and their relationships. - [Plan Types](https://docs.getenso.ai/docs/core-concepts/plan-types.md): Enso supports multiple plan types to help you model your pricing and billing strategies. Understanding these plan types is essential for setting up your products and services correctly. - [Metering](https://docs.getenso.ai/docs/metering.md): How to setup metering. - [One time setup](https://docs.getenso.ai/docs/org-setup.md): One time setup - [Setup catalogue](https://docs.getenso.ai/docs/setup-catalog.md): Setup your billing catalogue - [Introduction](https://docs.getenso.ai/index.md) - [Quickstart](https://docs.getenso.ai/quickstart.md): Start using Enso for all your billing needs in few quick steps. ## OpenAPI Specs - [openapi](https://docs.getenso.ai/api-reference/openapi.json) ## Optional - [Website](https://getenso.ai)