| POST,OPTIONS | /v1/dashboard/finance |
|---|
"use strict";
export class DashboardStatTile {
/** @param {{Key?:string,Label?:string,Value?:number,PreviousValue?:number,Unit?:string,DeltaPct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Label;
/** @type {number} */
Value;
/** @type {?number} */
PreviousValue;
/** @type {string} */
Unit;
/** @type {?number} */
DeltaPct;
}
export class DashboardSeriesPoint {
/** @param {{Label?:string,Value?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Label;
/** @type {number} */
Value;
}
export class DashboardSeries {
/** @param {{Name?:string,Points?:DashboardSeriesPoint[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {DashboardSeriesPoint[]} */
Points = [];
}
export class FinanceLocationRow {
/** @param {{LocationName?:string,ServiceRev?:number,ProductRev?:number,SubscriptionRev?:number,Total?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LocationName;
/** @type {number} */
ServiceRev;
/** @type {number} */
ProductRev;
/** @type {number} */
SubscriptionRev;
/** @type {number} */
Total;
}
export class FinanceTopRow {
/** @param {{Name?:string,Revenue?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {number} */
Revenue;
}
export class FinanceSubscriptionInfo {
/** @param {{Mrr?:number,Arr?:number,ActiveCount?:number,NewCount?:number,ChurnedCount?:number,ChurnRatePct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Mrr;
/** @type {number} */
Arr;
/** @type {number} */
ActiveCount;
/** @type {number} */
NewCount;
/** @type {number} */
ChurnedCount;
/** @type {number} */
ChurnRatePct;
}
export class FinanceResponse {
/** @param {{ResponseStatus?:ResponseStatus,Stats?:DashboardStatTile[],Trend?:DashboardSeries[],SourceMix?:DashboardSeries,ByLocation?:FinanceLocationRow[],TopServices?:FinanceTopRow[],TopProducts?:FinanceTopRow[],Subscriptions?:FinanceSubscriptionInfo}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {DashboardStatTile[]} */
Stats = [];
/** @type {DashboardSeries[]} */
Trend = [];
/** @type {DashboardSeries} */
SourceMix;
/** @type {FinanceLocationRow[]} */
ByLocation = [];
/** @type {FinanceTopRow[]} */
TopServices = [];
/** @type {FinanceTopRow[]} */
TopProducts = [];
/** @type {FinanceSubscriptionInfo} */
Subscriptions;
}
export class FinanceRequest {
/** @param {{FromDate?:string,ToDate?:string,LocationIds?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FromDate;
/** @type {string} */
ToDate;
/** @type {string[]} */
LocationIds = [];
}
JavaScript FinanceRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FinanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FromDate>0001-01-01T00:00:00</FromDate>
<LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</LocationIds>
<ToDate>0001-01-01T00:00:00</ToDate>
</FinanceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ByLocation>
<FinanceLocationRow>
<LocationName>String</LocationName>
<ProductRev>0</ProductRev>
<ServiceRev>0</ServiceRev>
<SubscriptionRev>0</SubscriptionRev>
<Total>0</Total>
</FinanceLocationRow>
</ByLocation>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SourceMix>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</SourceMix>
<Stats>
<DashboardStatTile>
<Key>String</Key>
<Label>String</Label>
<PreviousValue>0</PreviousValue>
<Unit>String</Unit>
<Value>0</Value>
</DashboardStatTile>
</Stats>
<Subscriptions>
<ActiveCount>0</ActiveCount>
<Arr>0</Arr>
<ChurnRatePct>0</ChurnRatePct>
<ChurnedCount>0</ChurnedCount>
<Mrr>0</Mrr>
<NewCount>0</NewCount>
</Subscriptions>
<TopProducts>
<FinanceTopRow>
<Name>String</Name>
<Revenue>0</Revenue>
</FinanceTopRow>
</TopProducts>
<TopServices>
<FinanceTopRow>
<Name>String</Name>
<Revenue>0</Revenue>
</FinanceTopRow>
</TopServices>
<Trend>
<DashboardSeries>
<Name>String</Name>
<Points>
<DashboardSeriesPoint>
<Label>String</Label>
<Value>0</Value>
</DashboardSeriesPoint>
</Points>
</DashboardSeries>
</Trend>
</FinanceResponse>