Trendsic Platform Service

CommissionBatchSecuritiesRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/CommissionBatchSecurities/{CommissionBatchId}
GET,POST,OPTIONS	/v1/CommissionBatchSecurities

"use strict";
export class Ledger {
    /** @param {{LedgerId?:number,AgentId?:number,CommissionBatchId?:number,Rank?:string,Commissions?:number,Clawbacks?:number,Adjustments?:number,PreviousBalance?:number,ASAPCharges?:number,Payout?:number,BalanceForward?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    LedgerId;
    /** @type {number} */
    AgentId;
    /** @type {number} */
    CommissionBatchId;
    /** @type {string} */
    Rank;
    /** @type {number} */
    Commissions;
    /** @type {number} */
    Clawbacks;
    /** @type {number} */
    Adjustments;
    /** @type {number} */
    PreviousBalance;
    /** @type {number} */
    ASAPCharges;
    /** @type {number} */
    Payout;
    /** @type {number} */
    BalanceForward;
}
export class LedgerExtended extends Ledger {
    /** @param {{AgentFirstName?:string,AgentLastName?:string,AgentName?:string,AgentLevel?:number,PayChexId?:string,LedgerId?:number,AgentId?:number,CommissionBatchId?:number,Rank?:string,Commissions?:number,Clawbacks?:number,Adjustments?:number,PreviousBalance?:number,ASAPCharges?:number,Payout?:number,BalanceForward?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    AgentFirstName;
    /** @type {string} */
    AgentLastName;
    /** @type {string} */
    AgentName;
    /** @type {number} */
    AgentLevel;
    /** @type {string} */
    PayChexId;
}
export class CommissionBatchSecuritiesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ReportData?:LedgerExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {LedgerExtended[]} */
    ReportData = [];
}
export class CommissionBatchSecuritiesRequest {
    /** @param {{CommissionBatchId?:number,Ledger?:LedgerExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CommissionBatchId;
    /** @type {LedgerExtended[]} */
    Ledger = [];
}

JavaScript CommissionBatchSecuritiesRequest 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.

POST /v1/CommissionBatchSecurities HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommissionBatchId: 0,
	Ledger: 
	[
		{
			AgentFirstName: String,
			AgentLastName: String,
			AgentName: String,
			AgentLevel: 0,
			PayChexId: String,
			LedgerId: 0,
			AgentId: 0,
			CommissionBatchId: 0,
			Rank: String,
			Commissions: 0,
			Clawbacks: 0,
			Adjustments: 0,
			PreviousBalance: 0,
			ASAPCharges: 0,
			Payout: 0,
			BalanceForward: 0
		}
	]
}

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: 
	[
		{
			AgentFirstName: String,
			AgentLastName: String,
			AgentName: String,
			AgentLevel: 0,
			PayChexId: String,
			LedgerId: 0,
			AgentId: 0,
			CommissionBatchId: 0,
			Rank: String,
			Commissions: 0,
			Clawbacks: 0,
			Adjustments: 0,
			PreviousBalance: 0,
			ASAPCharges: 0,
			Payout: 0,
			BalanceForward: 0
		}
	]
}