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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommissionAdjustment:
    id: int = 0
    adjustment_date: datetime.datetime = datetime.datetime(1, 1, 1)
    agent: Optional[str] = None
    reason: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    approved: Optional[str] = None
    adj_type: Optional[str] = None
    income: Optional[str] = None
    paid: Optional[str] = None
    balance_forward: Optional[str] = None
    balance_date: Optional[str] = None
    agent_i_d: int = 0
    commission_batch_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommissionAdjustmentResponse:
    response_status: Optional[ResponseStatus] = None
    commission_adjustments: List[CommissionAdjustment] = field(default_factory=list)
    commission_adjustment: Optional[CommissionAdjustment] = None
    commission_adjustment_i_d: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommissionAdjustmentRequest:
    commission_adjustments: List[CommissionAdjustment] = field(default_factory=list)
    commission_adjustment: Optional[CommissionAdjustment] = None
    commission_adjustment_i_d: int = 0

Python 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
}