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

export class CommissionAdjustment
{
    public ID: number;
    public AdjustmentDate: string;
    public Agent: string;
    public Reason: string;
    public Amount: number;
    public Approved: string;
    public AdjType: string;
    public Income: string;
    public Paid: string;
    public BalanceForward: string;
    public BalanceDate: string;
    public AgentID: number;
    public CommissionBatchId: number;

    public constructor(init?: Partial<CommissionAdjustment>) { (Object as any).assign(this, init); }
}

export class CommissionAdjustmentResponse
{
    public ResponseStatus: ResponseStatus;
    public CommissionAdjustments: CommissionAdjustment[] = [];
    public CommissionAdjustment: CommissionAdjustment;
    public CommissionAdjustmentID: number;

    public constructor(init?: Partial<CommissionAdjustmentResponse>) { (Object as any).assign(this, init); }
}

export class CommissionAdjustmentRequest
{
    public CommissionAdjustments: CommissionAdjustment[] = [];
    public CommissionAdjustment: CommissionAdjustment;
    public CommissionAdjustmentID: number;

    public constructor(init?: Partial<CommissionAdjustmentRequest>) { (Object as any).assign(this, init); }
}

TypeScript CommissionAdjustmentRequest 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/CommissionAdjustment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommissionAdjustments: 
	[
		{
			ID: 0,
			AdjustmentDate: 0001-01-01,
			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-01,
		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: 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
		}
	},
	CommissionAdjustments: 
	[
		{
			ID: 0,
			AdjustmentDate: 0001-01-01,
			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-01,
		Agent: String,
		Reason: String,
		Amount: 0,
		Approved: String,
		AdjType: String,
		Income: String,
		Paid: String,
		BalanceForward: String,
		BalanceDate: String,
		AgentID: 0,
		CommissionBatchId: 0
	},
	CommissionAdjustmentID: 0
}