Press CTRL+K to open search

Get Purchase Order Record

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

GET /v1/purchase-order/

Overview

This endpoint retrieves a single Purchase Order including its header and all associated detail lines using the provided UUID.

It is designed for retrieving the full details of a specific Purchase Order.

Notes

  • Authentication and authorization are required.

  • The UUID must be a valid, existing Purchase Order identifier.

  • If the UUID is not found, an error is returned.

  • The response includes both header and all associated detail lines.

UI Navigation

Asset management → Purchase Orders → Purchase Order Entry

Finders

Not applicable.

This is a GET (single record) endpoint and does not support finders.

Path Parameters

Parameter Description Type Required
vuuid Virtual unique identifier of the Purchase Order String True

Query Standards

Not applicable.

This endpoint does not support finder, limit, offset, or orderBy.

Finders with Example

Not applicable.

Finders are not supported for single-record GET operations.

Attributes

The response contains a header object and a lines array.

The header object represents the Purchase Order master record.

Each object in the lines array represents one detail line associated with the Purchase Order.

All attributes are listed below for completeness.

Header Attributes (PoMasterItem)

CMiC UI Fieldname Object Name Description Type Data Length Example Mandatory
PomstCompCode header pomstCompCode Company code for the Purchase Order String 8 CL02 N/A
PomstNum header pomstNum Purchase Order number String 10 PO-000123 N/A
PomstBchNum header pomstBchNum Batch number Number 10 1001 N/A
PomstVenCode header pomstVenCode Vendor code String 8 VEN001 N/A
PomstDeptCode header pomstDeptCode Department code String 6 00 N/A
PomstExptdDate header pomstExptdDate Expected delivery date Date N/A 2026-06-01 N/A
PomstOrdDate header pomstOrdDate Order date Date N/A 2026-05-10 N/A
PomstTypeCode header pomstTypeCode Purchase Order type code String 4 STD N/A
PomstStatCode header pomstStatCode Status code String 4 OPEN N/A
PomstTermCode header pomstTermCode Payment terms code String 4 NET30 N/A
PomstCurrCode header pomstCurrCode Currency code String 4 CAD N/A
PomstFobCode header pomstFobCode FOB code String 4 DEST N/A
PomstBuyCode header pomstBuyCode Buyer code String 8 BUY01 N/A
PomstAddCode header pomstAddCode Ship-to address code String 8 ADD01 N/A
PomstShplneCode header pomstShplneCode Shipping line code String 8 SHP01 N/A
PomstShpmetCode header pomstShpmetCode Shipment method code String 8 TRUCK N/A
PomstTxt1Code header pomstTxt1Code Text code 1 String 8 TXT1 N/A
PomstTxt2Code header pomstTxt2Code Text code 2 String 8 TXT2 N/A
PomstShpinstDesc header pomstShpinstDesc Shipping instructions description String 255 Handle with care N/A
PomstDesc1 header pomstDesc1 Description line 1 String 255 Office supplies N/A
PomstDesc2 header pomstDesc2 Description line 2 String 255 Q2 2026 N/A
PomstReqCode header pomstReqCode Requisition code String 8 REQ001 N/A
PomstWipAccCode header pomstWipAccCode WIP account code String 20 WIP01 N/A
PomstWipDeptCode header pomstWipDeptCode WIP department code String 6 WIP N/A
PomstShipinstTxt1Code header pomstShipinstTxt1Code Shipping instruction text code 1 String 8 SI1 N/A
PomstShipinstTxt2Code header pomstShipinstTxt2Code Shipping instruction text code 2 String 8 SI2 N/A
PomstShipinstTxt3Code header pomstShipinstTxt3Code Shipping instruction text code 3 String 8 SI3 N/A
PomstShipinstTxt4Code header pomstShipinstTxt4Code Shipping instruction text code 4 String 8 SI4 N/A
PomstShipinstTxt5Code header pomstShipinstTxt5Code Shipping instruction text code 5 String 8 SI5 N/A
PomstReleaseNum header pomstReleaseNum Release number Number 6 0 N/A
PomstBilltoAddCode header pomstBilltoAddCode Bill-to address code String 8 BILL01 N/A
PomstReqReason header pomstReqReason Requisition reason String 255 Project requirement N/A
PomstVendOrderAddCode header pomstVendOrderAddCode Vendor order address code String 8 VORD01 N/A
PomstComplianceFlag header pomstComplianceFlag Compliance flag (Y/N) String 1 Y N/A
PomstActionCode header pomstActionCode Action code String 4 APPR N/A
PomstPrintStatus header pomstPrintStatus Print status String 4 N N/A
PomstJobCompCode header pomstJobCompCode Job company code String 8 CL02 N/A
PomstJobCode header pomstJobCode Job code String 12 JOB001 N/A
PomstContactCode header pomstContactCode Contact code String 8 CON01 N/A
PomstHoldPaymentFlag header pomstHoldPaymentFlag Hold payment flag (Y/N) String 1 N N/A
PomstHoldPaymentDays header pomstHoldPaymentDays Number of days to hold payment Number 6 30 N/A
PomstAddCompCode header pomstAddCompCode Address company code String 8 CL02 N/A
PomstSuspDeptCode header pomstSuspDeptCode Suspense department code String 6 SUSP N/A
PomstPorgrCode header pomstPorgrCode Purchase Order group code String 8 GRP01 N/A
PomstDefaultRecCode header pomstDefaultRecCode Default receiving code String 8 REC01 N/A
PomstRoutCompCode header pomstRoutCompCode Routing company code String 8 CL02 N/A
PomstRoutJobCode header pomstRoutJobCode Routing job code String 12 RJOB01 N/A
PomstDistTypeCode header pomstDistTypeCode Distribution type code String 4 STD N/A
PomstUserField1 header pomstUserField1 User-defined field 1 String 30 Custom1 N/A
PomstUserField2 header pomstUserField2 User-defined field 2 String 30 Custom2 N/A
PomstUserField3 header pomstUserField3 User-defined field 3 String 30 Custom3 N/A
PomstVUuid header pomstVUuid Virtual unique identifier String 64 abc-123-def N/A
PomstAdvPayAmt header pomstAdvPayAmt Advance payment amount Number 14,2 5000.00 N/A
PomstAdvPayPct header pomstAdvPayPct Advance payment percentage Number 6,2 10.00 N/A
PomstAdvPayMultiFlag header pomstAdvPayMultiFlag Allow multiple advance payments (Y/N) String 1 N N/A
PomstIuCreateDate header pomstIuCreateDate Record creation date Timestamp N/A System generated N/A
PomstIuCreateUser header pomstIuCreateUser Record created by String 30 System generated N/A
PomstIuUpdateDate header pomstIuUpdateDate Last update date Timestamp N/A System generated N/A
PomstIuUpdateUser header pomstIuUpdateUser Last updated by String 30 System generated N/A

Line Attributes (PoDetailItem)

CMiC UI Fieldname Object Name Description Type Data Length Example Mandatory
PosCompCode line posCompCode Company code String 8 CL02 N/A
PosPoNum line posPoNum Purchase Order number String 10 PO-000123 N/A
PosReleaseNum line posReleaseNum Release number Number 6 0 N/A
PosLineNum line posLineNum Line number Number 6 1 N/A
PosPoItemType line posPoItemType PO item type String 4 ITM N/A
PosItmCode line posItmCode Item code String 20 ITEM001 N/A
PosItmName line posItmName Item name String 60 Office Chair N/A
PosWmCode line posWmCode Work method code String 8 WM01 N/A
PosOrdQty line posOrdQty Ordered quantity Number 14,4 10.0 N/A
PosExptdPriceAmt line posExptdPriceAmt Expected unit price Number 14,4 250.00 N/A
PosUserTypeCode line posUserTypeCode User type code String 4 USR1 N/A
PosUserField1–8 line posUserField1–8 User-defined fields 1 through 8 String 30 Custom N/A
PosCiitemtypCode line posCiitemtypCode Inventory item type code String 8 TYPE01 N/A
PosItemLocCode line posItemLocCode Item location code String 7 LOC01 N/A
PosTax1Code line posTax1Code Tax code 1 String 8 GST N/A
PosTax2Code line posTax2Code Tax code 2 String 8 PST N/A
PosTax3Code line posTax3Code Tax code 3 String 8 HST N/A
PosTax1TaxableFlag line posTax1TaxableFlag Tax 1 taxable flag String 1 Y N/A
PosTax2TaxableFlag line posTax2TaxableFlag Tax 2 taxable flag String 1 N N/A
PosTax3TaxableFlag line posTax3TaxableFlag Tax 3 taxable flag String 1 N N/A
PosExtdAmt line posExtdAmt Extended amount Number 14,2 2500.00 N/A
PosTaxAmt line posTaxAmt Tax amount Number 14,2 325.00 N/A
PosTotAmt line posTotAmt Total amount Number 14,2 2825.00 N/A
PosRecIntoInvFlag line posRecIntoInvFlag Receive into inventory flag String 1 N N/A
PosDesc line posDesc Line description String 255 Ergonomic chair N/A
PosWbsvCode1–4 line posWbsvCode1–4 WBS value codes 1 through 4 String 20 WBS1 N/A
PosExptdDate line posExptdDate Expected date Timestamp N/A 2026-06-01 N/A
PosVUuid line posVUuid Detail line UUID String 64 abc-456-def N/A
PomstVUuid line pomstVUuid Parent header UUID String 64 abc-123-def N/A
PosIuCreateDate line posIuCreateDate Record creation date Timestamp N/A System generated N/A
PosIuCreateUser line posIuCreateUser Record created by String 30 System generated N/A
PosIuUpdateDate line posIuUpdateDate Last update date Timestamp N/A System generated N/A
PosIuUpdateUser line posIuUpdateUser Last updated by String 30 System generated N/A
Security
HTTP
Type basic

Basic authentication

Path parameters
vuuid
stringRequired
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
"{\n    \"header\": {\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    \"lines\": [\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}"
string
Contact Us
Copyright © 2024 CMiC All Rights Reserved