Get
/po-rest-api/jersey/v1/purchase-change-order/master/4E69C78976F5FD36E0630B811DAC6604
Get Change Order Master by UUID
Overview
Returns a single PO Change Order master (header) record only — no detail lines — identified by its virtual UUID (POCOH_V_UUID).
This API is used when you need header information for a specific change order and do not require its line items. Sourced from PO_COMAST_API_V.
Notes
The
vuuidpath parameter is required. A blank value returns400 Bad Request.If no record is found for the supplied UUID, a
404 Not Founderror is returned.Authentication is required to access this endpoint.
UI Navigation
Asset Management → Purchase Orders → Change Orders
View Objects
| Section | View Object | Database View |
|---|---|---|
| Header | PoComastViewObj |
PO_COMAST_API_V |
Finders
| Finder | Parameter | Description |
|---|---|---|
| UUID Lookup | vuuid (path) |
Directly identifies the change order header by its virtual UUID (POCOH_V_UUID) |
HTTP Method & Endpoint
Method: GET
Endpoint:
/po-rest-api/jersey/v1/po-change-order/master/{vuuid}
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| vuuid | Virtual UUID of the change order header (POCOH_V_UUID) |
4E69C78976F5FD36E0630B811DAC6604 |
Query Parameters
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| N/A | — | — | — | This endpoint does not accept query parameters |
Example Request
/po-rest-api/jersey/v1/po-change-order/master/4E69C78976F5FD36E0630B811DAC6604
Attributes
The response is a single flat JSON object representing the change order master record.
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |
|---|---|---|---|---|---|---|---|
| PocohVUuid | changeOrderHeader | pocohVUuid | Unique virtual identifier for the change order header | String | 64 | 4E69C78976F5FD36E0630B811DAC6604 | System Generated |
| PocohCompCode | changeOrderHeader | pocohCompCode | Company code the change order belongs to | String | 8 | QAT | True |
| PocohCompName | changeOrderHeader | pocohCompName | Full name of the company | String | 60 | QAT Company | False |
| PocohPoNum | changeOrderHeader | pocohPoNum | Parent purchase order number | String | 20 | PO000004 | True |
| PocohNum | changeOrderHeader | pocohNum | Change order number | String | 10 | 1 | True |
| PocohReleaseNum | changeOrderHeader | pocohReleaseNum | PO release number | Number | 10 | 1 | True |
| PocohBchNum | changeOrderHeader | pocohBchNum | Batch number | Number | 10 | 42 | False |
| PocohVenCode | changeOrderHeader | pocohVenCode | Vendor code | String | 16 | AETNA | False |
| PocohVenName | changeOrderHeader | pocohVenName | Vendor full name | String | 60 | Aetna Insurance | False |
| PocohDeptCode | changeOrderHeader | pocohDeptCode | Department code | String | 6 | ADMIN | False |
| PocohDeptName | changeOrderHeader | pocohDeptName | Department name | String | 60 | Administration | False |
| PocohExptdDate | changeOrderHeader | pocohExptdDate | Expected delivery date | Date | N/A | 2024-03-31 | False |
| PocohOrdDate | changeOrderHeader | pocohOrdDate | Date the order was placed | Date | N/A | 2024-01-15 | False |
| PocohRecDate | changeOrderHeader | pocohRecDate | Actual receive date | Date | N/A | 2024-04-05 | False |
| PocohTypeCode | changeOrderHeader | pocohTypeCode | PO type code (e.g. S = Standard) | String | 1 | S | False |
| PocohAdjCode | changeOrderHeader | pocohAdjCode | Adjustment code | String | 1 | A | False |
| PocohStatCode | changeOrderHeader | pocohStatCode | Status code (R = Released, C = Closed) | String | 1 | R | False |
| PocohChgCode | changeOrderHeader | pocohChgCode | Change code | String | 16 | MOD | False |
| PocohTermCode | changeOrderHeader | pocohTermCode | Payment term code | String | 8 | NET30 | False |
| PocohTermName | changeOrderHeader | pocohTermName | Payment term description | String | 30 | Net 30 Days | False |
| PocohInvCode | changeOrderHeader | pocohInvCode | Invoice code | String | 16 | INV001 | False |
| PocohInvDate | changeOrderHeader | pocohInvDate | Invoice date | Date | N/A | 2024-02-01 | False |
| PocohInvDueDate | changeOrderHeader | pocohInvDueDate | Invoice due date | Date | N/A | 2024-03-01 | False |
| PocohInvDiscAmt | changeOrderHeader | pocohInvDiscAmt | Invoice discount amount | Number | 10,2 | 50.00 | False |
| PocohCurrCode | changeOrderHeader | pocohCurrCode | Currency code | String | 3 | US | False |
| PocohCurrName | changeOrderHeader | pocohCurrName | Currency name | String | 30 | US Dollar | False |
| PocohFobCode | changeOrderHeader | pocohFobCode | Freight on board code | String | 8 | DEST | False |
| PocohBuyCode | changeOrderHeader | pocohBuyCode | Buyer code | String | 8 | JSMITH | False |
| PocohAddCode | changeOrderHeader | pocohAddCode | Ship-to address code | String | 10 | MAIN | False |
| PocohAddName | changeOrderHeader | pocohAddName | Ship-to address name | String | 60 | Main Office | False |
| PocohShplneCode | changeOrderHeader | pocohShplneCode | Shipping line code | String | 8 | FEDEX | False |
| PocohShpmetCode | changeOrderHeader | pocohShpmetCode | Shipping method code | String | 8 | GROUND | False |
| PocohShpinstDesc | changeOrderHeader | pocohShpinstDesc | Shipping instructions description | String | 240 | Handle with care | False |
| PocohDesc1 | changeOrderHeader | pocohDesc1 | Change order description line 1 | String | 60 | Office supplies amendment | False |
| PocohDesc2 | changeOrderHeader | pocohDesc2 | Change order description line 2 | String | 60 | Additional items added | False |
| PocohAdjPrice | changeOrderHeader | pocohAdjPrice | Adjusted price total | Number | 10,2 | 1250.00 | False |
| PocohUnadjPrice | changeOrderHeader | pocohUnadjPrice | Unadjusted price total | Number | 10,2 | 1200.00 | False |
| PocohCostedCode | changeOrderHeader | pocohCostedCode | Costed code | String | 1 | Y | False |
| PocohRefNum | changeOrderHeader | pocohRefNum | Reference number | String | 20 | REF-2024-001 | False |
| PocohRefDate | changeOrderHeader | pocohRefDate | Reference date | Date | N/A | 2024-01-10 | False |
| PocohReqCode | changeOrderHeader | pocohReqCode | Requisition code | String | 8 | REQ001 | False |
| PocohRecCode | changeOrderHeader | pocohRecCode | Receiving code | String | 1 | P | False |
| PocohWipAccCode | changeOrderHeader | pocohWipAccCode | WIP account code | String | 8 | WIP-01 | False |
| PocohWipAccName | changeOrderHeader | pocohWipAccName | WIP account name | String | 60 | Work In Progress 01 | False |
| PocohWipDeptCode | changeOrderHeader | pocohWipDeptCode | WIP department code | String | 6 | WIPD01 | False |
| PocohWipDeptName | changeOrderHeader | pocohWipDeptName | WIP department name | String | 60 | WIP Department 01 | False |
| PocohBilltoAddCode | changeOrderHeader | pocohBilltoAddCode | Bill-to address code | String | 10 | BILLTO01 | False |
| PocohComplianceFlag | changeOrderHeader | pocohComplianceFlag | Compliance flag (Y/N) | String | 1 | Y | False |
| PocohJobCompCode | changeOrderHeader | pocohJobCompCode | Job company code | String | 8 | QAT | False |
| PocohJobCompName | changeOrderHeader | pocohJobCompName | Job company name | String | 60 | QAT Company | False |
| PocohJobCode | changeOrderHeader | pocohJobCode | Job code | String | 16 | JOB001 | False |
| PocohJobName | changeOrderHeader | pocohJobName | Job name | String | 60 | Office Renovation | False |
| PocohContactCode | changeOrderHeader | pocohContactCode | Vendor contact code | String | 8 | CONT01 | False |
| PocohDate | changeOrderHeader | pocohDate | Change order date | Date | N/A | 2024-01-15 | False |
| PocohPoTotal | changeOrderHeader | pocohPoTotal | Total amount of the purchase change order | Number | 10,2 | 37 | False |
| PocohLumpSumPoFlag | changeOrderHeader | pocohLumpSumPoFlag | Indicates lump sum PO (Y/N) | String | 1 | N | False |
| PocohLumpSumPoAmt | changeOrderHeader | pocohLumpSumPoAmt | Lump sum PO amount | Number | 10,2 | 0.00 | False |
| PocohVenTax1 | changeOrderHeader | pocohVenTax1 | Vendor tax code 1 | String | 8 | HST | False |
| PocohVenTax2 | changeOrderHeader | pocohVenTax2 | Vendor tax code 2 | String | 8 | — | False |
| PocohVenTax3 | changeOrderHeader | pocohVenTax3 | Vendor tax code 3 | String | 8 | — | False |
| PocohJobTax1 | changeOrderHeader | pocohJobTax1 | Job tax code 1 | String | 8 | HST | False |
| PocohJobTax2 | changeOrderHeader | pocohJobTax2 | Job tax code 2 | String | 8 | — | False |
| PocohJobTax3 | changeOrderHeader | pocohJobTax3 | Job tax code 3 | String | 8 | — | False |
| PocohDiscountPct | changeOrderHeader | pocohDiscountPct | Discount percentage | Number | 6,2 | 5.00 | False |
| PocohSelectFlag | changeOrderHeader | pocohSelectFlag | Record selection flag | String | 1 | Y | False |
| PocohIuCreateDate | changeOrderHeader | pocohIuCreateDate | Record creation timestamp (ISO-8601) | Timestamp | N/A | 2013-11-14T14:25:45-05:00 | System Generated |
| PocohIuCreateUser | changeOrderHeader | pocohIuCreateUser | User who created the record | String | 30 | DA | System Generated |
| PocohIuUpdateDate | changeOrderHeader | pocohIuUpdateDate | Record last update timestamp (ISO-8601) | Timestamp | N/A | 2014-08-18T09:45:37-04:00 | System Generated |
| PocohIuUpdateUser | changeOrderHeader | pocohIuUpdateUser | User who last updated the record | String | 30 | DA | System Generated |
Security
HTTP
Type basic
Basic authentication
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\n \"pocohVUuid\": \"4E69C78976F5FD36E0630B811DAC6604\",\n \"pocohCompCode\": \"QAT\",\n \"pocohCompName\": \"QA Test Company\",\n \"pocohPoNum\": \"PO000004\",\n \"pocohNum\": \"1\",\n \"pocohBchNum\": null,\n \"pocohVenCode\": \"AETNA\",\n \"pocohVenName\": \"Aetna Insurance\",\n \"pocohDeptCode\": null,\n \"pocohDeptName\": null,\n \"pocohExptdDate\": \"2013-10-31\",\n \"pocohOrdDate\": \"2013-10-31\",\n \"pocohRecDate\": null,\n \"pocohTypeCode\": \"S\",\n \"pocohAdjCode\": null,\n \"pocohStatCode\": \"R\",\n \"pocohChgCode\": \"O\",\n \"pocohTermCode\": \"21NE30\",\n \"pocohTermName\": \"2% Discount Net 30\",\n \"pocohInvCode\": null,\n \"pocohInvDate\": null,\n \"pocohInvDueDate\": null,\n \"pocohInvDiscDate\": null,\n \"pocohInvDiscAmt\": 0,\n \"pocohCurrCode\": \"US\",\n \"pocohCurrName\": \"US Dollars\",\n \"pocohFobCode\": null,\n \"pocohBuyCode\": \"QA3\",\n \"pocohAddCode\": null,\n \"pocohShplneCode\": null,\n \"pocohShpmetCode\": null,\n \"pocohTxt1Code\": null,\n \"pocohTxt2Code\": null,\n \"pocohShpinstDesc\": null,\n \"pocohDesc1\": \"Comment\",\n \"pocohDesc2\": null,\n \"pocohAdjPrice\": 0,\n \"pocohUnadjPrice\": 0,\n \"pocohCurrConvNum\": 1,\n \"pocohCostedCode\": null,\n \"pocohRefNum\": null,\n \"pocohRefDate\": null,\n \"pocohReqCode\": \"QA3\",\n \"pocohRecCode\": null,\n \"pocohReprintDate\": \"2014-08-18T12:08:00-04:00\",\n \"pocohWipAccCode\": null,\n \"pocohWipAccName\": null,\n \"pocohWipDeptCode\": null,\n \"pocohWipDeptName\": null,\n \"pocohShipinstTxt1Code\": null,\n \"pocohShipinstTxt2Code\": null,\n \"pocohShipinstTxt3Code\": null,\n \"pocohShipinstTxt4Code\": null,\n \"pocohShipinstTxt5Code\": null,\n \"pocohReleaseNum\": 1,\n \"pocohBilltoAddCode\": null,\n \"pocohReqReason\": null,\n \"pocohInvTypeCode\": null,\n \"pocohImageFilename\": null,\n \"pocohInvSerCode\": null,\n \"pocohVendOrderAddCode\": \"AD1\",\n \"pocohComplianceFlag\": null,\n \"pocohJobCompCode\": \"QAT\",\n \"pocohJobCompName\": \"QA Test Company\",\n \"pocohJobCode\": null,\n \"pocohJobName\": null,\n \"pocohContactCode\": null,\n \"pocohAddCompCode\": \"QAT\",\n \"pocohAddCompName\": \"QA Test Company\",\n \"pocohPrintDate\": \"2014-08-18T09:43:44-04:00\",\n \"pocohDefaultRecCode\": \"M\",\n \"pocohDate\": \"2013-11-14\",\n \"pocohPoTotal\": 37,\n \"pocohIuCreateDate\": \"2013-11-14T14:25:45-05:00\",\n \"pocohIuCreateUser\": \"QA3\",\n \"pocohIuUpdateDate\": \"2014-08-18T09:45:37-04:00\",\n \"pocohIuUpdateUser\": \"QA3\",\n \"pocohManPoRecFlag\": null,\n \"pocohAcctDescription\": null,\n \"pocohLumpSumPoFlag\": null,\n \"pocohLumpSumPoAmt\": null,\n \"pocohVenTax1\": \"TC\",\n \"pocohVenTax2\": null,\n \"pocohVenTax3\": null,\n \"pocohJobTax1\": null,\n \"pocohJobTax2\": null,\n \"pocohJobTax3\": null,\n \"pocohDiscountPct\": 0,\n \"pocohAddName\": null,\n \"pocohBlkLineItemsFlag\": null,\n \"pocohSelectFlag\": \"N\"\n}"string