| Requires any of the roles: | Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Adjustment/{ID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Adjustment | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/Adjustment/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/Adjustment/DateRange/{ParamStartDate}/{ParamEndDate} |
"use strict";
export class Adjustment {
/** @param {{ID?:number,AdjustmentDate?:string,Agent?:string,Reason?:string,Amount?:number,Approved?:string,AdjType?:string,Income?:string,Paid?:string,BalanceForward?:string,BalanceDate?:string}} [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;
}
export class AdjustmentResponse {
/** @param {{ResponseStatus?:ResponseStatus,Adjustment?:Adjustment[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Adjustment[]} */
Adjustment = [];
}
export class AdjustmentRequest {
/** @param {{Adjustment?:Adjustment[],AgentID?:number,ParamStartDate?:string,ParamEndDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Adjustment[]} */
Adjustment = [];
/** @type {number} */
AgentID;
/** @type {string} */
ParamStartDate;
/** @type {string} */
ParamEndDate;
}
JavaScript AdjustmentRequest 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/Adjustment/{ID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Adjustment":[{"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,"ParamStartDate":"0001-01-01T00:00:00.0000000","ParamEndDate":"0001-01-01T00:00:00.0000000"}
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"}},"Adjustment":[{"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"}]}