Update or Modify Cash Flow Permission
PUT /ws/rest/service/v1/cashflow/permission/{project_number}
Purpose
Update permission (in user mode) of a specific cash flow in a shell based on shell number or from company level if project/shell number is not provided.
The input JSON shall provide various options to be considered for fetching the data
Request Format
All parameters must be URL encoded.
POST body is in JSON format.
Note: POST call has input & output both as JSON in the body
Path Parameter
project_number: Specify the project number in which the cash flow exists; if not provided, cash flows are fetched from Company Level.
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 Request
This is an example of a sample request.
{
"data" :
{
"names": ["cash flow 1", "cash flow 2", "cash flow 3"],
"permissions": [
{
"login_name": "coadmin",
"type": "U",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"modify_permission": "0",
"view": "1"
}
},
{
"type": "PG"
"full_name": "Project Manager 1",
"group_name": "Project Manager 1",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
}
]
}
}
In request, "names" is mandatory.
In the request body names can be provided in below two formats
1. "names": ["cash flow 1", "cash flow 2", "cash flow 3"] For one or more cash flows.
2. "names": "cash flow 1" For only one cash flow.
If names not provided, an error response will be provided to user to provide cash flows.
Sample Success Response
This is an example of a successful response with status code 200.
{
"data": {
"cash flow 1": {
"permissions": [
{
"login_name": "donna",
"full_name": "Donna Pinciotti",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
},
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "U"
},
{
"full_name": "Project Managers",
"group_name": "Project Managers",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "PG"
}
],
"updated_users": [
"coadmin"
],
"updated_groups": [
"Project Managers"
]
},
"cash flow 2": {
"permissions": [
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
}
],
"updated_users": [],
"updated_groups": []
},
"cash flow 3": {
"permissions": [
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "U"
},
{
"login_name": "donna",
"full_name": "Donna Pinciotti",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
},
{
"full_name": "Project Managers",
"group_name": "Project Managers",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "PG"
}
],
"updated_users": [
"coadmin"
],
"updated_groups": [
"Project Managers"
]
}
},
"message": [
"success"
],
"status": 200
}
Sample Failed Response
This is an example of a failed response with a status code 3000.
{
"data": {
"cash flow 1": {
"permissions": [
{
"login_name": "donna",
"full_name": "Donna Pinciotti",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
},
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "U"
},
{
"full_name": "Project Managers",
"group_name": "Project Managers",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "PG"
}
],
"updated_users": [
"coadmin"
],
"updated_groups": [
"Project Managers"
]
}
},
"message": [
{
"name": "cash flow 2",
"status": "update permission error message"},
{
"name": "cash flow 3",
"status": "update permission error message"}
],
"status": 3000
}
Related Topics
Response Error Codes (REST API Details in Cash Flow)
Create Rollup Cash Flows for Company
Update Rollup Cash Flows for Company
Delete Cash Flow - Summary Curves
Get Rollup Status - for Template Cash Flows
Update Rollup Status - For Template Cash Flows
Get Cash Flow Refresh Job Status
Get Summary Cash Flow Properties
Create (Add User or Group) Cash Flow Permission
Delete (Remove User or Group) Cash Flow Permission
Last Published Tuesday, July 1, 2025