| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/CommissionReport/{StartDate}/{EndDate} |
|---|
"use strict";
export class CommissionRecord {
/** @param {{Id?:number,DateCreated?:string,AgentNumber?:string,AgentName?:string,PolicyNumber?:string,InsuredAnnuitant?:string,ProcessDate?:string,Premium?:number,GrossCommission?:number,CommRate?:number,Part?:number,PaymentDate?:string,PolicyType?:string,Company?:string,AgentId?:number,DateProcessed?:string,CommissionBatchId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
DateCreated;
/** @type {string} */
AgentNumber;
/** @type {string} */
AgentName;
/** @type {string} */
PolicyNumber;
/** @type {string} */
InsuredAnnuitant;
/** @type {string} */
ProcessDate;
/** @type {number} */
Premium;
/** @type {number} */
GrossCommission;
/** @type {number} */
CommRate;
/** @type {number} */
Part;
/** @type {string} */
PaymentDate;
/** @type {string} */
PolicyType;
/** @type {string} */
Company;
/** @type {number} */
AgentId;
/** @type {string} */
DateProcessed;
/** @type {number} */
CommissionBatchId;
}
export class CommissionReportResponse {
/** @param {{ResponseStatus?:ResponseStatus,ReportData?:CommissionRecord[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {CommissionRecord[]} */
ReportData = [];
}
export class CommissionReportRequest {
/** @param {{StartDate?:string,EndDate?:string,ShowProcessed?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
/** @type {boolean} */
ShowProcessed;
}
JavaScript CommissionReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}