Get
/po-rest-api/jersey/v1/purchase-change-order/master
Get Change Order Masters (List API)
Overview
Returns a paginated list of PO Change Order master (header) records only, without any detail lines.
This API is used when you need header-level information about change orders — such as vendor, status, amounts, and dates — without the overhead of fetching line items. Sourced from PO_COMAST_API_V.
Notes
Pagination is supported using
limitandoffset.At least one filter parameter is required. Requests with no filters return
400 Bad Request.All string filter values are automatically uppercased before being applied.
Results can be sorted using
orderBy. Accepted sort keys:companyCode,poNumber,coNumber,releaseNumber,createDate,updateDate,oraseq. AppendDESCfor descending order.Maximum
limitis 200. Values above 200 are clamped to 200.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 |
|---|---|---|
| Filter by Company | companyCode |
Filters by company code (POCOH_COMP_CODE) |
| Filter by PO Number | poNumber |
Filters by purchase order number (POCOH_PO_NUM) |
| Filter by CO Number | coNumber |
Filters by change order number (POCOH_NUM) |
| Filter by Release | releaseNumber |
Filters by release number (POCOH_RELEASE_NUM) — must be a valid integer |
| Audit Date | auditDate |
Returns records where the later of create date / update date ≥ supplied date. Format: YYYY-MM-DD |
HTTP Method & Endpoint
Method: GET
Endpoint:
/po-rest-api/jersey/v1/po-change-order/master
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| N/A | This endpoint does not require path parameters | N/A |
Query Parameters
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| companyCode | String | Conditional* | — | Company code filter |
| poNumber | String | Conditional* | — | Purchase order number filter |
| coNumber | String | Conditional* | — | Change order number filter |
| releaseNumber | Integer | Conditional* | — | Release number filter (must be a valid integer) |
| auditDate | String | Conditional* | — | Audit date filter in YYYY-MM-DD format |
| limit | Integer | No | 25 | Number of records to return (max 200) |
| offset | Integer | No | 0 | Starting index of records |
| orderBy | String | No | — | Sort field and direction e.g. createDate DESC |
<p >* At least one filter parameter is required.</p>
Example Request
/po-rest-api/jersey/v1/po-change-order/master?companyCode=QAT&limit=25&offset=0
/po-rest-api/jersey/v1/po-change-order/master?companyCode=QAT&poNumber=PO000004&orderBy=coNumber DESC
/po-rest-api/jersey/v1/po-change-order/master?auditDate=2024-01-01&limit=50
Attributes
The response contains an items array. Each object in the array represents one 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 |
| 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 |
| PocohCurrConvNum | changeOrderHeader | pocohCurrConvNum | Currency conversion number | Number | 10,6 | 1.0 | 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 |
| PocohReprintDate | changeOrderHeader | pocohReprintDate | Last reprint date | Date | N/A | 2024-02-20 | 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 |
| PocohReqReason | changeOrderHeader | pocohReqReason | Requisition reason text | String | 240 | Price adjustment | False |
| PocohInvTypeCode | changeOrderHeader | pocohInvTypeCode | Invoice type code | String | 8 | STD | False |
| PocohImageFilename | changeOrderHeader | pocohImageFilename | Attached image filename | String | 60 | co_signed.pdf | False |
| PocohInvSerCode | changeOrderHeader | pocohInvSerCode | Invoice serial code | String | 4 | SER001 | False |
| PocohVendOrderAddCode | changeOrderHeader | pocohVendOrderAddCode | Vendor ordering address code | String | 10 | VEND-ADDR-01 | 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 |
| PocohAddCompCode | changeOrderHeader | pocohAddCompCode | Address company code | String | 8 | QAT | False |
| PocohAddCompName | changeOrderHeader | pocohAddCompName | Address company name | String | 60 | QAT Company | False |
| PocohPrintDate | changeOrderHeader | pocohPrintDate | Date the CO was printed | Date | N/A | 2024-01-16 | False |
| PocohDefaultRecCode | changeOrderHeader | pocohDefaultRecCode | Default receiving code | String | 1 | F | 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 |
| PocohManPoRecFlag | changeOrderHeader | pocohManPoRecFlag | Manual PO receipt flag (Y/N) | String | 1 | N | False |
| PocohAcctDescription | changeOrderHeader | pocohAcctDescription | Account description | String | 60 | Operating Expenses | 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 |
| PocohBlkLineItemsFlag | changeOrderHeader | pocohBlkLineItemsFlag | Block individual line item edits (Y/N) | String | 1 | N | 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
Query parameters
companyCode
string
ExampleALT
poNumber
string
ExampleJP000017
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\n \"items\": [\n {\n \"pocohVUuid\": \"4E69C789753EFD36E0630B811DAC6604\",\n \"pocohCompCode\": \"ALT\",\n \"pocohCompName\": \"Andy's Company ALT\",\n \"pocohPoNum\": \"JP000017\",\n \"pocohNum\": \"*\",\n \"pocohBchNum\": 670,\n \"pocohVenCode\": \"ALIED\",\n \"pocohVenName\": \"Alied Recycling\",\n \"pocohDeptCode\": null,\n \"pocohDeptName\": null,\n \"pocohExptdDate\": \"2010-04-22\",\n \"pocohOrdDate\": \"2010-04-08T12:49:12-04:00\",\n \"pocohRecDate\": null,\n \"pocohTypeCode\": \"S\",\n \"pocohAdjCode\": null,\n \"pocohStatCode\": \"O\",\n \"pocohChgCode\": \"O\",\n \"pocohTermCode\": \"NET30\",\n \"pocohTermName\": \"Net 30\",\n \"pocohInvCode\": null,\n \"pocohInvDate\": null,\n \"pocohInvDueDate\": null,\n \"pocohInvDiscDate\": null,\n \"pocohInvDiscAmt\": null,\n \"pocohCurrCode\": \"US\",\n \"pocohCurrName\": \"US Dollars\",\n \"pocohFobCode\": null,\n \"pocohBuyCode\": \"DA\",\n \"pocohAddCode\": null,\n \"pocohShplneCode\": null,\n \"pocohShpmetCode\": null,\n \"pocohTxt1Code\": null,\n \"pocohTxt2Code\": null,\n \"pocohShpinstDesc\": null,\n \"pocohDesc1\": null,\n \"pocohDesc2\": null,\n \"pocohAdjPrice\": null,\n \"pocohUnadjPrice\": null,\n \"pocohCurrConvNum\": null,\n \"pocohCostedCode\": null,\n \"pocohRefNum\": null,\n \"pocohRefDate\": \"2010-04-08T12:49:12-04:00\",\n \"pocohReqCode\": \"DA\",\n \"pocohRecCode\": null,\n \"pocohReprintDate\": null,\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\": null,\n \"pocohComplianceFlag\": null,\n \"pocohJobCompCode\": null,\n \"pocohJobCompName\": null,\n \"pocohJobCode\": null,\n \"pocohJobName\": null,\n \"pocohContactCode\": null,\n \"pocohAddCompCode\": null,\n \"pocohAddCompName\": null,\n \"pocohPrintDate\": null,\n \"pocohDefaultRecCode\": null,\n \"pocohDate\": null,\n \"pocohPoTotal\": 85000,\n \"pocohIuCreateDate\": \"2010-04-08T12:52:07-04:00\",\n \"pocohIuCreateUser\": \"ANDYTESTV10\",\n \"pocohIuUpdateDate\": null,\n \"pocohIuUpdateUser\": null,\n \"pocohManPoRecFlag\": null,\n \"pocohAcctDescription\": null,\n \"pocohLumpSumPoFlag\": null,\n \"pocohLumpSumPoAmt\": null,\n \"pocohVenTax1\": null,\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 }\n ],\n \"totalCount\": 1,\n \"limit\": 25,\n \"offset\": 0,\n \"hasMore\": false,\n \"count\": 1\n}"string