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

 

Get /buckets

Provides the entire list of revenue buckets

Returns the entire list of revenue buckets. A deal can have 1 or more revenue buckets depending on the business model. Each revenue bucket has its own behaviour in terms of average selling price, length, renewal probability, recognition policy (percentage paid at the start, monthy and end). A bucket can be a product line, a service, a license, etc.

All associated configuration is intended for the Revenue Planer capacity for the future.

Request URL

https://{client_id}.salesseek.net/api/buckets

Response Type

Response content type: JSON Array[Buckets]

ModelExample of Response
Array[Buckets]

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: 100,
    id: "8b8484c2f383",
    length: 0,
    mix: 100,
    name: "Services",
    recognition_policy_end: 0,
    recognition_policy_monthly: 0,
    recognition_policy_start: 0,
    renewal: 0,
    short_id: "Services",
  },
  {
    average_selling_price: 200,
    id: "8b848383",
    length: 6,
    mix: 50,
    name: "Product",
    recognition_policy_start: 20,
    recognition_policy_monthly: 5,
    recognition_policy_end: 50,
    renewal: 10,
    short_id: "Product",
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int

 


 

 

POST /bucket

Creates a new revenue Bucket

Creates a new User and Returns the resulting User

 

Request URL

https://{client_id}.salesseek.net/api/buckets

Request Body
{
    average_selling_price: 600,
    length: 3,
    mix: 100,
    name: "3 Months Customer Service",
    recognition_policy_end: 0,
    recognition_policy_monthly: 33.33,
    recognition_policy_start: 0,
    renewal: 75
  }

 

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: 600,
    id: "8b848f383",
    length: 3,
    mix: 100,
    name: "3 Months Customer Service",
    recognition_policy_end: 0,
    recognition_policy_monthly: 33.33,
    recognition_policy_start: 0,
    renewal: 75,
    short_id: "3 Months",
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
userOut-The Bucket created after the successful requestJSON

 

 


 

 

PATCH /bucket/{bucket_id}

Update a specific Bucket by its ID

Update a 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

 

 


 

DELETE /buckets/{bucket_id}

Deletes a specific Bucket by its ID

Delete a Bucket by {bucket_id}

Request URL

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

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
bucket_idInYThe id of bucket to be deletedstring
  • No labels