Services

Tenant-level billable services catalog management. Provides CRUD operations with filtering by category, client type, archived status, and search terms. Includes library access for creating services from templates, AI-powered service generation from service names (generates description and pricing), pricing factor generation for existing services, and creating services from library templates with optional property overrides.

OpenAPI Spec

Guides Operations Schemas

GET List BillableServices
Lists all BillableServices for the given tenant. Requires: ViewAll on BillableServices.
/tenants/{tenant}/services
POST Create BillableService
Creates a new BillableService for the specified tenant. Requires: Create on BillableServices.
/tenants/{tenant}/services
GET Get BillableService
Gets a BillableService for the specified tenant. Requires: ViewAll on BillableServices.
/tenants/{tenant}/services/{code}
PUT Update BillableService
Updates a BillableService for the specified tenant. Requires: Update on BillableServices.
/tenants/{tenant}/services/{code}
DELETE Delete BillableService
Deletes a BillableService for the specified tenant. Requires: Delete on BillableServices.
/tenants/{tenant}/services/{code}
GET List Library BillableServices
List all BillableServices available in the library as templates. Use optional 'search' query parameter to filter by Code, Name, or Description. Requi...
/tenants/{tenant}/services/library
GET Get Library BillableService
Get details of a specific BillableService template from the library Requires: ViewAll on BillableServices.
/tenants/{tenant}/services/library/{code}
PUT Revert BillableService to Library
Reverts the BillableService to the current library template version, overwriting any local edits. The BillableService's code is preserved so it remain...
/tenants/{tenant}/services/{code}/library-version
POST Import Services from Library
Creates one or more BillableServices for the tenant based on library templates. Requires: Create on BillableServices.
/tenants/{tenant}/services/library/import
POST Generate Service
Generates a complete BillableService DTO with AI-generated content based on the service name Requires: Create on BillableServices.
/tenants/{tenant}/services/generate
POST Generate Pricing Factors
Generates pricing factor questions and options for an existing service using AI Requires: Update on BillableServices.
/tenants/{tenant}/services/{code}/generatefactors
GET Get Required Client Fields for Service
Returns client fields that are required by recurring tasks linked to this service. Requires: ViewAll on BillableServices.
/tenants/{tenant}/services/{code}/required-client-fields
GET Get Bill for Work Coverage
Returns whether an active recurring task for this service uses a workflow with a Bill for Work step, which is what bills a service set to bill when th...
/tenants/{tenant}/services/{code}/bill-for-work-coverage
POST Bulk Assign Service
Assigns this billable service to multiple clients at once. Optionally creates onboarding tasks for each new assignment. Requires: Create on ClientBil...
/tenants/{tenant}/services/{code}/clients/bulk-assign
PATCH Bulk Update Client Services
Updates fields across multiple client service assignments belonging to this service. Assignments belonging to a different service are ignored. Only pr...
/tenants/{tenant}/services/{code}/clients/bulk-update
POST Bulk Remove Client Services
Removes multiple client service assignments belonging to this service. Assignments belonging to a different service are ignored. Fails if any have bil...
/tenants/{tenant}/services/{code}/clients/bulk-remove