Page tree
Skip to end of metadata
Go to start of metadata

Get /revenue_planner_config/{config_id} 

Provides the revenue configuration

Returns the unique revenue planner configuration.

The revenue planner configuration includes all the parameters to calculate what can be the expected revenue, including work force capacity, average selling price, expected monthly lead growth, etc.

Request URL

https://{client_id}.salesseek.net/api/revenue_planner_configs/1

Response Type

Response content type: Revenue_Planner_Config(JSON)

ModelExample of Response

Revenue_Planner_Config (JSON) {

bucket_configs (Array[Bucket]): the entire list of revenue buckets including all their configuration,

close_ratio (number): the expected percentage of won deals over the amount of incoming leads,

current_date (timestamp): current date, it will be taken as the middle month for everything that is shown on the revenue planner, eg: the head_count_by_date

head_counts_by_date (Array[Head_counts_month]): list of months and the planned workforce from the specific team taking care of closing deals (sales, sales & mktg)

monthly_lead_growth (number): expected increase (in percentage) of lead amount of leads in case it is percentage-based,

monthly_new_leads (int): expected amount of leads to be increased by month in case it is amount-based,

productivity (number): avg. monthly profit-generation capacity per sales person,

ramp_time (int): amount of days for a sales person to reach the avg. productivity level

sales_cycle (int): avg. amount of days for a newly received lead to become a won deal

}

Head_counts_month (AssociativeArray(month:headcount)) {

key (timestamp): First day of the represented month period, formatted as: Wdd Mmm 01 YYYY 00:00:00 GMT+0000 (BST),

value (number): amount of workforce on the sales department (or any employee dedicated to close deals from leads)

}

Bucket {

average_selling_price (double): ,

id (string): unique identifier for this bucket,

length (int): amount of months for this bucket(service) to be valid for a customer (if is a product will be perpetual = 0) ,

mix (double): probability for this bucket to be included each Deal (percentage),

name (int): bucket name to be shown,

recognition_policy_start (number): percentage over the total income which will be received at the start of the agreement of this service,

recognition_policy_monthly (number): percentage over the total income which will be received monthly during the duration of this service (length),

recognition_policy_end (number): percentage over the total income which will be received at the end of the duration of this service ,

renewal (number): probability to renew this deal related to the same customer (percentage),

short_id (string): Alias which can be used as a unique identifier for the Bucket

}

{
	close_ratio: 60
	current_date: "2014-01-09T16:16:32.544648"
	head_counts_by_date: {
		Wed Oct 01 2014 00:00:00 GMT+0100 (BST):15, 
		Sat Nov 01 2014 00:00:00 GMT+0000 (BST):15
		,…
	}
	monthly_lead_growth: 5
	monthly_new_leads: 0
	productivity: 100000
	ramp_time: 120
	sales_cycle: 90
	bucket_configs: [
		0: {
    		average_selling_price: 1000,
		    id: "8b8442f383",
		    length: 0,
		    mix: 100,
    		name: "Product",
		    recognition_policy_end: 0,
		    recognition_policy_monthly: 0,
		    recognition_policy_start: 100,
		    renewal: 10,
		    short_id: "Product",
		},
		1: {
		    average_selling_price: 2000,
		    id: "8b8442f384",
		    length: 6,
		    mix: 50,
		    name: "Service",
		    recognition_policy_start: 20,
		    recognition_policy_monthly: 5,
		    recognition_policy_end: 50,
		    renewal: 50,
		    short_id: "Service",
		}
	]

}


 

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 revenue_planner_config_idInYThe id of revenue_planner_config to be deletedstring
responseOut-The revenue_planner_config created after the successful requestJSON

 


 

 

PATCH /revenue_planner_configs/{revenue_planner_config_id}

Update a specific revenue_planner_config by its ID

Updates a revenue_planner_config by its {revenue_planner_config_id} and Returns the resulting element. The fields updated are just the ones passed on the request body

 

Request URL

https://{client_id}.salesseek.net/api/revenue_planner_configs/69d1fbe62  

 

Request Body
{
  monthly_lead_growth: 15
}

 

Response Type

Response content type: Revenue_Planner_Configuration (JSON)

ModelExample of Response

Revenue_Planner_Config (JSON) {

bucket_configs (Array[Bucket]): the entire list of revenue buckets including all their configuration,

close_ratio (number): the expected percentage of won deals over the amount of incoming leads,

current_date (timestamp): current date, it will be taken as the middle month for everything that is shown on the revenue planner, eg: the head_count_by_date

head_counts_by_date (Array[Head_counts_month]): list of months and the planned workforce from the specific team taking care of closing deals (sales, sales & mktg)

monthly_lead_growth (number): expected increase (in percentage) of lead amount of leads in case it is percentage-based,

monthly_new_leads (int): expected amount of leads to be increased by month in case it is amount-based,

productivity (number): avg. monthly profit-generation capacity per sales person,

ramp_time (int): amount of days for a sales person to reach the avg. productivity level

sales_cycle (int): avg. amount of days for a newly received lead to become a won deal

}

Head_counts_month (AssociativeArray(month:headcount)) {

key (timestamp): First day of the represented month period, formatted as: Wdd Mmm 01 YYYY 00:00:00 GMT+0000 (BST),

value (number): amount of workforce on the sales department (or any employee dedicated to close deals from leads)

}

Bucket {

average_selling_price (double): ,

id (string): unique identifier for this bucket,

length (int): amount of months for this bucket(service) to be valid for a customer (if is a product will be perpetual = 0) ,

mix (double): probability for this bucket to be included each Deal (percentage),

name (int): bucket name to be shown,

recognition_policy_start (number): percentage over the total income which will be received at the start of the agreement of this service,

recognition_policy_monthly (number): percentage over the total income which will be received monthly during the duration of this service (length),

recognition_policy_end (number): percentage over the total income which will be received at the end of the duration of this service ,

renewal (number): probability to renew this deal related to the same customer (percentage),

short_id (string): Alias which can be used as a unique identifier for the Bucket

}

{
	close_ratio: 60
	current_date: "2014-01-09T16:16:32.544648"
	head_counts_by_date: {
		Wed Oct 01 2014 00:00:00 GMT+0100 (BST):15, 
		Sat Nov 01 2014 00:00:00 GMT+0000 (BST):15
		,…
	}
	monthly_lead_growth: 15
	monthly_new_leads: 0
	productivity: 100000
	ramp_time: 120
	sales_cycle: 90
	bucket_configs: [
		0: {
    		average_selling_price: 1000,
		    id: "8b8442f383",
		    length: 0,
		    mix: 100,
    		name: "Product",
		    recognition_policy_end: 0,
		    recognition_policy_monthly: 0,
		    recognition_policy_start: 100,
		    renewal: 10,
		    short_id: "Product",
		},
		1: {
		    average_selling_price: 2000,
		    id: "8b8442f384",
		    length: 6,
		    mix: 50,
		    name: "Service",
		    recognition_policy_start: 20,
		    recognition_policy_monthly: 5,
		    recognition_policy_end: 50,
		    renewal: 50,
		    short_id: "Service",
		}
	]

}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
revenue_planner_config_idInYThe id of the revenue_planner_config to be updatedstring
 revenue_planner_config InYThe subset of the revenue_planner_config fields to be updatedJSON
 response OutThe revenue_planner_config after the successful updateJSON

 

 


 

 

PATCH /revenue_planner_bucket/{bucket_id}

Update a specific Bucket by its ID

Update a revenue bucket by {bucket_id} and Returns the resulting Bucket. The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/buckets/a3451f5--640585a5d026

Request Body
{
  length: 12,
  recognition_policy_monthly: 8.5,
  name: "1 Year Customer Service",
  average_selling_price: 2400
}

 

Response Type

Response content type: JSON Buckets

ModelExample of Response

Bucket {

average_selling_price (double): ,

id (string): unique identifier for this bucket,

length (int): amount of months for this bucket(service) to be valid for a customer (if is a product will be perpetual = 0) ,

mix (double): probability for this bucket to be included each Deal (percentage),

name (int): bucket name to be shown,

recognition_policy_start (number): percentage over the total income which will be received at the start of the agreement of this service,

recognition_policy_monthly (number): percentage over the total income which will be received monthly during the duration of this service (length),

recognition_policy_end (number): percentage over the total income which will be received at the end of the duration of this service ,

renewal (number): probability to renew this deal related to the same customer (percentage),

short_id (string): Alias which can be used as a unique identifier for the Bucket

}

{
    average_selling_price: 2400,
    id: "a3451f5--640585a5d026",
    length: 12,
    mix: 100,
    name: "1 Year Customer Service",
    recognition_policy_end: 0,
    recognition_policy_monthly: 8.5,
    recognition_policy_start: 0,
    renewal: 75,
    short_id: "3 Months",
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
user_idInYThe id of the user to be updatedstring
bucketInYThe subset of the bucket model fields to be updatedJSON
bucketOutThe bucket after the successful update

 

JSON
  • No labels