/buildops-service-agreements | Type: Application | PCID required: Yes
Tools
buildops-service-agreements_create_task_template_product
Add product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
task_template_id | string | Yes | — | ID of the task template |
property_id | string | No | — | ID of the property |
asset_id | string | No | — | ID of the asset |
description | string | No | — | Description override for the product |
productId | string | Yes | — | ID of the product |
quantity | integer | Yes | — | Quantity of the product |
buildops-service-agreements_delete_task_template_product
Delete product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
id | string | Yes | — | ID of the task template product to delete |
task_template_id | string | Yes | — | ID of the task template |
property_id | string | No | — | ID of the property |
asset_id | string | No | — | ID of the asset |
buildops-service-agreements_delete_v1_service_agreement_asset_checklist
Delete asset checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
id | string | Yes | — | ID of the asset checklist association to delete |
delete_associated_entities | boolean | No | — | Whether to delete entities such as maintenance templates associated with this asset checklist |
buildops-service-agreements_delete_v1_service_agreement_property
Delete customer property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
propertyId | string | Yes | — | Unique identifier of the property to remove |
delete_associated_entities | boolean | No | — | Whether to delete entities associated with this property |
buildops-service-agreements_delete_v1_service_agreement_property_checklist
Delete customer property checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
id | string | Yes | — | ID of the property checklist association to delete |
delete_associated_entities | boolean | No | — | Whether to delete entities such as maintenance templates associated with this property checklist |
buildops-service-agreements_delete_v1_service_agreement_task_template
Delete task template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
task_template_id | string | Yes | — | ID of the task template |
property_id | string | No | — | ID of the property |
asset_id | string | No | — | ID of the asset |
delete_associated_entities | boolean | No | — | Whether to delete entities such as maintenance templates associated with this task template |
buildops-service-agreements_get_agreement_budgets
Get budget information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service agreement ID |
customerPropertyId | string | No | — | Customer property ID (required for SEPARATE property bundle mode) |
buildops-service-agreements_get_agreement_recurrence_definitions
Get recurrence definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service Agreement ID |
buildops-service-agreements_get_task_template_products
Fetch products Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
task_template_id | string | Yes | — | ID of the task template |
property_id | string | No | — | ID of the property |
asset_id | string | No | — | ID of the asset |
page | integer | No | — | The page to get (0-indexed) |
page_size | integer | No | — | The number of items to get per page |
buildops-service-agreements_get_v1_checklists
Fetch checklists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_type_id | string | No | — | Asset type ID to filter checklists by. |
checklist_type | string | No | — | Type of checklist to filter by |
page | string | No | — | The page to get (0-indexed) |
page_size | string | No | — | The number of items to get per page |
buildops-service-agreements_get_v1_service_agreement
Fetch Service Agreements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | No | — | Customer ID to filter service agreements by. |
page | string | No | — | The page to get (0-indexed) |
page_size | string | No | — | The number of items to get per page |
start | string | No | — | ISO 8601 string to filter data based on last modified date time |
end | string | No | — | ISO 8601 string to filter data based on last modified date time |
dateFilterType | string | No | — | The filter type for the filtering based on different dates (possible values createdDate, lastUpdatedDate, startDate, endDate) |
advanced_scheduling_state | string | No | — | Filter by advanced scheduling state |
agreement_number | string | No | — | Filter service agreements by agreement number |
buildops-service-agreements_get_v1_service_agreement_asset_checklists
Fetch asset checklists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-agreements_get_v1_service_agreement_properties
Fetch customer properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
page | string | No | — | The page number to retrieve (0-indexed) |
page_size | string | No | — | Number of items to return per page (max 100) |
buildops-service-agreements_get_v1_service_agreement_property_checklists
Fetch customer property checklists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-agreements_get_v1_service_agreement_service_agreement_id
Get service agreement by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service Agreement ID |
buildops-service-agreements_get_v1_service_agreement_task_templates
Fetch task templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-agreements_get_v1_service_agreement_type_by_id
Get service agreement type by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier of the service agreement type |
buildops-service-agreements_get_v1_service_agreement_types
Fetch service agreement types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page to get (0-indexed) |
page_size | integer | No | — | The number of items to get per page |
buildops-service-agreements_get_v1_work_types
List work typesbuildops-service-agreements_patch_agreement_recurrence_definition
Update a recurrence definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service Agreement ID |
recurrenceDefinitionId | string | Yes | — | Recurrence Definition ID |
billingInterval | string | No | — | Billing interval for recurring billing |
escalator | number | No | — | Escalator rate for price adjustments |
firstIssueDateTime | integer | No | — | First issue date (epoch seconds) |
lastIssueDateTime | integer | No | — | Last issue date (epoch seconds) |
priceFutureYearsMode | string | No | — | Mode for pricing future years |
buildops-service-agreements_patch_agreement_recurrence_definition_year
Update a recurrence definition year Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service Agreement ID |
recurrenceDefinitionYearId | string | Yes | — | Recurrence Definition Year ID |
invoiceAmount | number | No | — | Invoice amount for this recurrence definition year |
buildops-service-agreements_patch_v1_service_agreement_service_agreement_id
Update service agreement by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service Agreement ID |
agreementName | string | No | — | Agreement Name |
agreementNumber | string | No | — | Agreement Number |
billingCustomerId | string | No | — | Billing Customer ID |
billingType | string | No | — | Billing type for the service agreement |
customerId | string | No | — | Customer ID |
customerPoNumber | string | No | — | Customer PO Number |
departmentId | string | No | — | Department ID |
endDate | string | No | — | End Date. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000). |
externalContract | object | No | — | External Contract |
priceBookId | string | No | — | Price Book ID |
projectManagerId | string | No | — | Project manager employee ID |
serviceAgreementTypeId | string | No | — | Service Agreement Type ID |
soldById | string | No | — | Sold by employee ID |
startDate | string | No | — | Start Date. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000). |
buildops-service-agreements_patch_v1_service_agreement_task_template
Update task template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
task_template_id | string | Yes | — | ID of the task template |
property_id | string | No | — | ID of the property |
asset_id | string | No | — | ID of the asset |
description | string | No | — | Description of the task template |
frequency | string | No | — | Frequency of the task |
hourTypeId | string | No | — | ID of the payroll hour type |
laborEstimate | integer | No | — | Estimated labor time in minutes |
laborGroupId | string | No | — | ID of the labor rate group |
laborRate | number | No | — | Hourly labor rate in dollars |
laborTypeId | string | No | — | ID of the labor type |
name | string | No | — | Name of the task template |
numberOfOccurrences | integer | No | — | Number of times the task should occur |
startDate | string | No | — | Start date in epoch seconds. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000). |
buildops-service-agreements_post_v1_service_agreement
Create service agreement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agreementName | string | Yes | — | Agreement Name |
agreementNumber | string | Yes | — | Agreement Number |
billingCustomerId | string | Yes | — | Billing Customer ID |
billingType | string | No | — | Billing type for the service agreement |
customerId | string | Yes | — | Customer ID |
customerPoNumber | string | No | — | Customer PO Number |
departmentId | string | Yes | — | Department ID |
endDate | string | No | — | End Date. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000). |
externalContract | object | No | — | External Contract |
priceBookId | string | No | — | Price Book ID |
projectManagerId | string | No | — | Project manager employee ID |
serviceAgreementTypeId | string | Yes | — | Service Agreement Type ID |
soldById | string | No | — | Sold by employee ID |
startDate | string | Yes | — | Start Date. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000). |
buildops-service-agreements_post_v1_service_agreement_asset_checklist
Add asset checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
delete_associated_entities | boolean | No | — | Whether to delete entities such as maintenance templates associated with this asset checklist |
assetId | string | Yes | — | Unique identifier of the asset |
checklistId | string | Yes | — | Unique identifier of the checklist |
buildops-service-agreements_post_v1_service_agreement_property
Add customer property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
propertyId | string | Yes | — | Unique identifier of the property |
buildops-service-agreements_post_v1_service_agreement_property_checklist
Add customer property checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
delete_associated_entities | boolean | No | — | Whether to delete entities such as maintenance templates with this property checklist |
checklistId | string | Yes | — | Unique identifier of the checklist |
propertyId | string | Yes | — | Unique identifier of the property |
buildops-service-agreements_post_v1_service_agreement_task_template
Create task template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
asset_id | string | No | — | ID of the asset to associate with the task template, null if this is a property task template |
property_id | string | No | — | ID of the property to associate with the task template, null if this is a asset task template |
description | string | No | — | Description of the task template |
frequency | string | No | — | Frequency of the task |
hourTypeId | string | No | — | ID of the payroll hour type |
laborEstimate | integer | No | — | Estimated labor time in minutes |
laborGroupId | string | No | — | ID of the labor rate group |
laborRate | number | No | — | Hourly labor rate in dollars |
laborTypeId | string | No | — | ID of the labor type |
name | string | Yes | — | Name of the task template |
numberOfOccurrences | integer | No | — | Number of times the task should occur |
startDate | string | Yes | — | Start date in epoch seconds. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000). |
taskTemplateChecklistId | string | Yes | — | ID of the checklist to use for this task |
buildops-service-agreements_update_budget_buckets
Update budget buckets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Service agreement ID |
customerPropertyId | string | No | — | Customer property ID (required for SEPARATE property bundle mode) |
budgetBuckets | object[] | Yes | — | List of budget bucket updates |
buildops-service-agreements_update_task_template_product
Update product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAgreementId | string | Yes | — | Unique identifier of the service agreement |
id | string | Yes | — | ID of the task template product to update |
task_template_id | string | Yes | — | ID of the task template |
property_id | string | No | — | ID of the property |
asset_id | string | No | — | ID of the asset |
description | string | No | — | Description override for the product |
productId | string | No | — | ID of the product |
quantity | number | No | — | Quantity of the product |

