Get Editable SOV Column Data

Purpose

Retrieve eligible editable SOV column values for one Base Commit record. Use the response to determine the field names, current values, and line identifiers needed by the update request.

Prerequisites

Ensure you have Get permissions for SOV Services.

Request Format

Request parameters are specified as a JSON map with an options object.

Field	Required?	Description
`project_number`	Yes	Project or shell number containing the Base Commit record
`base_commit_bpname`	Yes	Supported Classic Payment Application Base Commit BP/design name
`record_no`	Yes	Base Commit record number for the SOV to retrieve

Recommendations

Call the retrieval operation before an update to capture the current field names, _refnum, and bitemid values.
Send only fields that must change and validate data values against the configured field definitions before calling the API.
Use the rest_audit_id from every response in integration logs and troubleshooting records.
Plan any Cash Flow impacts separately. The REST update does not perform the UI SOV-to-Cash-Flow synchronization.

Sample Request

{

"options": {

"project_number": "P-0007",

"base_commit_bpname": "Pay Test 4 Contract",

"record_no": "uxpayt41-0006"

}

Response Format

A JSON response includes data, message, status, and rest_audit_id. The data array returns the record number and line rows. Each row contains editable data-element (DE) name/value pairs. bitemid contains the full hierarchical cost code. _refnum reflects Ref. from the UI.

Sample Success Response

{

"data": [{

"record_no": "uxpayt41-0006",

"rows": [{"_refnum": 1, "bitemid": "01000~~01700",

"A1": "Test21_AP0", "long_desc": "L1190"}]

}],

"message": ["success"], "status": 200, "rest_audit_id": 147

}

Supported Validation Messages and Status Codes

The following validation messages and status codes display in the response when incorrect values are provided in the request.

Use-case Scenario	Status Code	Message or Result
Missing project number	13001	Project/Shell number is mandatory and is missing in the input request.
Invalid project number	602	Project/Shell Number is not correct.
Inactive, View-Only, or On-Hold project/shell	1245	Create/Update/Delete cannot be performed when project/shell status is Inactive or View-Only or On-Hold.
Missing or invalid request keys	1707	Invalid Input Parameter.
Invalid BP name	603	Business Process Name is not correct.
Unsupported SOV type	11013	Provide a valid Base Commit BP Name of Classic Payment Applications SOV Type.
SOV not found	11011	Could not retrieve SOV Information.
More than one Base Commit record	11014	Only one Base Commit record is supported.
Group by Commit Code	11017	Base Commit SOV Line type Group by commit codes is not supported.
Line or field validation failure	3000	Record status identifies the Ref. line and the invalid field or line-identity issue.
Update privilege not granted	403	Forbidden.