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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CommissionRecord() = 
        member val Id:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val AgentNumber:String = null with get,set
        member val AgentName:String = null with get,set
        member val PolicyNumber:String = null with get,set
        member val InsuredAnnuitant:String = null with get,set
        member val ProcessDate:DateTime = new DateTime() with get,set
        member val Premium:Decimal = new Decimal() with get,set
        member val GrossCommission:Decimal = new Decimal() with get,set
        member val CommRate:Double = new Double() with get,set
        member val Part:Double = new Double() with get,set
        member val PaymentDate:DateTime = new DateTime() with get,set
        member val PolicyType:String = null with get,set
        member val Company:String = null with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val DateProcessed:DateTime = new DateTime() with get,set
        member val CommissionBatchId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CommissionReportResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ReportData:ResizeArray<CommissionRecord> = new ResizeArray<CommissionRecord>() with get,set

    [<AllowNullLiteral>]
    type CommissionReportRequest() = 
        member val StartDate:DateTime = new DateTime() with get,set
        member val EndDate:DateTime = new DateTime() with get,set
        member val ShowProcessed:Boolean = new Boolean() with get,set

F# 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
		}
	]
}