Scenarios

What-if copies of a deal's sections, services, items, and bookings, applied back to the deal by overwrite (replace everything) or sync (diff and merge). All scenario endpoints require the Scenario Builder feature on the organization's plan.

Attributes

budget_total number
Response Nullable

Total budget amount across all services (budget currency).

budget_total_default number
Response Nullable

Total budget amount across all services (organization default currency).

budget_total_normalized number
Response Nullable

Total budget amount across all services (normalized currency).

budget_used number
Response Nullable

Amount of budget consumed so far (budget currency).

budget_used_default number
Response Nullable

Amount of budget consumed so far (organization default currency).

budget_used_normalized number
Response Nullable

Amount of budget consumed so far (normalized currency).

copy_services boolean
Request

Whether the new scenario starts with a copy of the deal's sections and services.

cost number
Response Parameter `sort` Nullable

Total costs including labor and expenses (budget currency).

cost_default number
Response Nullable

Total costs including labor and expenses (organization default currency).

cost_normalized number
Response Nullable

Total costs including labor and expenses (normalized currency).

created_at string
Response Parameter `sort`

When the scenario was created.

creator person
Response Parameter `sort`

The person who created this scenario.

currency string
Response Nullable

Scenario currency code (budget currency).

currency_default string
Response

Organization default currency code.

currency_normalized string
Response Nullable

Normalized currency code.

deal deal
Response

The deal or budget this scenario belongs to.

deal_id integer
Request Parameter `filter`

ID of the deal or budget this scenario belongs to. Set on create and cannot be changed.

deleted_at string
Response Nullable

Soft-deletion timestamp.

end_date string
Response Request Parameter `sort` Nullable

End date of the scenario.

id integer
Parameter `filter`

The unique identifier of this scenario.

last_applied_at string
Response Parameter `sort` Nullable

When the scenario was last applied to its deal.

metadata object
Response Nullable

Preview of what applying the scenario to its deal would change.

Show child attributes
name string
Response Request Parameter `sort`

Descriptive name for the scenario.

organization organization
Response

The organization this scenario belongs to.

profit number
Response Nullable

Revenue minus costs (budget currency).

profit_default number
Response Nullable

Revenue minus costs (organization default currency).

profit_margin string
Response Parameter `sort` Nullable

Profit as a percentage of revenue.

profit_normalized number
Response Nullable

Revenue minus costs (normalized currency).

project_id integer
Parameter `filter`

ID of the project linked to the scenario's deal.

revenue number
Response Parameter `sort` Nullable

Total revenue from services (budget currency).

revenue_default number
Response Nullable

Total revenue from services (organization default currency).

revenue_normalized number
Response Nullable

Total revenue from services (normalized currency).

start_date string
Response Request Parameter `sort` Nullable

Start date of the scenario.

Examples

Loading example