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

Tools

ToolDescription
buildops-projects_get_v1_change_ordersGet Change Order Requests List
buildops-projects_get_v1_change_orders_change_order_idGet Change Order Request by ID
buildops-projects_get_v1_projectsGet Projects List
buildops-projects_get_v1_projects_projec_idGet Project By Project ID
buildops-projects_get_v1_projects_project_id_cost_codesGet Cost Codes by Project ID
buildops-projects_get_v1_projects_project_id_phasesGet Project Phases List
buildops-projects_get_v1_projects_project_id_phases_phase_idGet Project Phases by Phase ID
buildops-projects_get_v1_projects_project_id_phases_phase_id_departmentsGet Project Phase Department List
buildops-projects_get_v1_projects_project_id_phases_phase_id_departments_department_idGet Project Phase Department by ID
buildops-projects_get_v1_projects_project_id_schedule_of_valuesGet Project Schedule of Values List
buildops-projects_get_v1_projects_project_id_schedule_of_values_schedule_of_value_idGet Project Schedule of Value by ID
buildops-projects_get_v1_purchase_orders_receiptsGet Purchase Orders Receipts List
buildops-projects_get_v1_purchase_orders_receipts_receipt_idGet Purchase Order Receipt By Receipt ID
buildops-projects_get_v1_wip_reports_company_settingsGet WIP Reports Company Settings
buildops-projects_get_v1_wip_reports_idGet WIP report by ID
buildops-projects_post_v1_quotesCreate a Quote
buildops-projects_put_v1_projects_project_idUpdate Project by Project ID
buildops-projects_put_v1_purchase_orders_receipts_receipt_idUpdate Purchase Orders Receipt
buildops-projects_put_v1_purchase_orders_receipts_receipt_id_billUpdates line items of the Bill (bill readback)
buildops-projects_quote_controller_get_all_quotesGet all Quotes
buildops-projects_quote_controller_get_quote_by_idGet Quote by ID

buildops-projects_get_v1_change_orders

Get Change Order Requests List Parameters:
ParameterTypeRequiredDefaultDescription
projectstringNoproject id
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
projectIdstringYesprojectId identifier

buildops-projects_get_v1_change_orders_change_order_id

Get Change Order Request by ID Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesprojectId identifier
changeOrderIdstringYeschangeOrderId identifier

buildops-projects_get_v1_projects

Get Projects List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
startstringNoISO 8601 string to filter data based on last modified date time
endstringNoISO 8601 string to filter data based on last modified date time
statusstringNoThe status of the entity
dateFilterTypestringNoThe filter type for the filtering based on different dates (possible values createdDateTime, lastUpdatedDateTime)
project_numberstringNoSearch project by project number
includePhasesbooleanNoInclude project phases in the response
includeCostCodesbooleanNoInclude project cost codes in the response
includePhaseCostCodesbooleanNoInclude phase-scoped cost codes with budget breakdown (ProjectPhaseDepartmentCostCode)

buildops-projects_get_v1_projects_projec_id

Get Project By Project ID Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject ID

buildops-projects_get_v1_projects_project_id_cost_codes

Get Cost Codes by Project ID Parameters:
ParameterTypeRequiredDefaultDescription
departmentobjectNodepartment id
phasesobjectNoThe phases value
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
projectIdstringYesprojectId identifier

buildops-projects_get_v1_projects_project_id_phases

Get Project Phases List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
departmentstringNoDepartment ID
projectIdstringYesprojectId identifier

buildops-projects_get_v1_projects_project_id_phases_phase_id

Get Project Phases by Phase ID Parameters:
ParameterTypeRequiredDefaultDescription
departmentstringNoDepartment ID
projectIdstringYesprojectId identifier
phaseIdstringYesphaseId identifier

buildops-projects_get_v1_projects_project_id_phases_phase_id_departments

Get Project Phase Department List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
projectIdstringYesprojectId identifier
phaseIdstringYesphaseId identifier

buildops-projects_get_v1_projects_project_id_phases_phase_id_departments_department_id

Get Project Phase Department by ID Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesprojectId identifier
phaseIdstringYesphaseId identifier
departmentIdstringYesdepartmentId identifier

buildops-projects_get_v1_projects_project_id_schedule_of_values

Get Project Schedule of Values List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
change_order_idstringNoIdentifier for the Change Order to filter
projectIdstringYesprojectId identifier

buildops-projects_get_v1_projects_project_id_schedule_of_values_schedule_of_value_id

Get Project Schedule of Value by ID Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesprojectId identifier
scheduleOfValueIdstringYesscheduleOfValueId identifier
includestringNoAllows to return relations

buildops-projects_get_v1_purchase_orders_receipts

Get Purchase Orders Receipts List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
startstringNoISO 8601 string to filter data based on last modified date time
endstringNoISO 8601 string to filter data based on last modified date time
statusstringNoFilter receipts by its status

buildops-projects_get_v1_purchase_orders_receipts_receipt_id

Get Purchase Order Receipt By Receipt ID Parameters:
ParameterTypeRequiredDefaultDescription
receiptIdstringYesReceipt ID
includestring[]NoAllows to return relations

buildops-projects_get_v1_wip_reports_company_settings

Get WIP Reports Company Settings

buildops-projects_get_v1_wip_reports_id

Get WIP report by ID Parameters:
ParameterTypeRequiredDefaultDescription
wipReportIdstringYeswipReportId identifier

buildops-projects_post_v1_quotes

Create a Quote Parameters:
ParameterTypeRequiredDefaultDescription
accountManagerIdstringNoAccount Manager ID (Employee)
billingCustomerIdstringNoCustomer ID. If not provided, the billing customer from property will be used.
blanketPOIdstringNoBlanket PO ID
customerPoNumberstringNoCustomer PO Number
departmentIdstringYesDepartment ID
descriptionstringNoInternal Notes field
discountsobject[]NoThe discounts value
dueDatestringNoDue Date
expirationDatestringNoExpiration Date
expirationLengthintegerNoExpiration (days)
issueDescriptionstringNoIssue Description
itemsobject[]NoThe items value
jobTypeIdstringNoJob Type ID
namestringNoTitle
orderedByIdstringNoCompany Representative / Ordered By ID
ownerIdstringNoProject Manager ID (Employee)
priceBookIdstringNoPricebook ID. If not provided, the pricebook from property, customer or default pricebook will be used.
propertyIdstringYesProperty ID
propertyRepIdstringNoProperty Representative
salesByIdstringNoSold By ID (Employee)
scopeOfWorkstringNoScope of Work
sectionsobject[]NoThe sections value
serviceAgreementIdstringNoService Agreement ID
serviceZoneIdsstring[]NoService Zone IDs. Required when Zone Management feature is enabled
taxRateIdstringNoTax Rate ID. If not provided, the property’s
versionLabelstringNoVersion title field

buildops-projects_put_v1_projects_project_id

Update Project by Project ID Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject ID
address1stringNoThe address1 value
address2stringNoThe address2 value
addressCitystringNoAddress City
addressPostalstringNoAddress Postal
addressStatestringNoAddress State
arBalanceintegerNoAr Balance
billingCustomerIdstringNoBilling Customer Id
contactNumberstringNoContact Number
customerIdstringNoCustomer Id
dateEndstringNoDate End
dateStartstringNoDate Start
departmentIdstringNoDepartment Id
descriptionstringNoThe description value
emailstringNoThe email value
entryForArchitectIdstringNoEntry For Architect Id
externalPONumberstringNoExternal PO Number
foremanIdstringNoForeman Id
gcProjectManagerIdstringNoGc Project Manager Id
gcSuperintendentIdstringNoGc Superintendent Id
imgUrlstringNoImg Url
namestringNoThe name value
numberstringNoThe number value
projectManagerIdstringNoProject Manager Id
projectOwnerIdstringNoProject Owner Id
projectProgressintegerNoProject Progress
projectSubtypeIdstringNoProject Subtype Id
projectTypeIdstringNoProject Type Id
propertyIdstringNoProperty Id
sendToIdstringNoSend To Id
statusstringNoThe status value

buildops-projects_put_v1_purchase_orders_receipts_receipt_id

Update Purchase Orders Receipt Parameters:
ParameterTypeRequiredDefaultDescription
receiptIdstringYesReceipt ID
accountingClosePeriodIdstringNoAccounting Close Period Id
approvalNotestringNoApproval Note
approvalNoteByIdstringNoApproval Note By Id
approvalNoteDateTimenumberNoApproval Note Date Time
approvalStatusstringNoApproval Status
defaultWarehouseIdstringNoDefault Warehouse Id
departmentIdstringNoDepartment Id
descriptionstringNoThe description value
freightstringNoThe freight value
invoiceAmountnumberNoInvoice Amount
isRecognizedbooleanNoIs Recognized
jobIdstringNoJob Id
paymentTermIdstringNoPayment Term Id
projectIdstringNoProject Id
receiptNumberstringNoReceipt Number
statusstringNoThe status value
taxRateIdstringNoTax Rate Id
transactionDatenumberNoTransaction Date
vendorDocumentNumberstringNoVendor Document Number
vendorIdstringNoVendor Id
visitIdstringNoVisit Id

buildops-projects_put_v1_purchase_orders_receipts_receipt_id_bill

Updates line items of the Bill (bill readback) Parameters:
ParameterTypeRequiredDefaultDescription
receiptIdstringYesReceipt ID
isImportedbooleanNoIs Imported
linesobject[]NoThe lines value

buildops-projects_quote_controller_get_all_quotes

Get all Quotes Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number for pagination
page_sizenumberNopage size
quote_numbernumberNoquote number

buildops-projects_quote_controller_get_quote_by_id

Get Quote by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesquoteId identifier