Skip to main content
Server path: /buildops-service-agreements | Type: Application | PCID required: Yes

Tools

ToolDescription
buildops-service-agreements_create_task_template_productAdd product
buildops-service-agreements_delete_task_template_productDelete product
buildops-service-agreements_delete_v1_service_agreement_asset_checklistDelete asset checklist
buildops-service-agreements_delete_v1_service_agreement_propertyDelete customer property
buildops-service-agreements_delete_v1_service_agreement_property_checklistDelete customer property checklist
buildops-service-agreements_delete_v1_service_agreement_task_templateDelete task template
buildops-service-agreements_get_agreement_budgetsGet budget information
buildops-service-agreements_get_agreement_recurrence_definitionsGet recurrence definitions
buildops-service-agreements_get_task_template_productsFetch products
buildops-service-agreements_get_v1_checklistsFetch checklists
buildops-service-agreements_get_v1_service_agreementFetch Service Agreements
buildops-service-agreements_get_v1_service_agreement_asset_checklistsFetch asset checklists
buildops-service-agreements_get_v1_service_agreement_propertiesFetch customer properties
buildops-service-agreements_get_v1_service_agreement_property_checklistsFetch customer property checklists
buildops-service-agreements_get_v1_service_agreement_service_agreement_idGet service agreement by ID
buildops-service-agreements_get_v1_service_agreement_task_templatesFetch task templates
buildops-service-agreements_get_v1_service_agreement_type_by_idGet service agreement type by ID
buildops-service-agreements_get_v1_service_agreement_typesFetch service agreement types
buildops-service-agreements_get_v1_work_typesList work types
buildops-service-agreements_patch_agreement_recurrence_definitionUpdate a recurrence definition
buildops-service-agreements_patch_agreement_recurrence_definition_yearUpdate a recurrence definition year
buildops-service-agreements_patch_v1_service_agreement_service_agreement_idUpdate service agreement by ID
buildops-service-agreements_patch_v1_service_agreement_task_templateUpdate task template
buildops-service-agreements_post_v1_service_agreementCreate service agreement
buildops-service-agreements_post_v1_service_agreement_asset_checklistAdd asset checklist
buildops-service-agreements_post_v1_service_agreement_propertyAdd customer property
buildops-service-agreements_post_v1_service_agreement_property_checklistAdd customer property checklist
buildops-service-agreements_post_v1_service_agreement_task_templateCreate task template
buildops-service-agreements_update_budget_bucketsUpdate budget buckets
buildops-service-agreements_update_task_template_productUpdate product

buildops-service-agreements_create_task_template_product

Add product Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
task_template_idstringYesID of the task template
property_idstringNoID of the property
asset_idstringNoID of the asset
descriptionstringNoDescription override for the product
productIdstringYesID of the product
quantityintegerYesQuantity of the product

buildops-service-agreements_delete_task_template_product

Delete product Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
idstringYesID of the task template product to delete
task_template_idstringYesID of the task template
property_idstringNoID of the property
asset_idstringNoID of the asset

buildops-service-agreements_delete_v1_service_agreement_asset_checklist

Delete asset checklist Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
idstringYesID of the asset checklist association to delete
delete_associated_entitiesbooleanNoWhether to delete entities such as maintenance templates associated with this asset checklist

buildops-service-agreements_delete_v1_service_agreement_property

Delete customer property Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
propertyIdstringYesUnique identifier of the property to remove
delete_associated_entitiesbooleanNoWhether to delete entities associated with this property

buildops-service-agreements_delete_v1_service_agreement_property_checklist

Delete customer property checklist Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
idstringYesID of the property checklist association to delete
delete_associated_entitiesbooleanNoWhether 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:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
task_template_idstringYesID of the task template
property_idstringNoID of the property
asset_idstringNoID of the asset
delete_associated_entitiesbooleanNoWhether to delete entities such as maintenance templates associated with this task template

buildops-service-agreements_get_agreement_budgets

Get budget information Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService agreement ID
customerPropertyIdstringNoCustomer property ID (required for SEPARATE property bundle mode)

buildops-service-agreements_get_agreement_recurrence_definitions

Get recurrence definitions Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService Agreement ID

buildops-service-agreements_get_task_template_products

Fetch products Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
task_template_idstringYesID of the task template
property_idstringNoID of the property
asset_idstringNoID of the asset
pageintegerNoThe page to get (0-indexed)
page_sizeintegerNoThe number of items to get per page

buildops-service-agreements_get_v1_checklists

Fetch checklists Parameters:
ParameterTypeRequiredDefaultDescription
asset_type_idstringNoAsset type ID to filter checklists by.
checklist_typestringNoType of checklist to filter by
pagestringNoThe page to get (0-indexed)
page_sizestringNoThe number of items to get per page

buildops-service-agreements_get_v1_service_agreement

Fetch Service Agreements Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringNoCustomer ID to filter service agreements by.
pagestringNoThe page to get (0-indexed)
page_sizestringNoThe number of items to get per page
startstringNoISO 8601 string to filter data based on last modified date time
endstringNoISO 8601 string to filter data based on last modified date time
dateFilterTypestringNoThe filter type for the filtering based on different dates (possible values createdDate, lastUpdatedDate, startDate, endDate)
advanced_scheduling_statestringNoFilter by advanced scheduling state
agreement_numberstringNoFilter service agreements by agreement number

buildops-service-agreements_get_v1_service_agreement_asset_checklists

Fetch asset checklists Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-agreements_get_v1_service_agreement_properties

Fetch customer properties Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
pagestringNoThe page number to retrieve (0-indexed)
page_sizestringNoNumber of items to return per page (max 100)

buildops-service-agreements_get_v1_service_agreement_property_checklists

Fetch customer property checklists Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-agreements_get_v1_service_agreement_service_agreement_id

Get service agreement by ID Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService Agreement ID

buildops-service-agreements_get_v1_service_agreement_task_templates

Fetch task templates Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-agreements_get_v1_service_agreement_type_by_id

Get service agreement type by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier of the service agreement type

buildops-service-agreements_get_v1_service_agreement_types

Fetch service agreement types Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page to get (0-indexed)
page_sizeintegerNoThe number of items to get per page

buildops-service-agreements_get_v1_work_types

List work types

buildops-service-agreements_patch_agreement_recurrence_definition

Update a recurrence definition Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService Agreement ID
recurrenceDefinitionIdstringYesRecurrence Definition ID
billingIntervalstringNoBilling interval for recurring billing
escalatornumberNoEscalator rate for price adjustments
firstIssueDateTimeintegerNoFirst issue date (epoch seconds)
lastIssueDateTimeintegerNoLast issue date (epoch seconds)
priceFutureYearsModestringNoMode for pricing future years

buildops-service-agreements_patch_agreement_recurrence_definition_year

Update a recurrence definition year Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService Agreement ID
recurrenceDefinitionYearIdstringYesRecurrence Definition Year ID
invoiceAmountnumberNoInvoice amount for this recurrence definition year

buildops-service-agreements_patch_v1_service_agreement_service_agreement_id

Update service agreement by ID Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService Agreement ID
agreementNamestringNoAgreement Name
agreementNumberstringNoAgreement Number
billingCustomerIdstringNoBilling Customer ID
billingTypestringNoBilling type for the service agreement
customerIdstringNoCustomer ID
customerPoNumberstringNoCustomer PO Number
departmentIdstringNoDepartment ID
endDatestringNoEnd Date. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000).
externalContractobjectNoExternal Contract
priceBookIdstringNoPrice Book ID
projectManagerIdstringNoProject manager employee ID
serviceAgreementTypeIdstringNoService Agreement Type ID
soldByIdstringNoSold by employee ID
startDatestringNoStart 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:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
task_template_idstringYesID of the task template
property_idstringNoID of the property
asset_idstringNoID of the asset
descriptionstringNoDescription of the task template
frequencystringNoFrequency of the task
hourTypeIdstringNoID of the payroll hour type
laborEstimateintegerNoEstimated labor time in minutes
laborGroupIdstringNoID of the labor rate group
laborRatenumberNoHourly labor rate in dollars
laborTypeIdstringNoID of the labor type
namestringNoName of the task template
numberOfOccurrencesintegerNoNumber of times the task should occur
startDatestringNoStart 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:
ParameterTypeRequiredDefaultDescription
agreementNamestringYesAgreement Name
agreementNumberstringYesAgreement Number
billingCustomerIdstringYesBilling Customer ID
billingTypestringNoBilling type for the service agreement
customerIdstringYesCustomer ID
customerPoNumberstringNoCustomer PO Number
departmentIdstringYesDepartment ID
endDatestringNoEnd Date. The time should correspond to the first moment of the day referenced in the relevant timezone (ie 00:00:00.000).
externalContractobjectNoExternal Contract
priceBookIdstringNoPrice Book ID
projectManagerIdstringNoProject manager employee ID
serviceAgreementTypeIdstringYesService Agreement Type ID
soldByIdstringNoSold by employee ID
startDatestringYesStart 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:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
delete_associated_entitiesbooleanNoWhether to delete entities such as maintenance templates associated with this asset checklist
assetIdstringYesUnique identifier of the asset
checklistIdstringYesUnique identifier of the checklist

buildops-service-agreements_post_v1_service_agreement_property

Add customer property Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
propertyIdstringYesUnique identifier of the property

buildops-service-agreements_post_v1_service_agreement_property_checklist

Add customer property checklist Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
delete_associated_entitiesbooleanNoWhether to delete entities such as maintenance templates with this property checklist
checklistIdstringYesUnique identifier of the checklist
propertyIdstringYesUnique identifier of the property

buildops-service-agreements_post_v1_service_agreement_task_template

Create task template Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
asset_idstringNoID of the asset to associate with the task template, null if this is a property task template
property_idstringNoID of the property to associate with the task template, null if this is a asset task template
descriptionstringNoDescription of the task template
frequencystringNoFrequency of the task
hourTypeIdstringNoID of the payroll hour type
laborEstimateintegerNoEstimated labor time in minutes
laborGroupIdstringNoID of the labor rate group
laborRatenumberNoHourly labor rate in dollars
laborTypeIdstringNoID of the labor type
namestringYesName of the task template
numberOfOccurrencesintegerNoNumber of times the task should occur
startDatestringYesStart 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).
taskTemplateChecklistIdstringYesID of the checklist to use for this task

buildops-service-agreements_update_budget_buckets

Update budget buckets Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesService agreement ID
customerPropertyIdstringNoCustomer property ID (required for SEPARATE property bundle mode)
budgetBucketsobject[]YesList of budget bucket updates

buildops-service-agreements_update_task_template_product

Update product Parameters:
ParameterTypeRequiredDefaultDescription
serviceAgreementIdstringYesUnique identifier of the service agreement
idstringYesID of the task template product to update
task_template_idstringYesID of the task template
property_idstringNoID of the property
asset_idstringNoID of the asset
descriptionstringNoDescription override for the product
productIdstringNoID of the product
quantitynumberNoQuantity of the product