Trendsic Platform Service

<back to all web services

CommissionAdjustmentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
DELETE/v1/CommissionAdjustment/{CommissionAdjustmentID}
GET, POST, PUT, DELETE, OPTIONS/v1/CommissionAdjustment
"use strict";
export class CommissionAdjustment {
    /** @param {{ID?:number,AdjustmentDate?:string,Agent?:string,Reason?:string,Amount?:number,Approved?:string,AdjType?:string,Income?:string,Paid?:string,BalanceForward?:string,BalanceDate?:string,AgentID?:number,CommissionBatchId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    AdjustmentDate;
    /** @type {string} */
    Agent;
    /** @type {string} */
    Reason;
    /** @type {number} */
    Amount;
    /** @type {string} */
    Approved;
    /** @type {string} */
    AdjType;
    /** @type {string} */
    Income;
    /** @type {string} */
    Paid;
    /** @type {string} */
    BalanceForward;
    /** @type {string} */
    BalanceDate;
    /** @type {number} */
    AgentID;
    /** @type {number} */
    CommissionBatchId;
}
export class CommissionAdjustmentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,CommissionAdjustments?:CommissionAdjustment[],CommissionAdjustment?:CommissionAdjustment,CommissionAdjustmentID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CommissionAdjustment[]} */
    CommissionAdjustments = [];
    /** @type {CommissionAdjustment} */
    CommissionAdjustment;
    /** @type {number} */
    CommissionAdjustmentID;
}
export class CommissionAdjustmentRequest {
    /** @param {{CommissionAdjustments?:CommissionAdjustment[],CommissionAdjustment?:CommissionAdjustment,CommissionAdjustmentID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CommissionAdjustment[]} */
    CommissionAdjustments = [];
    /** @type {CommissionAdjustment} */
    CommissionAdjustment;
    /** @type {number} */
    CommissionAdjustmentID;
}

JavaScript CommissionAdjustmentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/CommissionAdjustment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CommissionAdjustments":[{"ID":0,"AdjustmentDate":"0001-01-01T00:00:00.0000000","Agent":"String","Reason":"String","Amount":0,"Approved":"String","AdjType":"String","Income":"String","Paid":"String","BalanceForward":"String","BalanceDate":"String","AgentID":0,"CommissionBatchId":0}],"CommissionAdjustment":{"ID":0,"AdjustmentDate":"0001-01-01T00:00:00.0000000","Agent":"String","Reason":"String","Amount":0,"Approved":"String","AdjType":"String","Income":"String","Paid":"String","BalanceForward":"String","BalanceDate":"String","AgentID":0,"CommissionBatchId":0},"CommissionAdjustmentID":0}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"CommissionAdjustments":[{"ID":0,"AdjustmentDate":"0001-01-01T00:00:00.0000000","Agent":"String","Reason":"String","Amount":0,"Approved":"String","AdjType":"String","Income":"String","Paid":"String","BalanceForward":"String","BalanceDate":"String","AgentID":0,"CommissionBatchId":0}],"CommissionAdjustment":{"ID":0,"AdjustmentDate":"0001-01-01T00:00:00.0000000","Agent":"String","Reason":"String","Amount":0,"Approved":"String","AdjType":"String","Income":"String","Paid":"String","BalanceForward":"String","BalanceDate":"String","AgentID":0,"CommissionBatchId":0},"CommissionAdjustmentID":0}