Update Purchase Change Order Lines

Prev Next
Patch
/po-rest-api/jersey/v1/po-change-order/lines/58CEEE8CCAE1650DE0630B811DAC89C2

PO Change Order — Update Summary Line

Overview

Updates a single change order summary line, identified by its unique identifier. The header
and any other lines are never touched, and only editable line fields are accepted.

Notes

  • The request payload uses the same envelope shape as create — a lines array — but only the
    first element (lines[0]) is applied; the endpoint updates exactly one line per call.

  • Attribute values are applied reflectively: every non-null field present in lines[0] is
    written to the row, unless it is restricted (see Attributes below), in which case the whole
    request fails before anything is written.

  • On success the row is reloaded and returned — there is no separate "read" view for the
    response.

UI Navigation

Asset Management → Purchase Order → Change Orders → Enter Change Order

Finders

Not applicable — targets a single record by POCS_V_UUID.

HTTP Method & Endpoint

PATCH {base_url}/po-rest-api/jersey/v1/po-change-order/lines/{vuuid}
Content-Type: application/json

Path Parameters

Field Type Required Default Description
vuuid String True — POCS_V_UUID of the summary line to update

Query Parameters

None.

Example Request

curl -X PATCH "{base_url}/po-rest-api/jersey/v1/po-change-order/lines/57583E9AF08B542CE0630B811DACCB66" \
  -H "Authorization: Basic {credentials}" \
  -H "Content-Type: application/json" \
  -d '{
    "lines": [
      {
        "pocsOrdQty": 75,
        "pocsExptdPriceAmt": 13.25
      }
    ]
  }'

Example Response (200 OK)

{
  "pocsVUuid": "57583E9AF08B542CE0630B811DACCB66",
  "pocsCompCode": "ALT",
  "pocsPoNum": "PO000004",
  "pocsNum": "1",
  "pocsLineNum": 1,
  "pocsOrdQty": 75,
  "pocsExptdPriceAmt": 13.25
}

Attributes

Request body — lines[0] object

Any of the following line fields may be supplied except those marked as restricted below,
which raise PO-000267-ERR (identifier = the offending field name) if supplied. Only one
restricted field is reported per request — the check stops at the first restricted field it
encounters.

Name Description Type Data Length Example Editable
pocsVUuid Virtual UUID, unique row identifier String 64 — Restricted
pocsCompCode Company code String 8 ALT Restricted
pocsPoNum Parent PO number String 11 PO000004 Restricted
pocsNum Change order number String 11 1 Restricted
pocsReleaseNum Release number Number(11) 11 1 Restricted
pocsLineNum Summary line number Number(6) 6 1 Restricted
pocsOraseq Internal sequence number Number — — Restricted (not accepted on create either)
pocsCiitemtypCode item type code String 2 MA True
pocsClassCode Item class code String 4 OFF1 True
pocsDesc Line description String 4000 Revised paper order True
pocsDiscountPct Discount percentage Number — 2.500 True
pocsExptdPriceAmt Expected unit price Number — 12.5000 True
pocsExtdAmt Extended amount (calculated) Number — 1250.00 Restricted
pocsItemLocCode Item location code String 7 ILOC01 True
pocsItmCode Item/product code String 16 PAPER-A4 True
pocsItmName Item/product name (lookup) String 4000 — Restricted
pocsJobName Job name (lookup) String 60 — Restricted
pocsPhsName Phase name (lookup) String 50 — Restricted
pocsCatName Category name (lookup) String 30 — Restricted
pocsLumpSumPoFlag Lump-sum PO flag (Y/N, calculated) String 1 — Restricted
pocsOrdQty Quantity ordered Number — 100.0000 True
pocsOvrdExptdPriceFlag Override expected price flag (Y/N) String 1 Y True
pocsPoItemType PO item type (I=Inventory, N=Non-stock, F=Free-form) String 1 N True
pocsPoOrdQty PO ordered quantity (calculated) Number — 80.0000 Restricted
pocsPoOrderedQty PO ordered quantity, alt calculation (calculated) Number — 80.0000 Restricted
pocsPoPriceAmt PO price amount (calculated) Number — 12.5000 Restricted
pocsPobldLineNum Source PO build line number (calculated) Number(6) 6 1 Restricted
pocsRecIntoInvFlag Receive into inventory flag (Y/N) String 1 Y True
pocsSuggestedPrice Suggested price (calculated) Number — 12.5000 Restricted
pocsTax1Code / Tax2Code / Tax3Code Tax codes 1-3 String 11 each HST True
pocsTax1TaxableFlag / Tax2.../Tax3... Taxable flags for tax 1-3 (Y/N) String 1 each Y True
pocsTaxAmt Tax amount (calculated) Number — 150.00 Restricted
pocsTotAmt Total amount (calculated) Number — 1400.00 Restricted
pocsUserField1..8 User-defined fields 1-8 String 60 each — True
pocsUserTypeCode User-defined type code String 3 STD True
pocsWmCode Unit of measure code String 2 BX True
pocsTavCode1..4 TAV codes 1-4 String 10 each TAV01 True
pocsWbsvCode1..8 WBS value codes 1-8 (always disabled in the CMiC UI) String 60 each — Restricted
pocsWbsvCode9..12 WBS value codes 9-12 String 60 each — True
pocsIuCreateDate Record creation timestamp Timestamp — — Restricted
pocsIuUpdateDate Record last update timestamp Timestamp — — Restricted

Response body

Flat, updated line object — same shape as the table above, all fields populated with their
current values.

Error Codes

HTTP Error Code Reason
400 PO-000263-ERR vuuid and request body are both required
400 PO-000266-ERR lines array with at least one (non-null) line is required in the request payload
404 PO-000262-ERR No summary line found for the supplied vuuid
400 PO-000267-ERR A key or system attribute was supplied (see table above)
500 (unhandled exception) Any other unexpected error; the transaction is rolled back
Security
HTTP
Type basic

Basic authentication

Header parameters
Content-Type
string
Exampleapplication/json
Body parameters
object
Example{ "lines": [ { "pocsOrdQty": 20 } ] }
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
"{\n    \"pocsVUuid\": \"58CEEE8CCAE1650DE0630B811DAC89C2\",\n    \"pocsCompCode\": \"ZZ\",\n    \"pocsPoNum\": \"FM2\",\n    \"pocsNum\": \"2\",\n    \"pocsReleaseNum\": 1,\n    \"pocsLineNum\": 2,\n    \"pocsOraseq\": 2653866316,\n    \"pocsCalledFromAppCode\": \"PO\",\n    \"pocsCiitemtypCode\": null,\n    \"pocsClassCode\": null,\n    \"pocsDesc\": null,\n    \"pocsDiscountPct\": 0,\n    \"pocsExptdPriceAmt\": 78000,\n    \"pocsExtdAmt\": 1560000,\n    \"pocsItemLocCode\": null,\n    \"pocsItmCode\": \"WA\",\n    \"pocsItmName\": \"Test  A\",\n    \"pocsJobName\": null,\n    \"pocsPhsName\": null,\n    \"pocsCatName\": null,\n    \"pocsLumpSumPoFlag\": null,\n    \"pocsMinOrderQty\": null,\n    \"pocsOnHandQty\": null,\n    \"pocsOnOrderQty\": null,\n    \"pocsOnReserveQty\": null,\n    \"pocsOrdQty\": 20,\n    \"pocsOvrdExptdPriceFlag\": \"N\",\n    \"pocsPoItemType\": \"N\",\n    \"pocsPoOrdQty\": null,\n    \"pocsPoOrderedQty\": null,\n    \"pocsPoPriceAmt\": null,\n    \"pocsPobldLineNum\": null,\n    \"pocsRecIntoInvFlag\": \"N\",\n    \"pocsSuggestedPrice\": null,\n    \"pocsTacSetupFlag\": \"Y\",\n    \"pocsTax1Code\": null,\n    \"pocsTax1OnTaxFlag\": null,\n    \"pocsTax1Perc\": null,\n    \"pocsTax1TaxableFlag\": \"Y\",\n    \"pocsTax2Code\": null,\n    \"pocsTax2OnTaxFlag\": null,\n    \"pocsTax2Perc\": null,\n    \"pocsTax2TaxableFlag\": \"Y\",\n    \"pocsTax3Code\": null,\n    \"pocsTax3OnTaxFlag\": null,\n    \"pocsTax3Perc\": null,\n    \"pocsTax3TaxableFlag\": \"Y\",\n    \"pocsTaxAmt\": 0,\n    \"pocsTotAmt\": 1560000,\n    \"pocsUserField1\": \"ZZ\",\n    \"pocsUserField2\": \"00\",\n    \"pocsUserField3\": \"1000.100\",\n    \"pocsUserField4\": null,\n    \"pocsUserField5\": null,\n    \"pocsUserField6\": null,\n    \"pocsUserField7\": null,\n    \"pocsUserField8\": null,\n    \"pocsUserFieldEdtFlag5\": \"Y\",\n    \"pocsUserFieldEdtFlag6\": \"Y\",\n    \"pocsUserFieldEdtFlag7\": \"Y\",\n    \"pocsUserFieldEdtFlag8\": \"Y\",\n    \"pocsUserFieldName5\": \"TAC Value Not On File\",\n    \"pocsUserFieldName6\": \"TAC Value Not On File\",\n    \"pocsUserFieldName7\": null,\n    \"pocsUserFieldName8\": \"TAC Value Not On File\",\n    \"pocsUserTypeCode\": \"G\",\n    \"pocsWbsSetupFlag\": \"N\",\n    \"pocsWmCode\": \"G\",\n    \"pocsTavCode1\": null,\n    \"pocsTavCode2\": null,\n    \"pocsTavCode3\": null,\n    \"pocsTavCode4\": null,\n    \"pocsWbsvCode1\": null,\n    \"pocsWbsvCode2\": null,\n    \"pocsWbsvCode3\": null,\n    \"pocsWbsvCode4\": null,\n    \"pocsWbsvCode5\": null,\n    \"pocsWbsvCode6\": null,\n    \"pocsWbsvCode7\": null,\n    \"pocsWbsvCode8\": null,\n    \"pocsWbsvCode9\": null,\n    \"pocsWbsvCode10\": null,\n    \"pocsWbsvCode11\": null,\n    \"pocsWbsvCode12\": null\n}"
string
Copyright © 2024 CMiC All Rights Reserved