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}
CommissionReportRequest Parameters:
NameParameterData TypeRequiredDescription
StartDatepathDateTimeNo
EndDatepathDateTimeNo
ShowProcessedqueryboolNo
CommissionReportResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ReportDataformList<CommissionRecord>No
CommissionRecord Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DateCreatedformDateTimeNo
AgentNumberformstringNo
AgentNameformstringNo
PolicyNumberformstringNo
InsuredAnnuitantformstringNo
ProcessDateformDateTimeNo
PremiumformdecimalNo
GrossCommissionformdecimalNo
CommRateformdoubleNo
PartformdoubleNo
PaymentDateformDateTimeNo
PolicyTypeformstringNo
CompanyformstringNo
AgentIdformintNo
DateProcessedformDateTimeNo
CommissionBatchIdformintNo

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