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}

"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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommissionReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ReportData>
    <CommissionRecord>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <AgentNumber>String</AgentNumber>
      <CommRate>0</CommRate>
      <CommissionBatchId>0</CommissionBatchId>
      <Company>String</Company>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateProcessed>0001-01-01T00:00:00</DateProcessed>
      <GrossCommission>0</GrossCommission>
      <Id>0</Id>
      <InsuredAnnuitant>String</InsuredAnnuitant>
      <Part>0</Part>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <PolicyNumber>String</PolicyNumber>
      <PolicyType>String</PolicyType>
      <Premium>0</Premium>
      <ProcessDate>0001-01-01T00:00:00</ProcessDate>
    </CommissionRecord>
  </ReportData>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CommissionReportResponse>