| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET, OPTIONS | /v1/AutomatedAdjustment/{AutomatedAdjustmentID} | ||
|---|---|---|---|
| DELETE | /v1/AutomatedAdjustment/{AutomatedAdjustmentID} | ||
| GET, POST, PUT, DELETE, OPTIONS | /v1/AutomatedAdjustment |
"use strict";
export class AutomatedAdjustment {
/** @param {{AutomatedAdustmentId?:number,Name?:string,FromAgentId?:number,ToAgentId?:string,ToAgentName?:string,Description?:string,TypeId?:number,TypeDescription?:string,FrequencyId?:number,FrequencyDescription?:string,Amount?:number,ChargeCount?:number,ChargeSum?:number,Installments?:number,PauseUntil?:string,DateCreated?:string,CreatedBy?:string,ModifiedBy?:string,FirstCommissionRequired?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AutomatedAdustmentId;
/** @type {string} */
Name;
/** @type {number} */
FromAgentId;
/** @type {string} */
ToAgentId;
/** @type {string} */
ToAgentName;
/** @type {string} */
Description;
/** @type {number} */
TypeId;
/** @type {string} */
TypeDescription;
/** @type {number} */
FrequencyId;
/** @type {string} */
FrequencyDescription;
/** @type {number} */
Amount;
/** @type {number} */
ChargeCount;
/** @type {number} */
ChargeSum;
/** @type {number} */
Installments;
/** @type {?string} */
PauseUntil;
/** @type {string} */
DateCreated;
/** @type {string} */
CreatedBy;
/** @type {string} */
ModifiedBy;
/** @type {boolean} */
FirstCommissionRequired;
}
export class AutomatedAdjustmentType {
/** @param {{AutomatedAdjustmentTypeId?:number,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AutomatedAdjustmentTypeId;
/** @type {string} */
Description;
}
export class AutomatedAdjustmentfrequency {
/** @param {{AutomatedAdjustmentFrequencyId?:number,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AutomatedAdjustmentFrequencyId;
/** @type {string} */
Description;
}
export class AutomatedAdjustmentResponse {
/** @param {{ResponseStatus?:ResponseStatus,AutomatedAdjustments?:AutomatedAdjustment[],AutomatedAdjustment?:AutomatedAdjustment,AutomatedAdjustmentID?:number,AutomatedAdjustmentTypes?:AutomatedAdjustmentType[],AutomatedAdjustmentFrequencies?:AutomatedAdjustmentfrequency[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {AutomatedAdjustment[]} */
AutomatedAdjustments = [];
/** @type {AutomatedAdjustment} */
AutomatedAdjustment;
/** @type {number} */
AutomatedAdjustmentID;
/** @type {AutomatedAdjustmentType[]} */
AutomatedAdjustmentTypes = [];
/** @type {AutomatedAdjustmentfrequency[]} */
AutomatedAdjustmentFrequencies = [];
}
export class AutomatedAdjustmentRequest {
/** @param {{AutomatedAdjustments?:AutomatedAdjustment[],AutomatedAdjustment?:AutomatedAdjustment,AutomatedAdjustmentID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AutomatedAdjustment[]} */
AutomatedAdjustments = [];
/** @type {AutomatedAdjustment} */
AutomatedAdjustment;
/** @type {number} */
AutomatedAdjustmentID;
}
JavaScript AutomatedAdjustmentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/AutomatedAdjustment HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AutomatedAdjustments":[{"AutomatedAdustmentId":0,"Name":"String","FromAgentId":0,"ToAgentId":"0","ToAgentName":"String","Description":"String","TypeId":0,"TypeDescription":"String","FrequencyId":0,"FrequencyDescription":"String","Amount":0,"ChargeCount":0,"ChargeSum":0,"Installments":0,"PauseUntil":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedBy":"String","FirstCommissionRequired":false}],"AutomatedAdjustment":{"AutomatedAdustmentId":0,"Name":"String","FromAgentId":0,"ToAgentId":"0","ToAgentName":"String","Description":"String","TypeId":0,"TypeDescription":"String","FrequencyId":0,"FrequencyDescription":"String","Amount":0,"ChargeCount":0,"ChargeSum":0,"Installments":0,"PauseUntil":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedBy":"String","FirstCommissionRequired":false},"AutomatedAdjustmentID":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AutomatedAdjustments":[{"AutomatedAdustmentId":0,"Name":"String","FromAgentId":0,"ToAgentId":"0","ToAgentName":"String","Description":"String","TypeId":0,"TypeDescription":"String","FrequencyId":0,"FrequencyDescription":"String","Amount":0,"ChargeCount":0,"ChargeSum":0,"Installments":0,"PauseUntil":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedBy":"String","FirstCommissionRequired":false}],"AutomatedAdjustment":{"AutomatedAdustmentId":0,"Name":"String","FromAgentId":0,"ToAgentId":"0","ToAgentName":"String","Description":"String","TypeId":0,"TypeDescription":"String","FrequencyId":0,"FrequencyDescription":"String","Amount":0,"ChargeCount":0,"ChargeSum":0,"Installments":0,"PauseUntil":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedBy":"String","FirstCommissionRequired":false},"AutomatedAdjustmentID":0,"AutomatedAdjustmentTypes":[{"AutomatedAdjustmentTypeId":0,"Description":"String"}],"AutomatedAdjustmentFrequencies":[{"AutomatedAdjustmentFrequencyId":0,"Description":"String"}]}