Scenario Services

Line items of a scenario, mirroring the deal's services and carrying their pricing, budgets, and financial totals. All scenario endpoints require the Scenario Builder feature on the organization's plan.

Attributes

billable boolean
Response

Whether this service is billable to the client.

billing_type_id integer
Response Request Enum

How this service is billed: fixed price, actuals, percentage, or non-billable.

Enum Values (4 values)

  • 1
    Fixed
  • 2
    Actuals
  • 3
    None
  • 4
    Percentage
budget_cap_enabled boolean
Response Request

Whether a hard budget cap prevents tracking beyond the budget total.

budget_total number
Response Nullable

Total budget for this service.

budget_total_default number
Response Nullable

Total budget for this service in the organization's default currency.

budget_total_normalized number
Response Nullable

Total budget for this service in the organization's normalized currency.

budget_used number
Response Nullable

Budget consumed so far.

budget_used_default number
Response Nullable

Budget consumed so far in the organization's default currency.

budget_used_normalized number
Response Nullable

Budget consumed so far in the organization's normalized currency.

cost number
Response Nullable

Total cost including labor and expenses.

cost_default number
Response Nullable

Total cost including labor and expenses in the organization's default currency.

cost_normalized number
Response Nullable

Total cost including labor and expenses in the organization's normalized currency.

created_at string
Response

When the service was created.

currency string
Response Nullable

Currency code for this service's financial values.

currency_default string
Response

Currency code in the organization's default currency.

currency_normalized string
Response Nullable

Currency code in the organization's normalized currency.

deal deal
Response

The deal or budget this service is part of.

description string
Response Request Nullable

Longer description of the service.

discount string
Response Request Nullable

Discount percentage subtracted from the service price.

discount_amount number
Response Request Nullable

Total discount in monetary terms.

discount_amount_default number
Response Nullable

Total discount in monetary terms in the organization's default currency.

discount_amount_normalized number
Response Nullable

Total discount in monetary terms in the organization's normalized currency.

discount_type string
Response Enum

Which discount is in effect: percentage or fixed amount.

Enum Values (2 values)

  • percentage
    Percentage
  • amount
    Amount
editor_config object
Response Nullable

Rich text editor configuration.

id integer
Parameter `filter`

Unique identifier of the service.

initial_service_id integer
Response

ID of the original service across copies and applies; the service's own ID when it is the original.

markup string
Response Request Nullable

Markup percentage added to the service price.

markup_amount number
Response Nullable

Total markup in monetary terms.

markup_amount_default number
Response Nullable

Total markup in monetary terms in the organization's default currency.

markup_amount_normalized number
Response Nullable

Total markup in monetary terms in the organization's normalized currency.

name string
Response Request Parameter `sort`

Name of the service.

organization organization
Response

The organization this service belongs to.

origin_service_id integer
Response Nullable

ID of the deal service this scenario service was copied from, or null if it was added in the scenario.

position integer
Response Request Nullable

Sort order within the scenario's service list.

price number
Response Request Nullable

Unit price for this service.

price_default number
Response Nullable

Unit price for this service in the organization's default currency.

price_normalized number
Response Nullable

Unit price for this service in the organization's normalized currency.

profit number
Response Nullable

Service profit: revenue minus costs.

profit_default number
Response Nullable

Service profit in the organization's default currency.

profit_margin ["string", "number"]
Response

Profit as a percentage of revenue.

profit_normalized number
Response Nullable

Service profit in the organization's normalized currency.

quantity string
Response Request

Number of units (hours, days, or pieces) for this service.

revenue number
Response Nullable

Total revenue from this service.

revenue_default number
Response Nullable

Total revenue from this service in the organization's default currency.

revenue_normalized number
Response Nullable

Total revenue from this service in the organization's normalized currency.

scenario scenario
Response

The scenario this service belongs to.

scenario_bookings array of scenario booking
Response

Bookings scheduled for this service's items.

scenario_id integer
Request Parameter `filter`

ID of the scenario this service belongs to.

scenario_items array of scenario item
Response

The person assignments on this service.

scenario_section scenario section
Response

The section grouping this service within the scenario.

scenario_section_id integer
Request

ID of the section grouping this service within the scenario.

service_type service type
Response

The work category this service belongs to.

service_type_id integer
Request

The work category this service belongs to.

unit integer
Parameter `filter` Enum

The tracking unit (hours, days, or pieces) for this service.

Enum Values (3 values)

  • 1
    Hour
  • 2
    Piece
  • 3
    Day
unit_id integer
Response Request Nullable Enum

Tracking unit: hours, days, or pieces.

Enum Values (3 values)

  • 1
    Hour
  • 2
    Piece
  • 3
    Day

Examples

Loading example