Get
/po-rest-api/jersey/v1/purchase-change-order/detail/4E7ECC5F8D3F3AD8E0630B811DAC7BCF
Get Change Order Detail Line by UUID
Overview
Returns a single PO Change Order detail (line) record identified by its virtual UUID (POCOD_V_UUID).
This API is used when you already know the unique identifier of a specific change order line item and need its full detail. Sourced from PO_CODET_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 |
|---|---|---|
| Lines | PoCodetViewObj |
PO_CODET_API_V |
Finders
| Finder | Parameter | Description |
|---|---|---|
| UUID Lookup | vuuid (path) |
Directly identifies the detail line by its virtual UUID (POCOD_V_UUID) |
HTTP Method & Endpoint
Method: GET
Endpoint:
/po-rest-api/jersey/v1/po-change-order/detail/{vuuid}
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| vuuid | Virtual UUID of the detail line (POCOD_V_UUID) |
A1B2C3D4E5F67890A1B2C3D4E5F67890 |
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/detail/A1B2C3D4E5F67890A1B2C3D4E5F67890
Attributes
The response is a single flat JSON object representing the change order detail line.
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |
|---|---|---|---|---|---|---|---|
| PocodVUuid | changeOrderLine | pocodVUuid | Unique virtual identifier for the detail line | String | 64 | A1B2C3D4E5F67890A1B2C3D4E5F67890 | System Generated |
| PocodCompCode | changeOrderLine | pocodCompCode | Company code | String | 8 | QAT | True |
| PocodPoNum | changeOrderLine | pocodPoNum | Parent purchase order number | String | 20 | PO000004 | True |
| PocodReleaseNum | changeOrderLine | pocodReleaseNum | PO release number | Number | 10 | 1 | True |
| PocodNum | changeOrderLine | pocodNum | Change order number | String | 10 | 1 | True |
| PocodLineNum | changeOrderLine | pocodLineNum | Detail line number | Number | 10 | 1 | True |
| PocodPoItemType | changeOrderLine | pocodPoItemType | Item type (M = Material, S = Service) | String | 1 | M | False |
| PocodClassCode | changeOrderLine | pocodClassCode | Item class code | String | 8 | OFFICE | False |
| PocodItmCode | changeOrderLine | pocodItmCode | Item / product code | String | 20 | PAPER-A4 | False |
| PocodItmName | changeOrderLine | pocodItmName | Item / product name | String | 60 | A4 Copy Paper | False |
| PocodWmCode | changeOrderLine | pocodWmCode | Unit of measure code | String | 4 | BOX | False |
| PocodOrdQty | changeOrderLine | pocodOrdQty | Quantity ordered on the change order line | Number | 10,4 | 100.0000 | False |
| PocodExptdPriceAmt | changeOrderLine | pocodExptdPriceAmt | Expected unit price amount | Number | 10,4 | 12.5000 | False |
| PocodDesc | changeOrderLine | pocodDesc | Line item description | String | 60 | Revised paper order | False |
| PocodExtendedAmt | changeOrderLine | pocodExtendedAmt | Extended line amount (qty × price) | Number | 10,2 | 1250.00 | False |
| PocodTax1Code | changeOrderLine | pocodTax1Code | Tax code 1 | String | 8 | HST | False |
| PocodTax2Code | changeOrderLine | pocodTax2Code | Tax code 2 | String | 8 | — | False |
| PocodTax3Code | changeOrderLine | pocodTax3Code | Tax code 3 | String | 8 | — | False |
| PocodTax1TaxableFlag | changeOrderLine | pocodTax1TaxableFlag | Taxable under tax 1 (Y/N) | String | 1 | Y | False |
| PocodTax2TaxableFlag | changeOrderLine | pocodTax2TaxableFlag | Taxable under tax 2 (Y/N) | String | 1 | N | False |
| PocodTax3TaxableFlag | changeOrderLine | pocodTax3TaxableFlag | Taxable under tax 3 (Y/N) | String | 1 | N | False |
| PocodPoOrdQty | changeOrderLine | pocodPoOrdQty | Original PO ordered quantity | Number | 10,4 | 80.0000 | False |
| PocodActPriceAmt | changeOrderLine | pocodActPriceAmt | Original PO unit price | Number | 10,4 | 11.0000 | False |
| PocodOvrdExptdPriceFlag | changeOrderLine | pocodOvrdExptdPriceFlag | Override expected price flag (Y/N) | String | 1 | Y | False |
| PocodTypeCode | changeOrderLine | pocodTypeCode | Line type code | String | 1 | S | False |
| PocodStatCode | changeOrderLine | pocodStatCode | Line status code | String | 1 | O | False |
| PocodDeptCode | changeOrderLine | pocodDeptCode | Department code | String | 6 | ADMIN | False |
| PocodDeptName | changeOrderLine | pocodDeptName | Department name | String | 60 | Administration | False |
| PocodCurrCode | changeOrderLine | pocodCurrCode | Currency code | String | 3 | US | False |
| PocodCurrName | changeOrderLine | pocodCurrName | Currency name | String | 30 | US Dollar | False |
| PocodJobCode | changeOrderLine | pocodJobCode | Job code | String | 16 | JOB001 | False |
| PocodJobName | changeOrderLine | pocodJobName | Job name associated with the line | String | 60 | Office Renovation | False |
| PocodPhsCode | changeOrderLine | pocodPhsCode | Phase code | String | 16 | PH01 | False |
| PocodPhsName | changeOrderLine | pocodPhsName | Phase name | String | 60 | Phase 1 | False |
| PocodCatCode | changeOrderLine | pocodCatCode | Category code | String | 16 | CAT01 | False |
| PocodCatName | changeOrderLine | pocodCatName | Category name | String | 60 | Supplies | False |
| PocodWipAccCode | changeOrderLine | pocodWipAccCode | WIP account code | String | 20 | WIP-01 | False |
| PocodWipAccName | changeOrderLine | pocodWipAccName | WIP account name | String | 60 | Work In Progress 01 | False |
| PocodWipDeptCode | changeOrderLine | pocodWipDeptCode | WIP department code | String | 6 | WIPD01 | False |
| PocodWipDeptName | changeOrderLine | pocodWipDeptName | WIP department name | String | 60 | WIP Department 01 | False |
| PocodIvAccCode | changeOrderLine | pocodIvAccCode | Inventory account code | String | 20 | INV-001 | False |
| PocodIvAccName | changeOrderLine | pocodIvAccName | Inventory account name | String | 60 | Inventory Account | False |
| PocodIvDeptCode | changeOrderLine | pocodIvDeptCode | Inventory department code | String | 6 | INVDEPT | False |
| PocodIvDeptName | changeOrderLine | pocodIvDeptName | Inventory department name | String | 60 | Inventory Dept | False |
| PocodLocCode | changeOrderLine | pocodLocCode | Location code | String | 8 | LOC01 | False |
| PocodLocName | changeOrderLine | pocodLocName | Location name | String | 60 | Main Warehouse | False |
| PocodItemLocCode | changeOrderLine | pocodItemLocCode | Item location code | String | 7 | ILOC01 | False |
| PocodItemLocName | changeOrderLine | pocodItemLocName | Item location name | String | 60 | Warehouse A | False |
| PocodEqpCode | changeOrderLine | pocodEqpCode | Equipment code | String | 16 | EQP001 | False |
| PocodEqpName | changeOrderLine | pocodEqpName | Equipment name | String | 60 | Forklift 01 | False |
| PocodRecIntoInvFlag | changeOrderLine | pocodRecIntoInvFlag | Receive into inventory flag (Y/N) | String | 1 | Y | False |
| PocodDiscountPct | changeOrderLine | pocodDiscountPct | Discount percentage for the line | Number | 6,2 | 5.00 | False |
| PocodCiitemtypCode | changeOrderLine | pocodCiitemtypCode | Construction item type code | String | 8 | MAT | False |
| PocodCiitemtypName | changeOrderLine | pocodCiitemtypName | Construction item type name | String | 60 | Material | False |
| PocodLineChgFlag | changeOrderLine | pocodLineChgFlag | Line changed flag (Y/N) | String | 1 | N | False |
| PocodCloseCode | changeOrderLine | pocodCloseCode | Close code | String | 1 | — | False |
| PocodCloseReasonCode | changeOrderLine | pocodCloseReasonCode | Close reason code | String | 8 | — | False |
| PocodSubLineNum | changeOrderLine | pocodSubLineNum | Sub-line number | Number | 10 | 0 | False |
| PocodBchNum | changeOrderLine | pocodBchNum | Batch number | Number | 10 | 42 | False |
| PocodInvTypeCode | changeOrderLine | pocodInvTypeCode | Invoice type code | String | 8 | STD | False |
| PocodOrdWmCode | changeOrderLine | pocodOrdWmCode | Order unit of measure code | String | 4 | BOX | False |
| PocodOrdWmName | changeOrderLine | pocodOrdWmName | Order unit of measure name | String | 30 | Box | False |
| PocodInvWmCode | changeOrderLine | pocodInvWmCode | Invoice unit of measure code | String | 4 | BOX | False |
| PocodInvWmName | changeOrderLine | pocodInvWmName | Invoice unit of measure name | String | 30 | Box | False |
| PocodExptdDate | changeOrderLine | pocodExptdDate | Expected delivery date | Date | N/A | 2024-03-31 | False |
| PocodRecDate | changeOrderLine | pocodRecDate | Actual receipt date | Date | N/A | 2024-04-05 | False |
| PocodAdjPriceAmt | changeOrderLine | pocodAdjPriceAmt | Adjusted price amount | Number | 10,4 | 12.5000 | False |
| PocodRecQty | changeOrderLine | pocodRecQty | Quantity received | Number | 10,4 | 50.0000 | False |
| PocodRectodateQty | changeOrderLine | pocodRectodateQty | Cumulative received quantity | Number | 10,4 | 50.0000 | False |
| PocodRejQty | changeOrderLine | pocodRejQty | Quantity rejected | Number | 10,4 | 2.0000 | False |
| PocodRejtodateQty | changeOrderLine | pocodRejtodateQty | Cumulative rejected quantity | Number | 10,4 | 2.0000 | False |
| PocodInvQty | changeOrderLine | pocodInvQty | Invoiced quantity | Number | 10,4 | 25.0000 | False |
| PocodInvtodateQty | changeOrderLine | pocodInvtodateQty | Cumulative invoiced quantity | Number | 10,4 | 25.0000 | False |
| PocodPayQty | changeOrderLine | pocodPayQty | Paid quantity | Number | 10,4 | 25.0000 | False |
| PocodPaytodateQty | changeOrderLine | pocodPaytodateQty | Cumulative paid quantity | Number | 10,4 | 25.0000 | False |
| PocodAllocatedQty | changeOrderLine | pocodAllocatedQty | Allocated quantity | Number | 10,4 | 0.0000 | False |
| PocodLstOrdQty | changeOrderLine | pocodLstOrdQty | Last ordered quantity | Number | 10,4 | 80.0000 | False |
| PocodClaimQty | changeOrderLine | pocodClaimQty | Claim quantity | Number | 10,4 | 0.0000 | False |
| PocodClaimtodateQty | changeOrderLine | pocodClaimtodateQty | Cumulative claim quantity | Number | 10,4 | 0.0000 | False |
| PocodSrcCompCode | changeOrderLine | pocodSrcCompCode | Source company code | String | 8 | QAT | False |
| PocodSrcCompName | changeOrderLine | pocodSrcCompName | Source company name | String | 60 | QAT Company | False |
| PocodPmCode | changeOrderLine | pocodPmCode | Project management code | String | 8 | — | False |
| PocodExpCode | changeOrderLine | pocodExpCode | Expense code | String | 8 | — | False |
| PocodTrancodeCode | changeOrderLine | pocodTrancodeCode | Transaction code | String | 8 | — | False |
| PocodTrancodeName | changeOrderLine | pocodTrancodeName | Transaction code name | String | 60 | — | False |
| PocodShplCode | changeOrderLine | pocodShplCode | Shipment line code | String | 8 | FEDEX | False |
| PocodItmtypCode | changeOrderLine | pocodItmtypCode | Item type code | String | 8 | MAT | False |
| PocodItmtypName | changeOrderLine | pocodItmtypName | Item type name | String | 60 | Material | False |
| PocodWmName | changeOrderLine | pocodWmName | Unit of measure name | String | 30 | Box | False |
| PocodItemWmCode | changeOrderLine | pocodItemWmCode | Item unit of measure code | String | 4 | BOX | False |
| PocodCostAmt | changeOrderLine | pocodCostAmt | Cost amount | Number | 10,2 | 1000.00 | False |
| PocodStdCostAmt | changeOrderLine | pocodStdCostAmt | Standard cost amount | Number | 10,2 | 950.00 | False |
| PocodAvgCostAmt | changeOrderLine | pocodAvgCostAmt | Average cost amount | Number | 10,2 | 975.00 | False |
| PocodLstCostAmt | changeOrderLine | pocodLstCostAmt | Last cost amount | Number | 10,2 | 960.00 | False |
| PocodVarAccCode | changeOrderLine | pocodVarAccCode | Variance account code | String | 20 | — | False |
| PocodVarAccName | changeOrderLine | pocodVarAccName | Variance account name | String | 60 | — | False |
| PocodVarDeptCode | changeOrderLine | pocodVarDeptCode | Variance department code | String | 6 | — | False |
| PocodVarDeptName | changeOrderLine | pocodVarDeptName | Variance department name | String | 60 | — | False |
| PocodIvCode | changeOrderLine | pocodIvCode | Inventory code | String | 8 | — | False |
| PocodJobCtrlCode | changeOrderLine | pocodJobCtrlCode | Job control code | String | 8 | — | False |
| PocodPhsCtrlCode | changeOrderLine | pocodPhsCtrlCode | Phase control code | String | 8 | — | False |
| PocodCatCtrlCode | changeOrderLine | pocodCatCtrlCode | Category control code | String | 8 | — | False |
| PocodEcEqpCode | changeOrderLine | pocodEcEqpCode | Equipment cost equipment code | String | 16 | — | False |
| PocodEcCstCode | changeOrderLine | pocodEcCstCode | Equipment cost cost code | String | 16 | — | False |
| PocodComponCode | changeOrderLine | pocodComponCode | Component code | String | 16 | — | False |
| PocodComponName | changeOrderLine | pocodComponName | Component name | String | 60 | — | False |
Security
HTTP
Type basic
Basic authentication
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\n \"pocodVUuid\": \"4E7ECC5F8D3F3AD8E0630B811DAC7BCF\",\n \"pocodCompCode\": \"QAT\",\n \"pocodCompName\": \"QA Test Company\",\n \"pocodPoNum\": \"JP000013\",\n \"pocodNum\": \"*\",\n \"pocodLineNum\": 1,\n \"pocodReleaseNum\": 1,\n \"pocodBchNum\": null,\n \"pocodDeptCode\": \"00\",\n \"pocodDeptName\": \"Company Level\",\n \"pocodItmCode\": \"WIDGET1\",\n \"pocodItmName\": \"Widget 1\",\n \"pocodItmtypCode\": null,\n \"pocodItmtypName\": null,\n \"pocodIvDeptCode\": null,\n \"pocodIvDeptName\": null,\n \"pocodIvAccCode\": null,\n \"pocodIvAccName\": null,\n \"pocodVarDeptCode\": null,\n \"pocodVarDeptName\": null,\n \"pocodVarAccCode\": null,\n \"pocodVarAccName\": null,\n \"pocodExptdDate\": null,\n \"pocodRecDate\": null,\n \"pocodExptdPriceAmt\": 20,\n \"pocodActPriceAmt\": null,\n \"pocodAdjPriceAmt\": null,\n \"pocodCostAmt\": null,\n \"pocodStdCostAmt\": null,\n \"pocodAvgCostAmt\": null,\n \"pocodLstCostAmt\": null,\n \"pocodCurrCode\": \"US\",\n \"pocodCurrName\": \"US Dollars\",\n \"pocodOrdQty\": 10,\n \"pocodLstOrdQty\": 10,\n \"pocodRecQty\": null,\n \"pocodRectodateQty\": null,\n \"pocodRejQty\": null,\n \"pocodRejtodateQty\": null,\n \"pocodClaimQty\": null,\n \"pocodClaimtodateQty\": null,\n \"pocodPayQty\": null,\n \"pocodPaytodateQty\": null,\n \"pocodInvQty\": null,\n \"pocodInvtodateQty\": null,\n \"pocodWmCode\": null,\n \"pocodWmName\": null,\n \"pocodOrdWmCode\": \"EA\",\n \"pocodOrdWmName\": \"Each\",\n \"pocodInvWmCode\": null,\n \"pocodInvWmName\": null,\n \"pocodStatCode\": \"O\",\n \"pocodLocCode\": \"LOC1\",\n \"pocodLocName\": \"Location 1\",\n \"pocodJobCode\": null,\n \"pocodJobName\": null,\n \"pocodJobCtrlCode\": null,\n \"pocodPhsCode\": null,\n \"pocodPhsName\": null,\n \"pocodPhsCtrlCode\": null,\n \"pocodCatCode\": null,\n \"pocodCatName\": null,\n \"pocodCatCtrlCode\": null,\n \"pocodTxt1Code\": null,\n \"pocodTxt1Name\": null,\n \"pocodTxt2Code\": null,\n \"pocodTxt2Name\": null,\n \"pocodTxt3Code\": null,\n \"pocodTxt3Name\": null,\n \"pocodDesc\": null,\n \"pocodOrdTrnNum\": null,\n \"pocodRecTrnNum\": null,\n \"pocodIvCode\": \"N\",\n \"pocodCloseCode\": null,\n \"pocodSubLineNum\": null,\n \"pocodEcEqpCode\": null,\n \"pocodEcCstCode\": null,\n \"pocodQuoteNum\": null,\n \"pocodTax1Code\": \"CA\",\n \"pocodTax1Name\": \"California State Tax\",\n \"pocodTax2Code\": \"CHICAGO\",\n \"pocodTax2Name\": \"Chicago Compound Tax\",\n \"pocodTax3Code\": \"IL\",\n \"pocodTax3Name\": \"Illinois State Tax\",\n \"pocodTax1TaxableFlag\": \"Y\",\n \"pocodTax2TaxableFlag\": \"Y\",\n \"pocodTax3TaxableFlag\": \"Y\",\n \"pocodLineChgFlag\": null,\n \"pocodShplCode\": null,\n \"pocodWipAccCode\": \"5300.102\",\n \"pocodWipAccName\": \"Equipment Insurance\",\n \"pocodWipDeptCode\": \"00\",\n \"pocodWipDeptName\": \"Company Level\",\n \"pocodSwoOraseq\": null,\n \"pocodWbsvCode1\": null,\n \"pocodWbsvCode2\": null,\n \"pocodWbsvCode3\": null,\n \"pocodWbsvCode4\": null,\n \"pocodWbsvCode5\": null,\n \"pocodWbsvCode6\": null,\n \"pocodWbsvCode7\": null,\n \"pocodWbsvCode8\": null,\n \"pocodWbsvCode9\": null,\n \"pocodWbsvCode10\": null,\n \"pocodWbsvCode11\": null,\n \"pocodWbsvCode12\": null,\n \"pocodPmCode\": null,\n \"pocodEqpCode\": \"QATTR3\",\n \"pocodEqpName\": \"QAT Truck 3\",\n \"pocodComponCode\": \"ALL\",\n \"pocodComponName\": \"No Components\",\n \"pocodTrancodeCode\": \"102\",\n \"pocodTrancodeName\": \"Insurance\",\n \"pocodTendpackCode\": null,\n \"pocodTendpackLineNum\": null,\n \"pocodSiNum\": null,\n \"pocodSiLineNum\": null,\n \"pocodSrcCompCode\": \"QAT\",\n \"pocodSrcCompName\": \"QA Test Company\",\n \"pocodClassCode\": null,\n \"pocodClassName\": null,\n \"pocodCiitemtypCode\": null,\n \"pocodCiitemtypName\": null,\n \"pocodInvTypeCode\": null,\n \"pocodItemLocCode\": null,\n \"pocodItemLocName\": null,\n \"pocodTypeCode\": \"E\",\n \"pocodSiMastJobCode\": null,\n \"pocodCloseReasonCode\": null,\n \"pocodAllocatedQty\": null,\n \"pocodRecIntoInvFlag\": \"N\",\n \"pocodWoCode\": null,\n \"pocodWitmLineNumber\": null,\n \"pocodExpCode\": null,\n \"pocodWDetailCode\": null,\n \"pocodUserTypeCode\": \"E\",\n \"pocodUserField1\": \"QAT\",\n \"pocodUserField2\": \"QATTR3\",\n \"pocodUserField3\": \"ALL\",\n \"pocodUserField4\": \"102\",\n \"pocodUserField5\": null,\n \"pocodUserField6\": null,\n \"pocodUserField7\": null,\n \"pocodUserField8\": null,\n \"pocodTavCode1\": null,\n \"pocodTavCode2\": null,\n \"pocodTavCode3\": null,\n \"pocodTavCode4\": null,\n \"pocodObjectOraseq\": 3450856,\n \"pocodExtendedAmt\": 200,\n \"pocodPoTypeCode\": \"S\",\n \"pocodPoItemType\": \"N\",\n \"pocodItemWmCode\": \"EA\",\n \"pocodOvrdExptdPriceFlag\": null,\n \"pocodIuCreateDate\": \"2013-12-18T10:50:11-05:00\",\n \"pocodIuCreateUser\": \"QA3\",\n \"pocodIuUpdateDate\": null,\n \"pocodIuUpdateUser\": null,\n \"pocodUserFieldName5\": null,\n \"pocodUserFieldName6\": null,\n \"pocodUserFieldName7\": null,\n \"pocodUserFieldName8\": null\n}"string