Trendsic Platform Service

<back to all web services

AddCommissionAdjustmentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/AddCommissionAdjustment
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 AddCommissionAdjustmentResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommAdjustment:
    agent_id: int = 0
    agent_name: Optional[str] = None
    policy_number: Optional[str] = None
    insured_annuitant: Optional[str] = None
    process_date: datetime.datetime = datetime.datetime(1, 1, 1)
    premium: Optional[str] = None
    gross_commission: Decimal = decimal.Decimal(0)
    comm_rate: Optional[str] = None
    part: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    payment_date: datetime.datetime = datetime.datetime(1, 1, 1)
    policy_type: Optional[str] = None
    company: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddCommissionAdjustmentRequest:
    comm_adjustment: Optional[CommAdjustment] = None

Python AddCommissionAdjustmentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/AddCommissionAdjustment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddCommissionAdjustmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CommAdjustment>
    <AgentId>0</AgentId>
    <AgentName>String</AgentName>
    <Amount>0</Amount>
    <CommRate>String</CommRate>
    <Company>String</Company>
    <GrossCommission>0</GrossCommission>
    <InsuredAnnuitant>String</InsuredAnnuitant>
    <PaymentDate>0001-01-01T00:00:00</PaymentDate>
    <PolicyNumber>String</PolicyNumber>
    <PolicyType>String</PolicyType>
    <Premium>String</Premium>
    <ProcessDate>0001-01-01T00:00:00</ProcessDate>
    <part>String</part>
  </CommAdjustment>
</AddCommissionAdjustmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddCommissionAdjustmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
</AddCommissionAdjustmentResponse>