> ## 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-inventory > BuildOps Inventory - warehouses, bills, purchase orders, receipts, vendors **Server path:** `/buildops-inventory` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | [`buildops-inventory_bill_controller_public_bypass_bill_v1`](#buildops-inventory_bill_controller_public_bypass_bill_v1) | Bypass a bill | | [`buildops-inventory_bill_controller_public_create_v1`](#buildops-inventory_bill_controller_public_create_v1) | Create a bill | | [`buildops-inventory_bill_controller_public_delete_v1`](#buildops-inventory_bill_controller_public_delete_v1) | Delete a bill by id | | [`buildops-inventory_bill_controller_public_export_v1`](#buildops-inventory_bill_controller_public_export_v1) | Mark Bill to be exported | | [`buildops-inventory_bill_controller_public_find_by_id_v1`](#buildops-inventory_bill_controller_public_find_by_id_v1) | Find a bill by id | | [`buildops-inventory_bill_controller_public_post_v1`](#buildops-inventory_bill_controller_public_post_v1) | Mark Bill as posted | | [`buildops-inventory_bill_controller_public_update_by_id_v1`](#buildops-inventory_bill_controller_public_update_by_id_v1) | Update a Bill | | [`buildops-inventory_bill_controller_public_void_v1`](#buildops-inventory_bill_controller_public_void_v1) | Void a bill | | [`buildops-inventory_bill_line_controller_public_create_1_v1`](#buildops-inventory_bill_line_controller_public_create_1_v1) | Create a bill line | | [`buildops-inventory_bill_line_controller_public_delete_1_v1`](#buildops-inventory_bill_line_controller_public_delete_1_v1) | Delete a bill line by id | | [`buildops-inventory_bill_line_controller_public_find_by_id_1_v1`](#buildops-inventory_bill_line_controller_public_find_by_id_1_v1) | Find a bill line by id | | [`buildops-inventory_bill_line_controller_public_update_1_v1`](#buildops-inventory_bill_line_controller_public_update_1_v1) | Update a bill line by id | | [`buildops-inventory_get_v1_purchase_orders`](#buildops-inventory_get_v1_purchase_orders) | Get Purchase Orders List | | [`buildops-inventory_get_v1_purchase_orders_purchase_order_id`](#buildops-inventory_get_v1_purchase_orders_purchase_order_id) | Get Purchase Order by ID | | [`buildops-inventory_issue_line_controller_without_parent_public_get_inventory_issue_line_by_id_1_v1`](#buildops-inventory_issue_line_controller_without_parent_public_get_inventory_issue_line_by_id_1_v1) | Find InventoryIssueLines by inventory issue line id | | [`buildops-inventory_public_vendor_controller_public_create`](#buildops-inventory_public_vendor_controller_public_create) | Create a Vendor | | [`buildops-inventory_public_vendor_controller_public_delete_by_id`](#buildops-inventory_public_vendor_controller_public_delete_by_id) | Delete a Vendor by ID | | [`buildops-inventory_public_vendor_controller_public_find`](#buildops-inventory_public_vendor_controller_public_find) | Find Vendors | | [`buildops-inventory_public_vendor_controller_public_find_by_id`](#buildops-inventory_public_vendor_controller_public_find_by_id) | Find a Vendor by ID | | [`buildops-inventory_public_vendor_controller_public_patch_vendor`](#buildops-inventory_public_vendor_controller_public_patch_vendor) | Patch a Vendor | | [`buildops-inventory_purchase_order_controller_public_create_1_v1`](#buildops-inventory_purchase_order_controller_public_create_1_v1) | Create a purchase order or subcontract | | [`buildops-inventory_purchase_order_controller_public_find_by_id_1_v1`](#buildops-inventory_purchase_order_controller_public_find_by_id_1_v1) | Find a purchase order or subcontract by id | | [`buildops-inventory_purchase_order_controller_public_void_1_v1`](#buildops-inventory_purchase_order_controller_public_void_1_v1) | Void a purchase order or subcontract | | [`buildops-inventory_purchase_order_line_controller_public_create_1_v1`](#buildops-inventory_purchase_order_line_controller_public_create_1_v1) | Create multiple purchase order lines | | [`buildops-inventory_purchase_order_line_controller_public_delete_by_id_1_v1`](#buildops-inventory_purchase_order_line_controller_public_delete_by_id_1_v1) | Delete a purchase order line by id | | [`buildops-inventory_purchase_order_line_controller_public_find_by_id_1_v1`](#buildops-inventory_purchase_order_line_controller_public_find_by_id_1_v1) | Find a purchase order line by id | | [`buildops-inventory_purchase_order_line_controller_public_update_by_id_v2_1_v2`](#buildops-inventory_purchase_order_line_controller_public_update_by_id_v2_1_v2) | Update a purchase order line by id | | [`buildops-inventory_purchase_order_receipt_controller_public_create_2_v1`](#buildops-inventory_purchase_order_receipt_controller_public_create_2_v1) | Create a purchase order receipt | | [`buildops-inventory_purchase_order_receipt_controller_public_delete_by_id_2_v1`](#buildops-inventory_purchase_order_receipt_controller_public_delete_by_id_2_v1) | Delete Purchase Order Receipt by ID | | [`buildops-inventory_purchase_order_receipt_controller_public_export_2_v1`](#buildops-inventory_purchase_order_receipt_controller_public_export_2_v1) | Export a purchase order receipt by id | | [`buildops-inventory_purchase_order_receipt_controller_public_find_by_id_2_v1`](#buildops-inventory_purchase_order_receipt_controller_public_find_by_id_2_v1) | Find a purchase order receipt by id | | [`buildops-inventory_purchase_order_receipt_controller_public_post_2_v1`](#buildops-inventory_purchase_order_receipt_controller_public_post_2_v1) | Post a purchase order receipt by id | | [`buildops-inventory_purchase_order_receipt_line_controller_public_delete_by_id_1_v1`](#buildops-inventory_purchase_order_receipt_line_controller_public_delete_by_id_1_v1) | Delete a purchase order receipt line by id | | [`buildops-inventory_warehouse_controller_public_create_warehouse_v2_v2`](#buildops-inventory_warehouse_controller_public_create_warehouse_v2_v2) | Create a warehouse with required departmentId | | [`buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2`](#buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2) | Update a warehouse with required departmentId | | [`buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2_v1`](#buildops-inventory_warehouse_controller_public_edit_warehouse_v2_v2_v1) | Update a warehouse with required departmentId | | [`buildops-inventory_warehouse_controller_public_get_by_id_v2_v2`](#buildops-inventory_warehouse_controller_public_get_by_id_v2_v2) | Get a warehouse by id for public api | | [`buildops-inventory_warehouse_controller_public_get_by_id_v2_v2_v1`](#buildops-inventory_warehouse_controller_public_get_by_id_v2_v2_v1) | Get a warehouse by id for public api | | [`buildops-inventory_warehouse_controller_public_get_list_v1`](#buildops-inventory_warehouse_controller_public_get_list_v1) | Get a warehouse List | *** ## buildops-inventory\_bill\_controller\_public\_bypass\_bill\_v1 Bypass a bill **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `billId` | string | Yes | — | Bill Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_create\_v1 Create a bill **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | `accountingRefId` | string | No | — | Accounting Reference ID associated with this Bill | | | `addresses` | object\[] | No | — | The addresses of the bill, supported Billing, Shipping | | | `amountDue` | number | null | No | — | Amount due | | `assignedToId` | string | No | — | Assigned To ID, maps to the Employee this Bill is assigned to | | | `billLines` | object\[] | No | — | Bill Lines | | | `createdByEmployeeId` | string | No | — | Created by Employee ID | | | `defaultRetainagePercent` | number | No | — | Default retainage percent of the Bill | | | `departmentId` | string | Yes | — | Department ID, required | | | `description` | string | No | — | Description of the bill, free form text | | | `dueDate` | number | No | — | Due date, the date the bill is due. Int, unix format | | | `freight` | number | No | — | Freight cost, on a retirement path | | | `id` | string | No | — | The Bill UUID (mobile requirement) | | | `isCreatedFromMobile` | boolean | No | — | Is the bill created from mobile? | | | `isImported` | boolean | No | — | Imported bill. Only used by accounting integrations to mark that a bill was imported by accounting integration | | | `isRetainageApplicable` | boolean | No | — | Whether retainage is applicable to the Bill | | | `isRetainageBill` | boolean | No | — | Whether the Bill is a retainage bill | | | `isStandalone` | boolean | No | — | Standalone bill. Only used by accounting integrations to mark that a bill has no purhasing document associated with it | | | `issuedBy` | number | No | — | Issued by, the date the bill is required to be issued by. Int, unix format | | | `isUseTaxable` | boolean | No | — | If Bill is use taxable | | | `jobId` | string | No | — | Job ID, optional | | | `parentBillId` | string | No | — | Parent bill ID | | | `paymentTermId` | string | No | — | Payment Term ID, maps to PaymentTerm object | | | `postingDate` | number | No | — | Posting Date, the date the bill is required to be created for the accounting integration. Int, unix format | | | `projectId` | string | No | — | Project ID, optional | | | `projectManagerId` | string | No | — | Project Manager ID, ID of the Employee who is the Project Manager | | | `purchaseOrderId` | string | No | — | 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 | | | `purchaseOrderReceiptId` | string | No | — | ID of the PurchaseOrderReceipt the bill is related to. Nullable if a standalone bill, required if a bill related to a PurchaseOrderReceipt | | | `status` | string | No | — | The status value | | | `syncStatus` | object | No | — | Accounting sync status of the bill | | | `tax` | number | No | — | Tax amount | | | `taxAmountOverridden` | number | No | — | Tax override, tax received from the vendor | | | `taxRateId` | string | No | — | Tax rate ID, id of a valid TaxRate object, optional | | | `taxRegionId` | string | No | — | Tax Region ID, ID of the sales tax region associated with this Bill | | | `total` | number | No | — | Total amount | | | `totalCost` | number | No | — | Total cost | | | `totalRetainageAmount` | number | No | — | Retainage amount of the Bill Line | | | `vendorDocumentNumber` | string | No | — | free text field, can be edited, serves to reflect the external vendor document number, optional | | | `vendorId` | string | Yes | — | Vendor ID, id of a valid Vendor object, required | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountingRefId": { "type": "string", "description": "Accounting Reference ID associated with this Bill" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The id value" }, "tenantId": { "type": "string", "format": "uuid", "description": "Tenant Id" }, "audit": { "type": "object", "description": "The audit value" }, "addressLine1": { "type": "string", "description": "The address line 1" }, "addressLine2": { "type": "string", "description": "The address complement" }, "city": { "type": "string", "description": "The city of the address" }, "state": { "type": "string", "description": "The state of the address" }, "zipcode": { "type": "string", "description": "The postal code of the address" }, "addressType": { "type": "string", "enum": [ "billingAddress", "shippingAddress" ], "description": "The type of address" } }, "required": [ "id", "audit", "addressLine1", "addressLine2", "city", "state", "zipcode", "addressType" ] }, "description": "The addresses of the bill, supported Billing, Shipping" }, "amountDue": { "type": [ "number", "null" ], "description": "Amount due" }, "assignedToId": { "type": "string", "description": "Assigned To ID, maps to the Employee this Bill is assigned to" }, "billLines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The Bill Line UUID (mobile requirement)" }, "description": { "type": "string", "description": "Description of the bill line item" }, "quantity": { "type": "number", "description": "Quantity of the item" }, "lineNumber": { "type": "number", "description": "Line number" }, "unitCost": { "type": "number", "description": "Unit cost of the item" }, "unitPrice": { "type": "number", "description": "Unit price" }, "taxable": { "type": "boolean", "description": "Indicates if the item is taxable" }, "markup": { "type": "number", "description": "Markup percentage of the item" }, "taxRegionId": { "type": "string", "description": "Tax Region ID, ID of the use tax region associated with this bill line" }, "taxAmountOverridden": { "type": "number", "description": "Sales tax amount that can be manually informed for this bill line" }, "productId": { "type": "string", "description": "Product ID related to the bill line" }, "providerTaxCodeId": { "type": "string", "format": "uuid", "description": "Provider Tax Code ID" }, "costCodeId": { "type": "string", "description": "CostCode ID" }, "departmentId": { "type": "string", "description": "Department ID" }, "jobId": { "type": "string", "description": "Job ID" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure, a string" }, "jobCostTypeId": { "type": "string", "description": "JobCostType ID" }, "revenueTypeId": { "type": "string", "description": "RevenueType ID" }, "projectPhaseId": { "type": "string", "description": "Project phase ID" }, "projectCostCodeId": { "type": "string", "description": "Project cost code ID" }, "projectCostType": { "type": "string", "description": "Project cost type" }, "projectId": { "type": "string", "description": "Project ID" }, "purchaseOrderLineId": { "type": "string", "description": "Purchase order line ID" }, "purchaseOrderReceiptLineId": { "type": "string", "description": "Purchase order receipt line ID" }, "equipmentId": { "type": "string", "description": "Equipment ID, maps to the Equipment associated with this BillLine" }, "accountingSystemLineId": { "type": "string", "description": "Accounting Reference ID associated with this BillLine" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the bill line is taxable" }, "workTaxabilityTypeId": { "type": "string", "format": "uuid", "description": "Work Taxability Type ID" }, "jcPhaseId": { "type": "string", "description": "JC Phase ID" }, "jcCostTypeId": { "type": "string", "description": "JC Cost Type ID associated with the bill line" }, "billingStatus": { "type": "string", "enum": [ "NotInvoiced", "Billed", "DoNotInvoice" ], "description": "Billing status" }, "retainagePercent": { "type": "number", "description": "Retainage percent of the Bill Line" }, "retainageAmount": { "type": "number", "description": "Retainage amount of the Bill Line" } }, "required": [ "quantity", "lineNumber", "unitCost", "productId", "departmentId" ] }, "description": "Bill Lines" }, "createdByEmployeeId": { "type": "string", "description": "Created by Employee ID" }, "defaultRetainagePercent": { "type": "number", "description": "Default retainage percent of the Bill" }, "departmentId": { "type": "string", "description": "Department ID, required" }, "description": { "type": "string", "description": "Description of the bill, free form text" }, "dueDate": { "type": "number", "description": "Due date, the date the bill is due. Int, unix format" }, "freight": { "type": "number", "description": "Freight cost, on a retirement path" }, "id": { "type": "string", "description": "The Bill UUID (mobile requirement)" }, "isCreatedFromMobile": { "type": "boolean", "description": "Is the bill created from mobile?" }, "isImported": { "type": "boolean", "description": "Imported bill. Only used by accounting integrations to mark that a bill was imported by accounting integration" }, "isRetainageApplicable": { "type": "boolean", "description": "Whether retainage is applicable to the Bill" }, "isRetainageBill": { "type": "boolean", "description": "Whether the Bill is a retainage bill" }, "isStandalone": { "type": "boolean", "description": "Standalone bill. Only used by accounting integrations to mark that a bill has no purhasing document associated with it" }, "issuedBy": { "type": "number", "description": "Issued by, the date the bill is required to be issued by. Int, unix format" }, "isUseTaxable": { "type": "boolean", "description": "If Bill is use taxable" }, "jobId": { "type": "string", "description": "Job ID, optional" }, "parentBillId": { "type": "string", "description": "Parent bill ID" }, "paymentTermId": { "type": "string", "description": "Payment Term ID, maps to PaymentTerm object" }, "postingDate": { "type": "number", "description": "Posting Date, the date the bill is required to be created for the accounting integration. Int, unix format" }, "projectId": { "type": "string", "description": "Project ID, optional" }, "projectManagerId": { "type": "string", "description": "Project Manager ID, ID of the Employee who is the Project Manager" }, "purchaseOrderId": { "type": "string", "description": "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" }, "purchaseOrderReceiptId": { "type": "string", "description": "ID of the PurchaseOrderReceipt the bill is related to. Nullable if a standalone bill, required if a bill related to a PurchaseOrderReceipt" }, "status": { "type": "string", "description": "The status value", "enum": [ "Exported", "Pending", "Posted", "Void", "Closed", "Draft", "Bypassed" ] }, "syncStatus": { "description": "Accounting sync status of the bill" }, "tax": { "type": "number", "description": "Tax amount" }, "taxAmountOverridden": { "type": "number", "description": "Tax override, tax received from the vendor" }, "taxRateId": { "type": "string", "description": "Tax rate ID, id of a valid TaxRate object, optional" }, "taxRegionId": { "type": "string", "description": "Tax Region ID, ID of the sales tax region associated with this Bill" }, "total": { "type": "number", "description": "Total amount" }, "totalCost": { "type": "number", "description": "Total cost" }, "totalRetainageAmount": { "type": "number", "description": "Retainage amount of the Bill Line" }, "vendorDocumentNumber": { "type": "string", "description": "free text field, can be edited, serves to reflect the external vendor document number, optional" }, "vendorId": { "type": "string", "description": "Vendor ID, id of a valid Vendor object, required" } }, "required": [ "PCID", "departmentId", "vendorId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_delete\_v1 Delete a bill by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `billId` | string | Yes | — | Bill Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_export\_v1 Mark Bill to be exported **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `billId` | string | Yes | — | Bill Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_find\_by\_id\_v1 Find a bill by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------- | | `billId` | string | Yes | — | Bill Id | | `include` | string\[] | No | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "Related resources to include" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_post\_v1 Mark Bill as posted **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `billId` | string | Yes | — | Bill Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_update\_by\_id\_v1 Update a Bill **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------- | ---------- | | `billId` | string | Yes | — | Bill Id | | | `include` | string\[] | No | — | Related resources to include | | | `addresses` | object\[] | No | — | The addresses of the bill, supported Billing, Shipping | | | `amountDue` | number | null | No | — | Amount due | | `approvalNote` | string | No | — | Approval note | | | `approvalNoteById` | string | No | — | Approval note by Employee ID | | | `approvalNoteDateTime` | number | No | — | Approval note date time | | | `approvalStatus` | string | No | — | Bill Approval Status | | | `assignedToId` | string | No | — | Assigned to ID | | | `departmentId` | string | No | — | Department ID | | | `description` | string | No | — | Description of the bill | | | `dueDate` | number | No | — | Due date | | | `equipmentId` | string | No | — | Equipment ID, maps to the Equipment associated with this BillLine | | | `invoicedStatus` | string | No | — | Invoiced Status | | | `issuedBy` | number | No | — | Issued by | | | `isUseTaxable` | boolean | No | — | Indicates if the item is taxable | | | `jobId` | string | No | — | Job ID | | | `orderedById` | string | No | — | Ordered by ID | | | `paymentTermId` | string | No | — | Payment term ID | | | `postingDate` | number | No | — | Posting Date | | | `projectId` | string | No | — | Project ID | | | `projectManagerId` | string | No | — | Project manager ID | | | `purchaseOrderId` | string | No | — | Purchase order ID | | | `purchaseOrderReceiptId` | string | No | — | Purchase order receipt ID | | | `status` | string | No | — | The status value | | | `syncStatus` | string | No | — | Sync Status | | | `tax` | number | No | — | Tax amount | | | `taxAmountOverridden` | number | No | — | Tax override, tax received from the vendor | | | `taxRateId` | string | No | — | Tax rate ID | | | `taxRegionId` | string | No | — | Tax Region ID, ID of the use tax region associated with this bill | | | `totalCost` | number | No | — | Total cost | | | `vendorDocumentNumber` | string | No | — | Vendor document number | | | `vendorId` | string | No | — | Vendor ID | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "Related resources to include" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The id value" }, "tenantId": { "type": "string", "format": "uuid", "description": "Tenant Id" }, "audit": { "type": "object", "description": "The audit value" }, "addressLine1": { "type": "string", "description": "The address line 1" }, "addressLine2": { "type": "string", "description": "The address complement" }, "city": { "type": "string", "description": "The city of the address" }, "state": { "type": "string", "description": "The state of the address" }, "zipcode": { "type": "string", "description": "The postal code of the address" }, "addressType": { "type": "string", "enum": [ "billingAddress", "shippingAddress" ], "description": "The type of address" } }, "required": [ "id", "audit", "addressLine1", "addressLine2", "city", "state", "zipcode", "addressType" ] }, "description": "The addresses of the bill, supported Billing, Shipping" }, "amountDue": { "type": [ "number", "null" ], "description": "Amount due" }, "approvalNote": { "type": "string", "description": "Approval note" }, "approvalNoteById": { "type": "string", "description": "Approval note by Employee ID" }, "approvalNoteDateTime": { "type": "number", "description": "Approval note date time" }, "approvalStatus": { "type": "string", "description": "Bill Approval Status" }, "assignedToId": { "type": "string", "description": "Assigned to ID" }, "departmentId": { "type": "string", "description": "Department ID" }, "description": { "type": "string", "description": "Description of the bill" }, "dueDate": { "type": "number", "description": "Due date" }, "equipmentId": { "type": "string", "description": "Equipment ID, maps to the Equipment associated with this BillLine" }, "invoicedStatus": { "type": "string", "description": "Invoiced Status" }, "issuedBy": { "type": "number", "description": "Issued by" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the item is taxable" }, "jobId": { "type": "string", "description": "Job ID" }, "orderedById": { "type": "string", "description": "Ordered by ID" }, "paymentTermId": { "type": "string", "description": "Payment term ID" }, "postingDate": { "type": "number", "description": "Posting Date" }, "projectId": { "type": "string", "description": "Project ID" }, "projectManagerId": { "type": "string", "description": "Project manager ID" }, "purchaseOrderId": { "type": "string", "description": "Purchase order ID" }, "purchaseOrderReceiptId": { "type": "string", "description": "Purchase order receipt ID" }, "status": { "type": "string", "description": "The status value", "enum": [ "Exported", "Pending", "Posted", "Void", "Closed", "Draft", "Bypassed" ] }, "syncStatus": { "type": "string", "description": "Sync Status", "enum": [ "Syncing", "InSync", "SyncFailed", "Bypassed" ] }, "tax": { "type": "number", "description": "Tax amount" }, "taxAmountOverridden": { "type": "number", "description": "Tax override, tax received from the vendor" }, "taxRateId": { "type": "string", "description": "Tax rate ID" }, "taxRegionId": { "type": "string", "description": "Tax Region ID, ID of the use tax region associated with this bill" }, "totalCost": { "type": "number", "description": "Total cost" }, "vendorDocumentNumber": { "type": "string", "description": "Vendor document number" }, "vendorId": { "type": "string", "description": "Vendor ID" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_controller\_public\_void\_v1 Void a bill **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `billId` | string | Yes | — | Bill Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" } }, "required": [ "PCID", "billId" ] } ``` *** ## buildops-inventory\_bill\_line\_controller\_public\_create\_1\_v1 Create a bill line **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------- | | `billId` | string | Yes | — | Bill Id | | `accountingSystemLineId` | string | No | — | Accounting Reference ID associated with this BillLine | | `billingStatus` | string | No | — | Billing status | | `costCodeId` | string | No | — | CostCode ID | | `departmentId` | string | Yes | — | Department ID | | `description` | string | No | — | Description of the bill line item | | `equipmentId` | string | No | — | Equipment ID, maps to the Equipment associated with this BillLine | | `id` | string | No | — | The Bill Line UUID (mobile requirement) | | `isUseTaxable` | boolean | No | — | Indicates if the bill line is taxable | | `jcCostTypeId` | string | No | — | JC Cost Type ID associated with the bill line | | `jcPhaseId` | string | No | — | JC Phase ID | | `jobCostTypeId` | string | No | — | JobCostType ID | | `jobId` | string | No | — | Job ID | | `lineNumber` | number | Yes | — | Line number | | `markup` | number | No | — | Markup percentage of the item | | `productId` | string | Yes | — | Product ID related to the bill line | | `projectCostCodeId` | string | No | — | Project cost code ID | | `projectCostType` | string | No | — | Project cost type | | `projectId` | string | No | — | Project ID | | `projectPhaseId` | string | No | — | Project phase ID | | `providerTaxCodeId` | string | No | — | Provider Tax Code ID | | `purchaseOrderLineId` | string | No | — | Purchase order line ID | | `purchaseOrderReceiptLineId` | string | No | — | Purchase order receipt line ID | | `quantity` | number | Yes | — | Quantity of the item | | `retainageAmount` | number | No | — | Retainage amount of the Bill Line | | `retainagePercent` | number | No | — | Retainage percent of the Bill Line | | `revenueTypeId` | string | No | — | RevenueType ID | | `taxable` | boolean | No | — | Indicates if the item is taxable | | `taxAmountOverridden` | number | No | — | Sales tax amount that can be manually informed for this bill line | | `taxRegionId` | string | No | — | Tax Region ID, ID of the use tax region associated with this bill line | | `unitCost` | number | Yes | — | Unit cost of the item | | `unitOfMeasure` | string | No | — | Unit of measure, a string | | `unitPrice` | number | No | — | Unit price | | `workTaxabilityTypeId` | string | No | — | Work Taxability Type ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billId": { "type": "string", "description": "Bill Id" }, "accountingSystemLineId": { "type": "string", "description": "Accounting Reference ID associated with this BillLine" }, "billingStatus": { "type": "string", "description": "Billing status", "enum": [ "NotInvoiced", "Billed", "DoNotInvoice" ] }, "costCodeId": { "type": "string", "description": "CostCode ID" }, "departmentId": { "type": "string", "description": "Department ID" }, "description": { "type": "string", "description": "Description of the bill line item" }, "equipmentId": { "type": "string", "description": "Equipment ID, maps to the Equipment associated with this BillLine" }, "id": { "type": "string", "description": "The Bill Line UUID (mobile requirement)" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the bill line is taxable" }, "jcCostTypeId": { "type": "string", "description": "JC Cost Type ID associated with the bill line" }, "jcPhaseId": { "type": "string", "description": "JC Phase ID" }, "jobCostTypeId": { "type": "string", "description": "JobCostType ID" }, "jobId": { "type": "string", "description": "Job ID" }, "lineNumber": { "type": "number", "description": "Line number" }, "markup": { "type": "number", "description": "Markup percentage of the item" }, "productId": { "type": "string", "description": "Product ID related to the bill line" }, "projectCostCodeId": { "type": "string", "description": "Project cost code ID" }, "projectCostType": { "type": "string", "description": "Project cost type" }, "projectId": { "type": "string", "description": "Project ID" }, "projectPhaseId": { "type": "string", "description": "Project phase ID" }, "providerTaxCodeId": { "type": "string", "description": "Provider Tax Code ID" }, "purchaseOrderLineId": { "type": "string", "description": "Purchase order line ID" }, "purchaseOrderReceiptLineId": { "type": "string", "description": "Purchase order receipt line ID" }, "quantity": { "type": "number", "description": "Quantity of the item" }, "retainageAmount": { "type": "number", "description": "Retainage amount of the Bill Line" }, "retainagePercent": { "type": "number", "description": "Retainage percent of the Bill Line" }, "revenueTypeId": { "type": "string", "description": "RevenueType ID" }, "taxable": { "type": "boolean", "description": "Indicates if the item is taxable" }, "taxAmountOverridden": { "type": "number", "description": "Sales tax amount that can be manually informed for this bill line" }, "taxRegionId": { "type": "string", "description": "Tax Region ID, ID of the use tax region associated with this bill line" }, "unitCost": { "type": "number", "description": "Unit cost of the item" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure, a string" }, "unitPrice": { "type": "number", "description": "Unit price" }, "workTaxabilityTypeId": { "type": "string", "description": "Work Taxability Type ID" } }, "required": [ "PCID", "billId", "departmentId", "lineNumber", "productId", "quantity", "unitCost" ] } ``` *** ## buildops-inventory\_bill\_line\_controller\_public\_delete\_1\_v1 Delete a bill line by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------- | | `billLineId` | string | Yes | — | Bill Line Id | | `resetBillSyncStatusIfThreeWayMatching` | boolean | No | — | Set the related Bill's accounting sync status to null, which is required for some operations | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billLineId": { "type": "string", "description": "Bill Line Id" }, "resetBillSyncStatusIfThreeWayMatching": { "type": "boolean", "description": "Set the related Bill's accounting sync status to null, which is required for some operations" } }, "required": [ "PCID", "billLineId" ] } ``` *** ## buildops-inventory\_bill\_line\_controller\_public\_find\_by\_id\_1\_v1 Find a bill line by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ---------------------------- | | `billLineId` | string | Yes | — | Bill Line Id | | `include` | string\[] | No | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billLineId": { "type": "string", "description": "Bill Line Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "Related resources to include" } }, "required": [ "PCID", "billLineId" ] } ``` *** ## buildops-inventory\_bill\_line\_controller\_public\_update\_1\_v1 Update a bill line by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------- | | `billLineId` | string | Yes | — | Bill Line Id | | `resetBillSyncStatusIfThreeWayMatching` | boolean | No | — | Set the related Bill's accounting sync status to null, which is required for some operations | | `accountingSystemLineId` | string | No | — | Accounting Reference ID associated with this BillLine | | `billingStatus` | string | No | — | Billing status of the line item | | `costCodeId` | string | No | — | Cost Code ID of the bill line | | `departmentId` | string | No | — | Department ID of the bill line | | `description` | string | No | — | Line Item Description | | `equipmentId` | string | No | — | Equipment ID of the bill line | | `id` | string | No | — | BuildOps ID of the bill line | | `invoiceQuantity` | number | No | — | Invoice quantity | | `isUseTaxable` | boolean | No | — | Indicates if the bill line is taxable | | `itemGlGroupId` | string | No | — | The GL group id. | | `jobCloseoutDescription` | string | No | — | Job Closeout Description | | `jobCloseoutTaxable` | boolean | No | — | Job Closeout taxable | | `jobCostTypeId` | string | No | — | Job Code ID of the bill line | | `jobId` | string | No | — | Job ID of the bill line | | `markup` | number | No | — | Markup percentage of the item | | `productId` | string | No | — | Product ID of the bill line | | `projectCostCodeId` | string | No | — | Project Cost Code ID of the bill line | | `projectCostType` | string | No | — | Project Cost Type of the bill line | | `projectId` | string | No | — | Project ID of the bill line | | `projectPhaseId` | string | No | — | Project Phase ID of the bill line | | `providerTaxCodeId` | string | No | — | Provider Tax Code ID | | `purchaseOrderLineId` | string | No | — | Purchase Order Line ID | | `purchaseOrderReceiptLineId` | string | No | — | Purchase Order Receipt Line ID | | `quantity` | number | No | — | Quantity of the item | | `retainageAmount` | number | No | — | Retainage amount of the Bill Line | | `retainagePercent` | number | No | — | Retainage percent of the Bill Line | | `revenueTypeId` | string | No | — | Revenue Type ID of the bill line | | `taxable` | boolean | No | — | The taxable value | | `taxAmountOverridden` | number | No | — | Sales tax amount that can be manually informed for this bill line | | `taxRegionId` | string | No | — | Tax Region ID, ID of the use tax region associated with this bill line | | `unitCost` | number | No | — | Unit Cost of the item | | `unitPrice` | number | No | — | Unit Price of the item | | `version` | number | Yes | — | Current version of the BillLine record | | `workTaxabilityTypeId` | string | No | — | Work Taxability Type ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billLineId": { "type": "string", "description": "Bill Line Id" }, "resetBillSyncStatusIfThreeWayMatching": { "type": "boolean", "description": "Set the related Bill's accounting sync status to null, which is required for some operations" }, "accountingSystemLineId": { "type": "string", "description": "Accounting Reference ID associated with this BillLine" }, "billingStatus": { "type": "string", "description": "Billing status of the line item", "enum": [ "NotInvoiced", "Billed", "DoNotInvoice" ] }, "costCodeId": { "type": "string", "description": "Cost Code ID of the bill line" }, "departmentId": { "type": "string", "description": "Department ID of the bill line" }, "description": { "type": "string", "description": "Line Item Description" }, "equipmentId": { "type": "string", "description": "Equipment ID of the bill line" }, "id": { "type": "string", "description": "BuildOps ID of the bill line" }, "invoiceQuantity": { "type": "number", "description": "Invoice quantity" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the bill line is taxable" }, "itemGlGroupId": { "type": "string", "description": "The GL group id." }, "jobCloseoutDescription": { "type": "string", "description": "Job Closeout Description" }, "jobCloseoutTaxable": { "type": "boolean", "description": "Job Closeout taxable" }, "jobCostTypeId": { "type": "string", "description": "Job Code ID of the bill line" }, "jobId": { "type": "string", "description": "Job ID of the bill line" }, "markup": { "type": "number", "description": "Markup percentage of the item" }, "productId": { "type": "string", "description": "Product ID of the bill line" }, "projectCostCodeId": { "type": "string", "description": "Project Cost Code ID of the bill line" }, "projectCostType": { "type": "string", "description": "Project Cost Type of the bill line" }, "projectId": { "type": "string", "description": "Project ID of the bill line" }, "projectPhaseId": { "type": "string", "description": "Project Phase ID of the bill line" }, "providerTaxCodeId": { "type": "string", "description": "Provider Tax Code ID" }, "purchaseOrderLineId": { "type": "string", "description": "Purchase Order Line ID" }, "purchaseOrderReceiptLineId": { "type": "string", "description": "Purchase Order Receipt Line ID" }, "quantity": { "type": "number", "description": "Quantity of the item" }, "retainageAmount": { "type": "number", "description": "Retainage amount of the Bill Line" }, "retainagePercent": { "type": "number", "description": "Retainage percent of the Bill Line" }, "revenueTypeId": { "type": "string", "description": "Revenue Type ID of the bill line" }, "taxable": { "type": "boolean", "description": "The taxable value" }, "taxAmountOverridden": { "type": "number", "description": "Sales tax amount that can be manually informed for this bill line" }, "taxRegionId": { "type": "string", "description": "Tax Region ID, ID of the use tax region associated with this bill line" }, "unitCost": { "type": "number", "description": "Unit Cost of the item" }, "unitPrice": { "type": "number", "description": "Unit Price of the item" }, "version": { "type": "number", "description": "Current version of the BillLine record" }, "workTaxabilityTypeId": { "type": "string", "description": "Work Taxability Type ID" } }, "required": [ "PCID", "billLineId", "version" ] } ``` *** ## buildops-inventory\_get\_v1\_purchase\_orders Get Purchase Orders List **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------------- | | `page` | integer | No | — | Page number for pagination | | `page_size` | integer | No | — | Number of items per page | | `po_number` | string | No | — | Purchase Order Number | | `status` | string | No | — | Purchase Order Status | ```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" }, "po_number": { "type": "string", "description": "Purchase Order Number" }, "status": { "type": "string", "description": "Purchase Order Status" } }, "required": [ "PCID" ] } ``` *** ## buildops-inventory\_get\_v1\_purchase\_orders\_purchase\_order\_id Get Purchase Order by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------- | | `purchaseOrderId` | string | Yes | — | purchaseOrderId identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderId": { "type": "string", "description": "purchaseOrderId identifier" } }, "required": [ "PCID", "purchaseOrderId" ] } ``` *** ## buildops-inventory\_issue\_line\_controller\_without\_parent\_public\_get\_inventory\_issue\_line\_by\_id\_1\_v1 Find InventoryIssueLines by inventory issue line id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | ----------------------- | | `inventoryIssueLineId` | string | Yes | — | Inventory Issue Line Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventoryIssueLineId": { "type": "string", "description": "Inventory Issue Line Id" } }, "required": [ "PCID", "inventoryIssueLineId" ] } ``` *** ## buildops-inventory\_public\_vendor\_controller\_public\_create Create a Vendor **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------- | -------------------------------------------------------------- | | `accountingRefId` | string | No | — | The accounting system reference ID for the vendor | | | `accountingRefIdOfVendorType` | string | No | — | The accounting reference ID for the vendor type | | | `accountingVersion` | string | No | — | The version of the accounting system integration | | | `addressLine1` | string | null | No | — | The first line of the vendor address | | `addressLine2` | string | null | No | — | The second line of the vendor address (optional) | | `city` | string | null | No | — | The city of the vendor address | | `defaultRetainagePercent` | number | No | — | The default retainage percentage for this vendor | | | `email` | string | No | — | Email address for the vendor (must be valid email format) | | | `fax` | string | null | No | — | The fax number for the vendor | | `isRetainageApplicable` | boolean | No | — | Whether retainage is applicable to this vendor | | | `isUseTaxable` | boolean | No | — | Whether purchases from this vendor are subject to use tax by default | | | `name` | string | Yes | — | The name of the vendor | | | `notes` | string | null | No | — | Additional notes or comments about the vendor | | `phone` | string | null | No | — | The primary phone number for the vendor | | `primaryContact` | string | null | No | — | The primary contact person at the vendor company | | `shippingAddress` | object | No | — | The shipping address for the vendor (separate from main address) | | | `state` | string | null | No | — | The state/province of the vendor address | | `syncStatus` | string | No | — | The synchronization status with external accounting system | | | `taxRegionId` | string | null | No | — | The UUID of the default tax region associated with this vendor | | `type` | string | null | No | — | The type/category of the vendor (optional) | | `vendorCode` | string | No | — | A unique code or identifier for the vendor (internal reference) | | | `vendorTypeId` | string | No | — | The type id of the vendor. | | | `zipcode` | string | null | No | — | The postal/ZIP code of the vendor address | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountingRefId": { "type": "string", "description": "The accounting system reference ID for the vendor" }, "accountingRefIdOfVendorType": { "type": "string", "description": "The accounting reference ID for the vendor type" }, "accountingVersion": { "type": "string", "description": "The version of the accounting system integration" }, "addressLine1": { "type": [ "string", "null" ], "description": "The first line of the vendor address" }, "addressLine2": { "type": [ "string", "null" ], "description": "The second line of the vendor address (optional)" }, "city": { "type": [ "string", "null" ], "description": "The city of the vendor address" }, "defaultRetainagePercent": { "type": "number", "description": "The default retainage percentage for this vendor" }, "email": { "type": "string", "description": "Email address for the vendor (must be valid email format)" }, "fax": { "type": [ "string", "null" ], "description": "The fax number for the vendor" }, "isRetainageApplicable": { "type": "boolean", "description": "Whether retainage is applicable to this vendor" }, "isUseTaxable": { "type": "boolean", "description": "Whether purchases from this vendor are subject to use tax by default" }, "name": { "type": "string", "description": "The name of the vendor" }, "notes": { "type": [ "string", "null" ], "description": "Additional notes or comments about the vendor" }, "phone": { "type": [ "string", "null" ], "description": "The primary phone number for the vendor" }, "primaryContact": { "type": [ "string", "null" ], "description": "The primary contact person at the vendor company" }, "shippingAddress": { "description": "The shipping address for the vendor (separate from main address)" }, "state": { "type": [ "string", "null" ], "description": "The state/province of the vendor address" }, "syncStatus": { "type": "string", "description": "The synchronization status with external accounting system", "enum": [ "Syncing", "InSync", "SyncFailed", "Bypassed" ] }, "taxRegionId": { "type": [ "string", "null" ], "description": "The UUID of the default tax region associated with this vendor" }, "type": { "type": [ "string", "null" ], "description": "The type/category of the vendor (optional)", "enum": [ "Supplier", "Subcontractor", "SupplierAndSubcontractor" ] }, "vendorCode": { "type": "string", "description": "A unique code or identifier for the vendor (internal reference)" }, "vendorTypeId": { "type": "string", "description": "The type id of the vendor." }, "zipcode": { "type": [ "string", "null" ], "description": "The postal/ZIP code of the vendor address" } }, "required": [ "PCID", "name" ] } ``` *** ## buildops-inventory\_public\_vendor\_controller\_public\_delete\_by\_id Delete a Vendor by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `vendorId` | string | Yes | — | Vendor Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vendorId": { "type": "string", "description": "Vendor Id" } }, "required": [ "PCID", "vendorId" ] } ``` *** ## buildops-inventory\_public\_vendor\_controller\_public\_find Find Vendors **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | -------------------------- | | `include_inactive` | boolean | No | — | Include Inactive | | `page` | number | No | — | Page number for pagination | | `page_size` | number | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include_inactive": { "type": "boolean", "description": "Include Inactive" }, "page": { "type": "number", "description": "Page number for pagination" }, "page_size": { "type": "number", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## buildops-inventory\_public\_vendor\_controller\_public\_find\_by\_id Find a Vendor by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `vendorId` | string | Yes | — | Vendor Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vendorId": { "type": "string", "description": "Vendor Id" } }, "required": [ "PCID", "vendorId" ] } ``` *** ## buildops-inventory\_public\_vendor\_controller\_public\_patch\_vendor Patch a Vendor **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------ | | `vendorId` | string | Yes | — | Vendor Id | | `accountingRefIdOfVendorType` | string | No | — | The updated accounting reference ID for the vendor type | | `addressLine1` | string | No | — | The updated first line of the vendor address | | `addressLine2` | string | No | — | The updated second line of the vendor address (optional) | | `city` | string | No | — | The updated city of the vendor address | | `defaultRetainagePercent` | number | No | — | The default retainage percentage for this vendor | | `email` | string | No | — | Email address for the vendor (must be valid email format) | | `fax` | string | No | — | The updated fax number for the vendor | | `isActive` | boolean | No | — | Whether the vendor is currently active and available for use | | `isRetainageApplicable` | boolean | No | — | Whether retainage is applicable to this vendor | | `isUseTaxable` | boolean | No | — | Whether purchases from this vendor are subject to use tax by default | | `name` | string | Yes | — | The updated name of the vendor | | `notes` | string | No | — | Updated additional notes or comments about the vendor | | `phone` | string | No | — | The updated primary phone number for the vendor | | `primaryContact` | string | No | — | The updated primary contact person at the vendor company | | `shippingAddress` | object | No | — | The updated shipping address for the vendor (separate from main address) | | `state` | string | No | — | The updated state/province of the vendor address | | `taxRegionId` | string | No | — | The updated UUID of the default tax region associated with this vendor | | `type` | string | No | — | The updated type/category of the vendor | | `vendorCode` | string | No | — | A updated unique code or identifier for the vendor (internal reference) | | `vendorTypeId` | string | No | — | The type id of the vendor. | | `version` | number | No | — | The version number for optimistic concurrency control | | `zipcode` | string | No | — | The updated postal/ZIP code of the vendor address | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vendorId": { "type": "string", "description": "Vendor Id" }, "accountingRefIdOfVendorType": { "type": "string", "description": "The updated accounting reference ID for the vendor type" }, "addressLine1": { "type": "string", "description": "The updated first line of the vendor address" }, "addressLine2": { "type": "string", "description": "The updated second line of the vendor address (optional)" }, "city": { "type": "string", "description": "The updated city of the vendor address" }, "defaultRetainagePercent": { "type": "number", "description": "The default retainage percentage for this vendor" }, "email": { "type": "string", "description": "Email address for the vendor (must be valid email format)" }, "fax": { "type": "string", "description": "The updated fax number for the vendor" }, "isActive": { "type": "boolean", "description": "Whether the vendor is currently active and available for use" }, "isRetainageApplicable": { "type": "boolean", "description": "Whether retainage is applicable to this vendor" }, "isUseTaxable": { "type": "boolean", "description": "Whether purchases from this vendor are subject to use tax by default" }, "name": { "type": "string", "description": "The updated name of the vendor" }, "notes": { "type": "string", "description": "Updated additional notes or comments about the vendor" }, "phone": { "type": "string", "description": "The updated primary phone number for the vendor" }, "primaryContact": { "type": "string", "description": "The updated primary contact person at the vendor company" }, "shippingAddress": { "description": "The updated shipping address for the vendor (separate from main address)" }, "state": { "type": "string", "description": "The updated state/province of the vendor address" }, "taxRegionId": { "type": "string", "description": "The updated UUID of the default tax region associated with this vendor" }, "type": { "type": "string", "description": "The updated type/category of the vendor", "enum": [ "Supplier", "Subcontractor", "SupplierAndSubcontractor" ] }, "vendorCode": { "type": "string", "description": "A updated unique code or identifier for the vendor (internal reference)" }, "vendorTypeId": { "type": "string", "description": "The type id of the vendor." }, "version": { "type": "number", "description": "The version number for optimistic concurrency control" }, "zipcode": { "type": "string", "description": "The updated postal/ZIP code of the vendor address" } }, "required": [ "PCID", "vendorId", "name" ] } ``` *** ## buildops-inventory\_purchase\_order\_controller\_public\_create\_1\_v1 Create a purchase order or subcontract **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `include` | string\[] | No | — | Related resources to include | | `addresses` | object\[] | No | — | The addresses of the bill, supported Billing, Shipping | | `addressLine1` | string | No | — | Address line 1 for the Purchase Order | | `addressLine2` | string | No | — | Address line 2 for the Purchase Order | | `assignedToId` | string | No | — | Employee id assigned to the Purchase Order | | `city` | string | No | — | City for the Purchase Order | | `completionDate` | number | No | — | Date the subcontract work was completed, saved as a unix timestamp | | `customIdentifier` | string | No | — | Custom identifier for the Purchase Order | | `dateAdded` | number | Yes | — | Date the Purchase Order was created, saved as a unix timestamp (existing data already saved as timestamp) | | `dateOfPurchase` | number | Yes | — | Date the Purchase Order was purchased, saved as a unix timestamp (not necessarily the same as dateAdded) | | `defaultRetainagePercent` | number | No | — | Default retainage percent of the Subcontract | | `defaultWarehouseId` | string | No | — | Default warehouse id of Purchase Order (ff: warehouseStockInventoryEnabled) | | `departmentId` | string | Yes | — | Department id of Purchase Order | | `departmentName` | string | No | — | The name of the department | | `description` | string | No | — | Description for Purchase Order | | `directPayerSalesTax` | boolean | No | — | Direct payer sales tax for Purchase Order | | `effectiveDate` | number | No | — | Date the subcontract work started, saved as a unix timestamp | | `expectedByDate` | number | No | — | Expected by date for Purchase Order | | `freight` | number | No | — | Freight cost for Purchase Order | | `isFieldOrder` | boolean | No | — | Whether a Purchase Order is a field order or not | | `isRetainageApplicable` | boolean | No | — | Whether retainage is applicable to the Subcontract | | `isUseTaxable` | boolean | No | — | Whether a Purchase Order is using useTaxable or not | | `jobId` | string | No | — | Job id of Purchase Order | | `orderedById` | string | No | — | Ordered By ID of Purchase Order | | `originalTotalAmount` | number | No | — | Original total amount of the Subcontract | | `paymentTermId` | string | No | — | Payment Term id for the Subcontract | | `postingDate` | number | No | — | Posting date for the Purchase Order, saved as a unix timestamp | | `poTypeId` | string | No | — | PO type id of Purchase Order | | `projectId` | string | No | — | Project id of Purchase Order | | `projectManagerId` | string | No | — | Project manager id of Purchase Order | | `purchaseOrderLines` | object\[] | No | — | Purchase Order Lines | | `purchaseOrderTags` | string\[] | No | — | Purchase order tags for the Purchase Order | | `requiredByDate` | number | No | — | Date the Purchase Order is required by, saved as a unix timestamp (existing data already saved as timestamp) | | `shipTo` | string | No | — | Where the Purchase Order is shipping to | | `shipToEmployeeId` | string | No | — | Employee Id for where the Purchase Order is shipping to | | `shipToInstructions` | string | No | — | Shipping instructions for Purchase Order | | `shipToName` | string | No | — | Ship to name for the Purchase Order | | `shipToNameType` | string | No | — | Type of receipient for Purchase Order (not necessarily an enum) | | `state` | string | No | — | State (address) of the Purchase Order | | `status` | string | No | — | Status for the Purchase Order | | `subcontractSubcontractTags` | string\[] | No | — | Subcontract tags for the Subcontract | | `tax` | number | No | — | Tax amount for the Purchase Order | | `taxAmountOverridden` | number | No | — | Tax override, tax received from the vendor | | `taxRateId` | string | No | — | Tax rate id for the Purchase Order | | `taxRegionId` | string | No | — | Tax region id for the Purchase Order | | `templateId` | string | No | — | Tenant Purchase Order Template id | | `totalAmountPreTax` | number | No | — | The total amount before tax for the Purchase Order | | `totalCost` | number | No | — | The total cost of the Purchase Order | | `type` | string | No | — | Type of Purchase Order | | `vendorDocumentNumber` | string | No | — | External vendor reference or project code | | `vendorId` | string | Yes | — | Vendor for the Purchase Order | | `zipcode` | string | No | — | Zipcode for the Purchase Order | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "vendor", "job", "assignedTo", "project", "projectManager", "company", "addresses", "purchaseOrderLines", "purchaseOrderReceipts", "bills" ] }, "description": "Related resources to include" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The id value" }, "tenantId": { "type": "string", "format": "uuid", "description": "Tenant Id" }, "audit": { "type": "object", "description": "The audit value" }, "addressLine1": { "type": "string", "description": "The address line 1" }, "addressLine2": { "type": "string", "description": "The address complement" }, "city": { "type": "string", "description": "The city of the address" }, "state": { "type": "string", "description": "The state of the address" }, "zipcode": { "type": "string", "description": "The postal code of the address" }, "addressType": { "type": "string", "enum": [ "billingAddress", "shippingAddress" ], "description": "The type of address" } }, "required": [ "id", "audit", "addressLine1", "addressLine2", "city", "state", "zipcode", "addressType" ] }, "description": "The addresses of the bill, supported Billing, Shipping" }, "addressLine1": { "type": "string", "description": "Address line 1 for the Purchase Order" }, "addressLine2": { "type": "string", "description": "Address line 2 for the Purchase Order" }, "assignedToId": { "type": "string", "description": "Employee id assigned to the Purchase Order" }, "city": { "type": "string", "description": "City for the Purchase Order" }, "completionDate": { "type": "number", "description": "Date the subcontract work was completed, saved as a unix timestamp" }, "customIdentifier": { "type": "string", "description": "Custom identifier for the Purchase Order" }, "dateAdded": { "type": "number", "description": "Date the Purchase Order was created, saved as a unix timestamp (existing data already saved as timestamp)" }, "dateOfPurchase": { "type": "number", "description": "Date the Purchase Order was purchased, saved as a unix timestamp (not necessarily the same as dateAdded)" }, "defaultRetainagePercent": { "type": "number", "description": "Default retainage percent of the Subcontract" }, "defaultWarehouseId": { "type": "string", "description": "Default warehouse id of Purchase Order (ff: warehouseStockInventoryEnabled)" }, "departmentId": { "type": "string", "description": "Department id of Purchase Order" }, "departmentName": { "type": "string", "description": "The name of the department" }, "description": { "type": "string", "description": "Description for Purchase Order" }, "directPayerSalesTax": { "type": "boolean", "description": "Direct payer sales tax for Purchase Order" }, "effectiveDate": { "type": "number", "description": "Date the subcontract work started, saved as a unix timestamp" }, "expectedByDate": { "type": "number", "description": "Expected by date for Purchase Order" }, "freight": { "type": "number", "description": "Freight cost for Purchase Order" }, "isFieldOrder": { "type": "boolean", "description": "Whether a Purchase Order is a field order or not" }, "isRetainageApplicable": { "type": "boolean", "description": "Whether retainage is applicable to the Subcontract" }, "isUseTaxable": { "type": "boolean", "description": "Whether a Purchase Order is using useTaxable or not" }, "jobId": { "type": "string", "description": "Job id of Purchase Order" }, "orderedById": { "type": "string", "description": "Ordered By ID of Purchase Order" }, "originalTotalAmount": { "type": "number", "description": "Original total amount of the Subcontract" }, "paymentTermId": { "type": "string", "description": "Payment Term id for the Subcontract" }, "postingDate": { "type": "number", "description": "Posting date for the Purchase Order, saved as a unix timestamp" }, "poTypeId": { "type": "string", "description": "PO type id of Purchase Order" }, "projectId": { "type": "string", "description": "Project id of Purchase Order" }, "projectManagerId": { "type": "string", "description": "Project manager id of Purchase Order" }, "purchaseOrderLines": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "description": "Total amount of the Purchase Order Line" }, "departmentId": { "type": "string", "description": "Department id for the Purchase Order Line, required if project id is present" }, "description": { "type": "string", "description": "Description for Purchase Order Line" }, "equipmentId": { "type": "string", "description": "Equipment id for the Purchase Order Line" }, "lineNumber": { "type": "number", "description": "Line number for the Purchase Order Line" }, "productId": { "type": "string", "description": "Product id for the Purchase Order Line" }, "jobId": { "type": "string", "description": "Job id for the Purchase Order Line" }, "jobCostTypeId": { "type": "string", "description": "Job cost type id for the Purchase Order Line" }, "costCodeId": { "type": "string", "description": "Cost code id for the Purchase Order Line" }, "projectId": { "type": "string", "description": "Project id for the Purchase Order Line" }, "projectCostCodeId": { "type": "string", "description": "Project cost code id for the Purchase Order Line, required if project id is present" }, "projectCostType": { "type": "string", "description": "Project cost type for the Purchase Order Line, required if project id is present" }, "projectPhaseId": { "type": "string", "description": "Project phase Id for the Purchase Order Line, required if project id is present" }, "quantity": { "type": "number", "description": "Quantity of the Purchase Order Line" }, "revenueTypeId": { "type": "string", "description": "Revenue type Id for the Purchase Order Line" }, "taxRegionId": { "type": "string", "description": "Tax region Id for the Purchase Order Line" }, "providerTaxCodeId": { "type": "string", "format": "uuid", "description": "Provider Tax Code ID" }, "taxable": { "type": "boolean", "description": "If a Purchase Order Line is taxable" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the line is use taxable" }, "unitCost": { "type": "number", "description": "Unit cost of a Purchase Order Line" }, "unitOfMeasure": { "type": "string", "description": "Unit measure of a Purchase Order Line" }, "warehouseId": { "type": "string", "description": "Warehouse id for the Purchase Order Line" }, "purchaseRequisitionLineId": { "type": "string", "description": "Purchase requisition line id for the Purchase Order Line" }, "quantityFulfilled": { "type": "number", "description": "Quantity fulfilled for the Purchase Order Line" }, "parentId": { "type": "string", "description": "Id of the parent purchase order" }, "itemName": { "type": "string", "description": "Item name for the Purchase Order Line" }, "equipmentName": { "type": "string", "description": "Equipment name for the Purchase Order Line" }, "jcCostTypeId": { "type": "string", "description": "Job cost type ID for the Purchase Order Line" }, "jcPhaseId": { "type": "string", "description": "Job cost phase ID for the Purchase Order Line" }, "workTaxabilityTypeId": { "type": "string", "description": "Work taxability type ID for the Purchase Order Line" }, "billingStatus": { "type": "string", "enum": [ "NotInvoiced", "Billed", "DoNotInvoice" ], "description": "Billing status for the Purchase Order Line" }, "itemGlGroupId": { "type": "string", "description": "Item GL Group ID for the Purchase Order Line" }, "lineType": { "type": "string", "enum": [ "Inventory", "ItemNonInventory" ], "description": "Type of the Purchase Order Line" }, "taxCategoryId": { "type": "string", "description": "Tax category ID for the Purchase Order Line" }, "taxAmountOverridden": { "type": "number", "description": "Sales tax amount that can be manually informed for this purchase order line" }, "departmentName": { "type": "string", "description": "The name of the department" }, "retainagePercent": { "type": "number", "description": "subcontract purchase order line retainage percent if applicable, otherwise null" }, "retainageAmount": { "type": "number", "description": "subcontract purchase order line retainage amount if applicable, otherwise null" } }, "required": [ "productId", "quantity", "unitCost" ] }, "description": "Purchase Order Lines" }, "purchaseOrderTags": { "type": "array", "items": { "type": "string" }, "description": "Purchase order tags for the Purchase Order" }, "requiredByDate": { "type": "number", "description": "Date the Purchase Order is required by, saved as a unix timestamp (existing data already saved as timestamp)" }, "shipTo": { "type": "string", "description": "Where the Purchase Order is shipping to", "enum": [ "Job Site", "Warehouse", "Vendor Pickup", "Manually Enter Address" ] }, "shipToEmployeeId": { "type": "string", "description": "Employee Id for where the Purchase Order is shipping to" }, "shipToInstructions": { "type": "string", "description": "Shipping instructions for Purchase Order" }, "shipToName": { "type": "string", "description": "Ship to name for the Purchase Order" }, "shipToNameType": { "type": "string", "description": "Type of receipient for Purchase Order (not necessarily an enum)" }, "state": { "type": "string", "description": "State (address) of the Purchase Order" }, "status": { "type": "string", "description": "Status for the Purchase Order" }, "subcontractSubcontractTags": { "type": "array", "items": { "type": "string" }, "description": "Subcontract tags for the Subcontract" }, "tax": { "type": "number", "description": "Tax amount for the Purchase Order" }, "taxAmountOverridden": { "type": "number", "description": "Tax override, tax received from the vendor" }, "taxRateId": { "type": "string", "description": "Tax rate id for the Purchase Order" }, "taxRegionId": { "type": "string", "description": "Tax region id for the Purchase Order" }, "templateId": { "type": "string", "description": "Tenant Purchase Order Template id" }, "totalAmountPreTax": { "type": "number", "description": "The total amount before tax for the Purchase Order" }, "totalCost": { "type": "number", "description": "The total cost of the Purchase Order" }, "type": { "type": "string", "description": "Type of Purchase Order", "enum": [ "Standard", "Subcontract", "Drop-Ship" ] }, "vendorDocumentNumber": { "type": "string", "description": "External vendor reference or project code" }, "vendorId": { "type": "string", "description": "Vendor for the Purchase Order" }, "zipcode": { "type": "string", "description": "Zipcode for the Purchase Order" } }, "required": [ "PCID", "dateAdded", "dateOfPurchase", "departmentId", "vendorId" ] } ``` *** ## buildops-inventory\_purchase\_order\_controller\_public\_find\_by\_id\_1\_v1 Find a purchase order or subcontract by id **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------- | | `purchaseOrderId` | string | Yes | — | Purchase Order Id | | `include` | string\[] | No | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderId": { "type": "string", "description": "Purchase Order Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "vendor", "job", "assignedTo", "project", "projectManager", "company", "addresses", "purchaseOrderLines", "purchaseOrderReceipts", "bills" ] }, "description": "Related resources to include" } }, "required": [ "PCID", "purchaseOrderId" ] } ``` *** ## buildops-inventory\_purchase\_order\_controller\_public\_void\_1\_v1 Void a purchase order or subcontract **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------------------- | | `purchaseOrderId` | string | Yes | — | Purchase Order Id | | `voidDate` | number | No | — | The date the purchase order was voided | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderId": { "type": "string", "description": "Purchase Order Id" }, "voidDate": { "type": "number", "description": "The date the purchase order was voided" } }, "required": [ "PCID", "purchaseOrderId" ] } ``` *** ## buildops-inventory\_purchase\_order\_line\_controller\_public\_create\_1\_v1 Create multiple purchase order lines **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------ | | `body` | object\[] | Yes | — | Purchase order lines to create | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "description": "Total amount of the Purchase Order Line" }, "departmentId": { "type": "string", "description": "Department id for the Purchase Order Line, required if project id is present" }, "description": { "type": "string", "description": "Description for Purchase Order Line" }, "equipmentId": { "type": "string", "description": "Equipment id for the Purchase Order Line" }, "lineNumber": { "type": "number", "description": "Line number for the Purchase Order Line" }, "productId": { "type": "string", "description": "Product id for the Purchase Order Line" }, "jobId": { "type": "string", "description": "Job id for the Purchase Order Line" }, "jobCostTypeId": { "type": "string", "description": "Job cost type id for the Purchase Order Line" }, "costCodeId": { "type": "string", "description": "Cost code id for the Purchase Order Line" }, "projectId": { "type": "string", "description": "Project id for the Purchase Order Line" }, "projectCostCodeId": { "type": "string", "description": "Project cost code id for the Purchase Order Line, required if project id is present" }, "projectCostType": { "type": "string", "description": "Project cost type for the Purchase Order Line, required if project id is present" }, "projectPhaseId": { "type": "string", "description": "Project phase Id for the Purchase Order Line, required if project id is present" }, "quantity": { "type": "number", "description": "Quantity of the Purchase Order Line" }, "revenueTypeId": { "type": "string", "description": "Revenue type Id for the Purchase Order Line" }, "taxRegionId": { "type": "string", "description": "Tax region Id for the Purchase Order Line" }, "providerTaxCodeId": { "type": "string", "format": "uuid", "description": "Provider Tax Code ID" }, "taxable": { "type": "boolean", "description": "If a Purchase Order Line is taxable" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the line is use taxable" }, "unitCost": { "type": "number", "description": "Unit cost of a Purchase Order Line" }, "unitOfMeasure": { "type": "string", "description": "Unit measure of a Purchase Order Line" }, "warehouseId": { "type": "string", "description": "Warehouse id for the Purchase Order Line" }, "purchaseRequisitionLineId": { "type": "string", "description": "Purchase requisition line id for the Purchase Order Line" }, "quantityFulfilled": { "type": "number", "description": "Quantity fulfilled for the Purchase Order Line" }, "parentId": { "type": "string", "description": "Id of the parent purchase order" }, "itemName": { "type": "string", "description": "Item name for the Purchase Order Line" }, "equipmentName": { "type": "string", "description": "Equipment name for the Purchase Order Line" }, "jcCostTypeId": { "type": "string", "description": "Job cost type ID for the Purchase Order Line" }, "jcPhaseId": { "type": "string", "description": "Job cost phase ID for the Purchase Order Line" }, "workTaxabilityTypeId": { "type": "string", "description": "Work taxability type ID for the Purchase Order Line" }, "billingStatus": { "type": "string", "enum": [ "NotInvoiced", "Billed", "DoNotInvoice" ], "description": "Billing status for the Purchase Order Line" }, "itemGlGroupId": { "type": "string", "description": "Item GL Group ID for the Purchase Order Line" }, "lineType": { "type": "string", "enum": [ "Inventory", "ItemNonInventory" ], "description": "Type of the Purchase Order Line" }, "taxCategoryId": { "type": "string", "description": "Tax category ID for the Purchase Order Line" }, "taxAmountOverridden": { "type": "number", "description": "Sales tax amount that can be manually informed for this purchase order line" }, "departmentName": { "type": "string", "description": "The name of the department" }, "retainagePercent": { "type": "number", "description": "subcontract purchase order line retainage percent if applicable, otherwise null" }, "retainageAmount": { "type": "number", "description": "subcontract purchase order line retainage amount if applicable, otherwise null" } }, "required": [ "productId", "quantity", "unitCost" ] }, "description": "Purchase order lines to create" } }, "required": [ "PCID", "body" ] } ``` *** ## buildops-inventory\_purchase\_order\_line\_controller\_public\_delete\_by\_id\_1\_v1 Delete a purchase order line by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ---------------------- | | `purchaseOrderLineId` | string | Yes | — | Purchase Order Line Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderLineId": { "type": "string", "description": "Purchase Order Line Id" } }, "required": [ "PCID", "purchaseOrderLineId" ] } ``` *** ## buildops-inventory\_purchase\_order\_line\_controller\_public\_find\_by\_id\_1\_v1 Find a purchase order line by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------- | | `purchaseOrderLineId` | string | Yes | — | Purchase Order Line Id | | `include` | string\[] | No | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderLineId": { "type": "string", "description": "Purchase Order Line Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "job", "project", "purchaseOrderReceiptLines", "purchaseRequisitionLine", "billLines" ] }, "description": "Related resources to include" } }, "required": [ "PCID", "purchaseOrderLineId" ] } ``` *** ## buildops-inventory\_purchase\_order\_line\_controller\_public\_update\_by\_id\_v2\_1\_v2 Update a purchase order line by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------- | | `purchaseOrderLineId` | string | Yes | — | Purchase Order Line Id | | `amount` | number | No | — | Amount for the item (quantity \* unit cost) | | `billingStatus` | string | No | — | The billing status of the purchase order line | | `costCodeId` | string | No | — | Cost code ID | | `departmentId` | string | No | — | Department ID | | `departmentName` | string | No | — | Department name | | `description` | string | No | — | The description of the purchase order line | | `equipmentId` | string | No | — | Equipment ID if associated | | `equipmentName` | string | No | — | Equipment name if associated | | `includeInInvoice` | boolean | No | — | Whether to include PO Line in invoice or not | | `invoiceQuantity` | number | No | — | Invoice quantity | | `isUseTaxable` | boolean | No | — | Indicates if use taxable applies | | `itemName` | string | No | — | Item name | | `jcCostTypeId` | string | No | — | JC Cost type ID | | `jcPhaseId` | string | No | — | JC Phase ID | | `jobCloseoutDescription` | string | No | — | Job closeout description if applicable, otherwise null | | `jobCostTypeId` | string | No | — | Job cost type ID | | `jobId` | string | No | — | Job ID | | `lineNumber` | number | No | — | Line number of the item | | `lineType` | string | No | — | The line type | | `markup` | number | No | — | Markup percentage of the item | | `parentId` | string | No | — | Parent ID | | `productId` | string | No | — | Product ID | | `projectCostCodeId` | string | No | — | Project Cost Code ID | | `projectCostType` | string | No | — | Project cost type | | `projectId` | string | No | — | Project ID | | `projectPhaseId` | string | No | — | Project Phase ID | | `providerTaxCodeId` | string | No | — | Provider tax code ID | | `quantity` | number | No | — | Quantity of the item | | `quantityFulfilled` | number | No | — | Quantity fulfilled | | `retainageAmount` | number | No | — | subcontract purchase order line retainage amount if applicable, otherwise null | | `retainagePercent` | number | No | — | subcontract purchase order line retainage percent if applicable, otherwise null | | `revenueTypeId` | string | No | — | Revenue type ID | | `status` | string | No | — | Purchase Order Line status | | `taxable` | boolean | No | — | Whether the item is taxable | | `taxAmountOverridden` | number | No | — | Sales tax amount that can be manually informed for this purchase order line | | `taxRegionId` | string | No | — | Tax region ID | | `unitCost` | number | No | — | Unit cost of the item | | `unitOfMeasure` | string | No | — | Unit of measure | | `unitPrice` | number | No | — | Unit Price of the item | | `workTaxabilityTypeId` | string | No | — | Work taxability type ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderLineId": { "type": "string", "description": "Purchase Order Line Id" }, "amount": { "type": "number", "description": "Amount for the item (quantity * unit cost)" }, "billingStatus": { "type": "string", "description": "The billing status of the purchase order line", "enum": [ "NotInvoiced", "Billed", "DoNotInvoice" ] }, "costCodeId": { "type": "string", "description": "Cost code ID" }, "departmentId": { "type": "string", "description": "Department ID" }, "departmentName": { "type": "string", "description": "Department name" }, "description": { "type": "string", "description": "The description of the purchase order line" }, "equipmentId": { "type": "string", "description": "Equipment ID if associated" }, "equipmentName": { "type": "string", "description": "Equipment name if associated" }, "includeInInvoice": { "type": "boolean", "description": "Whether to include PO Line in invoice or not" }, "invoiceQuantity": { "type": "number", "description": "Invoice quantity" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if use taxable applies" }, "itemName": { "type": "string", "description": "Item name" }, "jcCostTypeId": { "type": "string", "description": "JC Cost type ID" }, "jcPhaseId": { "type": "string", "description": "JC Phase ID" }, "jobCloseoutDescription": { "type": "string", "description": "Job closeout description if applicable, otherwise null" }, "jobCostTypeId": { "type": "string", "description": "Job cost type ID" }, "jobId": { "type": "string", "description": "Job ID" }, "lineNumber": { "type": "number", "description": "Line number of the item" }, "lineType": { "type": "string", "description": "The line type", "enum": [ "Inventory", "ItemNonInventory" ] }, "markup": { "type": "number", "description": "Markup percentage of the item" }, "parentId": { "type": "string", "description": "Parent ID" }, "productId": { "type": "string", "description": "Product ID" }, "projectCostCodeId": { "type": "string", "description": "Project Cost Code ID" }, "projectCostType": { "type": "string", "description": "Project cost type" }, "projectId": { "type": "string", "description": "Project ID" }, "projectPhaseId": { "type": "string", "description": "Project Phase ID" }, "providerTaxCodeId": { "type": "string", "description": "Provider tax code ID" }, "quantity": { "type": "number", "description": "Quantity of the item" }, "quantityFulfilled": { "type": "number", "description": "Quantity fulfilled" }, "retainageAmount": { "type": "number", "description": "subcontract purchase order line retainage amount if applicable, otherwise null" }, "retainagePercent": { "type": "number", "description": "subcontract purchase order line retainage percent if applicable, otherwise null" }, "revenueTypeId": { "type": "string", "description": "Revenue type ID" }, "status": { "type": "string", "description": "Purchase Order Line status", "enum": [ "Draft", "Ordered", "Partially Fulfilled", "Fulfilled", "Cancelled", "Void", "Requested", "Unfulfilled" ] }, "taxable": { "type": "boolean", "description": "Whether the item is taxable" }, "taxAmountOverridden": { "type": "number", "description": "Sales tax amount that can be manually informed for this purchase order line" }, "taxRegionId": { "type": "string", "description": "Tax region ID" }, "unitCost": { "type": "number", "description": "Unit cost of the item" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure" }, "unitPrice": { "type": "number", "description": "Unit Price of the item" }, "workTaxabilityTypeId": { "type": "string", "description": "Work taxability type ID" } }, "required": [ "PCID", "purchaseOrderLineId" ] } ``` *** ## buildops-inventory\_purchase\_order\_receipt\_controller\_public\_create\_2\_v1 Create a purchase order receipt **Parameters:** | Parameter | Type | Required | Default | Description | | | ---------------------------- | --------- | -------- | ------- | ------------------------------------------------------ | ----------------------------- | | `addresses` | object\[] | No | — | The addresses of the bill, supported Billing, Shipping | | | `approvalNoteById` | string | null | No | — | Approval note by ID | | `approvalNoteDateTime` | number | No | — | Approval note date time | | | `approvalStatus` | string | No | — | Approval status | | | `assignedToId` | string | null | No | — | Assigned to ID | | `createdBy` | string | No | — | User who created the order | | | `defaultWarehouseId` | string | null | No | — | Default warehouse ID | | `departmentId` | string | No | — | Department ID | | | `description` | string | null | No | — | The description value | | `freight` | number | No | — | Freight cost | | | `intacctLocationId` | string | No | — | Intacct Location ID | | | `invoiceAmount` | number | null | No | — | Invoice amount | | `issuedBy` | number | No | — | Issued by timestamp (Unix time) | | | `isUseTaxable` | boolean | No | — | Indicates if the tax is applicable | | | `jobId` | string | No | — | Job ID | | | `lastUpdatedBy` | string | No | — | User who last updated the order | | | `parentId` | string | Yes | — | Parent ID | | | `paymentTermId` | string | No | — | Payment term ID | | | `postingDate` | number | No | — | Posting Date timestamp (Unix time) | | | `projectId` | string | null | No | — | Project ID | | `purchaseOrderReceiptLines` | object\[] | No | — | Purchase Order Receipt Lines | | | `receiptNumber` | string | Yes | — | Receipt number | | | `status` | string | No | — | Order status | | | `syncStatus` | string | No | — | Sync Status | | | `tax` | number | No | — | Tax amount | | | `taxAmountOverridden` | number | null | No | — | Tax amount overridden | | `taxRateId` | string | null | No | — | Tax rate ID | | `taxRegionId` | string | null | No | — | Tax region ID | | `vendorDocumentAttachmentId` | string | null | No | — | Vendor document attachment ID | | `vendorDocumentNumber` | string | null | No | — | Vendor document number | | `vendorId` | string | No | — | Vendor ID | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The id value" }, "tenantId": { "type": "string", "format": "uuid", "description": "Tenant Id" }, "audit": { "type": "object", "description": "The audit value" }, "addressLine1": { "type": "string", "description": "The address line 1" }, "addressLine2": { "type": "string", "description": "The address complement" }, "city": { "type": "string", "description": "The city of the address" }, "state": { "type": "string", "description": "The state of the address" }, "zipcode": { "type": "string", "description": "The postal code of the address" }, "addressType": { "type": "string", "enum": [ "billingAddress", "shippingAddress" ], "description": "The type of address" } }, "required": [ "id", "audit", "addressLine1", "addressLine2", "city", "state", "zipcode", "addressType" ] }, "description": "The addresses of the bill, supported Billing, Shipping" }, "approvalNoteById": { "type": [ "string", "null" ], "description": "Approval note by ID" }, "approvalNoteDateTime": { "type": "number", "description": "Approval note date time" }, "approvalStatus": { "type": "string", "description": "Approval status", "enum": [ "Unreviewed", "Approved", "Review Needed", "Rejected" ] }, "assignedToId": { "type": [ "string", "null" ], "description": "Assigned to ID" }, "createdBy": { "type": "string", "description": "User who created the order" }, "defaultWarehouseId": { "type": [ "string", "null" ], "description": "Default warehouse ID" }, "departmentId": { "type": "string", "description": "Department ID" }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "freight": { "type": "number", "description": "Freight cost" }, "intacctLocationId": { "type": "string", "description": "Intacct Location ID" }, "invoiceAmount": { "type": [ "number", "null" ], "description": "Invoice amount" }, "issuedBy": { "type": "number", "description": "Issued by timestamp (Unix time)" }, "isUseTaxable": { "type": "boolean", "description": "Indicates if the tax is applicable" }, "jobId": { "type": "string", "description": "Job ID" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated the order" }, "parentId": { "type": "string", "description": "Parent ID" }, "paymentTermId": { "type": "string", "description": "Payment term ID" }, "postingDate": { "type": "number", "description": "Posting Date timestamp (Unix time)" }, "projectId": { "type": [ "string", "null" ], "description": "Project ID" }, "purchaseOrderReceiptLines": { "type": "array", "items": { "type": "object", "properties": { "lineNumber": { "type": "number", "description": "Line number of the purchase order" }, "purchaseOrderLineId": { "type": "string", "description": "Unique identifier for the purchase order line" }, "quantity": { "type": "number", "description": "Quantity of the item in the purchase order" }, "purchaseOrderId": { "type": "string", "description": "Unique identifier for the purchase order" }, "productId": { "type": "string", "description": "Unique identifier for the product" }, "description": { "type": "string", "description": "Description of the item" }, "departmentId": { "type": "string", "description": "Department ID associated with the order" }, "equipmentId": { "type": "string", "description": "Equipment ID if applicable, otherwise null" }, "unitCost": { "type": "number", "description": "Unit cost of the item" }, "unitCostWithTax": { "type": "number", "description": "Unit cost added with tax of the item" }, "amount": { "type": "number", "format": "float", "description": "Amount of the item" }, "useTaxAmount": { "type": "number", "format": "float", "description": "Amount of the item with tax" }, "totalAmount": { "type": "number", "format": "float", "description": "Tax amount of the po line" }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the item" }, "taxable": { "type": "boolean", "description": "Indicates whether the item is taxable" }, "jobId": { "type": "string", "description": "Job ID associated with the order" }, "projectId": { "type": "string", "description": "Project ID if applicable, otherwise null" }, "tenantCompanyId": { "type": "string", "description": "Tenant company ID" }, "projectCostCodeId": { "type": "string", "description": "Project cost code ID if applicable, otherwise null" }, "projectPhaseId": { "type": "string", "description": "Project phase ID if applicable, otherwise null" }, "projectCostType": { "type": "string", "description": "Project cost type if applicable, otherwise null" }, "costCodeId": { "type": "string", "description": "Cost code ID" }, "revenueTypeId": { "type": "string", "description": "Revenue type ID" }, "jobCostTypeId": { "type": "string", "description": "Job cost type ID" }, "jobCloseoutDescription": { "type": "string", "description": "Job closeout description if applicable, otherwise null" }, "isUseTaxable": { "type": "boolean", "description": "Indicates whether use tax applies" }, "warehouseId": { "type": "string", "description": "Warehouse ID if applicable, otherwise null" }, "taxRegionId": { "type": "string", "description": "Tax region ID if applicable, otherwise null" }, "taxAmountOverridden": { "type": "number", "description": "Overridden tax amount if applicable, otherwise null" }, "providerTaxCodeId": { "type": "string", "description": "Provider tax code ID" }, "workTaxabilityTypeId": { "type": "string", "description": "Work taxability type ID" }, "jcPhaseId": { "type": "string", "description": "JC Phase ID associated with the purchase order receipt line" }, "jcCostTypeId": { "type": "string", "description": "JC Cost Type ID associated with the purchase order receipt line" }, "intacctLocationId": { "type": "string", "description": "Intacct Location ID" }, "expenseLedgerAccountId": { "type": "string", "description": "Expense ledger account ID if applicable, otherwise null" } }, "required": [ "lineNumber", "purchaseOrderLineId", "quantity", "purchaseOrderId", "productId", "description", "departmentId", "unitCost", "unitCostWithTax", "amount", "useTaxAmount", "totalAmount", "unitOfMeasure", "taxable", "jobId", "tenantCompanyId", "costCodeId", "revenueTypeId", "jobCostTypeId", "isUseTaxable", "providerTaxCodeId", "workTaxabilityTypeId", "jcPhaseId", "jcCostTypeId", "intacctLocationId" ] }, "description": "Purchase Order Receipt Lines" }, "receiptNumber": { "type": "string", "description": "Receipt number" }, "status": { "type": "string", "description": "Order status", "enum": [ "Draft", "Pending", "Posted", "Exported", "Bypassed", "Closed", "Void" ] }, "syncStatus": { "type": "string", "description": "Sync Status", "enum": [ "Syncing", "InSync", "SyncFailed", "Bypassed" ] }, "tax": { "type": "number", "description": "Tax amount" }, "taxAmountOverridden": { "type": [ "number", "null" ], "description": "Tax amount overridden" }, "taxRateId": { "type": [ "string", "null" ], "description": "Tax rate ID" }, "taxRegionId": { "type": [ "string", "null" ], "description": "Tax region ID" }, "vendorDocumentAttachmentId": { "type": [ "string", "null" ], "description": "Vendor document attachment ID" }, "vendorDocumentNumber": { "type": [ "string", "null" ], "description": "Vendor document number" }, "vendorId": { "type": "string", "description": "Vendor ID" } }, "required": [ "PCID", "parentId", "receiptNumber" ] } ``` *** ## buildops-inventory\_purchase\_order\_receipt\_controller\_public\_delete\_by\_id\_2\_v1 Delete Purchase Order Receipt by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | ------------------------- | | `purchaseOrderReceiptId` | string | Yes | — | Purchase Order Receipt Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderReceiptId": { "type": "string", "description": "Purchase Order Receipt Id" } }, "required": [ "PCID", "purchaseOrderReceiptId" ] } ``` *** ## buildops-inventory\_purchase\_order\_receipt\_controller\_public\_export\_2\_v1 Export a purchase order receipt by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | ------------------------- | | `purchaseOrderReceiptId` | string | Yes | — | Purchase Order Receipt Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderReceiptId": { "type": "string", "description": "Purchase Order Receipt Id" } }, "required": [ "PCID", "purchaseOrderReceiptId" ] } ``` *** ## buildops-inventory\_purchase\_order\_receipt\_controller\_public\_find\_by\_id\_2\_v1 Find a purchase order receipt by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | ---------------------------- | | `purchaseOrderReceiptId` | string | Yes | — | Purchase Order Receipt Id | | `include` | string\[] | No | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderReceiptId": { "type": "string", "description": "Purchase Order Receipt Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "vendor", "job", "project", "assignedTo", "addresses", "purchaseOrderReceiptLines", "bills" ] }, "description": "Related resources to include" } }, "required": [ "PCID", "purchaseOrderReceiptId" ] } ``` *** ## buildops-inventory\_purchase\_order\_receipt\_controller\_public\_post\_2\_v1 Post a purchase order receipt by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | ------------------------- | | `purchaseOrderReceiptId` | string | Yes | — | Purchase Order Receipt Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderReceiptId": { "type": "string", "description": "Purchase Order Receipt Id" } }, "required": [ "PCID", "purchaseOrderReceiptId" ] } ``` *** ## buildops-inventory\_purchase\_order\_receipt\_line\_controller\_public\_delete\_by\_id\_1\_v1 Delete a purchase order receipt line by id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------ | -------- | ------- | ------------------------------ | | `purchaseOrderReceiptLineId` | string | Yes | — | Purchase Order Receipt Line Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purchaseOrderReceiptLineId": { "type": "string", "description": "Purchase Order Receipt Line Id" } }, "required": [ "PCID", "purchaseOrderReceiptLineId" ] } ``` *** ## buildops-inventory\_warehouse\_controller\_public\_create\_warehouse\_v2\_v2 Create a warehouse with required departmentId **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `accountingRefId` | string | null | No | — | The accounting system reference ID for the warehouse | | `address` | object | No | — | The physical address location of the warehouse | | | `departmentId` | string | null | No | — | The UUID of the department that owns or manages this warehouse | | `employeeIds` | string\[] | No | — | Array of employee UUIDs who have access to or work at this warehouse | | | `name` | string | Yes | — | The name of the warehouse (must be unique within the organization) | | | `productBundleId` | string | null | No | — | The UUID of the product bundle associated with this warehouse for inventory tracking | | `type` | string | null | No | — | The type/category of the warehouse (fixed location or mobile) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountingRefId": { "type": [ "string", "null" ], "description": "The accounting system reference ID for the warehouse" }, "address": { "description": "The physical address location of the warehouse" }, "departmentId": { "type": [ "string", "null" ], "description": "The UUID of the department that owns or manages this warehouse" }, "employeeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of employee UUIDs who have access to or work at this warehouse" }, "name": { "type": "string", "description": "The name of the warehouse (must be unique within the organization)" }, "productBundleId": { "type": [ "string", "null" ], "description": "The UUID of the product bundle associated with this warehouse for inventory tracking" }, "type": { "type": [ "string", "null" ], "description": "The type/category of the warehouse (fixed location or mobile)", "enum": [ "warehouse", "truck" ] } }, "required": [ "PCID", "name" ] } ``` *** ## buildops-inventory\_warehouse\_controller\_public\_edit\_warehouse\_v2\_v2 Update a warehouse with required departmentId **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ----------------------------- | | `warehouseId` | string | Yes | — | Warehouse Id | | `address` | object | No | — | The address of the warehouse. | | `departmentId` | string | No | — | Existing Department id | | `employeeIds` | string\[] | No | — | Technician ids | | `name` | string | No | — | Warehouse name | | `type` | string | No | — | Warehouse Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "warehouseId": { "type": "string", "description": "Warehouse Id" }, "address": { "description": "The address of the warehouse." }, "departmentId": { "type": "string", "description": "Existing Department id" }, "employeeIds": { "type": "array", "items": { "type": "string" }, "description": "Technician ids" }, "name": { "type": "string", "description": "Warehouse name" }, "type": { "type": "string", "description": "Warehouse Type", "enum": [ "warehouse", "truck" ] } }, "required": [ "PCID", "warehouseId" ] } ``` *** ## buildops-inventory\_warehouse\_controller\_public\_edit\_warehouse\_v2\_v2\_v1 Update a warehouse with required departmentId **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ----------------------------- | | `warehouseId` | string | Yes | — | Warehouse Id | | `address` | object | No | — | The address of the warehouse. | | `departmentId` | string | No | — | Existing Department id | | `employeeIds` | string\[] | No | — | Technician ids | | `name` | string | No | — | Warehouse name | | `type` | string | No | — | Warehouse Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "warehouseId": { "type": "string", "description": "Warehouse Id" }, "address": { "description": "The address of the warehouse." }, "departmentId": { "type": "string", "description": "Existing Department id" }, "employeeIds": { "type": "array", "items": { "type": "string" }, "description": "Technician ids" }, "name": { "type": "string", "description": "Warehouse name" }, "type": { "type": "string", "description": "Warehouse Type", "enum": [ "warehouse", "truck" ] } }, "required": [ "PCID", "warehouseId" ] } ``` *** ## buildops-inventory\_warehouse\_controller\_public\_get\_by\_id\_v2\_v2 Get a warehouse by id for public api **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------- | | `warehouseId` | string | Yes | — | Warehouse Id | | `include` | string\[] | Yes | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "warehouseId": { "type": "string", "description": "Warehouse Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "Related resources to include" } }, "required": [ "PCID", "warehouseId", "include" ] } ``` *** ## buildops-inventory\_warehouse\_controller\_public\_get\_by\_id\_v2\_v2\_v1 Get a warehouse by id for public api **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------- | | `warehouseId` | string | Yes | — | Warehouse Id | | `include` | string\[] | Yes | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "warehouseId": { "type": "string", "description": "Warehouse Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "Related resources to include" } }, "required": [ "PCID", "warehouseId", "include" ] } ``` *** ## buildops-inventory\_warehouse\_controller\_public\_get\_list\_v1 Get a warehouse List **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------- | | `page` | number | Yes | — | The page number. | | `page_size` | number | Yes | — | The page size. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "The page number." }, "page_size": { "type": "number", "description": "The page size." } }, "required": [ "PCID", "page", "page_size" ] } ```