Press CTRL+K to open search

Get Purchase Order Header

  • Published on Oct 7, 2026
Prev Next
Get
/po-rest-api/jersey/v1/purchase-order/

GET /v1/purchase-order — Find Purchase Order Headers

Overview

This endpoint retrieves Purchase Order headers only based on search filters.

It returns header-level information without detail lines. At least one filter parameter must be provided. Results are paginated and ordered by internal 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.

  • This endpoint returns header records only — detail lines are not included. Use GET /v1/purchase-order/{vuuid} to retrieve a full Purchase Order with lines.

UI Navigation

Asset Management → Purchase Orders → Purchase Order Entry

Finders

This endpoint supports the following finder parameters:

  • compCode — Filter by company code

  • poNum — Filter by Purchase Order number

  • venCode — Filter by vendor code

  • releaseNum — Filter by release number

At least one finder parameter must be supplied.

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 Purchase Order number filter String N/A N/A
venCode Vendor code filter String N/A N/A
releaseNum Release number filter Integer N/A N/A
limit Maximum number of records to return Integer 25 200
offset Number of records to skip Integer 0 N/A

Finders with Example

Find by Company Code

GET /v1/purchase-order?compCode=CL02

Find by Company Code and Vendor

GET /v1/purchase-order?compCode=CL02&venCode=VEN001

Find with Pagination

GET /v1/purchase-order?compCode=CL02&limit=50&offset=0

Attributes

The response contains an items array, along with pagination metadata.

Each object in the items array represents one Purchase Order header.

Response Structure

Field Description Type
items Array of Purchase Order header records Array
totalCount Total number of matching records Number
limit Applied page size Number
offset Applied offset Number
hasMore Whether more records exist beyond current page Boolean
count Number of records in current response Number

Header Attributes (PoMasterItem)

CMiC UI Fieldname Object Name Description Type Data Length
PomstCompCode header pomstCompCode Company code String 8
PomstNum header pomstNum Purchase Order number String 10
PomstBchNum header pomstBchNum Batch number Number 10
PomstVenCode header pomstVenCode Vendor code String 8
PomstDeptCode header pomstDeptCode Department code String 6
PomstExptdDate header pomstExptdDate Expected delivery date Date N/A
PomstOrdDate header pomstOrdDate Order date Date N/A
PomstTypeCode header pomstTypeCode PO type code String 4
PomstStatCode header pomstStatCode Status code String 4
PomstTermCode header pomstTermCode Payment terms code String 4
PomstCurrCode header pomstCurrCode Currency code String 4
PomstFobCode header pomstFobCode FOB code String 4
PomstBuyCode header pomstBuyCode Buyer code String 8
PomstAddCode header pomstAddCode Ship-to address code String 8
PomstShplneCode header pomstShplneCode Shipping line code String 8
PomstShpmetCode header pomstShpmetCode Shipment method code String 8
PomstTxt1Code header pomstTxt1Code Text code 1 String 8
PomstTxt2Code header pomstTxt2Code Text code 2 String 8
PomstShpinstDesc header pomstShpinstDesc Shipping instructions String 255
PomstDesc1 header pomstDesc1 Description line 1 String 255
PomstDesc2 header pomstDesc2 Description line 2 String 255
PomstReqCode header pomstReqCode Requisition code String 8
PomstWipAccCode header pomstWipAccCode WIP account code String 20
PomstWipDeptCode header pomstWipDeptCode WIP department code String 6
PomstShipinstTxt1Code header pomstShipinstTxt1Code Shipping instruction text code 1 String 8
PomstShipinstTxt2Code header pomstShipinstTxt2Code Shipping instruction text code 2 String 8
PomstShipinstTxt3Code header pomstShipinstTxt3Code Shipping instruction text code 3 String 8
PomstShipinstTxt4Code header pomstShipinstTxt4Code Shipping instruction text code 4 String 8
PomstShipinstTxt5Code header pomstShipinstTxt5Code Shipping instruction text code 5 String 8
PomstReleaseNum header pomstReleaseNum Release number Number 6
PomstBilltoAddCode header pomstBilltoAddCode Bill-to address code String 8
PomstReqReason header pomstReqReason Requisition reason String 255
PomstVendOrderAddCode header pomstVendOrderAddCode Vendor order address code String 8
PomstComplianceFlag header pomstComplianceFlag Compliance flag (Y/N) String 1
PomstActionCode header pomstActionCode Action code String 4
PomstPrintStatus header pomstPrintStatus Print status String 4
PomstJobCompCode header pomstJobCompCode Job company code String 8
PomstJobCode header pomstJobCode Job code String 12
PomstContactCode header pomstContactCode Contact code String 8
PomstHoldPaymentFlag header pomstHoldPaymentFlag Hold payment flag (Y/N) String 1
PomstHoldPaymentDays header pomstHoldPaymentDays Hold payment days Number 6
PomstAddCompCode header pomstAddCompCode Address company code String 8
PomstSuspDeptCode header pomstSuspDeptCode Suspense department code String 6
PomstPorgrCode header pomstPorgrCode PO group code String 8
PomstDefaultRecCode header pomstDefaultRecCode Default receiving code String 8
PomstRoutCompCode header pomstRoutCompCode Routing company code String 8
PomstRoutJobCode header pomstRoutJobCode Routing job code String 12
PomstDistTypeCode header pomstDistTypeCode Distribution type code String 4
PomstUserField1 header pomstUserField1 User-defined field 1 String 30
PomstUserField2 header pomstUserField2 User-defined field 2 String 30
PomstUserField3 header pomstUserField3 User-defined field 3 String 30
PomstVUuid header pomstVUuid Virtual unique identifier String 64
PomstAdvPayAmt header pomstAdvPayAmt Advance payment amount Number 14,2
PomstAdvPayPct header pomstAdvPayPct Advance payment percentage Number 6,2
PomstAdvPayMultiFlag header pomstAdvPayMultiFlag Allow multiple advance payments (Y/N) String 1
PomstIuCreateDate header pomstIuCreateDate Record creation date Timestamp N/A
PomstIuCreateUser header pomstIuCreateUser Record created by String 30
PomstIuUpdateDate header pomstIuUpdateDate Last update date Timestamp N/A
PomstIuUpdateUser header pomstIuUpdateUser 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            \"pomstCompCode\": \"ZZ\",\n            \"pomstNum\": \"PZZ00012\",\n            \"pomstBchNum\": null,\n            \"pomstVenCode\": \"ZZ-ACME\",\n            \"pomstDeptCode\": null,\n            \"pomstExptdDate\": null,\n            \"pomstOrdDate\": \"2026-05-10 18:38:09.0\",\n            \"pomstTypeCode\": \"S\",\n            \"pomstStatCode\": \"N\",\n            \"pomstTermCode\": \"TESTCO\",\n            \"pomstCurrCode\": \"US\",\n            \"pomstFobCode\": null,\n            \"pomstBuyCode\": \"ON\",\n            \"pomstAddCode\": \"ADD1\",\n            \"pomstShplneCode\": \"DHL\",\n            \"pomstShpmetCode\": null,\n            \"pomstTxt1Code\": null,\n            \"pomstTxt2Code\": null,\n            \"pomstShpinstDesc\": null,\n            \"pomstDesc1\": null,\n            \"pomstDesc2\": null,\n            \"pomstReqCode\": \"DA\",\n            \"pomstWipAccCode\": null,\n            \"pomstWipDeptCode\": null,\n            \"pomstShipinstTxt1Code\": null,\n            \"pomstShipinstTxt2Code\": null,\n            \"pomstShipinstTxt3Code\": null,\n            \"pomstShipinstTxt4Code\": null,\n            \"pomstShipinstTxt5Code\": null,\n            \"pomstReleaseNum\": 1,\n            \"pomstBilltoAddCode\": \"ADD2\",\n            \"pomstReqReason\": null,\n            \"pomstVendOrderAddCode\": \"A1\",\n            \"pomstComplianceFlag\": \"N\",\n            \"pomstActionCode\": null,\n            \"pomstPrintStatus\": null,\n            \"pomstJobCompCode\": \"ZZ\",\n            \"pomstJobCode\": null,\n            \"pomstContactCode\": null,\n            \"pomstHoldPaymentFlag\": \"N\",\n            \"pomstHoldPaymentDays\": null,\n            \"pomstAddCompCode\": \"ZZ\",\n            \"pomstSuspDeptCode\": null,\n            \"pomstIuCreateDate\": \"2026-05-10T18:38:09-04:00\",\n            \"pomstIuCreateUser\": \"YASHB\",\n            \"pomstIuUpdateDate\": \"2026-05-10T18:53:31-04:00\",\n            \"pomstIuUpdateUser\": \"YASHB\",\n            \"pomstPorgrCode\": null,\n            \"pomstDefaultRecCode\": \"M\",\n            \"pomstRoutCompCode\": null,\n            \"pomstRoutJobCode\": null,\n            \"pomstDistTypeCode\": \"G\",\n            \"pomstUserField1\": null,\n            \"pomstUserField2\": null,\n            \"pomstUserField3\": null,\n            \"pomstVUuid\": \"517F3F288557309DE0630B811DAC183E\",\n            \"pomstAdvPayAmt\": null,\n            \"pomstAdvPayPct\": null,\n            \"pomstAdvPayMultiFlag\": \"N\"\n        }\n    ],\n    \"totalCount\": 1,\n    \"limit\": 25,\n    \"offset\": 0,\n    \"hasMore\": false,\n    \"count\": 1\n}"
string
Contact Us
Copyright © 2024 CMiC All Rights Reserved