List BillableServices

GET /tenants/{tenant}/services

Lists all BillableServices for the given tenant.

Requires: ViewAll on BillableServices.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by. Valid values depend on the resource.

Name Category AccountingCode

Field to sort by. Valid values depend on the resource.

Name Category AccountingCode

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

categoryCode query string

Filter services by category code

Filter services by category code

clientType query string

Filter services by client type they are applicable to

Filter services by client type they are applicable to

isArchived query boolean

Filter by archived status (true = archived only, false = active only)

Filter by archived status (true = archived only, false = active only)

hasStages query boolean

Filter to only services that have stages defined (true = with stages only)

Filter to only services that have stages defined (true = with stages only)

hasPricingFactors query boolean

Filter to only services that have pricing factors defined (true = with pricing factors only)

Filter to only services that have pricing factors defined (true = with pricing factors only)

showKanbanBoard query boolean

Filter to only services with kanban board enabled (true = kanban-enabled only)

Filter to only services with kanban board enabled (true = kanban-enabled only)

hasPreparerRole query boolean

Filter by whether clients on the service have a Preparer (true = with a Preparer role only)

Filter by whether clients on the service have a Preparer (true = with a Preparer role only)

hasReviewerRole query boolean

Filter by whether clients on the service have a Reviewer (true = with a Reviewer role only)

Filter by whether clients on the service have a Reviewer (true = with a Reviewer role only)

requiredProduct query string

Filter to services that require this Sodium product

Filter to services that require this Sodium product

search query string

Search across service code and name (minimum 3 characters)

Search across service code and name (minimum 3 characters)

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json