Trendsic Platform Service

<back to all web services

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 Foundation
import ServiceStack

public class CommissionReportRequest : Codable
{
    public var startDate:Date
    public var endDate:Date
    public var showProcessed:Bool

    required public init(){}
}

public class CommissionReportResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var reportData:[CommissionRecord] = []

    required public init(){}
}

public class CommissionRecord : Codable
{
    public var id:Int
    public var dateCreated:Date
    public var agentNumber:String
    public var agentName:String
    public var policyNumber:String
    public var insuredAnnuitant:String
    public var processDate:Date
    public var premium:Double
    public var grossCommission:Double
    public var commRate:Double
    public var part:Double
    public var paymentDate:Date
    public var policyType:String
    public var company:String
    public var agentId:Int
    public var dateProcessed:Date
    public var commissionBatchId:Int

    required public init(){}
}


Swift CommissionReportRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","AgentNumber":"String","AgentName":"String","PolicyNumber":"String","InsuredAnnuitant":"String","ProcessDate":"0001-01-01T00:00:00.0000000","Premium":0,"GrossCommission":0,"CommRate":0,"Part":0,"PaymentDate":"0001-01-01T00:00:00.0000000","PolicyType":"String","Company":"String","AgentId":0,"DateProcessed":"0001-01-01T00:00:00.0000000","CommissionBatchId":0}]}