Post
/po-rest-api/jersey/v1/purchase-order/{vuuid}/lines
POST /v1/purchase-order/
Overview
This endpoint adds one or more detail lines to an existing Purchase Order identified by its UUID.
System-generated fields such as line number, UUID, and sequence values are automatically assigned and must not be provided in the request payload.
Notes
Authentication and authorization are required.
The target Purchase Order must exist; if the UUID is not found, an error is returned.
System-managed fields (
posLineNum,posPoNum,posReleaseNum,posOraseq,posVUuid) must not be provided in the payload and will be rejected if included.Line numbers are auto-incremented starting from the next available line number.
Each line in the request is validated individually.
UI Navigation
Asset Management → Purchase Orders → Purchase Order Entry
Finders
Not applicable.
This is a POST (create) endpoint and does not support finders.
Path Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
| vuuid | Virtual unique identifier of the parent 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 POST operations.
Attributes
The request body must contain a lines array.
Each object in the array represents one detail line to be added.
System-managed fields are automatically generated and must not be included.
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |
|---|---|---|---|---|---|---|---|
| PosCompCode | line | posCompCode | Company code for the detail line | String | 8 | CL02 | False |
| PosPoItemType | line | posPoItemType | PO item type | String | 4 | ITM | False |
| PosItmCode | line | posItmCode | Item code | String | 20 | ITEM001 | False |
| PosItmName | line | posItmName | Item name or description | String | 60 | Office Chair | False |
| PosWmCode | line | posWmCode | Work method code | String | 8 | WM01 | False |
| PosOrdQty | line | posOrdQty | Ordered quantity | Number | 14,4 | 10.0 | False |
| PosExptdPriceAmt | line | posExptdPriceAmt | Expected unit price amount | Number | 14,4 | 250.00 | False |
| PosUserTypeCode | line | posUserTypeCode | User type code | String | 4 | USR1 | False |
| PosUserField1 | line | posUserField1 | User-defined field 1 | String | 30 | Custom1 | False |
| PosUserField2 | line | posUserField2 | User-defined field 2 | String | 30 | Custom2 | False |
| PosUserField3 | line | posUserField3 | User-defined field 3 | String | 30 | Custom3 | False |
| PosUserField4 | line | posUserField4 | User-defined field 4 | String | 30 | Custom4 | False |
| PosUserField5 | line | posUserField5 | User-defined field 5 | String | 30 | Custom5 | False |
| PosUserField6 | line | posUserField6 | User-defined field 6 | String | 30 | Custom6 | False |
| PosUserField7 | line | posUserField7 | User-defined field 7 | String | 30 | Custom7 | False |
| PosUserField8 | line | posUserField8 | User-defined field 8 | String | 30 | Custom8 | False |
| PosCiitemtypCode | line | posCiitemtypCode | Inventory item type code | String | 8 | TYPE01 | False |
| PosItemLocCode | line | posItemLocCode | Item location code | String | 7 | LOC01 | False |
| PosTax1Code | line | posTax1Code | Tax code 1 | String | 8 | GST | False |
| PosTax2Code | line | posTax2Code | Tax code 2 | String | 8 | PST | False |
| PosTax3Code | line | posTax3Code | Tax code 3 | String | 8 | HST | False |
| PosTax1TaxableFlag | line | posTax1TaxableFlag | Tax 1 taxable flag (Y/N) | String | 1 | Y | False |
| PosTax2TaxableFlag | line | posTax2TaxableFlag | Tax 2 taxable flag (Y/N) | String | 1 | N | False |
| PosTax3TaxableFlag | line | posTax3TaxableFlag | Tax 3 taxable flag (Y/N) | String | 1 | N | False |
| PosRecIntoInvFlag | line | posRecIntoInvFlag | Receive into inventory flag (Y/N) | String | 1 | N | False |
| PosDesc | line | posDesc | Line description | String | 255 | Ergonomic office chair | False |
| PosWbsvCode1 | line | posWbsvCode1 | WBS value code 1 | String | 20 | WBS1 | False |
| PosWbsvCode2 | line | posWbsvCode2 | WBS value code 2 | String | 20 | WBS2 | False |
| PosWbsvCode3 | line | posWbsvCode3 | WBS value code 3 | String | 20 | WBS3 | False |
| PosWbsvCode4 | line | posWbsvCode4 | WBS value code 4 | String | 20 | WBS4 | False |
| PosExptdDate | line | posExptdDate | Expected date for the line item | Timestamp | N/A | 2026-06-01T00:00:00 | False |
| PosPoNum | line | posPoNum | Purchase Order number — must not be provided | String | 10 | System generated | False |
| PosReleaseNum | line | posReleaseNum | Release number — must not be provided | Number | 6 | System generated | False |
| PosLineNum | line | posLineNum | Line number — must not be provided | Number | 6 | System generated | False |
| PosOraseq | line | posOraseq | Internal sequence — must not be provided | Number | 18 | System generated | False |
| PosVUuid | line | posVUuid | Detail line UUID — must not be provided | String | 64 | System generated | False |
| PomstVUuid | line | pomstVUuid | Parent header UUID | String | 64 | System generated | False |
| PosExtdAmt | line | posExtdAmt | Extended amount (calculated) | Number | 14,2 | System generated | False |
| PosTaxAmt | line | posTaxAmt | Tax amount (calculated) | Number | 14,2 | System generated | False |
| PosTotAmt | line | posTotAmt | Total amount (calculated) | Number | 14,2 | System generated | False |
| PosIuCreateDate | line | posIuCreateDate | Record creation date | Timestamp | N/A | System generated | False |
| PosIuCreateUser | line | posIuCreateUser | Record created by | String | 30 | System generated | False |
| PosIuUpdateDate | line | posIuUpdateDate | Last update date | Timestamp | N/A | System generated | False |
| PosIuUpdateUser | line | posIuUpdateUser | Last updated by | String | 30 | System generated | False |
Security
HTTP
Type basic
Basic authentication
Path parameters
vuuid
stringRequired
Body parameters
object
Example{
"lines": [
{
"posCompCode": "ZZ",
"posPoItemType": "I",
"posItmCode": "DONUT",
"posItmName": "donut",
"posWmCode": "EA",
"posOrdQty": 12,
"posExptdPriceAmt": 0,
"posUserTypeCode": "G",
"posUserField1": "ZZ",
"posUserField2": "50",
"posUserField3": "1700.400",
"posUserField5": "TAC1V1",
"posUserField6": "1",
"posUserField8": "TAV4_1",
"posCiitemtypCode": "1",
"posItemLocCode": "MAIN",
"posTax1Code": "K1",
"posTax1TaxableFlag": "Y",
"posTax2TaxableFlag": "Y",
"posTax3TaxableFlag": "Y",
"posRecIntoInvFlag": "N",
"posDesc": "donut"
}
]
}
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\n \"lines\": [\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