Schedule of Values (SOV)

If you have the applicable permissions, you can perform the following steps for editable SOV column values in a Base Commit business process (BP) record.
  • Retrieve the current eligible SOV column values for a Base Commit record in a project.
  • Update configured customer-created SOV columns, plus supported grid-editable fields such as Description.
  • Clear a pull-down value by sending null, and clear a text value by sending an empty string.
  • Use the REST audit ID and SOV audit log to trace update activity and outcomes.

Scope and Constraints

The following assumptions apply:
  • The Get Editable SOV Column Data and Update Editable SOV Column Data services apply only to Classic Payment Application base-commit SOVs. The services do not support General Spends, Summary Payment Application (SPA) base commits, breakdown rows, or SOVs configured to group by commit code.
  • Only Classic Payment type SOVs with individual commit lines are supported. SOVs that group by commit code are not supported.
  • Only Active projects and shells are supported. Inactive, View-Only, and On-Hold projects and shells are not eligible.
  • Item number, SOV structure fields, rollup-only fields, noneditable fields, unsupported data types, and breakdown updates are not supported.
  • The combination of _refnum and bitemid is validated before the update. Both values are mandatory and cannot be edited. bitemid contains the full hierarchical cost code. _refnum reflects Ref. from the UI.
  • Nonexistent data elements (DEs) and noneditable DEs are silently bypassed.
  • For an editable DE, the REST service validates the data type and maximum length before updating the value.
  • The PUT operation provides atomic success at the record level. After payload-level project and design validation succeeds, the service validates all SOV rows for the specified record and commits them in a single transaction.
  • Bulk updates are not supported. Each call can update only one SOV BP record. A request that contains more than 5,000 SOV rows can affect performance and transaction handling.
  • The order ID cannot be changed. Item number updates are not supported.
  • The REST update does not perform the UI SOV-to-Cash-Flow synchronization. Cash Flow commitment curves consume SOV line-item data only from default columns.
  • The REST audit log records successful and failed GET and PUT operations.
  • The SOV audit log records only successful PUT operations.
  • REST updates are allowed when the Payment Application SOV is locked.
  • The <base_commit_bp>_li_sov database table is updated for all text-type and select-pulldown DEs. A checkbox is not editable in the SOV grid, even when Show in SOV is enabled for the checkbox. Therefore, the checkbox is not included in the response and cannot be updated.
  • The psov_row database table is updated for supported grid-editable columns. The only supported grid-editable column is long_desc. Item number is excluded.
  • The psov database table is updated with the modified date and time.
  • Changes to the database tables are reflected in the SOV and Commit Line Item Picker audit logs.
  • Internationalization is not supported.
  • Both Workflow and Non-workflow BP types are supported.
  • Breakdown updates are not supported.
  • For a select field with a String or Integer value, the request can contain either the value or the label. REST accepts either form and returns the same form in the PUT response. GET returns the label when a label is present. Otherwise, GET returns the name. An inactive value results in an error.