API Docs / Schemas / BulkAssignServiceRequest

BulkAssignServiceRequest

Request to assign a billable service to multiple clients at once

Properties

Name Type Description
clientCodes*array of string

The client codes to assign this service to

The client codes to assign this service to

billingFrequency*enum

OneOff Annual Quarterly Monthly

OneOff Annual Quarterly Monthly

pricenumber

Optional price override. When omitted, standard pricing is used.

Optional price override. When omitted, standard pricing is used.

overridePricingboolean

Whether to use a custom price instead of standard pricing.
When true, Price must be provided.

Whether to use a custom price instead of standard pricing.
When true, Price must be provided.

startDate*string

The start date for the new assignments

The start date for the new assignments

statusenum

Active Inactive Paused Proposed

Active Inactive Paused Proposed

autoInvoiceboolean

Whether the new assignments should automatically generate invoice line items

Whether the new assignments should automatically generate invoice line items

createOnboardingTasksboolean

Whether to create onboarding tasks for the new assignments.
Set to false when migrating data from another system.

Whether to create onboarding tasks for the new assignments.
Set to false when migrating data from another system.

stageCodestring

Optional stage code to set on the new assignments

Optional stage code to set on the new assignments

managedByUserCodestring

Optional managed-by user code

Optional managed-by user code

JSON Example

{
  "clientCodes": [
    "string"
  ],
  "billingFrequency": "OneOff",
  "price": 0,
  "overridePricing": false,
  "startDate": "2024-01-01T00:00:00Z"
}

Used By Operations