Get Fund Columns
GET /ws/rest/service/v1/fund/column/{project_number}
Purpose:
Get the funding column data. This API can be used to get the fund balance as user can use a formula column to calculate the balance.
Input:
All parameters should be URL encoded.
Path Parameter
project_number(Optional): Specify the project/shell number to get the project/shell funding data or empty to get the company data.
url parameter -
filter=
{
"column_names":["Manual Funding by Project" ,"Project Funding"],
"codes":["Fund0","Fund1","Fund2"]
}
Notes:
- Filter can be used to filter on column name and the fund code to get the data.
- For funding sheets with tree as display mode, if parent fund code is given in filter condition then error will be thrown.
- If with given filter column name, multiple columns exists in the funding sheet then validation error will be thrown.
Output:
JSON object containing 'status', 'data', 'message'
Note: If there are no columns defined in the fund sheet then the service will return an empty data array in the response.
Sample Response
{
"data":[
{
"Project Funding":{
"Data Source" : "Project_Funding",
"Funds":{
"fund0":101.00,
"fund1":100.2,
"fund2":100.3
}
}
},
{
"Manual Funding by Project":{
"Data Source" : "Manual_Funding",
"Funds":{
"fund0":101.00,
"fund1":100.2,
"fund2":100.3
}
}
}
],
"message":[
"success"
],
"status":"200"
}
Partial get is not allowed i.e. if one of the filter conditions fails then only error message will be returned.
Related Topics
Get Fund Assignment Order for Cost Sheet
Update Fund Assignment Order for Cost Sheet
Get Fund Consumption for CBS Level SOV (Auto-Order / Auto-Ratio)
Update Fund Consumption for CBS Level SOV (Auto-Order / Auto-Ratio)
Response Error Codes (Funding REST API Details)
Last Published Friday, December 13, 2024