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

Tools

ToolDescription
buildops-service_assign_v1_job_job_tagAssign Job Tag to Job
buildops-service_create_v1_job_taskCreate task in Job
buildops-service_create_v1_property_taskCreate task in property
buildops-service_delete_v1_tasks_task_idDelete task by ID
buildops-service_get_job_by_idGet Jobs List
buildops-service_get_v1_departamentsGet Departments List
buildops-service_get_v1_departments_department_idGet Department by Department ID
buildops-service_get_v1_inventory_products_idGet Inventory Product by ID
buildops-service_get_v1_job_tasksGet all tasks on a Job
buildops-service_get_v1_jobs_job_idGet Job by Job ID
buildops-service_get_v1_product_idGet Product by Product ID
buildops-service_get_v1_productsGet Products List
buildops-service_get_v1_propertiesGet Properties by tenantId
buildops-service_get_v1_properties_idGet Property By Property ID
buildops-service_get_v1_properties_tasksGet all tasks on a property
buildops-service_get_v1_property_history_idGet Property History By PropertyId
buildops-service_get_v1_representatives_idGet Representative By ID
buildops-service_get_v1_taskGet task by ID
buildops-service_get_v1_visits_idGet Visit by ID
buildops-service_get_v1_visits_listGet Visits List
buildops-service_post_customers_id_repsAdd Customer Representative by customerId
buildops-service_post_v1_jobsCreate a Job
buildops-service_post_v1_productsCreate Product
buildops-service_post_v1_propertiesCreate a Property
buildops-service_post_v1_properties_id_representativesCreate a Customer Representative with propertyId
buildops-service_post_v1_visits_id_actionUpdate Visit Status
buildops-service_put_v1_customers_id_representatives_representative_idUpdate Representative by representativeId at Customer Level
buildops-service_put_v1_jobs_job_idUpdate Job by ID
buildops-service_put_v1_products_idUpdate a Product by Product ID
buildops-service_put_v1_properties_idUpdate Property By Property ID
buildops-service_put_v1_properties_id_representatives_representative_idUpdate Customer Representative through property with representativeId
buildops-service_remove_v1_job_job_tagRemove Job Tag from Job
buildops-service_update_v1_taskUpdate task by ID
buildops-service_v1_get_customers_our_representativesGet Our Representatives List by customerId

buildops-service_assign_v1_job_job_tag

Assign Job Tag to Job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesJob ID
jobTagIdstringYesJob Tag Id

buildops-service_create_v1_job_task

Create task in Job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesJob ID
assetIdstringNoAssociated asset ID
descriptionstringNoTask description
namestringYesTask name
taskEntriesobject[]NoTask entries containing products and quantities

buildops-service_create_v1_property_task

Create task in property Parameters:
ParameterTypeRequiredDefaultDescription
propertyIdstringYesProperty ID
assetIdstringNoAssociated asset ID
descriptionstringNoTask description
namestringYesTask name
taskEntriesobject[]NoTask entries containing products and quantities

buildops-service_delete_v1_tasks_task_id

Delete task by ID Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesTask ID

buildops-service_get_job_by_id

Get Jobs List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
limitintegerNoNumber of items per page
page_sizeintegerNoNumber of items per page
job_numberstringNoJob number that you want to filter by.

buildops-service_get_v1_departaments

Get Departments List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service_get_v1_departments_department_id

Get Department by Department ID Parameters:
ParameterTypeRequiredDefaultDescription
departmentIdstringYesDepartment ID

buildops-service_get_v1_inventory_products_id

Get Inventory Product by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesInventory Product ID

buildops-service_get_v1_job_tasks

Get all tasks on a Job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesJob ID

buildops-service_get_v1_jobs_job_id

Get Job by Job ID Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesJob ID
includestringNoAllows to return relations

buildops-service_get_v1_product_id

Get Product by Product ID Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID

buildops-service_get_v1_products

Get Products List Parameters:
ParameterTypeRequiredDefaultDescription
codestringNoProduct Code
page_sizeintegerNoNumber of items per page
limitstringNoHow many items should come in the request.
pagenumberNoPage that you want to filter.

buildops-service_get_v1_properties

Get Properties by tenantId Parameters:
ParameterTypeRequiredDefaultDescription
include_addressesbooleanNoAllows to return properties with his addresses.
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
include_inactivebooleanNoIf this parameter is passed as true, this endpoint will return inactive vendors.

buildops-service_get_v1_properties_id

Get Property By Property ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProperty ID
include_addressesbooleanNoDEPRECATED: Use include instead. Include addresses.
includestring[]NoAllows to return relations

buildops-service_get_v1_properties_tasks

Get all tasks on a property Parameters:
ParameterTypeRequiredDefaultDescription
propertyIdstringYesProperty ID

buildops-service_get_v1_property_history_id

Get Property History By PropertyId Parameters:
ParameterTypeRequiredDefaultDescription
propertyIdstringYesProperty ID

buildops-service_get_v1_representatives_id

Get Representative By ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresentative ID

buildops-service_get_v1_task

Get task by ID Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesTask ID

buildops-service_get_v1_visits_id

Get Visit by ID Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoAllows to return relations
idstringYesVisit ID

buildops-service_get_v1_visits_list

Get Visits List Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringNojobId for filtering visits
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service_post_customers_id_reps

Add Customer Representative by customerId Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCustomer ID
bestContactstringNoBest Contact
cellPhonestringNoCell Phone
contactRolestringNoContact Role
contactTypestringNoContact Type
emailstringNoThe email value
firstNamestringNoFirst Name
isDoNotCallbooleanNoIs Do Not Call
isEmailOptOutbooleanNoIs Email Opt Out
isSmsOptOutbooleanNoIs Sms Opt Out
landlinePhonestringNoLandline Phone
lastNamestringNoLast Name
middleNamestringNoMiddle Name
namestringNoThe name value
nickNamestringNoNick Name
profilePictureUrlstringNoProfile Picture Url
salutationstringNoThe salutation value
userTitlestringNoUser Title

buildops-service_post_v1_jobs

Create a Job Parameters:
ParameterTypeRequiredDefaultDescription
accountingJobNumberstringNoAccounting Job Number
accountManagerIdstringNoAccount Manager Id
amountNotToExceednumberNoAmount Not To Exceed
amountPreTaxQuotednumberNoAmount Pre Tax Quoted
authorizedByIdstringNoAuthorized By Id
billingCustomerIdstringNoBilling Customer Id
blanketPOIdstringNoBlanket PO Id
certifiedPayrollbooleanNoCertified Payroll
closeoutReportbooleanNoCloseout Report
costAmountnumberNoCost Amount
customerIdstringYesCustomer Id
customerPropertyIdstringYesCustomer Property Id
customerProvidedPONumberstringNoCustomer Provided PO Number
customerProvidedWONumberstringNoCustomer Provided WO Number
customerRepIdstringNoCustomer Rep Id
customIdentifierstringNoCustom Identifier
departmentIdsstring[]NoDepartment Ids
detailedJobCostingEnabledbooleanNoDetailed Job Costing Enabled
dueDatestringNoDue Date
issueDescriptionstringNoIssue Description
isUseTaxablebooleanYesIs Use Taxable
jobTypeIdstringYesJob Type Id
labourRateGroupIdstringNoLabour Rate Group Id
ownerIdstringNoOwner Id
preferredTechnicianIdstringNoPreferred Technician Id
priceBookIdstringYesPrice Book Id
prioritystringNoThe priority value
serviceChannelDescriptionstringNoService Channel Description
soldByIdstringNoSold By Id
statusobjectYesThe status value
taxAmountQuotednumberNoTax Amount Quoted
totalBudgetedHoursnumberNoTotal Budgeted Hours

buildops-service_post_v1_products

Create Product Parameters:
ParameterTypeRequiredDefaultDescription
categorystringNoProduct category
codestringNoProduct code
costCodeIdstringNoCost code identifier
defaultFeeOnQuotesbooleanNoWhether this product is a default fee on quotes
defaultFeeOnTimeAndMaterialJobsbooleanNoWhether this product is a default fee on time and material jobs
defaultFeeOnTimeAndMaterialJobVisitsbooleanNoWhether this product is a default fee on time and material job visits
descriptionstringYesDescription of the product
imageUrlstringNoURL to product image
isGenericbooleanYesWhether the product is generic. If false, manufacturer information is required.
itemGlGroupIdstringNoItem GL group identifier
jobCostTypeIdstringNoJob cost type identifier
markupTypestringNoMarkup type
markupValuenumberNoMarkup value for the product
namestringYesName of the product
productManufacturerIdstringNoProduct manufacturer ID. Required when isGeneric is false.
productManufacturerNumberstringNoProduct manufacturer number. Required when isGeneric is false.
revenueTypeIdstringNoRevenue type identifier
skustringNoStock keeping unit
subCategorystringNoProduct subcategory
taxablebooleanYesWhether the product is taxable
taxCodeIdstringNoTax code identifier
typestringYesProduct type
unitCostnumberYesUnit cost of the product
unitOfMeasureIdstringNoUnit of measure identifier
warrantyProvidedBystringNoEntity providing the warranty
warrantyTypestringNoType of warranty

buildops-service_post_v1_properties

Create a Property Parameters:
ParameterTypeRequiredDefaultDescription
accountNumberstringNoAccount Number
addressLine1stringNoAddress Line1
addressTypestringNoAddress Type
billingCustomerIdstringNoBilling Customer Id
billTostringNoBill To
citystringNoThe city value
companyNamestringNoCompany Name
countrystringNoThe country value
customerIdstringYesCustomer Id
customerPropertyTypeValuestringNoCustomer Property Type Value
isTaxablebooleanNoIs Taxable
latitudenumberYesThe latitude value
longitudenumberYesThe longitude value
priceBookIdstringNoPrice Book Id
sameAddressbooleanNoSame Address
statestringNoThe state value
syncStatusstringNoSync Status
taxCodeIdstringNoTax Code Id
zipcodestringNoThe zipcode value

buildops-service_post_v1_properties_id_representatives

Create a Customer Representative with propertyId Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProperty ID
bestContactstringNoBest Contact
cellPhonestringNoCell Phone
contactRolestringNoContact Role
contactTypestringNoContact Type
emailstringNoThe email value
firstNamestringNoFirst Name
isDoNotCallbooleanNoIs Do Not Call
isEmailOptOutbooleanNoIs Email Opt Out
isSmsOptOutbooleanNoIs Sms Opt Out
landlinePhonestringNoLandline Phone
lastNamestringNoLast Name
middleNamestringNoMiddle Name
namestringNoThe name value
nickNamestringNoNick Name
profilePictureUrlstringNoProfile Picture Url
salutationstringNoThe salutation value
userTitlestringNoUser Title

buildops-service_post_v1_visits_id_action

Update Visit Status Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesVisit ID
actionstringNoThe action value

buildops-service_put_v1_customers_id_representatives_representative_id

Update Representative by representativeId at Customer Level Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCustomer ID
representative_idstringYesRepresentative ID
bestContactstringNoBest Contact
cellPhonestringNoCell Phone
contactRolestringNoContact Role
contactTypestringNoContact Type
emailstringNoThe email value
firstNamestringNoFirst Name
isActivebooleanNoIs Active
isDoNotCallbooleanNoIs Do Not Call
isEmailOptOutbooleanNoIs Email Opt Out
isSmsOptOutbooleanNoIs Sms Opt Out
landlinePhonestringNoLandline Phone
lastNamestringNoLast Name
middleNamestringNoMiddle Name
namestringNoThe name value
nickNamestringNoNick Name
profilePictureUrlstringNoProfile Picture Url
salutationstringNoThe salutation value
statusstringNoThe status value
userTitlestringNoUser Title
versionnumberNoThe version value

buildops-service_put_v1_jobs_job_id

Update Job by ID Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesJob ID
accountingJobNumberstringNoAccounting Job Number
accountManagerIdstringNoAccount Manager Id
amountNotToExceednumberNoAmount Not To Exceed
amountPreTaxQuotednumberNoAmount Pre Tax Quoted
authorizedByIdstringNoAuthorized By Id
billingCustomerIdstringNoBilling Customer Id
blanketPOIdstringNoBlanket PO Id
certifiedPayrollbooleanNoCertified Payroll
closeoutReportbooleanNoCloseout Report
costAmountnumberNoCost Amount
customerIdstringNoCustomer Id
customerPropertyIdstringNoCustomer Property Id
customerProvidedPONumberstringNoCustomer Provided PO Number
customerProvidedWONumberstringNoCustomer Provided WO Number
customerRepIdstringNoCustomer Rep Id
departmentIdsstring[]NoDepartment Ids
detailedJobCostingEnabledbooleanNoDetailed Job Costing Enabled
dueDatestringNoDue Date
issueDescriptionstringNoIssue Description
isUseTaxablebooleanNoIs Use Taxable
jobTypeIdstringNoJob Type Id
labourRateGroupIdstringNoLabour Rate Group Id
ownerIdstringNoOwner Id
preferredTechnicianIdstringNoPreferred Technician Id
priceBookIdstringNoPrice Book Id
prioritystringNoThe priority value
serviceChannelDescriptionstringNoService Channel Description
soldByIdstringNoSold By Id
statusobjectNoThe status value
taxAmountQuotednumberNoTax Amount Quoted
totalBudgetedHoursnumberNoTotal Budgeted Hours
versionintegerNoThe version value

buildops-service_put_v1_products_id

Update a Product by Product ID Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesProduct ID
accountingRefIdstringNoAccounting Ref Id
codestringNoThe code value
costCodeIdstringNoCost Code Id
descriptionstringNoThe description value
itemGlGroupIdstringNoItem Gl Group Id
jobCostTypeIdstringNoJob Cost Type Id
markupTypestringNoMarkup Type
markupValuenumberNoMarkup Value
namestringNoThe name value
revenueTypeIdstringNoRevenue Type Id
syncStatusstringNoSync Status
taxablebooleanNoThe taxable value
unitCostnumberNoUnit Cost
unitOfMeasureIdstringNoUnit Of Measure Id
unitPricenumberNoUnit Price

buildops-service_put_v1_properties_id

Update Property By Property ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesProperty ID
accountNumberstringNoAccount Number
billingCustomerIdstringNoBilling Customer Id
billTostringNoBill To
companyNamestringNoCompany Name
customerPropertyTypeValuestringNoCustomer Property Type Value
isActivebooleanNoIs Active
isTaxablebooleanNoIs Taxable
priceBookIdstringNoPrice Book Id
sameAddressbooleanNoSame Address
statusstringNoThe status value
taxCodeIdstringNoTax Code Id

buildops-service_put_v1_properties_id_representatives_representative_id

Update Customer Representative through property with representativeId Parameters:
ParameterTypeRequiredDefaultDescription
representative_idstringYesCustomer Representative ID
idstringYesProperty ID
bestContactstringNoBest Contact
cellPhonestringNoCell Phone
contactRolestringNoContact Role
contactTypestringNoContact Type
emailstringNoThe email value
firstNamestringNoFirst Name
isActivebooleanNoIs Active
isDoNotCallbooleanNoIs Do Not Call
isEmailOptOutbooleanNoIs Email Opt Out
isSmsOptOutbooleanNoIs Sms Opt Out
landlinePhonestringNoLandline Phone
lastNamestringNoLast Name
middleNamestringNoMiddle Name
namestringNoThe name value
nickNamestringNoNick Name
profilePictureUrlstringNoProfile Picture Url
salutationstringNoThe salutation value
statusstringNoThe status value
userTitlestringNoUser Title
versionnumberNoThe version value

buildops-service_remove_v1_job_job_tag

Remove Job Tag from Job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesJob ID
tagIdstringYesJob Tag ID

buildops-service_update_v1_task

Update task by ID Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesTask ID
assetIdstringNoAsset Id
descriptionstringNoThe description value
formIdsstring[]NoForm Ids
namestringNoThe name value
taskEntriesobject[]NoTask Entries

buildops-service_v1_get_customers_our_representatives

Get Our Representatives List by customerId Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
idstringYesCustomer ID