Get
/po-rest-api/jersey/v1/purchase-order/lines
GET /v1/purchase-order/lines — Find Purchase Order Lines
Overview
This endpoint retrieves Purchase Order detail lines based on search filters.
At least one filter parameter must be provided. Results are paginated and ordered by sequence number.
Notes
Authentication and authorization are required.
At least one query filter must be provided; otherwise the request is rejected.
Results are paginated with a default limit of 25 and a maximum of 200.
Filter parameters are case-sensitive.
UI Navigation
Asset Management → Purchase Orders → Purchase Order Entry
Finders
This endpoint supports the following finder parameters:
compCode— Filter by company codepoNum— Filter by Purchase Order numberreleaseNum— Filter by release numberlineNum— Filter by line numberitmCode— Filter by item code
Path Parameters
Not applicable.
This endpoint does not use path parameters.
Query Standards
| Parameter | Description | Type | Default | Max |
|---|---|---|---|---|
| compCode | Company code filter | String | N/A | N/A |
| poNum | PO number filter | String | N/A | N/A |
| releaseNum | Release number filter | Integer | N/A | N/A |
| lineNum | Line number filter | Integer | N/A | N/A |
| itmCode | Item code filter | String | N/A | N/A |
| limit | Max records to return | Integer | 25 | 200 |
| offset | Records to skip | Integer | 0 | N/A |
Finders with Example
Find by Company Code and PO Number
GET /v1/purchase-order/lines?compCode=CL02&poNum=PO-000123
Find by Item Code
GET /v1/purchase-order/lines?itmCode=ITEM001
Find with Pagination
GET /v1/purchase-order/lines?compCode=CL02&limit=50&offset=0
Attributes
The response contains an items array with pagination metadata (totalCount, limit, offset, hasMore, count).
Each object in the items array represents one Purchase Order detail line.
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length |
|---|---|---|---|---|---|
| PosCompCode | line | posCompCode | Company code | String | 8 |
| PosPoNum | line | posPoNum | Purchase Order number | String | 10 |
| PosReleaseNum | line | posReleaseNum | Release number | Number | 6 |
| PosLineNum | line | posLineNum | Line number | Number | 6 |
| PosPoItemType | line | posPoItemType | PO item type | String | 4 |
| PosItmCode | line | posItmCode | Item code | String | 20 |
| PosItmName | line | posItmName | Item name | String | 60 |
| PosWmCode | line | posWmCode | Work method code | String | 8 |
| PosOrdQty | line | posOrdQty | Ordered quantity | Number | 14,4 |
| PosExptdPriceAmt | line | posExptdPriceAmt | Expected unit price | Number | 14,4 |
| PosUserTypeCode | line | posUserTypeCode | User type code | String | 4 |
| PosUserField1 | line | posUserField1 | User-defined field 1 | String | 30 |
| PosUserField2 | line | posUserField2 | User-defined field 2 | String | 30 |
| PosUserField3 | line | posUserField3 | User-defined field 3 | String | 30 |
| PosUserField4 | line | posUserField4 | User-defined field 4 | String | 30 |
| PosUserField5 | line | posUserField5 | User-defined field 5 | String | 30 |
| PosUserField6 | line | posUserField6 | User-defined field 6 | String | 30 |
| PosUserField7 | line | posUserField7 | User-defined field 7 | String | 30 |
| PosUserField8 | line | posUserField8 | User-defined field 8 | String | 30 |
| PosCiitemtypCode | line | posCiitemtypCode | Inventory item type code | String | 8 |
| PosItemLocCode | line | posItemLocCode | Item location code | String | 7 |
| PosTax1Code | line | posTax1Code | Tax code 1 | String | 8 |
| PosTax2Code | line | posTax2Code | Tax code 2 | String | 8 |
| PosTax3Code | line | posTax3Code | Tax code 3 | String | 8 |
| PosTax1TaxableFlag | line | posTax1TaxableFlag | Tax 1 taxable flag | String | 1 |
| PosTax2TaxableFlag | line | posTax2TaxableFlag | Tax 2 taxable flag | String | 1 |
| PosTax3TaxableFlag | line | posTax3TaxableFlag | Tax 3 taxable flag | String | 1 |
| PosExtdAmt | line | posExtdAmt | Extended amount | Number | 14,2 |
| PosTaxAmt | line | posTaxAmt | Tax amount | Number | 14,2 |
| PosTotAmt | line | posTotAmt | Total amount | Number | 14,2 |
| PosRecIntoInvFlag | line | posRecIntoInvFlag | Receive into inventory flag | String | 1 |
| PosDesc | line | posDesc | Line description | String | 255 |
| PosWbsvCode1 | line | posWbsvCode1 | WBS value code 1 | String | 20 |
| PosWbsvCode2 | line | posWbsvCode2 | WBS value code 2 | String | 20 |
| PosWbsvCode3 | line | posWbsvCode3 | WBS value code 3 | String | 20 |
| PosWbsvCode4 | line | posWbsvCode4 | WBS value code 4 | String | 20 |
| PosExptdDate | line | posExptdDate | Expected date | Timestamp | N/A |
| PosVUuid | line | posVUuid | Detail line UUID | String | 64 |
| PomstVUuid | line | pomstVUuid | Parent header UUID | String | 64 |
| PosIuCreateDate | line | posIuCreateDate | Record creation date | Timestamp | N/A |
| PosIuCreateUser | line | posIuCreateUser | Record created by | String | 30 |
| PosIuUpdateDate | line | posIuUpdateDate | Last update date | Timestamp | N/A |
| PosIuUpdateUser | line | posIuUpdateUser | Last updated by | String | 30 |
Security
HTTP
Type basic
Basic authentication
Query parameters
compCode
string
ExampleZZ
poNum
string
ExamplePZZ00012
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\n \"items\": [\n {\n \"posCompCode\": \"ZZ\",\n \"posPoNum\": \"PZZ00012\",\n \"posReleaseNum\": 1,\n \"posLineNum\": 1,\n \"posPoItemType\": \"I\",\n \"posItmCode\": \"DONUT\",\n \"posItmName\": \"donut\",\n \"posWmCode\": \"EA\",\n \"posOrdQty\": 12,\n \"posExptdPriceAmt\": 0,\n \"posUserTypeCode\": \"G\",\n \"posUserField1\": \"ZZ\",\n \"posUserField2\": \"50\",\n \"posUserField3\": \"1700.400\",\n \"posUserField4\": null,\n \"posUserField5\": \"TAC1V1\",\n \"posUserField6\": \"1\",\n \"posUserField7\": null,\n \"posUserField8\": \"TAV4_1\",\n \"posCiitemtypCode\": \"1\",\n \"posItemLocCode\": \"MAIN\",\n \"posTax1Code\": \"K1\",\n \"posTax2Code\": null,\n \"posTax3Code\": null,\n \"posTax1TaxableFlag\": \"Y\",\n \"posTax2TaxableFlag\": \"Y\",\n \"posTax3TaxableFlag\": \"Y\",\n \"posExtdAmt\": 0,\n \"posTaxAmt\": 0,\n \"posTotAmt\": 0,\n \"posRecIntoInvFlag\": \"N\",\n \"posDesc\": \"donut\",\n \"posWbsvCode1\": null,\n \"posWbsvCode2\": null,\n \"posWbsvCode3\": null,\n \"posWbsvCode4\": null,\n \"posExptdDate\": null,\n \"posVUuid\": \"517F3F28859C309DE0630B811DAC183E\",\n \"pomstVUuid\": \"517F3F288557309DE0630B811DAC183E\",\n \"posIuCreateDate\": \"2026-05-10T18:51:04-04:00\",\n \"posIuCreateUser\": \"YASHB\",\n \"posIuUpdateDate\": null,\n \"posIuUpdateUser\": null\n },\n {\n \"posCompCode\": \"ZZ\",\n \"posPoNum\": \"PZZ00012\",\n \"posReleaseNum\": 1,\n \"posLineNum\": 2,\n \"posPoItemType\": \"I\",\n \"posItmCode\": \"DONUT\",\n \"posItmName\": \"donut\",\n \"posWmCode\": \"EA\",\n \"posOrdQty\": 12,\n \"posExptdPriceAmt\": 0,\n \"posUserTypeCode\": \"G\",\n \"posUserField1\": \"ZZ\",\n \"posUserField2\": \"50\",\n \"posUserField3\": \"1700.400\",\n \"posUserField4\": null,\n \"posUserField5\": \"TAC1V1\",\n \"posUserField6\": \"1\",\n \"posUserField7\": null,\n \"posUserField8\": \"TAV4_1\",\n \"posCiitemtypCode\": \"1\",\n \"posItemLocCode\": \"MAIN\",\n \"posTax1Code\": \"K1\",\n \"posTax2Code\": null,\n \"posTax3Code\": null,\n \"posTax1TaxableFlag\": \"Y\",\n \"posTax2TaxableFlag\": \"Y\",\n \"posTax3TaxableFlag\": \"Y\",\n \"posExtdAmt\": 0,\n \"posTaxAmt\": 0,\n \"posTotAmt\": 0,\n \"posRecIntoInvFlag\": \"N\",\n \"posDesc\": \"donut\",\n \"posWbsvCode1\": null,\n \"posWbsvCode2\": null,\n \"posWbsvCode3\": null,\n \"posWbsvCode4\": null,\n \"posExptdDate\": null,\n \"posVUuid\": \"517F3F2885A2309DE0630B811DAC183E\",\n \"pomstVUuid\": \"517F3F288557309DE0630B811DAC183E\",\n \"posIuCreateDate\": \"2026-05-10T18:53:31-04:00\",\n \"posIuCreateUser\": \"YASHB\",\n \"posIuUpdateDate\": null,\n \"posIuUpdateUser\": null\n }\n ],\n \"totalCount\": 2,\n \"limit\": 25,\n \"offset\": 0,\n \"hasMore\": false,\n \"count\": 2\n}"string