Trendsic Platform Service

FinanceRequest

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


export class DashboardStatTile
{
    public Key: string;
    public Label: string;
    public Value: number;
    public PreviousValue?: number;
    public Unit: string;
    public DeltaPct?: number;

    public constructor(init?: Partial<DashboardStatTile>) { (Object as any).assign(this, init); }
}

export class DashboardSeriesPoint
{
    public Label: string;
    public Value: number;

    public constructor(init?: Partial<DashboardSeriesPoint>) { (Object as any).assign(this, init); }
}

export class DashboardSeries
{
    public Name: string;
    public Points: DashboardSeriesPoint[] = [];

    public constructor(init?: Partial<DashboardSeries>) { (Object as any).assign(this, init); }
}

export class FinanceLocationRow
{
    public LocationName: string;
    public ServiceRev: number;
    public ProductRev: number;
    public SubscriptionRev: number;
    public Total: number;

    public constructor(init?: Partial<FinanceLocationRow>) { (Object as any).assign(this, init); }
}

export class FinanceTopRow
{
    public Name: string;
    public Revenue: number;

    public constructor(init?: Partial<FinanceTopRow>) { (Object as any).assign(this, init); }
}

export class FinanceSubscriptionInfo
{
    public Mrr: number;
    public Arr: number;
    public ActiveCount: number;
    public NewCount: number;
    public ChurnedCount: number;
    public ChurnRatePct: number;

    public constructor(init?: Partial<FinanceSubscriptionInfo>) { (Object as any).assign(this, init); }
}

export class FinanceResponse
{
    public ResponseStatus: ResponseStatus;
    public Stats: DashboardStatTile[] = [];
    public Trend: DashboardSeries[] = [];
    public SourceMix: DashboardSeries;
    public ByLocation: FinanceLocationRow[] = [];
    public TopServices: FinanceTopRow[] = [];
    public TopProducts: FinanceTopRow[] = [];
    public Subscriptions: FinanceSubscriptionInfo;

    public constructor(init?: Partial<FinanceResponse>) { (Object as any).assign(this, init); }
}

export class FinanceRequest
{
    public FromDate: string;
    public ToDate: string;
    public LocationIds: string[] = [];

    public constructor(init?: Partial<FinanceRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinanceRequest DTOs

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

HTTP + 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>