Trendsic Platform Service

FinanceRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/finance

**FinanceRequest** Parameters:
Name	Parameter	Data Type	Required
FromDate	body	DateTime	No
ToDate	body	DateTime	No
LocationIds	body	List<Guid>	No

**FinanceResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Stats	form	List<DashboardStatTile>	No
Trend	form	List<DashboardSeries>	No
SourceMix	form	DashboardSeries	No
ByLocation	form	List<FinanceLocationRow>	No
TopServices	form	List<FinanceTopRow>	No
TopProducts	form	List<FinanceTopRow>	No
Subscriptions	form	FinanceSubscriptionInfo	No

**DashboardStatTile** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Value	form	double	No
PreviousValue	form	double?	No
Unit	form	string	No
DeltaPct	form	double?	No

**DashboardSeries** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Points	form	List<DashboardSeriesPoint>	No

**DashboardSeriesPoint** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	No
Value	form	double	No

**FinanceLocationRow** Parameters:
Name	Parameter	Data Type	Required
LocationName	form	string	No
ServiceRev	form	double	No
ProductRev	form	double	No
SubscriptionRev	form	double	No
Total	form	double	No

**FinanceTopRow** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Revenue	form	double	No

**FinanceSubscriptionInfo** Parameters:
Name	Parameter	Data Type	Required
Mrr	form	double	No
Arr	form	double	No
ActiveCount	form	int	No
NewCount	form	int	No
ChurnedCount	form	int	No
ChurnRatePct	form	double	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dashboard/finance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: 0001-01-01,
	ToDate: 0001-01-01,
	LocationIds: 
	[
		00000000000000000000000000000000
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Stats: 
	[
		{
			Key: String,
			Label: String,
			Value: 0,
			PreviousValue: 0,
			Unit: String
		}
	],
	Trend: 
	[
		{
			Name: String,
			Points: 
			[
				{
					Label: String,
					Value: 0
				}
			]
		}
	],
	SourceMix: 
	{
		Name: String,
		Points: 
		[
			{
				Label: String,
				Value: 0
			}
		]
	},
	ByLocation: 
	[
		{
			LocationName: String,
			ServiceRev: 0,
			ProductRev: 0,
			SubscriptionRev: 0,
			Total: 0
		}
	],
	TopServices: 
	[
		{
			Name: String,
			Revenue: 0
		}
	],
	TopProducts: 
	[
		{
			Name: String,
			Revenue: 0
		}
	],
	Subscriptions: 
	{
		Mrr: 0,
		Arr: 0,
		ActiveCount: 0,
		NewCount: 0,
		ChurnedCount: 0,
		ChurnRatePct: 0
	}
}