Trendsic Platform Service

FinanceRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardStatTile:
    key: Optional[str] = None
    label: Optional[str] = None
    value: float = 0.0
    previous_value: Optional[float] = None
    unit: Optional[str] = None
    delta_pct: Optional[float] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardSeriesPoint:
    label: Optional[str] = None
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardSeries:
    name: Optional[str] = None
    points: List[DashboardSeriesPoint] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceLocationRow:
    location_name: Optional[str] = None
    service_rev: float = 0.0
    product_rev: float = 0.0
    subscription_rev: float = 0.0
    total: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceTopRow:
    name: Optional[str] = None
    revenue: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceSubscriptionInfo:
    mrr: float = 0.0
    arr: float = 0.0
    active_count: int = 0
    new_count: int = 0
    churned_count: int = 0
    churn_rate_pct: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceResponse:
    response_status: Optional[ResponseStatus] = None
    stats: List[DashboardStatTile] = field(default_factory=list)
    trend: List[DashboardSeries] = field(default_factory=list)
    source_mix: Optional[DashboardSeries] = None
    by_location: List[FinanceLocationRow] = field(default_factory=list)
    top_services: List[FinanceTopRow] = field(default_factory=list)
    top_products: List[FinanceTopRow] = field(default_factory=list)
    subscriptions: Optional[FinanceSubscriptionInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceRequest:
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)
    location_ids: List[str] = field(default_factory=list)

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