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

​
Tools

ToolDescription
buildops-inventory_bill_controller_public_bypass_bill_v1Bypass a bill
buildops-inventory_bill_controller_public_create_v1Create a bill
buildops-inventory_bill_controller_public_delete_v1Delete a bill by id
buildops-inventory_bill_controller_public_export_v1Mark Bill to be exported
buildops-inventory_bill_controller_public_find_by_id_v1Find a bill by id
buildops-inventory_bill_controller_public_post_v1Mark Bill as posted
buildops-inventory_bill_controller_public_update_by_id_v1Update a Bill
buildops-inventory_bill_controller_public_void_v1Void a bill
buildops-inventory_bill_line_controller_public_create_1_v1Create a bill line
buildops-inventory_bill_line_controller_public_delete_1_v1Delete a bill line by id
buildops-inventory_bill_line_controller_public_find_by_id_1_v1Find a bill line by id
buildops-inventory_bill_line_controller_public_update_1_v1Update a bill line by id
buildops-inventory_get_v1_purchase_ordersGet Purchase Orders List
buildops-inventory_get_v1_purchase_orders_purchase_order_idGet Purchase Order by ID
buildops-inventory_issue_line_controller_without_parent_public_get_inventory_issue_line_by_id_1_v1Find InventoryIssueLines by inventory issue line id
buildops-inventory_public_vendor_controller_public_createCreate a Vendor
buildops-inventory_public_vendor_controller_public_delete_by_idDelete a Vendor by ID
buildops-inventory_public_vendor_controller_public_findFind Vendors
buildops-inventory_public_vendor_controller_public_find_by_idFind a Vendor by ID
buildops-inventory_public_vendor_controller_public_patch_vendorPatch a Vendor
buildops-inventory_purchase_order_controller_public_create_1_v1Create a purchase order or subcontract
buildops-inventory_purchase_order_controller_public_find_by_id_1_v1Find a purchase order or subcontract by id
buildops-inventory_purchase_order_controller_public_void_1_v1Void a purchase order or subcontract
buildops-inventory_purchase_order_line_controller_public_create_1_v1Create multiple purchase order lines
buildops-inventory_purchase_order_line_controller_public_delete_by_id_1_v1Delete a purchase order line by id
buildops-inventory_purchase_order_line_controller_public_find_by_id_1_v1Find a purchase order line by id
buildops-inventory_purchase_order_line_controller_public_update_by_id_v2_1_v2Update a purchase order line by id
buildops-inventory_purchase_order_receipt_controller_public_create_2_v1Create a purchase order receipt
buildops-inventory_purchase_order_receipt_controller_public_delete_by_id_2_v1Delete Purchase Order Receipt by ID
buildops-inventory_purchase_order_receipt_controller_public_export_2_v1Export a purchase order receipt by id
buildops-inventory_purchase_order_receipt_controller_public_find_by_id_2_v1Find a purchase order receipt by id
buildops-inventory_purchase_order_receipt_controller_public_post_2_v1Post a purchase order receipt by id
buildops-inventory_purchase_order_receipt_line_controller_public_delete_by_id_1_v1Delete a purchase order receipt line by id
buildops-inventory_warehouse_controller_public_create_warehouse_v2_v2Create a warehouse with required departmentId
buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2Update a warehouse with required departmentId
buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2_v1Update a warehouse with required departmentId
buildops-inventory_warehouse_controller_public_get_by_id_v2_v2Get a warehouse by id for public api
buildops-inventory_warehouse_controller_public_get_by_id_v2_v2_v1Get a warehouse by id for public api
buildops-inventory_warehouse_controller_public_get_list_v1Get a warehouse List

​
buildops-inventory_bill_controller_public_bypass_bill_v1

Bypass a bill Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id

​
buildops-inventory_bill_controller_public_create_v1

Create a bill Parameters:
ParameterTypeRequiredDefaultDescription
accountingRefIdstringNo—Accounting Reference ID associated with this Bill
addressesobject[]No—The addresses of the bill, supported Billing, Shipping
amountDuenumberNo—Amount due
assignedToIdstringNo—Assigned To ID, maps to the Employee this Bill is assigned to
billLinesobject[]No—Bill Lines
createdByEmployeeIdstringNo—Created by Employee ID
defaultRetainagePercentnumberNo—Default retainage percent of the Bill
departmentIdstringYes—Department ID, required
descriptionstringNo—Description of the bill, free form text
dueDatenumberNo—Due date, the date the bill is due. Int, unix format
freightnumberNo—Freight cost, on a retirement path
idstringNo—The Bill UUID (mobile requirement)
isCreatedFromMobilebooleanNo—Is the bill created from mobile?
isImportedbooleanNo—Imported bill. Only used by accounting integrations to mark that a bill was imported by accounting integration
isRetainageApplicablebooleanNo—Whether retainage is applicable to the Bill
isRetainageBillbooleanNo—Whether the Bill is a retainage bill
isStandalonebooleanNo—Standalone bill. Only used by accounting integrations to mark that a bill has no purhasing document associated with it
issuedBynumberNo—Issued by, the date the bill is required to be issued by. Int, unix format
isUseTaxablebooleanNo—If Bill is use taxable
jobIdstringNo—Job ID, optional
parentBillIdstringNo—Parent bill ID
paymentTermIdstringNo—Payment Term ID, maps to PaymentTerm object
postingDatenumberNo—Posting Date, the date the bill is required to be created for the accounting integration. Int, unix format
projectIdstringNo—Project ID, optional
projectManagerIdstringNo—Project Manager ID, ID of the Employee who is the Project Manager
purchaseOrderIdstringNo—Purchase order ID, ID of the PurchaseOrder the bill is related to. Nullable if a standalone bill, required if a bill related to a PurchaseOrder
purchaseOrderReceiptIdstringNo—ID of the PurchaseOrderReceipt the bill is related to. Nullable if a standalone bill, required if a bill related to a PurchaseOrderReceipt
statusstringNo—The status value
syncStatusobjectNo—Accounting sync status of the bill
taxnumberNo—Tax amount
taxAmountOverriddennumberNo—Tax override, tax received from the vendor
taxRateIdstringNo—Tax rate ID, id of a valid TaxRate object, optional
taxRegionIdstringNo—Tax Region ID, ID of the sales tax region associated with this Bill
totalnumberNo—Total amount
totalCostnumberNo—Total cost
totalRetainageAmountnumberNo—Retainage amount of the Bill Line
vendorDocumentNumberstringNo—free text field, can be edited, serves to reflect the external vendor document number, optional
vendorIdstringYes—Vendor ID, id of a valid Vendor object, required

​
buildops-inventory_bill_controller_public_delete_v1

Delete a bill by id Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id

​
buildops-inventory_bill_controller_public_export_v1

Mark Bill to be exported Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id

​
buildops-inventory_bill_controller_public_find_by_id_v1

Find a bill by id Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id
includestring[]No—Related resources to include

​
buildops-inventory_bill_controller_public_post_v1

Mark Bill as posted Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id

​
buildops-inventory_bill_controller_public_update_by_id_v1

Update a Bill Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id
includestring[]No—Related resources to include
addressesobject[]No—The addresses of the bill, supported Billing, Shipping
amountDuenumberNo—Amount due
approvalNotestringNo—Approval note
approvalNoteByIdstringNo—Approval note by Employee ID
approvalNoteDateTimenumberNo—Approval note date time
approvalStatusstringNo—Bill Approval Status
assignedToIdstringNo—Assigned to ID
departmentIdstringNo—Department ID
descriptionstringNo—Description of the bill
dueDatenumberNo—Due date
equipmentIdstringNo—Equipment ID, maps to the Equipment associated with this BillLine
invoicedStatusstringNo—Invoiced Status
issuedBynumberNo—Issued by
isUseTaxablebooleanNo—Indicates if the item is taxable
jobIdstringNo—Job ID
orderedByIdstringNo—Ordered by ID
paymentTermIdstringNo—Payment term ID
postingDatenumberNo—Posting Date
projectIdstringNo—Project ID
projectManagerIdstringNo—Project manager ID
purchaseOrderIdstringNo—Purchase order ID
purchaseOrderReceiptIdstringNo—Purchase order receipt ID
statusstringNo—The status value
syncStatusstringNo—Sync Status
taxnumberNo—Tax amount
taxAmountOverriddennumberNo—Tax override, tax received from the vendor
taxRateIdstringNo—Tax rate ID
taxRegionIdstringNo—Tax Region ID, ID of the use tax region associated with this bill
totalCostnumberNo—Total cost
vendorDocumentNumberstringNo—Vendor document number
vendorIdstringNo—Vendor ID

​
buildops-inventory_bill_controller_public_void_v1

Void a bill Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id

​
buildops-inventory_bill_line_controller_public_create_1_v1

Create a bill line Parameters:
ParameterTypeRequiredDefaultDescription
billIdstringYes—Bill Id
accountingSystemLineIdstringNo—Accounting Reference ID associated with this BillLine
billingStatusstringNo—Billing status
costCodeIdstringNo—CostCode ID
departmentIdstringYes—Department ID
descriptionstringNo—Description of the bill line item
equipmentIdstringNo—Equipment ID, maps to the Equipment associated with this BillLine
idstringNo—The Bill Line UUID (mobile requirement)
isUseTaxablebooleanNo—Indicates if the bill line is taxable
jcCostTypeIdstringNo—JC Cost Type ID associated with the bill line
jcPhaseIdstringNo—JC Phase ID
jobCostTypeIdstringNo—JobCostType ID
jobIdstringNo—Job ID
lineNumbernumberYes—Line number
markupnumberNo—Markup percentage of the item
productIdstringYes—Product ID related to the bill line
projectCostCodeIdstringNo—Project cost code ID
projectCostTypestringNo—Project cost type
projectIdstringNo—Project ID
projectPhaseIdstringNo—Project phase ID
providerTaxCodeIdstringNo—Provider Tax Code ID
purchaseOrderLineIdstringNo—Purchase order line ID
purchaseOrderReceiptLineIdstringNo—Purchase order receipt line ID
quantitynumberYes—Quantity of the item
retainageAmountnumberNo—Retainage amount of the Bill Line
retainagePercentnumberNo—Retainage percent of the Bill Line
revenueTypeIdstringNo—RevenueType ID
taxablebooleanNo—Indicates if the item is taxable
taxAmountOverriddennumberNo—Sales tax amount that can be manually informed for this bill line
taxRegionIdstringNo—Tax Region ID, ID of the use tax region associated with this bill line
unitCostnumberYes—Unit cost of the item
unitOfMeasurestringNo—Unit of measure, a string
unitPricenumberNo—Unit price
workTaxabilityTypeIdstringNo—Work Taxability Type ID

​
buildops-inventory_bill_line_controller_public_delete_1_v1

Delete a bill line by id Parameters:
ParameterTypeRequiredDefaultDescription
billLineIdstringYes—Bill Line Id
resetBillSyncStatusIfThreeWayMatchingbooleanNo—Set the related Bill’s accounting sync status to null, which is required for some operations

​
buildops-inventory_bill_line_controller_public_find_by_id_1_v1

Find a bill line by id Parameters:
ParameterTypeRequiredDefaultDescription
billLineIdstringYes—Bill Line Id
includestring[]No—Related resources to include

​
buildops-inventory_bill_line_controller_public_update_1_v1

Update a bill line by id Parameters:
ParameterTypeRequiredDefaultDescription
billLineIdstringYes—Bill Line Id
resetBillSyncStatusIfThreeWayMatchingbooleanNo—Set the related Bill’s accounting sync status to null, which is required for some operations
accountingSystemLineIdstringNo—Accounting Reference ID associated with this BillLine
billingStatusstringNo—Billing status of the line item
costCodeIdstringNo—Cost Code ID of the bill line
departmentIdstringNo—Department ID of the bill line
descriptionstringNo—Line Item Description
equipmentIdstringNo—Equipment ID of the bill line
idstringNo—BuildOps ID of the bill line
invoiceQuantitynumberNo—Invoice quantity
isUseTaxablebooleanNo—Indicates if the bill line is taxable
itemGlGroupIdstringNo—The GL group id.
jobCloseoutDescriptionstringNo—Job Closeout Description
jobCloseoutTaxablebooleanNo—Job Closeout taxable
jobCostTypeIdstringNo—Job Code ID of the bill line
jobIdstringNo—Job ID of the bill line
markupnumberNo—Markup percentage of the item
productIdstringNo—Product ID of the bill line
projectCostCodeIdstringNo—Project Cost Code ID of the bill line
projectCostTypestringNo—Project Cost Type of the bill line
projectIdstringNo—Project ID of the bill line
projectPhaseIdstringNo—Project Phase ID of the bill line
providerTaxCodeIdstringNo—Provider Tax Code ID
purchaseOrderLineIdstringNo—Purchase Order Line ID
purchaseOrderReceiptLineIdstringNo—Purchase Order Receipt Line ID
quantitynumberNo—Quantity of the item
retainageAmountnumberNo—Retainage amount of the Bill Line
retainagePercentnumberNo—Retainage percent of the Bill Line
revenueTypeIdstringNo—Revenue Type ID of the bill line
taxablebooleanNo—The taxable value
taxAmountOverriddennumberNo—Sales tax amount that can be manually informed for this bill line
taxRegionIdstringNo—Tax Region ID, ID of the use tax region associated with this bill line
unitCostnumberNo—Unit Cost of the item
unitPricenumberNo—Unit Price of the item
versionnumberYes—Current version of the BillLine record
workTaxabilityTypeIdstringNo—Work Taxability Type ID

​
buildops-inventory_get_v1_purchase_orders

Get Purchase Orders List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNo—Page number for pagination
page_sizeintegerNo—Number of items per page
po_numberstringNo—Purchase Order Number
statusstringNo—Purchase Order Status

​
buildops-inventory_get_v1_purchase_orders_purchase_order_id

Get Purchase Order by ID Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderIdstringYes—purchaseOrderId identifier

​
buildops-inventory_issue_line_controller_without_parent_public_get_inventory_issue_line_by_id_1_v1

Find InventoryIssueLines by inventory issue line id Parameters:
ParameterTypeRequiredDefaultDescription
inventoryIssueLineIdstringYes—Inventory Issue Line Id

​
buildops-inventory_public_vendor_controller_public_create

Create a Vendor Parameters:
ParameterTypeRequiredDefaultDescription
accountingRefIdstringNo—The accounting system reference ID for the vendor
accountingRefIdOfVendorTypestringNo—The accounting reference ID for the vendor type
accountingVersionstringNo—The version of the accounting system integration
addressLine1stringNo—The first line of the vendor address
addressLine2stringNo—The second line of the vendor address (optional)
citystringNo—The city of the vendor address
defaultRetainagePercentnumberNo—The default retainage percentage for this vendor
emailstringNo—Email address for the vendor (must be valid email format)
faxstringNo—The fax number for the vendor
isRetainageApplicablebooleanNo—Whether retainage is applicable to this vendor
isUseTaxablebooleanNo—Whether purchases from this vendor are subject to use tax by default
namestringYes—The name of the vendor
notesstringNo—Additional notes or comments about the vendor
phonestringNo—The primary phone number for the vendor
primaryContactstringNo—The primary contact person at the vendor company
shippingAddressobjectNo—The shipping address for the vendor (separate from main address)
statestringNo—The state/province of the vendor address
syncStatusstringNo—The synchronization status with external accounting system
taxRegionIdstringNo—The UUID of the default tax region associated with this vendor
typestringNo—The type/category of the vendor (optional)
vendorCodestringNo—A unique code or identifier for the vendor (internal reference)
vendorTypeIdstringNo—The type id of the vendor.
zipcodestringNo—The postal/ZIP code of the vendor address

​
buildops-inventory_public_vendor_controller_public_delete_by_id

Delete a Vendor by ID Parameters:
ParameterTypeRequiredDefaultDescription
vendorIdstringYes—Vendor Id

​
buildops-inventory_public_vendor_controller_public_find

Find Vendors Parameters:
ParameterTypeRequiredDefaultDescription
include_inactivebooleanNo—Include Inactive
pagenumberNo—Page number for pagination
page_sizenumberNo—Number of results per page

​
buildops-inventory_public_vendor_controller_public_find_by_id

Find a Vendor by ID Parameters:
ParameterTypeRequiredDefaultDescription
vendorIdstringYes—Vendor Id

​
buildops-inventory_public_vendor_controller_public_patch_vendor

Patch a Vendor Parameters:
ParameterTypeRequiredDefaultDescription
vendorIdstringYes—Vendor Id
accountingRefIdOfVendorTypestringNo—The updated accounting reference ID for the vendor type
addressLine1stringNo—The updated first line of the vendor address
addressLine2stringNo—The updated second line of the vendor address (optional)
citystringNo—The updated city of the vendor address
defaultRetainagePercentnumberNo—The default retainage percentage for this vendor
emailstringNo—Email address for the vendor (must be valid email format)
faxstringNo—The updated fax number for the vendor
isActivebooleanNo—Whether the vendor is currently active and available for use
isRetainageApplicablebooleanNo—Whether retainage is applicable to this vendor
isUseTaxablebooleanNo—Whether purchases from this vendor are subject to use tax by default
namestringYes—The updated name of the vendor
notesstringNo—Updated additional notes or comments about the vendor
phonestringNo—The updated primary phone number for the vendor
primaryContactstringNo—The updated primary contact person at the vendor company
shippingAddressobjectNo—The updated shipping address for the vendor (separate from main address)
statestringNo—The updated state/province of the vendor address
taxRegionIdstringNo—The updated UUID of the default tax region associated with this vendor
typestringNo—The updated type/category of the vendor
vendorCodestringNo—A updated unique code or identifier for the vendor (internal reference)
vendorTypeIdstringNo—The type id of the vendor.
versionnumberNo—The version number for optimistic concurrency control
zipcodestringNo—The updated postal/ZIP code of the vendor address

​
buildops-inventory_purchase_order_controller_public_create_1_v1

Create a purchase order or subcontract Parameters:
ParameterTypeRequiredDefaultDescription
includestring[]No—Related resources to include
addressesobject[]No—The addresses of the bill, supported Billing, Shipping
addressLine1stringNo—Address line 1 for the Purchase Order
addressLine2stringNo—Address line 2 for the Purchase Order
assignedToIdstringNo—Employee id assigned to the Purchase Order
citystringNo—City for the Purchase Order
completionDatenumberNo—Date the subcontract work was completed, saved as a unix timestamp
customIdentifierstringNo—Custom identifier for the Purchase Order
dateAddednumberYes—Date the Purchase Order was created, saved as a unix timestamp (existing data already saved as timestamp)
dateOfPurchasenumberYes—Date the Purchase Order was purchased, saved as a unix timestamp (not necessarily the same as dateAdded)
defaultRetainagePercentnumberNo—Default retainage percent of the Subcontract
defaultWarehouseIdstringNo—Default warehouse id of Purchase Order (ff: warehouseStockInventoryEnabled)
departmentIdstringYes—Department id of Purchase Order
departmentNamestringNo—The name of the department
descriptionstringNo—Description for Purchase Order
directPayerSalesTaxbooleanNo—Direct payer sales tax for Purchase Order
effectiveDatenumberNo—Date the subcontract work started, saved as a unix timestamp
expectedByDatenumberNo—Expected by date for Purchase Order
freightnumberNo—Freight cost for Purchase Order
isFieldOrderbooleanNo—Whether a Purchase Order is a field order or not
isRetainageApplicablebooleanNo—Whether retainage is applicable to the Subcontract
isUseTaxablebooleanNo—Whether a Purchase Order is using useTaxable or not
jobIdstringNo—Job id of Purchase Order
orderedByIdstringNo—Ordered By ID of Purchase Order
originalTotalAmountnumberNo—Original total amount of the Subcontract
paymentTermIdstringNo—Payment Term id for the Subcontract
postingDatenumberNo—Posting date for the Purchase Order, saved as a unix timestamp
poTypeIdstringNo—PO type id of Purchase Order
projectIdstringNo—Project id of Purchase Order
projectManagerIdstringNo—Project manager id of Purchase Order
purchaseOrderLinesobject[]No—Purchase Order Lines
purchaseOrderTagsstring[]No—Purchase order tags for the Purchase Order
requiredByDatenumberNo—Date the Purchase Order is required by, saved as a unix timestamp (existing data already saved as timestamp)
shipTostringNo—Where the Purchase Order is shipping to
shipToEmployeeIdstringNo—Employee Id for where the Purchase Order is shipping to
shipToInstructionsstringNo—Shipping instructions for Purchase Order
shipToNamestringNo—Ship to name for the Purchase Order
shipToNameTypestringNo—Type of receipient for Purchase Order (not necessarily an enum)
statestringNo—State (address) of the Purchase Order
statusstringNo—Status for the Purchase Order
subcontractSubcontractTagsstring[]No—Subcontract tags for the Subcontract
taxnumberNo—Tax amount for the Purchase Order
taxAmountOverriddennumberNo—Tax override, tax received from the vendor
taxRateIdstringNo—Tax rate id for the Purchase Order
taxRegionIdstringNo—Tax region id for the Purchase Order
templateIdstringNo—Tenant Purchase Order Template id
totalAmountPreTaxnumberNo—The total amount before tax for the Purchase Order
totalCostnumberNo—The total cost of the Purchase Order
typestringNo—Type of Purchase Order
vendorDocumentNumberstringNo—External vendor reference or project code
vendorIdstringYes—Vendor for the Purchase Order
zipcodestringNo—Zipcode for the Purchase Order

​
buildops-inventory_purchase_order_controller_public_find_by_id_1_v1

Find a purchase order or subcontract by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderIdstringYes—Purchase Order Id
includestring[]No—Related resources to include

​
buildops-inventory_purchase_order_controller_public_void_1_v1

Void a purchase order or subcontract Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderIdstringYes—Purchase Order Id
voidDatenumberNo—The date the purchase order was voided

​
buildops-inventory_purchase_order_line_controller_public_create_1_v1

Create multiple purchase order lines Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]Yes—Purchase order lines to create

​
buildops-inventory_purchase_order_line_controller_public_delete_by_id_1_v1

Delete a purchase order line by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderLineIdstringYes—Purchase Order Line Id

​
buildops-inventory_purchase_order_line_controller_public_find_by_id_1_v1

Find a purchase order line by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderLineIdstringYes—Purchase Order Line Id
includestring[]No—Related resources to include

​
buildops-inventory_purchase_order_line_controller_public_update_by_id_v2_1_v2

Update a purchase order line by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderLineIdstringYes—Purchase Order Line Id
amountnumberNo—Amount for the item (quantity * unit cost)
billingStatusstringNo—The billing status of the purchase order line
costCodeIdstringNo—Cost code ID
departmentIdstringNo—Department ID
departmentNamestringNo—Department name
descriptionstringNo—The description of the purchase order line
equipmentIdstringNo—Equipment ID if associated
equipmentNamestringNo—Equipment name if associated
includeInInvoicebooleanNo—Whether to include PO Line in invoice or not
invoiceQuantitynumberNo—Invoice quantity
isUseTaxablebooleanNo—Indicates if use taxable applies
itemNamestringNo—Item name
jcCostTypeIdstringNo—JC Cost type ID
jcPhaseIdstringNo—JC Phase ID
jobCloseoutDescriptionstringNo—Job closeout description if applicable, otherwise null
jobCostTypeIdstringNo—Job cost type ID
jobIdstringNo—Job ID
lineNumbernumberNo—Line number of the item
lineTypestringNo—The line type
markupnumberNo—Markup percentage of the item
parentIdstringNo—Parent ID
productIdstringNo—Product ID
projectCostCodeIdstringNo—Project Cost Code ID
projectCostTypestringNo—Project cost type
projectIdstringNo—Project ID
projectPhaseIdstringNo—Project Phase ID
providerTaxCodeIdstringNo—Provider tax code ID
quantitynumberNo—Quantity of the item
quantityFulfillednumberNo—Quantity fulfilled
retainageAmountnumberNo—subcontract purchase order line retainage amount if applicable, otherwise null
retainagePercentnumberNo—subcontract purchase order line retainage percent if applicable, otherwise null
revenueTypeIdstringNo—Revenue type ID
statusstringNo—Purchase Order Line status
taxablebooleanNo—Whether the item is taxable
taxAmountOverriddennumberNo—Sales tax amount that can be manually informed for this purchase order line
taxRegionIdstringNo—Tax region ID
unitCostnumberNo—Unit cost of the item
unitOfMeasurestringNo—Unit of measure
unitPricenumberNo—Unit Price of the item
workTaxabilityTypeIdstringNo—Work taxability type ID

​
buildops-inventory_purchase_order_receipt_controller_public_create_2_v1

Create a purchase order receipt Parameters:
ParameterTypeRequiredDefaultDescription
addressesobject[]No—The addresses of the bill, supported Billing, Shipping
approvalNoteByIdstringNo—Approval note by ID
approvalNoteDateTimenumberNo—Approval note date time
approvalStatusstringNo—Approval status
assignedToIdstringNo—Assigned to ID
createdBystringNo—User who created the order
defaultWarehouseIdstringNo—Default warehouse ID
departmentIdstringNo—Department ID
descriptionstringNo—The description value
freightnumberNo—Freight cost
intacctLocationIdstringNo—Intacct Location ID
invoiceAmountnumberNo—Invoice amount
issuedBynumberNo—Issued by timestamp (Unix time)
isUseTaxablebooleanNo—Indicates if the tax is applicable
jobIdstringNo—Job ID
lastUpdatedBystringNo—User who last updated the order
parentIdstringYes—Parent ID
paymentTermIdstringNo—Payment term ID
postingDatenumberNo—Posting Date timestamp (Unix time)
projectIdstringNo—Project ID
purchaseOrderReceiptLinesobject[]No—Purchase Order Receipt Lines
receiptNumberstringYes—Receipt number
statusstringNo—Order status
syncStatusstringNo—Sync Status
taxnumberNo—Tax amount
taxAmountOverriddennumberNo—Tax amount overridden
taxRateIdstringNo—Tax rate ID
taxRegionIdstringNo—Tax region ID
vendorDocumentAttachmentIdstringNo—Vendor document attachment ID
vendorDocumentNumberstringNo—Vendor document number
vendorIdstringNo—Vendor ID

​
buildops-inventory_purchase_order_receipt_controller_public_delete_by_id_2_v1

Delete Purchase Order Receipt by ID Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderReceiptIdstringYes—Purchase Order Receipt Id

​
buildops-inventory_purchase_order_receipt_controller_public_export_2_v1

Export a purchase order receipt by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderReceiptIdstringYes—Purchase Order Receipt Id

​
buildops-inventory_purchase_order_receipt_controller_public_find_by_id_2_v1

Find a purchase order receipt by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderReceiptIdstringYes—Purchase Order Receipt Id
includestring[]No—Related resources to include

​
buildops-inventory_purchase_order_receipt_controller_public_post_2_v1

Post a purchase order receipt by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderReceiptIdstringYes—Purchase Order Receipt Id

​
buildops-inventory_purchase_order_receipt_line_controller_public_delete_by_id_1_v1

Delete a purchase order receipt line by id Parameters:
ParameterTypeRequiredDefaultDescription
purchaseOrderReceiptLineIdstringYes—Purchase Order Receipt Line Id

​
buildops-inventory_warehouse_controller_public_create_warehouse_v2_v2

Create a warehouse with required departmentId Parameters:
ParameterTypeRequiredDefaultDescription
accountingRefIdstringNo—The accounting system reference ID for the warehouse
addressobjectNo—The physical address location of the warehouse
departmentIdstringNo—The UUID of the department that owns or manages this warehouse
employeeIdsstring[]No—Array of employee UUIDs who have access to or work at this warehouse
namestringYes—The name of the warehouse (must be unique within the organization)
productBundleIdstringNo—The UUID of the product bundle associated with this warehouse for inventory tracking
typestringNo—The type/category of the warehouse (fixed location or mobile)

​
buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2

Update a warehouse with required departmentId Parameters:
ParameterTypeRequiredDefaultDescription
warehouseIdstringYes—Warehouse Id
addressobjectNo—The address of the warehouse.
departmentIdstringNo—Existing Department id
employeeIdsstring[]No—Technician ids
namestringNo—Warehouse name
typestringNo—Warehouse Type

​
buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2_v1

Update a warehouse with required departmentId Parameters:
ParameterTypeRequiredDefaultDescription
warehouseIdstringYes—Warehouse Id
addressobjectNo—The address of the warehouse.
departmentIdstringNo—Existing Department id
employeeIdsstring[]No—Technician ids
namestringNo—Warehouse name
typestringNo—Warehouse Type

​
buildops-inventory_warehouse_controller_public_get_by_id_v2_v2

Get a warehouse by id for public api Parameters:
ParameterTypeRequiredDefaultDescription
warehouseIdstringYes—Warehouse Id
includestring[]Yes—Related resources to include

​
buildops-inventory_warehouse_controller_public_get_by_id_v2_v2_v1

Get a warehouse by id for public api Parameters:
ParameterTypeRequiredDefaultDescription
warehouseIdstringYes—Warehouse Id
includestring[]Yes—Related resources to include

​
buildops-inventory_warehouse_controller_public_get_list_v1

Get a warehouse List Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberYes—The page number.
page_sizenumberYes—The page size.