/buildops-projects | Type: Application | PCID required: Yes
Tools
buildops-projects_get_v1_change_orders
Get Change Order Requests List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | No | — | project id |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
projectId | string | Yes | — | projectId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project": {
"type": "string",
"description": "project id"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
}
},
"required": [
"PCID",
"projectId"
]
}
buildops-projects_get_v1_change_orders_change_order_id
Get Change Order Request by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | projectId identifier |
changeOrderId | string | Yes | — | changeOrderId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
},
"changeOrderId": {
"type": "string",
"description": "changeOrderId identifier"
}
},
"required": [
"PCID",
"projectId",
"changeOrderId"
]
}
buildops-projects_get_v1_projects
Get Projects List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
start | string | No | — | ISO 8601 string to filter data based on last modified date time |
end | string | No | — | ISO 8601 string to filter data based on last modified date time |
status | string | No | — | The status of the entity |
dateFilterType | string | No | — | The filter type for the filtering based on different dates (possible values createdDateTime, lastUpdatedDateTime) |
project_number | string | No | — | Search project by project number |
includePhases | boolean | No | — | Include project phases in the response |
includeCostCodes | boolean | No | — | Include project cost codes in the response |
includePhaseCostCodes | boolean | No | — | Include phase-scoped cost codes with budget breakdown (ProjectPhaseDepartmentCostCode) |
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"
},
"start": {
"type": "string",
"description": "ISO 8601 string to filter data based on last modified date time"
},
"end": {
"type": "string",
"description": "ISO 8601 string to filter data based on last modified date time"
},
"status": {
"type": "string",
"description": "The status of the entity"
},
"dateFilterType": {
"type": "string",
"description": "The filter type for the filtering based on different dates (possible values createdDateTime, lastUpdatedDateTime)"
},
"project_number": {
"type": "string",
"description": "Search project by project number"
},
"includePhases": {
"type": "boolean",
"description": "Include project phases in the response"
},
"includeCostCodes": {
"type": "boolean",
"description": "Include project cost codes in the response"
},
"includePhaseCostCodes": {
"type": "boolean",
"description": "Include phase-scoped cost codes with budget breakdown (ProjectPhaseDepartmentCostCode)"
}
},
"required": [
"PCID"
]
}
buildops-projects_get_v1_projects_projec_id
Get Project By Project ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project ID"
}
},
"required": [
"PCID",
"projectId"
]
}
buildops-projects_get_v1_projects_project_id_cost_codes
Get Cost Codes by Project ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
department | object | No | — | department id |
phases | object | No | — | The phases value |
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
projectId | string | Yes | — | projectId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"department": {
"description": "department id"
},
"phases": {
"description": "The phases value"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
}
},
"required": [
"PCID",
"projectId"
]
}
buildops-projects_get_v1_projects_project_id_phases
Get Project Phases List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
department | string | No | — | Department ID |
projectId | string | Yes | — | projectId identifier |
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"
},
"department": {
"type": "string",
"description": "Department ID"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
}
},
"required": [
"PCID",
"projectId"
]
}
buildops-projects_get_v1_projects_project_id_phases_phase_id
Get Project Phases by Phase ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
department | string | No | — | Department ID |
projectId | string | Yes | — | projectId identifier |
phaseId | string | Yes | — | phaseId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"department": {
"type": "string",
"description": "Department ID"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
},
"phaseId": {
"type": "string",
"description": "phaseId identifier"
}
},
"required": [
"PCID",
"projectId",
"phaseId"
]
}
buildops-projects_get_v1_projects_project_id_phases_phase_id_departments
Get Project Phase Department List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
projectId | string | Yes | — | projectId identifier |
phaseId | string | Yes | — | phaseId identifier |
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"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
},
"phaseId": {
"type": "string",
"description": "phaseId identifier"
}
},
"required": [
"PCID",
"projectId",
"phaseId"
]
}
buildops-projects_get_v1_projects_project_id_phases_phase_id_departments_department_id
Get Project Phase Department by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | projectId identifier |
phaseId | string | Yes | — | phaseId identifier |
departmentId | string | Yes | — | departmentId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
},
"phaseId": {
"type": "string",
"description": "phaseId identifier"
},
"departmentId": {
"type": "string",
"description": "departmentId identifier"
}
},
"required": [
"PCID",
"projectId",
"phaseId",
"departmentId"
]
}
buildops-projects_get_v1_projects_project_id_schedule_of_values
Get Project Schedule of Values List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
change_order_id | string | No | — | Identifier for the Change Order to filter |
projectId | string | Yes | — | projectId identifier |
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"
},
"change_order_id": {
"type": "string",
"description": "Identifier for the Change Order to filter"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
}
},
"required": [
"PCID",
"projectId"
]
}
buildops-projects_get_v1_projects_project_id_schedule_of_values_schedule_of_value_id
Get Project Schedule of Value by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | projectId identifier |
scheduleOfValueId | string | Yes | — | scheduleOfValueId identifier |
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"
},
"projectId": {
"type": "string",
"description": "projectId identifier"
},
"scheduleOfValueId": {
"type": "string",
"description": "scheduleOfValueId identifier"
},
"include": {
"type": "string",
"description": "Allows to return relations",
"enum": [
"lines"
]
}
},
"required": [
"PCID",
"projectId",
"scheduleOfValueId"
]
}
buildops-projects_get_v1_purchase_orders_receipts
Get Purchase Orders Receipts List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
start | string | No | — | ISO 8601 string to filter data based on last modified date time |
end | string | No | — | ISO 8601 string to filter data based on last modified date time |
status | string | No | — | Filter receipts by its status |
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"
},
"start": {
"type": "string",
"description": "ISO 8601 string to filter data based on last modified date time"
},
"end": {
"type": "string",
"description": "ISO 8601 string to filter data based on last modified date time"
},
"status": {
"type": "string",
"description": "Filter receipts by its status"
}
},
"required": [
"PCID"
]
}
buildops-projects_get_v1_purchase_orders_receipts_receipt_id
Get Purchase Order Receipt By Receipt ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receiptId | string | Yes | — | Receipt 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"
},
"receiptId": {
"type": "string",
"description": "Receipt ID"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"costCodes",
"jobCostTypes"
]
},
"description": "Allows to return relations"
}
},
"required": [
"PCID",
"receiptId"
]
}
buildops-projects_get_v1_wip_reports_company_settings
Get WIP Reports Company SettingsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
buildops-projects_get_v1_wip_reports_id
Get WIP report by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
wipReportId | string | Yes | — | wipReportId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"wipReportId": {
"type": "string",
"description": "wipReportId identifier"
}
},
"required": [
"PCID",
"wipReportId"
]
}
buildops-projects_post_v1_quotes
Create a Quote Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountManagerId | string | No | — | Account Manager ID (Employee) |
billingCustomerId | string | No | — | Customer ID. If not provided, the billing customer from property will be used. |
blanketPOId | string | No | — | Blanket PO ID |
customerPoNumber | string | No | — | Customer PO Number |
departmentId | string | Yes | — | Department ID |
description | string | No | — | Internal Notes field |
discounts | object[] | No | — | The discounts value |
dueDate | string | No | — | Due Date |
expirationDate | string | No | — | Expiration Date |
expirationLength | integer | No | — | Expiration (days) |
issueDescription | string | No | — | Issue Description |
items | object[] | No | — | The items value |
jobTypeId | string | No | — | Job Type ID |
name | string | No | — | Title |
orderedById | string | No | — | Company Representative / Ordered By ID |
ownerId | string | No | — | Project Manager ID (Employee) |
priceBookId | string | No | — | Pricebook ID. If not provided, the pricebook from property, customer or default pricebook will be used. |
propertyId | string | Yes | — | Property ID |
propertyRepId | string | No | — | Property Representative |
salesById | string | No | — | Sold By ID (Employee) |
scopeOfWork | string | No | — | Scope of Work |
sections | object[] | No | — | The sections value |
serviceAgreementId | string | No | — | Service Agreement ID |
serviceZoneIds | string[] | No | — | Service Zone IDs. Required when Zone Management feature is enabled |
taxRateId | string | No | — | Tax Rate ID. If not provided, the property’s |
versionLabel | string | No | — | Version title field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountManagerId": {
"type": "string",
"description": "Account Manager ID (Employee)"
},
"billingCustomerId": {
"type": "string",
"description": "Customer ID. If not provided, the billing customer from property will be used."
},
"blanketPOId": {
"type": "string",
"description": "Blanket PO ID"
},
"customerPoNumber": {
"type": "string",
"description": "Customer PO Number"
},
"departmentId": {
"type": "string",
"description": "Department ID"
},
"description": {
"type": "string",
"description": "Internal Notes field"
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"format": "uuid",
"description": "Product ID"
},
"description": {
"type": "string",
"description": "The description value"
},
"quantity": {
"type": "number",
"description": "The quantity value"
},
"unitCost": {
"type": "number",
"description": "Unit Cost"
},
"unitPrice": {
"type": "number",
"description": "Unit Price"
},
"taxable": {
"type": "boolean",
"description": "Is this item taxable?. If not provided, the product taxable will be used."
},
"costCodeId": {
"type": "string",
"format": "uuid",
"description": "Cost Code ID. If not provided, the product cost code will be used."
},
"jobCostTypeId": {
"type": "string",
"format": "uuid",
"description": "Job Cost Type ID. If not provided, the product job cost type will be used"
},
"revenueTypeId": {
"type": "string",
"format": "uuid",
"description": "Job Cost ID used for Revenue. If not provided, the product revenue type will be used."
},
"taxCodeId": {
"type": "string",
"format": "uuid",
"description": "Tax Code ID. Available only when line level tax feature is enabled."
},
"departmentId": {
"type": "string",
"format": "uuid",
"description": "Department ID. If not provided, the quote department will be used."
}
},
"required": [
"productId",
"quantity",
"unitCost",
"unitPrice"
]
},
"description": "The discounts value"
},
"dueDate": {
"type": "string",
"description": "Due Date"
},
"expirationDate": {
"type": "string",
"description": "Expiration Date"
},
"expirationLength": {
"type": "integer",
"description": "Expiration (days)"
},
"issueDescription": {
"type": "string",
"description": "Issue Description"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"format": "uuid",
"description": "Product ID"
},
"description": {
"type": "string",
"description": "The description value"
},
"quantity": {
"type": "number",
"description": "The quantity value"
},
"unitCost": {
"type": "number",
"description": "Unit Cost"
},
"unitPrice": {
"type": "number",
"description": "Unit Price"
},
"taxable": {
"type": "boolean",
"description": "Is this item taxable?. If not provided, the product taxable will be used."
},
"costCodeId": {
"type": "string",
"format": "uuid",
"description": "Cost Code ID. If not provided, the product cost code will be used."
},
"jobCostTypeId": {
"type": "string",
"format": "uuid",
"description": "Job Cost Type ID. If not provided, the product job cost type will be used"
},
"revenueTypeId": {
"type": "string",
"format": "uuid",
"description": "Job Cost ID used for Revenue. If not provided, the product revenue type will be used."
},
"taxCodeId": {
"type": "string",
"format": "uuid",
"description": "Tax Code ID. Available only when line level tax feature is enabled."
},
"departmentId": {
"type": "string",
"format": "uuid",
"description": "Department ID. If not provided, the quote department will be used."
}
},
"required": [
"productId",
"quantity",
"unitCost",
"unitPrice"
]
},
"description": "The items value"
},
"jobTypeId": {
"type": "string",
"description": "Job Type ID"
},
"name": {
"type": "string",
"description": "Title"
},
"orderedById": {
"type": "string",
"description": "Company Representative / Ordered By ID"
},
"ownerId": {
"type": "string",
"description": "Project Manager ID (Employee)"
},
"priceBookId": {
"type": "string",
"description": "Pricebook ID. If not provided, the pricebook from property, customer or default pricebook will be used."
},
"propertyId": {
"type": "string",
"description": "Property ID"
},
"propertyRepId": {
"type": "string",
"description": "Property Representative"
},
"salesById": {
"type": "string",
"description": "Sold By ID (Employee)"
},
"scopeOfWork": {
"type": "string",
"description": "Scope of Work"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Section name"
},
"description": {
"type": "string",
"description": "Section Description"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product ID"
},
"description": {
"type": "string"
},
"quantity": {
"type": "number"
},
"unitCost": {
"type": "number"
},
"unitPrice": {
"type": "number"
},
"taxable": {
"type": "boolean",
"description": "Is this item taxable?. If not provided, the product taxable will be used."
},
"costCodeId": {
"type": "string",
"description": "Cost Code ID. If not provided, the product cost code will be used."
},
"jobCostTypeId": {
"type": "string",
"description": "Job Cost Type ID. If not provided, the product job cost type will be used"
},
"revenueTypeId": {
"type": "string",
"description": "Job Cost ID used for Revenue. If not provided, the product revenue type will be used."
},
"taxCodeId": {
"type": "string",
"description": "Tax Code ID. Available only when line level tax feature is enabled."
},
"departmentId": {
"type": "string",
"description": "Department ID. If not provided, the quote department will be used."
}
}
},
"description": "The items value"
},
"laborItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"billingHours": {
"type": "number",
"description": "Billing Hours"
},
"payrollHours": {
"type": "number",
"description": "payroll hours"
},
"description": {
"type": "string"
},
"labourRateGroupId": {
"type": "string",
"description": "Labor Rate Group ID"
},
"labourTypeId": {
"type": "string",
"description": "Labor Type ID "
},
"jobCostTypeId": {
"type": "string",
"description": "Job Cost Type ID"
},
"payrollHourTypeId": {
"type": "string",
"description": "Payroll Hour Type ID"
},
"billingHourTypeId": {
"type": "string",
"description": "Billing Hour Type id. If not provided, the payroll to billing hour type mapping will be used"
},
"unitCost": {
"type": "number",
"description": "Unit Cost"
},
"unitPrice": {
"type": "number",
"description": "Unit Price"
},
"isTaxable": {
"type": "boolean"
},
"taxCodeId": {
"type": "string",
"description": "Tax Rate ID. Only available for tenants with multiple taxes enabled"
}
}
},
"description": "Labor Items"
}
}
},
"description": "The sections value"
},
"serviceAgreementId": {
"type": "string",
"description": "Service Agreement ID"
},
"serviceZoneIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Service Zone IDs. Required when Zone Management feature is enabled"
},
"taxRateId": {
"type": "string",
"description": "Tax Rate ID. If not provided, the property's"
},
"versionLabel": {
"type": "string",
"description": "Version title field"
}
},
"required": [
"PCID",
"departmentId",
"propertyId"
]
}
buildops-projects_put_v1_projects_project_id
Update Project by Project ID Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
projectId | string | Yes | — | Project ID | |
address1 | string | null | No | — | The address1 value |
address2 | string | null | No | — | The address2 value |
addressCity | string | null | No | — | Address City |
addressPostal | string | null | No | — | Address Postal |
addressState | string | null | No | — | Address State |
arBalance | integer | No | — | Ar Balance | |
billingCustomerId | string | No | — | Billing Customer Id | |
contactNumber | string | null | No | — | Contact Number |
customerId | string | null | No | — | Customer Id |
dateEnd | string | null | No | — | Date End |
dateStart | string | null | No | — | Date Start |
departmentId | string | No | — | Department Id | |
description | string | null | No | — | The description value |
email | string | null | No | — | The email value |
entryForArchitectId | string | null | No | — | Entry For Architect Id |
externalPONumber | string | null | No | — | External PO Number |
foremanId | string | null | No | — | Foreman Id |
gcProjectManagerId | string | null | No | — | Gc Project Manager Id |
gcSuperintendentId | string | null | No | — | Gc Superintendent Id |
imgUrl | string | null | No | — | Img Url |
name | string | No | — | The name value | |
number | string | null | No | — | The number value |
projectManagerId | string | No | — | Project Manager Id | |
projectOwnerId | string | null | No | — | Project Owner Id |
projectProgress | integer | No | — | Project Progress | |
projectSubtypeId | string | No | — | Project Subtype Id | |
projectTypeId | string | No | — | Project Type Id | |
propertyId | string | null | No | — | Property Id |
sendToId | string | null | No | — | Send To Id |
status | string | No | — | The status value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project ID"
},
"address1": {
"type": [
"string",
"null"
],
"description": "The address1 value"
},
"address2": {
"type": [
"string",
"null"
],
"description": "The address2 value"
},
"addressCity": {
"type": [
"string",
"null"
],
"description": "Address City"
},
"addressPostal": {
"type": [
"string",
"null"
],
"description": "Address Postal"
},
"addressState": {
"type": [
"string",
"null"
],
"description": "Address State"
},
"arBalance": {
"type": "integer",
"description": "Ar Balance"
},
"billingCustomerId": {
"type": "string",
"description": "Billing Customer Id"
},
"contactNumber": {
"type": [
"string",
"null"
],
"description": "Contact Number"
},
"customerId": {
"type": [
"string",
"null"
],
"description": "Customer Id"
},
"dateEnd": {
"type": [
"string",
"null"
],
"description": "Date End"
},
"dateStart": {
"type": [
"string",
"null"
],
"description": "Date Start"
},
"departmentId": {
"type": "string",
"description": "Department Id"
},
"description": {
"type": [
"string",
"null"
],
"description": "The description value"
},
"email": {
"type": [
"string",
"null"
],
"description": "The email value"
},
"entryForArchitectId": {
"type": [
"string",
"null"
],
"description": "Entry For Architect Id"
},
"externalPONumber": {
"type": [
"string",
"null"
],
"description": "External PO Number"
},
"foremanId": {
"type": [
"string",
"null"
],
"description": "Foreman Id"
},
"gcProjectManagerId": {
"type": [
"string",
"null"
],
"description": "Gc Project Manager Id"
},
"gcSuperintendentId": {
"type": [
"string",
"null"
],
"description": "Gc Superintendent Id"
},
"imgUrl": {
"type": [
"string",
"null"
],
"description": "Img Url"
},
"name": {
"type": "string",
"description": "The name value"
},
"number": {
"type": [
"string",
"null"
],
"description": "The number value"
},
"projectManagerId": {
"type": "string",
"description": "Project Manager Id"
},
"projectOwnerId": {
"type": [
"string",
"null"
],
"description": "Project Owner Id"
},
"projectProgress": {
"type": "integer",
"description": "Project Progress"
},
"projectSubtypeId": {
"type": "string",
"description": "Project Subtype Id"
},
"projectTypeId": {
"type": "string",
"description": "Project Type Id"
},
"propertyId": {
"type": [
"string",
"null"
],
"description": "Property Id"
},
"sendToId": {
"type": [
"string",
"null"
],
"description": "Send To Id"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"Bid",
"Accepted",
"Work In Progress",
"Work Complete",
"Closed",
"Void"
]
}
},
"required": [
"PCID",
"projectId"
]
}
buildops-projects_put_v1_purchase_orders_receipts_receipt_id
Update Purchase Orders Receipt Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
receiptId | string | Yes | — | Receipt ID | |
accountingClosePeriodId | string | null | No | — | Accounting Close Period Id |
approvalNote | string | null | No | — | Approval Note |
approvalNoteById | string | null | No | — | Approval Note By Id |
approvalNoteDateTime | number | null | No | — | Approval Note Date Time |
approvalStatus | string | null | No | — | Approval Status |
defaultWarehouseId | string | null | No | — | Default Warehouse Id |
departmentId | string | null | No | — | Department Id |
description | string | null | No | — | The description value |
freight | string | null | No | — | The freight value |
invoiceAmount | number | null | No | — | Invoice Amount |
isRecognized | boolean | null | No | — | Is Recognized |
jobId | string | null | No | — | Job Id |
paymentTermId | string | null | No | — | Payment Term Id |
projectId | string | null | No | — | Project Id |
receiptNumber | string | null | No | — | Receipt Number |
status | string | null | No | — | The status value |
taxRateId | string | null | No | — | Tax Rate Id |
transactionDate | number | null | No | — | Transaction Date |
vendorDocumentNumber | string | null | No | — | Vendor Document Number |
vendorId | string | null | No | — | Vendor Id |
visitId | string | null | No | — | Visit Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receiptId": {
"type": "string",
"description": "Receipt ID"
},
"accountingClosePeriodId": {
"type": [
"string",
"null"
],
"description": "Accounting Close Period Id"
},
"approvalNote": {
"type": [
"string",
"null"
],
"description": "Approval Note"
},
"approvalNoteById": {
"type": [
"string",
"null"
],
"description": "Approval Note By Id"
},
"approvalNoteDateTime": {
"type": [
"number",
"null"
],
"description": "Approval Note Date Time"
},
"approvalStatus": {
"type": [
"string",
"null"
],
"description": "Approval Status"
},
"defaultWarehouseId": {
"type": [
"string",
"null"
],
"description": "Default Warehouse Id"
},
"departmentId": {
"type": [
"string",
"null"
],
"description": "Department Id"
},
"description": {
"type": [
"string",
"null"
],
"description": "The description value"
},
"freight": {
"type": [
"string",
"null"
],
"description": "The freight value"
},
"invoiceAmount": {
"type": [
"number",
"null"
],
"description": "Invoice Amount"
},
"isRecognized": {
"type": [
"boolean",
"null"
],
"description": "Is Recognized"
},
"jobId": {
"type": [
"string",
"null"
],
"description": "Job Id"
},
"paymentTermId": {
"type": [
"string",
"null"
],
"description": "Payment Term Id"
},
"projectId": {
"type": [
"string",
"null"
],
"description": "Project Id"
},
"receiptNumber": {
"type": [
"string",
"null"
],
"description": "Receipt Number"
},
"status": {
"type": [
"string",
"null"
],
"description": "The status value"
},
"taxRateId": {
"type": [
"string",
"null"
],
"description": "Tax Rate Id"
},
"transactionDate": {
"type": [
"number",
"null"
],
"description": "Transaction Date"
},
"vendorDocumentNumber": {
"type": [
"string",
"null"
],
"description": "Vendor Document Number"
},
"vendorId": {
"type": [
"string",
"null"
],
"description": "Vendor Id"
},
"visitId": {
"type": [
"string",
"null"
],
"description": "Visit Id"
}
},
"required": [
"PCID",
"receiptId"
]
}
buildops-projects_put_v1_purchase_orders_receipts_receipt_id_bill
Updates line items of the Bill (bill readback) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receiptId | string | Yes | — | Receipt ID |
isImported | boolean | No | — | Is Imported |
lines | object[] | No | — | The lines value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receiptId": {
"type": "string",
"description": "Receipt ID"
},
"isImported": {
"type": "boolean",
"description": "Is Imported"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"purchaseOrderReceiptLineId": {
"type": "string",
"description": "Purchase Order Receipt Line Id"
},
"quantity": {
"type": "number",
"description": "The quantity value"
},
"unitCost": {
"type": "number",
"description": "Unit Cost"
},
"description": {
"type": "string",
"description": "The description value"
}
},
"required": [
"purchaseOrderReceiptLineId"
]
},
"description": "The lines value"
}
},
"required": [
"PCID",
"receiptId"
]
}
buildops-projects_quote_controller_get_all_quotes
Get all Quotes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number for pagination |
page_size | number | No | — | page size |
quote_number | number | No | — | quote number |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "number",
"description": "Page number for pagination"
},
"page_size": {
"type": "number",
"description": "page size"
},
"quote_number": {
"type": "number",
"description": "quote number"
}
},
"required": [
"PCID"
]
}
buildops-projects_quote_controller_get_quote_by_id
Get Quote by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | quoteId identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "quoteId identifier"
}
},
"required": [
"PCID",
"id"
]
}

