Trendsic Platform Service

<back to all web services

FinanceRequest

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DashboardSeries
    {
        public virtual string Name { get; set; }
        public virtual List<DashboardSeriesPoint> Points { get; set; } = [];
    }

    public partial class DashboardSeriesPoint
    {
        public virtual string Label { get; set; }
        public virtual double Value { get; set; }
    }

    public partial class DashboardStatTile
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual double Value { get; set; }
        public virtual double? PreviousValue { get; set; }
        public virtual string Unit { get; set; }
        public virtual double? DeltaPct { get; set; }
    }

    public partial class FinanceLocationRow
    {
        public virtual string LocationName { get; set; }
        public virtual double ServiceRev { get; set; }
        public virtual double ProductRev { get; set; }
        public virtual double SubscriptionRev { get; set; }
        public virtual double Total { get; set; }
    }

    public partial class FinanceRequest
    {
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
        public virtual List<Guid> LocationIds { get; set; } = [];
    }

    public partial class FinanceResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<DashboardStatTile> Stats { get; set; } = [];
        public virtual List<DashboardSeries> Trend { get; set; } = [];
        public virtual DashboardSeries SourceMix { get; set; }
        public virtual List<FinanceLocationRow> ByLocation { get; set; } = [];
        public virtual List<FinanceTopRow> TopServices { get; set; } = [];
        public virtual List<FinanceTopRow> TopProducts { get; set; } = [];
        public virtual FinanceSubscriptionInfo Subscriptions { get; set; }
    }

    public partial class FinanceSubscriptionInfo
    {
        public virtual double Mrr { get; set; }
        public virtual double Arr { get; set; }
        public virtual int ActiveCount { get; set; }
        public virtual int NewCount { get; set; }
        public virtual int ChurnedCount { get; set; }
        public virtual double ChurnRatePct { get; set; }
    }

    public partial class FinanceTopRow
    {
        public virtual string Name { get; set; }
        public virtual double Revenue { get; set; }
    }

}

C# FinanceRequest DTOs

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
	}
}