| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CommissionAdjustmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CommissionAdjustment>
<AdjType>String</AdjType>
<AdjustmentDate>0001-01-01T00:00:00</AdjustmentDate>
<Agent>String</Agent>
<AgentID>0</AgentID>
<Amount>0</Amount>
<Approved>String</Approved>
<BalanceDate>String</BalanceDate>
<BalanceForward>String</BalanceForward>
<CommissionBatchId>0</CommissionBatchId>
<ID>0</ID>
<Income>String</Income>
<Paid>String</Paid>
<Reason>String</Reason>
</CommissionAdjustment>
<CommissionAdjustmentID>0</CommissionAdjustmentID>
<CommissionAdjustments>
<CommissionAdjustment>
<AdjType>String</AdjType>
<AdjustmentDate>0001-01-01T00:00:00</AdjustmentDate>
<Agent>String</Agent>
<AgentID>0</AgentID>
<Amount>0</Amount>
<Approved>String</Approved>
<BalanceDate>String</BalanceDate>
<BalanceForward>String</BalanceForward>
<CommissionBatchId>0</CommissionBatchId>
<ID>0</ID>
<Income>String</Income>
<Paid>String</Paid>
<Reason>String</Reason>
</CommissionAdjustment>
</CommissionAdjustments>
</CommissionAdjustmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CommissionAdjustmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CommissionAdjustment>
<AdjType>String</AdjType>
<AdjustmentDate>0001-01-01T00:00:00</AdjustmentDate>
<Agent>String</Agent>
<AgentID>0</AgentID>
<Amount>0</Amount>
<Approved>String</Approved>
<BalanceDate>String</BalanceDate>
<BalanceForward>String</BalanceForward>
<CommissionBatchId>0</CommissionBatchId>
<ID>0</ID>
<Income>String</Income>
<Paid>String</Paid>
<Reason>String</Reason>
</CommissionAdjustment>
<CommissionAdjustmentID>0</CommissionAdjustmentID>
<CommissionAdjustments>
<CommissionAdjustment>
<AdjType>String</AdjType>
<AdjustmentDate>0001-01-01T00:00:00</AdjustmentDate>
<Agent>String</Agent>
<AgentID>0</AgentID>
<Amount>0</Amount>
<Approved>String</Approved>
<BalanceDate>String</BalanceDate>
<BalanceForward>String</BalanceForward>
<CommissionBatchId>0</CommissionBatchId>
<ID>0</ID>
<Income>String</Income>
<Paid>String</Paid>
<Reason>String</Reason>
</CommissionAdjustment>
</CommissionAdjustments>
<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>
</CommissionAdjustmentResponse>