Get Fund Consumption for CBS Level SOV (Auto-Order / Auto-Ratio)
GET /ws/rest/service/v1/fund/sov/consumption/{project_number}
Purpose
To Fetch assigned Funds to CBS in SOV of types "General Spends" & "Payment Applications".
Request Parameters
All parameters should be URL encoded.
Both input & output in JSON format.
Get Fund Consumption for CBS Level SOV input JSON
filter = {
"commit_bp_name" : ["bp_name"],
"record_no" : ["base_record_no"],
"cbs_code" : ["100~~101"],
"item#" : [1234],
"sov_type" : "General Spends",
"assignment_type": "SOV Auto-Order"
}
If a filter is not provided, all SOVs (from "General Spends" & "Payment Applications") will be fetched. If a filter is provided, the "AND" condition is seen.
Filter Condition Key Definitions
Key | Definition |
|---|---|
commit_bp_name | Optional. The commit_bp_name references those BPs that have SOV Auto-Order, or SOV Auto-Ratio, fund assignment selected in Funding Sheet properties. One or more inputs are supported in filter. |
record_no | Optional. The base record number of the SOV sheet. One or more inputs are supported in filter. The record_no supports '%' wildcard character to filter record_no. For example: The "record_no" : "PO-001%", will fetch SOV details for all the records starting with "PO-001". |
cbs_code | Optional. The CBS code to which the fund is assigned. One or more inputs are supported in filter. |
item# | Optional. Uniquely identifiable row number "item#" in the SOV sheet. One or more inputs are supported in filter. |
sov_type | Optional. Only one value is supported at a time in the filter: General Spends" or "Payment Applications". |
assignment_type | Optional. Only one value is supported at a time in the filter: "SOV Auto-Order" or "SOV Auto-Ratio". |
'Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Success Response
{
"data": {
"Purchase Orders": {
"sov_type": "General Spends",
"assignment_type": "SOV Auto-Ratio",
"record_no": {
"PO-0002": {
"rows": [
{
"item#": "000010",
"cbs_code": "100~~101",
"fund_assignment": [
{
"fund_code": "funding",
"fund_ratio": "40",
"status" : "Active"
},
{
"fund_code": "State Funding",
"fund_ratio": "0",
"status" : "Inactive"
},
{
"fund_code": "Federal Funding",
"fund_ratio": "60",
"status" : "Active"
}
]
},
{
"item#": "000020",
"cbs_code": "100~~102",
"fund_assignment": [
{
"fund_code": "State Funding",
"fund_ratio": "100",
"status" : "Active"
}
]
},
{
"item#": "000030",
"cbs_code": "100~~102",
"fund_assignment": []
},
{
"item#": "000040",
"cbs_code": "300~~302",
"fund_assignment": []
}
]
},
"PO-0001": {
"rows": [
{
"item#": "000010",
"cbs_code": "100~~101",
"fund_assignment": [
{
"fund_code": "funding",
"fund_ratio": "100",
"status" : "Active"
}
]
}
]
}
}
},
,
"Group_by_CBS_base_commit_bp": {
"sov_type": "General Spends",
"assignment_type": "SOV Auto-Order",
"record_no": {
"uxfund20-0000": {
"rows": [
{
"item#": "000010",
"cbs_code": "100~~101",
"fund_assignment": [
{
"fund_code" : "funding",
"status" : "Active"
},
{
"fund_code" : "State Funding",
"status" : "Active"
}
{
"fund_code" : "Federal Funding",
"status" : "Active"
}
]
}
]
}
}
},
"SM Cost PG Commit WF": {
"sov_type": "Payment Applications",
"assignment_type": "SOV Auto-Order",
"record_no": {
"uxfund4-0001": {
"rows": [
{
"item#": "000010",
"cbs_code": "100~~101",
"fund_assignment": [
{
"fund_code" : "funding",
"status" : "Active"
}
]
}
]
}
}
}
},
"message": [ "Success" ],
"status": 200
}
Notes:
- To perform this call, the Integration user need to have the Get permission under Cost CBS Services permission (under "User Administration in Company Admin mode").
- Only the SOV sheets with "Fund Assignment" enabled (in the sheets) will be fetched as part of GET SOV consumption call.
- The SOV sheets that are funded from Commit Fund Sheet will not get fetched from this GET call.
- From the SOV sheet, the Summary rows will not be fetched. Only the rows with Cost code assigned to them (normal rows or breakdown of summary row) will be fetched in GET call.
Related Topics
Get Fund Assignment Order for Cost Sheet
Update Fund Assignment Order for Cost Sheet
Update Fund Consumption for CBS Level SOV (Auto-Order / Auto-Ratio)
Response Error Codes (Funding REST API Details)
Last Published Wednesday, April 9, 2025