/buildops-service | Type: Application | PCID required: Yes
Tools
buildops-service_assign_v1_job_job_tag
Assign Job Tag to Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | Job ID |
jobTagId | string | Yes | — | Job Tag Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job ID"
},
"jobTagId": {
"type": "string",
"description": "Job Tag Id"
}
},
"required": [
"PCID",
"jobId",
"jobTagId"
]
}
buildops-service_create_v1_job_task
Create task in Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | Job ID |
assetId | string | No | — | Associated asset ID |
description | string | No | — | Task description |
name | string | Yes | — | Task name |
taskEntries | object[] | No | — | Task entries containing products and quantities |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job ID"
},
"assetId": {
"type": "string",
"description": "Associated asset ID"
},
"description": {
"type": "string",
"description": "Task description"
},
"name": {
"type": "string",
"description": "Task name"
},
"taskEntries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"format": "uuid",
"description": "Product ID for the task entry"
},
"description": {
"type": "string",
"description": "Description of the task entry"
},
"quantity": {
"type": "number",
"description": "Quantity of the product"
}
},
"required": [
"productId",
"description",
"quantity"
]
},
"description": "Task entries containing products and quantities"
}
},
"required": [
"PCID",
"jobId",
"name"
]
}
buildops-service_create_v1_property_task
Create task in property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
propertyId | string | Yes | — | Property ID |
assetId | string | No | — | Associated asset ID |
description | string | No | — | Task description |
name | string | Yes | — | Task name |
taskEntries | object[] | No | — | Task entries containing products and quantities |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"propertyId": {
"type": "string",
"description": "Property ID"
},
"assetId": {
"type": "string",
"description": "Associated asset ID"
},
"description": {
"type": "string",
"description": "Task description"
},
"name": {
"type": "string",
"description": "Task name"
},
"taskEntries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"format": "uuid",
"description": "Product ID for the task entry"
},
"description": {
"type": "string",
"description": "Description of the task entry"
},
"quantity": {
"type": "number",
"description": "Quantity of the product"
}
},
"required": [
"productId",
"description",
"quantity"
]
},
"description": "Task entries containing products and quantities"
}
},
"required": [
"PCID",
"propertyId",
"name"
]
}
buildops-service_delete_v1_tasks_task_id
Delete task by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Task ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "Task ID"
}
},
"required": [
"PCID",
"taskId"
]
}
buildops-service_get_job_by_id
Get Jobs List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
limit | integer | No | — | Number of items per page |
page_size | integer | No | — | Number of items per page |
job_number | string | No | — | Job number that you want to filter by. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"limit": {
"type": "integer",
"description": "Number of items per page"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"job_number": {
"type": "string",
"description": "Job number that you want to filter by."
}
},
"required": [
"PCID"
]
}
buildops-service_get_v1_departaments
Get Departments List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
}
},
"required": [
"PCID"
]
}
buildops-service_get_v1_departments_department_id
Get Department by Department ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
departmentId | string | Yes | — | Department ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"departmentId": {
"type": "string",
"description": "Department ID"
}
},
"required": [
"PCID",
"departmentId"
]
}
buildops-service_get_v1_inventory_products_id
Get Inventory Product by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Inventory Product ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Inventory Product ID"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_get_v1_job_tasks
Get all tasks on a Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | Job ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job ID"
}
},
"required": [
"PCID",
"jobId"
]
}
buildops-service_get_v1_jobs_job_id
Get Job by Job ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | Job ID |
include | string | No | — | Allows to return relations |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job ID"
},
"include": {
"type": "string",
"description": "Allows to return relations",
"enum": [
"attributes",
"departments"
]
}
},
"required": [
"PCID",
"jobId"
]
}
buildops-service_get_v1_product_id
Get Product by Product ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"productId": {
"type": "string",
"description": "Product ID"
}
},
"required": [
"PCID",
"productId"
]
}
buildops-service_get_v1_products
Get Products List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | No | — | Product Code |
page_size | integer | No | — | Number of items per page |
limit | string | No | — | How many items should come in the request. |
page | number | No | — | Page that you want to filter. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"code": {
"type": "string",
"description": "Product Code"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"limit": {
"type": "string",
"description": "How many items should come in the request."
},
"page": {
"type": "number",
"description": "Page that you want to filter."
}
},
"required": [
"PCID"
]
}
buildops-service_get_v1_properties
Get Properties by tenantId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include_addresses | boolean | No | — | Allows to return properties with his addresses. |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
include_inactive | boolean | No | — | If this parameter is passed as true, this endpoint will return inactive vendors. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include_addresses": {
"type": "boolean",
"description": "Allows to return properties with his addresses."
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"include_inactive": {
"type": "boolean",
"description": "If this parameter is passed as true, this endpoint will return inactive vendors."
}
},
"required": [
"PCID"
]
}
buildops-service_get_v1_properties_id
Get Property By Property ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Property ID |
include_addresses | boolean | No | — | DEPRECATED: Use include instead. Include addresses. |
include | string[] | No | — | Allows to return relations |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Property ID"
},
"include_addresses": {
"type": "boolean",
"description": "DEPRECATED: Use `include` instead. Include addresses."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"addresses",
"attributes"
]
},
"description": "Allows to return relations"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_get_v1_properties_tasks
Get all tasks on a property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
propertyId | string | Yes | — | Property ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"propertyId": {
"type": "string",
"description": "Property ID"
}
},
"required": [
"PCID",
"propertyId"
]
}
buildops-service_get_v1_property_history_id
Get Property History By PropertyId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
propertyId | string | Yes | — | Property ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"propertyId": {
"type": "string",
"description": "Property ID"
}
},
"required": [
"PCID",
"propertyId"
]
}
buildops-service_get_v1_representatives_id
Get Representative By ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Representative ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Representative ID"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_get_v1_task
Get task by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Task ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "Task ID"
}
},
"required": [
"PCID",
"taskId"
]
}
buildops-service_get_v1_visits_id
Get Visit by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | Allows to return relations |
id | string | Yes | — | Visit ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "string",
"description": "Allows to return relations"
},
"id": {
"type": "string",
"description": "Visit ID"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_get_v1_visits_list
Get Visits List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | No | — | jobId for filtering visits |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "jobId for filtering visits"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
}
},
"required": [
"PCID"
]
}
buildops-service_post_customers_id_reps
Add Customer Representative by customerId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Customer ID |
bestContact | string | No | — | Best Contact |
cellPhone | string | No | — | Cell Phone |
contactRole | string | No | — | Contact Role |
contactType | string | No | — | Contact Type |
email | string | No | — | The email value |
firstName | string | No | — | First Name |
isDoNotCall | boolean | No | — | Is Do Not Call |
isEmailOptOut | boolean | No | — | Is Email Opt Out |
isSmsOptOut | boolean | No | — | Is Sms Opt Out |
landlinePhone | string | No | — | Landline Phone |
lastName | string | No | — | Last Name |
middleName | string | No | — | Middle Name |
name | string | No | — | The name value |
nickName | string | No | — | Nick Name |
profilePictureUrl | string | No | — | Profile Picture Url |
salutation | string | No | — | The salutation value |
userTitle | string | No | — | User Title |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Customer ID"
},
"bestContact": {
"type": "string",
"description": "Best Contact"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"contactRole": {
"type": "string",
"description": "Contact Role"
},
"contactType": {
"type": "string",
"description": "Contact Type"
},
"email": {
"type": "string",
"description": "The email value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"isDoNotCall": {
"type": "boolean",
"description": "Is Do Not Call"
},
"isEmailOptOut": {
"type": "boolean",
"description": "Is Email Opt Out"
},
"isSmsOptOut": {
"type": "boolean",
"description": "Is Sms Opt Out"
},
"landlinePhone": {
"type": "string",
"description": "Landline Phone"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"name": {
"type": "string",
"description": "The name value"
},
"nickName": {
"type": "string",
"description": "Nick Name"
},
"profilePictureUrl": {
"type": "string",
"description": "Profile Picture Url"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"userTitle": {
"type": "string",
"description": "User Title"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_post_v1_jobs
Create a Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingJobNumber | string | No | — | Accounting Job Number |
accountManagerId | string | No | — | Account Manager Id |
amountNotToExceed | number | No | — | Amount Not To Exceed |
amountPreTaxQuoted | number | No | — | Amount Pre Tax Quoted |
authorizedById | string | No | — | Authorized By Id |
billingCustomerId | string | No | — | Billing Customer Id |
blanketPOId | string | No | — | Blanket PO Id |
certifiedPayroll | boolean | No | — | Certified Payroll |
closeoutReport | boolean | No | — | Closeout Report |
costAmount | number | No | — | Cost Amount |
customerId | string | Yes | — | Customer Id |
customerPropertyId | string | Yes | — | Customer Property Id |
customerProvidedPONumber | string | No | — | Customer Provided PO Number |
customerProvidedWONumber | string | No | — | Customer Provided WO Number |
customerRepId | string | No | — | Customer Rep Id |
customIdentifier | string | No | — | Custom Identifier |
departmentIds | string[] | No | — | Department Ids |
detailedJobCostingEnabled | boolean | No | — | Detailed Job Costing Enabled |
dueDate | string | No | — | Due Date |
issueDescription | string | No | — | Issue Description |
isUseTaxable | boolean | Yes | — | Is Use Taxable |
jobTypeId | string | Yes | — | Job Type Id |
labourRateGroupId | string | No | — | Labour Rate Group Id |
ownerId | string | No | — | Owner Id |
preferredTechnicianId | string | No | — | Preferred Technician Id |
priceBookId | string | Yes | — | Price Book Id |
priority | string | No | — | The priority value |
serviceChannelDescription | string | No | — | Service Channel Description |
soldById | string | No | — | Sold By Id |
status | object | Yes | — | The status value |
taxAmountQuoted | number | No | — | Tax Amount Quoted |
totalBudgetedHours | number | No | — | Total Budgeted Hours |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountingJobNumber": {
"type": "string",
"description": "Accounting Job Number"
},
"accountManagerId": {
"type": "string",
"description": "Account Manager Id"
},
"amountNotToExceed": {
"type": "number",
"description": "Amount Not To Exceed"
},
"amountPreTaxQuoted": {
"type": "number",
"description": "Amount Pre Tax Quoted"
},
"authorizedById": {
"type": "string",
"description": "Authorized By Id"
},
"billingCustomerId": {
"type": "string",
"description": "Billing Customer Id"
},
"blanketPOId": {
"type": "string",
"description": "Blanket PO Id"
},
"certifiedPayroll": {
"type": "boolean",
"description": "Certified Payroll"
},
"closeoutReport": {
"type": "boolean",
"description": "Closeout Report"
},
"costAmount": {
"type": "number",
"description": "Cost Amount"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"customerPropertyId": {
"type": "string",
"description": "Customer Property Id"
},
"customerProvidedPONumber": {
"type": "string",
"description": "Customer Provided PO Number"
},
"customerProvidedWONumber": {
"type": "string",
"description": "Customer Provided WO Number"
},
"customerRepId": {
"type": "string",
"description": "Customer Rep Id"
},
"customIdentifier": {
"type": "string",
"description": "Custom Identifier"
},
"departmentIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Department Ids"
},
"detailedJobCostingEnabled": {
"type": "boolean",
"description": "Detailed Job Costing Enabled"
},
"dueDate": {
"type": "string",
"description": "Due Date"
},
"issueDescription": {
"type": "string",
"description": "Issue Description"
},
"isUseTaxable": {
"type": "boolean",
"description": "Is Use Taxable"
},
"jobTypeId": {
"type": "string",
"description": "Job Type Id"
},
"labourRateGroupId": {
"type": "string",
"description": "Labour Rate Group Id"
},
"ownerId": {
"type": "string",
"description": "Owner Id"
},
"preferredTechnicianId": {
"type": "string",
"description": "Preferred Technician Id"
},
"priceBookId": {
"type": "string",
"description": "Price Book Id"
},
"priority": {
"type": "string",
"description": "The priority value"
},
"serviceChannelDescription": {
"type": "string",
"description": "Service Channel Description"
},
"soldById": {
"type": "string",
"description": "Sold By Id"
},
"status": {
"description": "The status value",
"enum": [
"Open",
"In Progress",
"On Hold",
"Canceled",
"Complete"
]
},
"taxAmountQuoted": {
"type": "number",
"description": "Tax Amount Quoted"
},
"totalBudgetedHours": {
"type": "number",
"description": "Total Budgeted Hours"
}
},
"required": [
"PCID",
"customerId",
"customerPropertyId",
"isUseTaxable",
"jobTypeId",
"priceBookId",
"status"
]
}
buildops-service_post_v1_products
Create Product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category | string | No | — | Product category |
code | string | No | — | Product code |
costCodeId | string | No | — | Cost code identifier |
defaultFeeOnQuotes | boolean | No | — | Whether this product is a default fee on quotes |
defaultFeeOnTimeAndMaterialJobs | boolean | No | — | Whether this product is a default fee on time and material jobs |
defaultFeeOnTimeAndMaterialJobVisits | boolean | No | — | Whether this product is a default fee on time and material job visits |
description | string | Yes | — | Description of the product |
imageUrl | string | No | — | URL to product image |
isGeneric | boolean | Yes | — | Whether the product is generic. If false, manufacturer information is required. |
itemGlGroupId | string | No | — | Item GL group identifier |
jobCostTypeId | string | No | — | Job cost type identifier |
markupType | string | No | — | Markup type |
markupValue | number | No | — | Markup value for the product |
name | string | Yes | — | Name of the product |
productManufacturerId | string | No | — | Product manufacturer ID. Required when isGeneric is false. |
productManufacturerNumber | string | No | — | Product manufacturer number. Required when isGeneric is false. |
revenueTypeId | string | No | — | Revenue type identifier |
sku | string | No | — | Stock keeping unit |
subCategory | string | No | — | Product subcategory |
taxable | boolean | Yes | — | Whether the product is taxable |
taxCodeId | string | No | — | Tax code identifier |
type | string | Yes | — | Product type |
unitCost | number | Yes | — | Unit cost of the product |
unitOfMeasureId | string | No | — | Unit of measure identifier |
warrantyProvidedBy | string | No | — | Entity providing the warranty |
warrantyType | string | No | — | Type of warranty |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "Product category"
},
"code": {
"type": "string",
"description": "Product code"
},
"costCodeId": {
"type": "string",
"description": "Cost code identifier"
},
"defaultFeeOnQuotes": {
"type": "boolean",
"description": "Whether this product is a default fee on quotes"
},
"defaultFeeOnTimeAndMaterialJobs": {
"type": "boolean",
"description": "Whether this product is a default fee on time and material jobs"
},
"defaultFeeOnTimeAndMaterialJobVisits": {
"type": "boolean",
"description": "Whether this product is a default fee on time and material job visits"
},
"description": {
"type": "string",
"description": "Description of the product"
},
"imageUrl": {
"type": "string",
"description": "URL to product image"
},
"isGeneric": {
"type": "boolean",
"description": "Whether the product is generic. If false, manufacturer information is required."
},
"itemGlGroupId": {
"type": "string",
"description": "Item GL group identifier"
},
"jobCostTypeId": {
"type": "string",
"description": "Job cost type identifier"
},
"markupType": {
"type": "string",
"description": "Markup type"
},
"markupValue": {
"type": "number",
"description": "Markup value for the product"
},
"name": {
"type": "string",
"description": "Name of the product"
},
"productManufacturerId": {
"type": "string",
"description": "Product manufacturer ID. Required when isGeneric is false."
},
"productManufacturerNumber": {
"type": "string",
"description": "Product manufacturer number. Required when isGeneric is false."
},
"revenueTypeId": {
"type": "string",
"description": "Revenue type identifier"
},
"sku": {
"type": "string",
"description": "Stock keeping unit"
},
"subCategory": {
"type": "string",
"description": "Product subcategory"
},
"taxable": {
"type": "boolean",
"description": "Whether the product is taxable"
},
"taxCodeId": {
"type": "string",
"description": "Tax code identifier"
},
"type": {
"type": "string",
"description": "Product type",
"enum": [
"Service",
"ItemNonInventory",
"ItemInventory"
]
},
"unitCost": {
"type": "number",
"description": "Unit cost of the product"
},
"unitOfMeasureId": {
"type": "string",
"description": "Unit of measure identifier"
},
"warrantyProvidedBy": {
"type": "string",
"description": "Entity providing the warranty"
},
"warrantyType": {
"type": "string",
"description": "Type of warranty"
}
},
"required": [
"PCID",
"description",
"isGeneric",
"name",
"taxable",
"type",
"unitCost"
]
}
buildops-service_post_v1_properties
Create a Property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountNumber | string | No | — | Account Number |
addressLine1 | string | No | — | Address Line1 |
addressType | string | No | — | Address Type |
billingCustomerId | string | No | — | Billing Customer Id |
billTo | string | No | — | Bill To |
city | string | No | — | The city value |
companyName | string | No | — | Company Name |
country | string | No | — | The country value |
customerId | string | Yes | — | Customer Id |
customerPropertyTypeValue | string | No | — | Customer Property Type Value |
isTaxable | boolean | No | — | Is Taxable |
latitude | number | Yes | — | The latitude value |
longitude | number | Yes | — | The longitude value |
priceBookId | string | No | — | Price Book Id |
sameAddress | boolean | No | — | Same Address |
state | string | No | — | The state value |
syncStatus | string | No | — | Sync Status |
taxCodeId | string | No | — | Tax Code Id |
zipcode | string | No | — | The zipcode value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountNumber": {
"type": "string",
"description": "Account Number"
},
"addressLine1": {
"type": "string",
"description": "Address Line1"
},
"addressType": {
"type": "string",
"description": "Address Type"
},
"billingCustomerId": {
"type": "string",
"description": "Billing Customer Id"
},
"billTo": {
"type": "string",
"description": "Bill To"
},
"city": {
"type": "string",
"description": "The city value"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"country": {
"type": "string",
"description": "The country value"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"customerPropertyTypeValue": {
"type": "string",
"description": "Customer Property Type Value"
},
"isTaxable": {
"type": "boolean",
"description": "Is Taxable"
},
"latitude": {
"type": "number",
"description": "The latitude value"
},
"longitude": {
"type": "number",
"description": "The longitude value"
},
"priceBookId": {
"type": "string",
"description": "Price Book Id"
},
"sameAddress": {
"type": "boolean",
"description": "Same Address"
},
"state": {
"type": "string",
"description": "The state value"
},
"syncStatus": {
"type": "string",
"description": "Sync Status"
},
"taxCodeId": {
"type": "string",
"description": "Tax Code Id"
},
"zipcode": {
"type": "string",
"description": "The zipcode value"
}
},
"required": [
"PCID",
"customerId",
"latitude",
"longitude"
]
}
buildops-service_post_v1_properties_id_representatives
Create a Customer Representative with propertyId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Property ID |
bestContact | string | No | — | Best Contact |
cellPhone | string | No | — | Cell Phone |
contactRole | string | No | — | Contact Role |
contactType | string | No | — | Contact Type |
email | string | No | — | The email value |
firstName | string | No | — | First Name |
isDoNotCall | boolean | No | — | Is Do Not Call |
isEmailOptOut | boolean | No | — | Is Email Opt Out |
isSmsOptOut | boolean | No | — | Is Sms Opt Out |
landlinePhone | string | No | — | Landline Phone |
lastName | string | No | — | Last Name |
middleName | string | No | — | Middle Name |
name | string | No | — | The name value |
nickName | string | No | — | Nick Name |
profilePictureUrl | string | No | — | Profile Picture Url |
salutation | string | No | — | The salutation value |
userTitle | string | No | — | User Title |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Property ID"
},
"bestContact": {
"type": "string",
"description": "Best Contact"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"contactRole": {
"type": "string",
"description": "Contact Role"
},
"contactType": {
"type": "string",
"description": "Contact Type"
},
"email": {
"type": "string",
"description": "The email value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"isDoNotCall": {
"type": "boolean",
"description": "Is Do Not Call"
},
"isEmailOptOut": {
"type": "boolean",
"description": "Is Email Opt Out"
},
"isSmsOptOut": {
"type": "boolean",
"description": "Is Sms Opt Out"
},
"landlinePhone": {
"type": "string",
"description": "Landline Phone"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"name": {
"type": "string",
"description": "The name value"
},
"nickName": {
"type": "string",
"description": "Nick Name"
},
"profilePictureUrl": {
"type": "string",
"description": "Profile Picture Url"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"userTitle": {
"type": "string",
"description": "User Title"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_post_v1_visits_id_action
Update Visit Status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Visit ID |
action | string | No | — | The action value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Visit ID"
},
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_put_v1_customers_id_representatives_representative_id
Update Representative by representativeId at Customer Level Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Customer ID |
representative_id | string | Yes | — | Representative ID |
bestContact | string | No | — | Best Contact |
cellPhone | string | No | — | Cell Phone |
contactRole | string | No | — | Contact Role |
contactType | string | No | — | Contact Type |
email | string | No | — | The email value |
firstName | string | No | — | First Name |
isActive | boolean | No | — | Is Active |
isDoNotCall | boolean | No | — | Is Do Not Call |
isEmailOptOut | boolean | No | — | Is Email Opt Out |
isSmsOptOut | boolean | No | — | Is Sms Opt Out |
landlinePhone | string | No | — | Landline Phone |
lastName | string | No | — | Last Name |
middleName | string | No | — | Middle Name |
name | string | No | — | The name value |
nickName | string | No | — | Nick Name |
profilePictureUrl | string | No | — | Profile Picture Url |
salutation | string | No | — | The salutation value |
status | string | No | — | The status value |
userTitle | string | No | — | User Title |
version | number | No | — | The version value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Customer ID"
},
"representative_id": {
"type": "string",
"description": "Representative ID"
},
"bestContact": {
"type": "string",
"description": "Best Contact"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"contactRole": {
"type": "string",
"description": "Contact Role"
},
"contactType": {
"type": "string",
"description": "Contact Type"
},
"email": {
"type": "string",
"description": "The email value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"isActive": {
"type": "boolean",
"description": "Is Active"
},
"isDoNotCall": {
"type": "boolean",
"description": "Is Do Not Call"
},
"isEmailOptOut": {
"type": "boolean",
"description": "Is Email Opt Out"
},
"isSmsOptOut": {
"type": "boolean",
"description": "Is Sms Opt Out"
},
"landlinePhone": {
"type": "string",
"description": "Landline Phone"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"name": {
"type": "string",
"description": "The name value"
},
"nickName": {
"type": "string",
"description": "Nick Name"
},
"profilePictureUrl": {
"type": "string",
"description": "Profile Picture Url"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"status": {
"type": "string",
"description": "The status value"
},
"userTitle": {
"type": "string",
"description": "User Title"
},
"version": {
"type": "number",
"description": "The version value"
}
},
"required": [
"PCID",
"id",
"representative_id"
]
}
buildops-service_put_v1_jobs_job_id
Update Job by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | Job ID |
accountingJobNumber | string | No | — | Accounting Job Number |
accountManagerId | string | No | — | Account Manager Id |
amountNotToExceed | number | No | — | Amount Not To Exceed |
amountPreTaxQuoted | number | No | — | Amount Pre Tax Quoted |
authorizedById | string | No | — | Authorized By Id |
billingCustomerId | string | No | — | Billing Customer Id |
blanketPOId | string | No | — | Blanket PO Id |
certifiedPayroll | boolean | No | — | Certified Payroll |
closeoutReport | boolean | No | — | Closeout Report |
costAmount | number | No | — | Cost Amount |
customerId | string | No | — | Customer Id |
customerPropertyId | string | No | — | Customer Property Id |
customerProvidedPONumber | string | No | — | Customer Provided PO Number |
customerProvidedWONumber | string | No | — | Customer Provided WO Number |
customerRepId | string | No | — | Customer Rep Id |
departmentIds | string[] | No | — | Department Ids |
detailedJobCostingEnabled | boolean | No | — | Detailed Job Costing Enabled |
dueDate | string | No | — | Due Date |
issueDescription | string | No | — | Issue Description |
isUseTaxable | boolean | No | — | Is Use Taxable |
jobTypeId | string | No | — | Job Type Id |
labourRateGroupId | string | No | — | Labour Rate Group Id |
ownerId | string | No | — | Owner Id |
preferredTechnicianId | string | No | — | Preferred Technician Id |
priceBookId | string | No | — | Price Book Id |
priority | string | No | — | The priority value |
serviceChannelDescription | string | No | — | Service Channel Description |
soldById | string | No | — | Sold By Id |
status | object | No | — | The status value |
taxAmountQuoted | number | No | — | Tax Amount Quoted |
totalBudgetedHours | number | No | — | Total Budgeted Hours |
version | integer | No | — | The version value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job ID"
},
"accountingJobNumber": {
"type": "string",
"description": "Accounting Job Number"
},
"accountManagerId": {
"type": "string",
"description": "Account Manager Id"
},
"amountNotToExceed": {
"type": "number",
"description": "Amount Not To Exceed"
},
"amountPreTaxQuoted": {
"type": "number",
"description": "Amount Pre Tax Quoted"
},
"authorizedById": {
"type": "string",
"description": "Authorized By Id"
},
"billingCustomerId": {
"type": "string",
"description": "Billing Customer Id"
},
"blanketPOId": {
"type": "string",
"description": "Blanket PO Id"
},
"certifiedPayroll": {
"type": "boolean",
"description": "Certified Payroll"
},
"closeoutReport": {
"type": "boolean",
"description": "Closeout Report"
},
"costAmount": {
"type": "number",
"description": "Cost Amount"
},
"customerId": {
"type": "string",
"description": "Customer Id"
},
"customerPropertyId": {
"type": "string",
"description": "Customer Property Id"
},
"customerProvidedPONumber": {
"type": "string",
"description": "Customer Provided PO Number"
},
"customerProvidedWONumber": {
"type": "string",
"description": "Customer Provided WO Number"
},
"customerRepId": {
"type": "string",
"description": "Customer Rep Id"
},
"departmentIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Department Ids"
},
"detailedJobCostingEnabled": {
"type": "boolean",
"description": "Detailed Job Costing Enabled"
},
"dueDate": {
"type": "string",
"description": "Due Date"
},
"issueDescription": {
"type": "string",
"description": "Issue Description"
},
"isUseTaxable": {
"type": "boolean",
"description": "Is Use Taxable"
},
"jobTypeId": {
"type": "string",
"description": "Job Type Id"
},
"labourRateGroupId": {
"type": "string",
"description": "Labour Rate Group Id"
},
"ownerId": {
"type": "string",
"description": "Owner Id"
},
"preferredTechnicianId": {
"type": "string",
"description": "Preferred Technician Id"
},
"priceBookId": {
"type": "string",
"description": "Price Book Id"
},
"priority": {
"type": "string",
"description": "The priority value"
},
"serviceChannelDescription": {
"type": "string",
"description": "Service Channel Description"
},
"soldById": {
"type": "string",
"description": "Sold By Id"
},
"status": {
"description": "The status value",
"enum": [
"Open",
"In Progress",
"On Hold",
"Canceled",
"Complete"
]
},
"taxAmountQuoted": {
"type": "number",
"description": "Tax Amount Quoted"
},
"totalBudgetedHours": {
"type": "number",
"description": "Total Budgeted Hours"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"jobId"
]
}
buildops-service_put_v1_products_id
Update a Product by Product ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID |
accountingRefId | string | No | — | Accounting Ref Id |
code | string | No | — | The code value |
costCodeId | string | No | — | Cost Code Id |
description | string | No | — | The description value |
itemGlGroupId | string | No | — | Item Gl Group Id |
jobCostTypeId | string | No | — | Job Cost Type Id |
markupType | string | No | — | Markup Type |
markupValue | number | No | — | Markup Value |
name | string | No | — | The name value |
revenueTypeId | string | No | — | Revenue Type Id |
syncStatus | string | No | — | Sync Status |
taxable | boolean | No | — | The taxable value |
unitCost | number | No | — | Unit Cost |
unitOfMeasureId | string | No | — | Unit Of Measure Id |
unitPrice | number | No | — | Unit Price |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"productId": {
"type": "string",
"description": "Product ID"
},
"accountingRefId": {
"type": "string",
"description": "Accounting Ref Id"
},
"code": {
"type": "string",
"description": "The code value"
},
"costCodeId": {
"type": "string",
"description": "Cost Code Id"
},
"description": {
"type": "string",
"description": "The description value"
},
"itemGlGroupId": {
"type": "string",
"description": "Item Gl Group Id"
},
"jobCostTypeId": {
"type": "string",
"description": "Job Cost Type Id"
},
"markupType": {
"type": "string",
"description": "Markup Type"
},
"markupValue": {
"type": "number",
"description": "Markup Value"
},
"name": {
"type": "string",
"description": "The name value"
},
"revenueTypeId": {
"type": "string",
"description": "Revenue Type Id"
},
"syncStatus": {
"type": "string",
"description": "Sync Status"
},
"taxable": {
"type": "boolean",
"description": "The taxable value"
},
"unitCost": {
"type": "number",
"description": "Unit Cost"
},
"unitOfMeasureId": {
"type": "string",
"description": "Unit Of Measure Id"
},
"unitPrice": {
"type": "number",
"description": "Unit Price"
}
},
"required": [
"PCID",
"productId"
]
}
buildops-service_put_v1_properties_id
Update Property By Property ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Property ID |
accountNumber | string | No | — | Account Number |
billingCustomerId | string | No | — | Billing Customer Id |
billTo | string | No | — | Bill To |
companyName | string | No | — | Company Name |
customerPropertyTypeValue | string | No | — | Customer Property Type Value |
isActive | boolean | No | — | Is Active |
isTaxable | boolean | No | — | Is Taxable |
priceBookId | string | No | — | Price Book Id |
sameAddress | boolean | No | — | Same Address |
status | string | No | — | The status value |
taxCodeId | string | No | — | Tax Code Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Property ID"
},
"accountNumber": {
"type": "string",
"description": "Account Number"
},
"billingCustomerId": {
"type": "string",
"description": "Billing Customer Id"
},
"billTo": {
"type": "string",
"description": "Bill To"
},
"companyName": {
"type": "string",
"description": "Company Name"
},
"customerPropertyTypeValue": {
"type": "string",
"description": "Customer Property Type Value"
},
"isActive": {
"type": "boolean",
"description": "Is Active"
},
"isTaxable": {
"type": "boolean",
"description": "Is Taxable"
},
"priceBookId": {
"type": "string",
"description": "Price Book Id"
},
"sameAddress": {
"type": "boolean",
"description": "Same Address"
},
"status": {
"type": "string",
"description": "The status value"
},
"taxCodeId": {
"type": "string",
"description": "Tax Code Id"
}
},
"required": [
"PCID",
"id"
]
}
buildops-service_put_v1_properties_id_representatives_representative_id
Update Customer Representative through property with representativeId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
representative_id | string | Yes | — | Customer Representative ID |
id | string | Yes | — | Property ID |
bestContact | string | No | — | Best Contact |
cellPhone | string | No | — | Cell Phone |
contactRole | string | No | — | Contact Role |
contactType | string | No | — | Contact Type |
email | string | No | — | The email value |
firstName | string | No | — | First Name |
isActive | boolean | No | — | Is Active |
isDoNotCall | boolean | No | — | Is Do Not Call |
isEmailOptOut | boolean | No | — | Is Email Opt Out |
isSmsOptOut | boolean | No | — | Is Sms Opt Out |
landlinePhone | string | No | — | Landline Phone |
lastName | string | No | — | Last Name |
middleName | string | No | — | Middle Name |
name | string | No | — | The name value |
nickName | string | No | — | Nick Name |
profilePictureUrl | string | No | — | Profile Picture Url |
salutation | string | No | — | The salutation value |
status | string | No | — | The status value |
userTitle | string | No | — | User Title |
version | number | No | — | The version value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"representative_id": {
"type": "string",
"description": "Customer Representative ID"
},
"id": {
"type": "string",
"description": "Property ID"
},
"bestContact": {
"type": "string",
"description": "Best Contact"
},
"cellPhone": {
"type": "string",
"description": "Cell Phone"
},
"contactRole": {
"type": "string",
"description": "Contact Role"
},
"contactType": {
"type": "string",
"description": "Contact Type"
},
"email": {
"type": "string",
"description": "The email value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"isActive": {
"type": "boolean",
"description": "Is Active"
},
"isDoNotCall": {
"type": "boolean",
"description": "Is Do Not Call"
},
"isEmailOptOut": {
"type": "boolean",
"description": "Is Email Opt Out"
},
"isSmsOptOut": {
"type": "boolean",
"description": "Is Sms Opt Out"
},
"landlinePhone": {
"type": "string",
"description": "Landline Phone"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"middleName": {
"type": "string",
"description": "Middle Name"
},
"name": {
"type": "string",
"description": "The name value"
},
"nickName": {
"type": "string",
"description": "Nick Name"
},
"profilePictureUrl": {
"type": "string",
"description": "Profile Picture Url"
},
"salutation": {
"type": "string",
"description": "The salutation value"
},
"status": {
"type": "string",
"description": "The status value"
},
"userTitle": {
"type": "string",
"description": "User Title"
},
"version": {
"type": "number",
"description": "The version value"
}
},
"required": [
"PCID",
"representative_id",
"id"
]
}
buildops-service_remove_v1_job_job_tag
Remove Job Tag from Job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | Job ID |
tagId | string | Yes | — | Job Tag ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job ID"
},
"tagId": {
"type": "string",
"description": "Job Tag ID"
}
},
"required": [
"PCID",
"jobId",
"tagId"
]
}
buildops-service_update_v1_task
Update task by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Task ID |
assetId | string | No | — | Asset Id |
description | string | No | — | The description value |
formIds | string[] | No | — | Form Ids |
name | string | No | — | The name value |
taskEntries | object[] | No | — | Task Entries |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "Task ID"
},
"assetId": {
"type": "string",
"description": "Asset Id"
},
"description": {
"type": "string",
"description": "The description value"
},
"formIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Form Ids"
},
"name": {
"type": "string",
"description": "The name value"
},
"taskEntries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product Id"
},
"description": {
"type": "string",
"description": "The description value"
},
"quantity": {
"type": "number",
"description": "The quantity value"
}
}
},
"description": "Task Entries"
}
},
"required": [
"PCID",
"taskId"
]
}
buildops-service_v1_get_customers_our_representatives
Get Our Representatives List by customerId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
id | string | Yes | — | Customer ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"id": {
"type": "string",
"description": "Customer ID"
}
},
"required": [
"PCID",
"id"
]
}