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