Creates and/or updates the config settings for the Forecasts module
Summary:
This endpoint is used to create and/or update the config settings for the Forecasts module as json data. It extends
the core config endpoint by adding the functionality to create
the Timeperiods and updates existing Opportunities for use in the Forecasts module.
Query Parameters:
| Param |
Description |
Optional |
Input Example:
{
"is_setup": 1,
"is_upgrade": 0,
"has_commits": 1,
"timeperiod_type": "chronological",
"timeperiod_interval": "Annual",
"timeperiod_leaf_interval": "Quarter",
"timeperiod_start_date": "2013-01-01",
"timeperiod_shown_forward": 2,
"timeperiod_shown_backward": 2,
"forecast_ranges": "show_binary",
"buckets_dom": "commit_stage_binary_dom",
"show_binary_ranges": {
"include": {
"min": 70,
"max": 100
},
"exclude": {
"min": 0,
"max": 69
}
},
"show_buckets_ranges": {
"include": {
"min": 85,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
],
"show_worksheet_likely": 1,
"show_worksheet_best": 1,
"show_worksheet_worst": 0,
"show_projected_likely": 1,
"show_projected_best": 1,
"show_projected_worst": 0,
"show_forecasts_commit_warnings": 1
}
Output Example:
{
"is_setup": 1,
"is_upgrade": 0,
"has_commits": 1,
"timeperiod_type": "chronological",
"timeperiod_interval": "Annual",
"timeperiod_leaf_interval": "Quarter",
"timeperiod_start_date": "2013-01-01",
"timeperiod_shown_forward": 2,
"timeperiod_shown_backward": 2,
"forecast_ranges": "show_binary",
"buckets_dom": "commit_stage_binary_dom",
"show_binary_ranges": {
"include": {
"min": 70,
"max": 100
},
"exclude": {
"min": 0,
"max": 69
}
},
"show_buckets_ranges": {
"include": {
"min": 85,
"max": 100
},
"upside": {
"min": 70,
"max": 84
},
"exclude": {
"min": 0,
"max": 69
}
},
"sales_stage_won": [
"Closed Won"
],
"sales_stage_lost": [
"Closed Lost"
],
"show_worksheet_likely": 1,
"show_worksheet_best": 1,
"show_worksheet_worst": 0,
"show_projected_likely": 1,
"show_projected_best": 1,
"show_projected_worst": 0,
"show_forecasts_commit_warnings": 1
}