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

Get /periods

Provides the entire list of Periods 

Returns the entire list of  Reporting Periods for the current and next years.

Reporting periods are the list of calculated time ranges for the reports based on defined time periods like Sales Forecasts and revenue planner. From SalesSeek settings, the reporting periods can be configured as Quarters or Months, for the system to automatically calculating the list of corresponding periods, eg: 2015 Q1, Q2.... or 2015 Jan, Feb, etc.

Request URL

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

Response Type

Response content type: JSON Array[Reporting_Periods]

ModelExample of Response

Array[Reporting_Period]

 

Reporting_Periods (JSON) {

end_date (date): the immediate next day after period ends, not included; formatted as YYYY-MM-DD,

id (string): unique id of the reporting period

name (string): automatic name (or alias) for this period to be shown,

start_date (date): first date of the reporting period, included. Formatted as YYYY-MM-DD

}

 

[
    0:{
		end_date: "2015-04-01"
		id: "c6eb8d3434"
		name: "2015FY Q1"
		start_date: "2015-01-01"
	},
	1: {
		end_date: "2015-07-01"
		id: "c6eb8d3435"
		name: "2015FY Q2"
		start_date: "2015-04-01"
	},
	2: {...},
    ...
	8: {...}
]

 

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_byInNResults are ordered by the provided field name followed by &20desc or &20ascint
responseOut-Resulting list of PeriodsArray[Period]

 

 


 

 

POST /periods

Change the periods sizes (months / Qs)

Creates a new Period and Returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/periods?reset&period_length=quarterly  

Response Type

Response content type: JSON(Reporting_Periods)

ModelExample of Response

Array[Reporting_Period]

 

Reporting_Periods (JSON) {

end_date (date): the immediate next day after period ends, not included; formatted as YYYY-MM-DD,

id (string): unique id of the reporting period

name (string): automatic name (or alias) for this period to be shown,

start_date (date): first date of the reporting period, included. Formatted as YYYY-MM-DD

}

 

[
    0:{
		end_date: "2015-04-01"
		id: "c6eb8d3434"
		name: "2015FY Q1"
		start_date: "2015-01-01"
	},
	1: {
		end_date: "2015-07-01"
		id: "c6eb8d3435"
		name: "2015FY Q2"
		start_date: "2015-04-01"
	},
	2: {...},
    ...
	8: {...}
]

 

Parameters

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

 

 


 

 

Get /periods/{period_id} 

Provides the Period matching Period_id

Returns the unique Period matching the Period_Id

Request URL

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

Response Type

Response content type: Array(Reporting_Periods

ModelExample of Response

Reporting_Periods (JSON) {

end_date (date): the immediate next day after period ends, not included; formatted as YYYY-MM-DD,

id (string): unique id of the reporting period

name (string): automatic name (or alias) for this period to be shown,

start_date (date): first date of the reporting period, included. Formatted as YYYY-MM-DD

}

[
    0:{
		end_date: "2015-04-01"
		id: "c6eb8d3434"
		name: "2015FY Q1"
		start_date: "2015-01-01"
	},
	1: {
		end_date: "2015-07-01"
		id: "c6eb8d3435"
		name: "2015FY Q2"
		start_date: "2015-04-01"
	},
	2: {...},
    ...
	8: {...}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 Period_idInYThe id of Period to be retrievedstring
responseOut-The Period to be retrievedJSON

 

 


 

 

PATCH /periods/{period_id}

Update a specific Period by its ID

Updates a period starting date by its {period_id} and Returns the resulting list of periods element. This change also affects the previous period end date.

 

Request URL

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

 

Request Body
{
  start_date: "2014-04-05"
}

 

Response Type

Response content type: Array(Periods)

ModelExample of Response

Array(Reporting_Periods)

Reporting_Periods (JSON) {

end_date (date): the immediate next day after period ends, not included; formatted as YYYY-MM-DD,

id (string): unique id of the reporting period

name (string): automatic name (or alias) for this period to be shown,

start_date (date): first date of the reporting period, included. Formatted as YYYY-MM-DD

}

[
    0:{
        end_date: "2015-04-05"
        id: "69d1fbe61"
        name: "2015FY Q1"
        start_date: "2015-01-01"
    },
    1: {
        end_date: "2015-07-01"
        id: "69d1fbe62"
        name: "2015FY Q2"
        start_date: "2015-04-05"
    },
    2: {...},
    ...
    8: {...}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Period_idInYThe id of the Period to be updatedstring
 Period InYThe subset of the Period fields to be updatedJSON
 response OutThe Period after the successful updateJSON
  • No labels