Services

Services are line items on a deal or budget that define the scope, pricing, and tracking for a deliverable. Each service specifies a billing type (fixed_fee, hourly, or days), a budget amount, and links time tracking to invoicing.

Services can have per-person assignments that restrict who can log time against them.

Attributes

after string
Parameter `filter`

Earliest bookable date for this service.

before string
Parameter `filter`

Latest bookable date for this service.

billable boolean
Response Parameter `filter`

Whether this service is billable to the client.

billable_time integer
Response Parameter `filter`

Billable hours tracked on the service.

billing_type integer
Parameter `filter` Enum

Billing type display name.

Enum Values (4 values)

  • 1
  • 2
  • 3
  • 4
billing_type_id integer
Response Request Enum

How this service is billed: hourly, daily, fixed price, or non-billable.

Enum Values (4 values)

  • 1
    Fixed
  • 2
    Actuals
  • 3
    None
  • 4
    Percentage
bookable_after string
Parameter `filter`

Start date from which resource bookings are allowed.

bookable_before string
Parameter `filter`

End date until which resource bookings are allowed.

bookable_date string
Parameter `filter`

Specific date for resource bookings on this service.

bookable_date_for_period string
Parameter `filter`

Filter services to those bookable on the specified date, considering the deal's bookable period.

booked_time integer
Response Parameter `filter`

Total scheduled (booked) time for this service.

booking_tracking_enabled boolean
Response Request Parameter `filter`

Whether resource bookings are enabled for this service.

budget object
Parameter `sort`

The deal budget this service is part of.

budget_cap_enabled boolean
Response Request Parameter `filter`

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

budget_date string
Parameter `filter`

The date of the budget period this service belongs to.

budgeted_time integer
Response Parameter `filter`

Budgeted hours allocated for this service.

budget_id integer
Parameter `filter`

The ID of the budget this service belongs to.

budget_remaining integer
Parameter `filter`

Budget amount remaining unused.

budgets_and_deals boolean
Parameter `filter`

List of related deals and budgets for this service.

budget_status integer
Parameter `filter` Enum

Current status of the service budget (e.g. on track, over budget).

Enum Values (2 values)

  • 1
  • 2
budget_total object
Response Parameter `filter`

Total budget for this service.

budget_total_default object
Response

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

budget_total_normalized object
Response

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

budget_used object
Response Parameter `filter`

Budget consumed so far.

budget_used_default object
Response

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

budget_used_normalized object
Response

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

company object
Parameter `sort`

The company (client) linked to the deal this service is on.

company_id integer
Parameter `filter`

The company (client) linked to the deal this service is on.

contract_id integer
Parameter `filter`

The recurring contract this service originated from.

cost object
Response Parameter `filter`

Total cost including labor and expenses.

cost_default object
Response

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

cost_normalized object
Response

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

currency object
Response

Currency code for this service's financial values.

currency_default object
Response

Currency code in the organization's default currency.

currency_normalized object
Response

Currency code in the organization's normalized currency.

custom_field_attachments array of attachment
Response

Files in file-type custom fields.

custom_field_people array of person
Response

People in person-type custom fields.

custom_fields object
Response Request Parameter `filter` Parameter `sort`

Custom field values on this service.

deal deal
Response

The deal or budget this service is part of.

deal_id integer
Request Parameter `filter`

The deal or budget this service is part of.

deal_stage_id integer
Parameter `filter`

The pipeline stage the parent deal is in.

deal_status_id integer
Parameter `filter`

The deal status of the parent deal.

deleted_at string
Response

Soft-deletion timestamp.

discount number
Response Request Parameter `filter`

Discount amount subtracted from the service price.

discount_amount object
Response Parameter `filter`

Total discount in monetary terms.

discount_amount_default object
Response

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

discount_amount_normalized object
Response

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

editor_config object
Response Request

Rich text editor configuration.

estimated_cost number
Response Request Parameter `filter`

Estimated cost based on estimated time and cost rates.

estimated_cost_default object
Response

Estimated cost based on estimated time and cost rates in the organization's default currency.

estimated_cost_normalized object
Response

Estimated cost based on estimated time and cost rates in the organization's normalized currency.

estimated_time integer
Response Request Parameter `filter`

Estimated hours for this service.

expense_amount object
Response

Total expense amount on this service.

expense_amount_default object
Response

Total expense amount on this service in the organization's default currency.

expense_amount_normalized object
Response

Total expense amount on this service in the organization's normalized currency.

expense_billable_amount object
Response

Billable portion of expenses.

expense_billable_amount_default object
Response

Billable portion of expenses in the organization's default currency.

expense_billable_amount_normalized object
Response

Billable portion of expenses in the organization's normalized currency.

expense_cost object
Parameter `filter`

Labor cost from worked time at cost rates.

expense_tracking_enabled boolean
Response Request Parameter `filter`

Whether expenses can be logged against this service.

explicit_access boolean
Parameter `filter`

When true, filters services to those the current user has been explicitly granted access to.

for_tracking boolean
Parameter `filter`

Whether this service is available for time tracking.

future_booked_time integer
Response Parameter `filter`

Future scheduled time remaining.

future_budget_used object
Response Parameter `filter`

Budget that will be consumed by future bookings.

future_budget_used_default object
Response

Budget that will be consumed by future bookings in the organization's default currency.

future_budget_used_normalized object
Response

Budget that will be consumed by future bookings in the organization's normalized currency.

future_cost object
Response

Projected cost from future scheduled bookings.

future_cost_default object
Response

Projected cost from future scheduled bookings in the organization's default currency.

future_cost_normalized object
Response

Projected cost from future scheduled bookings in the organization's normalized currency.

future_revenue object
Response

Revenue projected from future bookings.

future_revenue_default object
Response

Revenue projected from future bookings in the organization's default currency.

future_revenue_normalized object
Response

Revenue projected from future bookings in the organization's normalized currency.

id integer
Parameter `filter`

Unique identifier of the service.

initial_service_id integer
Response Parameter `filter`

ID of the first service in a rollover chain.

left_to_schedule_time integer
Parameter `filter`

Time remaining to be scheduled on this service.

limitation_type string
Response Request Parameter `filter` Enum

Budget cap enforcement type (soft warning vs hard cap).

Enum Values (4 values)

  • no_limitation
  • estimate_limitation
  • quantity_limitation
  • budget_fully_used
markup number
Response Request Parameter `filter`

Markup amount added to the service price.

markup_amount object
Response Parameter `filter`

Total markup in monetary terms.

markup_amount_default object
Response

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

markup_amount_normalized object
Response

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

name string
Response Request Parameter `filter` Parameter `sort`

Name of the service.

organization organization
Response

The organization this service belongs to.

origin_deal_id integer
Parameter `filter`

The ID of the original deal before rollover.

origin_service_id integer
Response Parameter `filter`

ID of the original service if this was duplicated or rolled over.

person person
Response

The person assigned to this service (for person-scoped services).

person_id integer
Request Parameter `filter`

The person assigned to this service (for person-scoped services).

pipeline_id integer
Parameter `filter`

The pipeline the parent deal belongs to.

position integer
Response Request

Sort order within the deal's service list.

price number
Response Request Parameter `filter`

Unit price for this service.

price_default object
Response

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

price_normalized object
Response

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

probability integer
Parameter `filter`

Win probability of the parent deal (percentage).

profit integer
Response Parameter `filter`

Service profit: revenue minus costs.

profit_default object
Response

Service profit in the organization's default currency.

profit_margin number
Response Parameter `filter`

Profit as a percentage of revenue.

profit_normalized object
Response

Service profit in the organization's normalized currency.

projected_revenue object
Response Parameter `filter`

Expected revenue including future scheduled work.

projected_revenue_default object
Response

Expected revenue including future scheduled work in the organization's default currency.

projected_revenue_normalized object
Response

Expected revenue including future scheduled work in the organization's normalized currency.

project_id integer
Parameter `filter`

The project this service is linked to.

projectless_budgets boolean
Parameter `filter`

Whether this service belongs to a budget without a linked project.

project_name object
Parameter `sort`

Name of the project this service is linked to.

project_type integer
Parameter `filter` Enum

Type of the project (billable or overhead).

Enum Values (2 values)

  • 1
  • 2
quantity number
Response Request Parameter `filter`

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

query string
Parameter `filter`

Full-text search query to filter services by name or description.

remaining_scheduled_time integer
Parameter `filter`

Time remaining to be scheduled on this service.

responsible_id integer
Parameter `filter`

The person responsible for this service.

revamped_unit integer
Parameter `filter` Enum

Whether this service uses the revamped unit system.

Enum Values (3 values)

  • 1
  • 2
  • 3
revenue object
Response Parameter `filter`

Total revenue from this service.

revenue_default object
Response

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

revenue_normalized object
Response

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

rolled_over_time integer
Response Request Parameter `filter`

Time rolled over from a previous retainer period.

sales_status_id integer
Parameter `filter` Enum

The sales status ID of the parent deal.

Enum Values (4 values)

  • 1
  • 2
  • 3
  • 4
section section
Response

The section grouping this service within the deal.

section_id integer
Request Parameter `filter`

The section grouping this service within the deal.

service_type service type
Response

The work category this service belongs to.

service_type_id integer
Request Parameter `filter`

The work category this service belongs to.

stage_status_id integer
Parameter `filter` Enum

The stage status ID of the parent deal.

Enum Values (4 values)

  • 1
  • 2
  • 3
  • 4
stage_type integer
Parameter `filter` Enum

The stage type of the parent deal.

Enum Values (2 values)

  • 1
  • 2
subsidiary_id integer
Parameter `filter`

The subsidiary associated with the parent deal.

task_id integer
Parameter `filter`

The task this service is linked to.

template boolean
Parameter `filter`

Whether this service is a template.

time_tracking_enabled boolean
Response Request Parameter `filter`

Whether team members can track time against this service.

trackable_by_person_id integer
Parameter `filter`

Whether this service is trackable by a specific person.

type integer
Parameter `filter`

JSON:API resource type identifier.

unapproved_time integer
Response Parameter `filter`

Total unapproved time entries in minutes.

unit integer
Parameter `filter` Enum

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

Enum Values (3 values)

  • 1
  • 2
  • 3
unit_id integer
Response Request Enum

Tracking unit: hours, days, or pieces.

Enum Values (3 values)

  • 1
    Hour
  • 2
    Piece
  • 3
    Day
updated_at string
Parameter `filter`

Timestamp of the last update to this service.

with_memberships boolean
Parameter `filter`

Whether this service has membership restrictions.

work_cost object
Response

Labor cost from tracked time.

work_cost_default object
Response

Labor cost from tracked time in the organization's default currency.

work_cost_normalized object
Response

Labor cost from tracked time in the organization's normalized currency.

worked_cost object
Parameter `filter`

Labor cost calculated from worked time.

worked_time integer
Response Parameter `filter`

Total hours tracked on this service.