Trendsic Platform Service

CommissionReportRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/CommissionReport/{StartDate}/{EndDate}

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 CommissionRecord:
    id: int = 0
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    agent_number: Optional[str] = None
    agent_name: Optional[str] = None
    policy_number: Optional[str] = None
    insured_annuitant: Optional[str] = None
    process_date: datetime.datetime = datetime.datetime(1, 1, 1)
    premium: Decimal = decimal.Decimal(0)
    gross_commission: Decimal = decimal.Decimal(0)
    comm_rate: float = 0.0
    part: float = 0.0
    payment_date: datetime.datetime = datetime.datetime(1, 1, 1)
    policy_type: Optional[str] = None
    company: Optional[str] = None
    agent_id: int = 0
    date_processed: datetime.datetime = datetime.datetime(1, 1, 1)
    commission_batch_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommissionReportResponse:
    response_status: Optional[ResponseStatus] = None
    report_data: List[CommissionRecord] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommissionReportRequest:
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    show_processed: bool = False

Python CommissionReportRequest DTOs

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.

GET /v1/CommissionReport/{StartDate}/{EndDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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
		}
	},
	ReportData: 
	[
		{
			Id: 0,
			DateCreated: 0001-01-01,
			AgentNumber: String,
			AgentName: String,
			PolicyNumber: String,
			InsuredAnnuitant: String,
			ProcessDate: 0001-01-01,
			Premium: 0,
			GrossCommission: 0,
			CommRate: 0,
			Part: 0,
			PaymentDate: 0001-01-01,
			PolicyType: String,
			Company: String,
			AgentId: 0,
			DateProcessed: 0001-01-01,
			CommissionBatchId: 0
		}
	]
}