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

 

Get /forecasts

Provides the entire list of Forecasts 

Returns the entire list of  Forecasts .

A forecast is a list of deals containing estimations about the closing probability, might be using an automatic weight based on the deal's phase or unweighted, ie: based on the sales person intuition.

Request URL

https://{client_id}.salesseek.net/api/forecasts?detail=normal&published=true&rows=1&order_by=published_date+desc  

Response Type

Response content type: JSON Array[Forecast]

ModelExample of Response

Array[Forecast]

 

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

 

[
  0:{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "041513321",
    is_most_recent: true,
    name: "Jacks Forecast Q1"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-07-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: false,
    published_date: null,
    short_id: "041cdf88f",
    type: "forecasts"
  },
  1:{....}
]

 

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
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int
order_byInN

Results are ordered by the provided field name followed by &20desc or &20asc,

in case nothing is provided it will be the creation date descendant

int
my_teamInNTrue or false if the expected list includes the forecast from every SalesSeek user under the current's user hierarchyboolean
responseOut-Resulting list of ForecastsArray[Forecast]

 

 


 

 

POST /forecasts

Creates a new Forecast 

Creates a new Forecast and Returns the resulting element 

Request URL

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

Request Body
{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    name: "Jacks Forecast Q1"
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-01-01"
    }
    published: false,
    forecast_opportunities: [
        0:{
            forecast_opportunity_buckets: [
		        0: { 
		            bucket_id: "8bc7b383"
    		        id: "5cb68de3"
	    	        value: 50
                },
                1: {...}
            ]
		    id: "e32910"
            opportunity: {
                currency: "USD"
                expected_close_date: "2014-01-18T12:24:28.224282"
                id: "00393b21"
                name: "Domotic House Design"
                phase: {
                    id: "877760f"
                    name: "Won"
                    order: 7
                    phase_type: "won"
                }
            }
            opportunity_id: "350393b21"
            status: "commited"
            weight: 0
        },
        1 :{...}
	]
}

 

Response Type

Response content type: Forecast

ModelExample of Response

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "0415321",
    is_most_recent: true,
    name: "Jacks Forecast Q1"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    owner_id: "2901445",
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-01-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: false,
    published_date: null,
    short_id: "041cdf88f",
    type: "forecasts",
    forecast_opportunities: [
        0:{
            forecast_opportunity_buckets: [
		        0: { 
		            bucket_id: "8bc7b383"
    		        id: "5cb68de3"
	    	        value: 50
                },
                1: {...}
            ]
		    id: "e32910"
            opportunity: {
                currency: "USD"
                expected_close_date: "2014-01-18T12:24:28.224282"
                id: "00393b21"
                name: "Domotic House Design"
                phase: {
                    id: "877760f"
                    name: "Won"
                    order: 7
                    phase_type: "won"
                }
            }
            opportunity_id: "350393b21"
            status: "commited"
            weight: 0
        },
        1 :{...}
	]
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The Forecast created after the successful requestJSON

 


 

POST /forecasts?aggregate

Aggregates 2 o more forecast into a New Forecast 

Creates a new Forecast by aggregating the forecasts opportunities from 2 or more selected forecasts, returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/forecasts?aggregate

Request Body
{
    new_forecast: {
        currencies_conversion: {
            AUD: "2",
            BRL: "3",
            currency: "USD"
        }
        name: "Aggregation of 2 existing forecasts"
    }
    aggregate_from: [
	    0: {
            id: "883322212"
        },
        1: {
            id: "883322213"
        }
    ]
}

 

Response Type

Response content type: Forecast

ModelExample of Response

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "0415321",
    is_most_recent: true,
    name: "Jacks Forecast Q1"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    owner_id: "2901445",
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-01-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: false,
    published_date: null,
    short_id: "041cdf88f",
    type: "forecasts",
    forecast_opportunities: [
        0:{
            forecast_opportunity_buckets: [
		        0: { 
		            bucket_id: "8bc7b383"
    		        id: "5cb68de3"
	    	        value: 50
                },
                1: {...}
            ]
		    id: "e32910"
            opportunity: {
                currency: "USD"
                expected_close_date: "2014-01-18T12:24:28.224282"
                id: "00393b21"
                name: "Domotic House Design"
                phase: {
                    id: "877760f"
                    name: "Won"
                    order: 7
                    phase_type: "won"
                }
            }
            opportunity_id: "350393b21"
            status: "commited"
            weight: 0
        },
        1 :{...}
	]
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The Forecast created after the successful requestJSON

 


 

DELETE /forecasts

Deletes a list of Forecasts

Deletes a list of Forecasts based on the provided Array of {forecasts_id}

Request URL

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

Request Body
[
  {"id": "88554461"},
  {"id": "88554462"},
  {"id": "88554463"}
]
 

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Forecasts_idsInYThe list of Forecasts ids to be deletedArray[JSON]

 


 

Get /forecasts/{forecast_id} 

Provides the Forecast matching Forecast_id

Returns the unique Forecast matching the Forecast_Id

As one of the most basic elements of SalesSeek CRM: An Forecast is a contact on the system, it might be related to an Organization, may have assigned Deals, might be included in Groups depending on their rules, if defined Lead Source then is also a Lead.

Request URL

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

Response Type

Response content type: Forecast

 

ModelExample of Response

 

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

 

{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "0415321",
    is_most_recent: true,
    name: "Jacks Forecast Q1"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    owner_id: "2901445",
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-01-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: false,
    published_date: null,
    short_id: "041cdf88f",
    type: "forecasts",
    forecast_opportunities: [
        0:{
            forecast_opportunity_buckets: [
		        0: { 
		            bucket_id: "8bc7b383"
    		        id: "5cb68de3"
	    	        value: 50
                },
                1: {...}
            ]
		    id: "e32910"
            opportunity: {
                currency: "USD"
                expected_close_date: "2014-01-18T12:24:28.224282"
                id: "00393b21"
                name: "Domotic House Design"
                phase: {
                    id: "877760f"
                    name: "Won"
                    order: 7
                    phase_type: "won"
                }
            }
            opportunity_id: "350393b21"
            status: "commited"
            weight: 0
        },
        1 :{...}
	]
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Forecast_idInYThe id of the requested Forecaststring
responseOut-The Forecast created after the successful requestJSON

 


 

 

PATCH /forecasts/{forecast_id}

Update a specific Forecast by its ID

Updates a Forecast by its {forecast_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/forecasts/69d1fbe62  

 

Request Body
{
    name: "Jacks Forecast Q2",
    period: {
         id:cf7b5fc1
    }
    id: "cf4054",
    published: true
}

 

Response Type

Response content type: JSON XXXXXXXXXXXXXX

ModelExample of Response

 

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "cf4054",
    is_most_recent: true,
    name: "Jacks Forecast Q2"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    owner_id: "2901445",
    period: {
        id: "cf44542292",
        name: "2014FY Q2",
        start_date: "2014-04-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: true,
    published_date: "2014-01-18T12:24:28.224282",
    short_id: "041cdf88f",
    type: "forecasts",
    forecast_opportunities: [
        0:{
            forecast_opportunity_buckets: [
		        0: { 
		            bucket_id: "8bc7b383"
    		        id: "5cb68de3"
	    	        value: 50
                },
                1: {...}
            ]
		    id: "e32910"
            opportunity: {
                currency: "USD"
                expected_close_date: "2014-01-18T12:24:28.224282"
                id: "00393b21"
                name: "Domotic House Design"
                phase: {
                    id: "877760f"
                    name: "Won"
                    order: 7
                    phase_type: "won"
                }
            }
            opportunity_id: "350393b21"
            status: "commited"
            weight: 0
        },
        1 :{...}
	]
}

 

Parameters

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

 

 

 


 

DELETE /forecasts/{forecast_id}

Deletes a specific Forecast by its ID

Deletes a Forecast by it {forecast_id}

Request URL

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

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Forecast_idInYThe id of Forecast to be deletedstring

 

 


 

POST /forecasts{forecast_id}?clone

Clone one forecast into a New Forecast 

Creates a new Forecast by aggregating the forecasts opportunities from 2 or more selected forecasts, returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/forecasts/88773300?clone  

Response Type

Response content type: Forecast

ModelExample of Response

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "0415321",
    is_most_recent: true,
    name: "Jacks Forecast Q1"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    owner_id: "2901445",
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-01-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: false,
    published_date: null,
    short_id: "041cdf88f",
    type: "forecasts",
    forecast_opportunities: [
        0:{
            forecast_opportunity_buckets: [
		        0: { 
		            bucket_id: "8bc7b383"
    		        id: "5cb68de3"
	    	        value: 50
                },
                1: {...}
            ]
		    id: "e32910"
            opportunity: {
                currency: "USD"
                expected_close_date: "2014-01-18T12:24:28.224282"
                id: "00393b21"
                name: "Domotic House Design"
                phase: {
                    id: "877760f"
                    name: "Won"
                    order: 7
                    phase_type: "won"
                }
            }
            opportunity_id: "350393b21"
            status: "commited"
            weight: 0
        },
        1 :{...}
	]
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The Forecast created after the successful requestJSON

 

 


 

Get /forecasts/{forecast_id}?csv

Downloads the Forecast matching Forecast_id

Downloads a csv format file (comma separated values) the unique Forecast matching the Forecast_Id

 

Request URL

https://{client_id}.salesseek.net/api/forecasts/69d1fbe62?csv

Response Type

Response content type: CSV

 

ModelExample of Response

 

"Opportunity","Phase","Status","Weight","Revenue Bucket1"

"Opportunity","Phase","Status","Weight","Revenue Bucket1"
"Rolfe Interio Design","Qualified","none",0.1,5000
"Lynda House Refurbish","Prospect","commited downside",0.4,8000
"Tom Fachade Reconstruction","Quote","commited",0.8,10000

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Forecast_idInYThe id of the requested Forecaststring
responseOut-The Forecast created after the successful requestcsv

 


 

Get /forecasts/{forecast_id}/acl

Gets the Forecast permissions list

Returns the allowed permisions for the current user over this forecast

 

Request URL

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

Response Type

Response content type: Array[Permissions]

 

ModelExample of Response

 

Array[PermissionRules]

 

PermissionRule (Array[user,permission]) {

0: user(string): string indicating the type and ID of the user to apply the permission rule to. A user can be one of the followings :

- salesseek.core.team

- salesseek.core.owner

- user_id

1: permission_type(Enum): the type of permission assigned to the associated user. A type can be one of the followings :

- salesseek.core.view

- salesseek.core.edit

- salesseek.core.all_permissions

}

[
    0: [
        0: {"salesseek.core.team#0f27c4},
        1: {"salesseek.core.edit"}
	],
    1: [
        0: {"salesseek.core.owner#2901f25"},
        1: {"salesseek.core.all_permissions"}
	],
    2: [
        0: {"46452885245"},
        1: {"salesseek.core.view"}
	]
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Forecast_idInYThe id of the Forecast to get the permission rulesstring
responseOut-The list of permissions configured for this forecastArray(PermissionRules)

 


 

POST /forecasts{forecast_id}/acl

Change permissions to the selected forecast

Entirely updates the permission rules assigned to this forecast

Request URL

https://{client_id}.salesseek.net/api/forecasts/88773300/acl

Request Body
[
    0: [
        0: {"salesseek.core.team#0f27c4},
        1: {"salesseek.core.edit"}
	],
    1: [
        0: {"salesseek.core.owner#2901f25"},
        1: {"salesseek.core.all_permissions"}
	],
    2: [
        0: {"46452885245"},
        1: {"salesseek.core.view"}
	]
]

Response Type

Response content type: Array[Permissions]

 

ModelExample of Response

 

Array[PermissionRules]

 

PermissionRule (Array[user,permission]) {

0: user(string): string indicating the type and ID of the user to apply the permission rule to. A user can be one of the followings :

- salesseek.core.team

- salesseek.core.owner

- user_id

1: permission_type(Enum): the type of permission assigned to the associated user. A type can be one of the followings :

- salesseek.core.view

- salesseek.core.edit

- salesseek.core.all_permissions

}

[
    0: [
        0: {"salesseek.core.team#0f27c4},
        1: {"salesseek.core.edit"}
	],
    1: [
        0: {"salesseek.core.owner#2901f25"},
        1: {"salesseek.core.all_permissions"}
	],
    2: [
        0: {"46452885245"},
        1: {"salesseek.core.view"}
	]
]

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Forecast_idInYThe id of the Forecast to get the permission rulesstring
PermissionsInYThe entire list of permission rules to assign to this forecastJSON
responseOut-The resulting list of permission rules assigned to this forecastJSON
  • No labels