Trendsic Platform Service

CommissionBatchRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/CommissionBatch/{CommissionBatchId}
GET,POST,OPTIONS	/v1/CommissionBatch


export class Ledger
{
    public LedgerId: number;
    public AgentId: number;
    public CommissionBatchId: number;
    public Rank: string;
    public Commissions: number;
    public Clawbacks: number;
    public Adjustments: number;
    public PreviousBalance: number;
    public ASAPCharges: number;
    public Payout: number;
    public BalanceForward: number;

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

export class LedgerExtended extends Ledger
{
    public AgentFirstName: string;
    public AgentLastName: string;
    public AgentName: string;
    public AgentLevel: number;
    public PayChexId: string;

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

export class CommissionBatchResponse
{
    public ResponseStatus: ResponseStatus;
    public ReportData: LedgerExtended[] = [];

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

export class CommissionBatchRequest
{
    public CommissionBatchId: number;
    public Ledger: LedgerExtended[] = [];

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

TypeScript CommissionBatchRequest 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/CommissionBatch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CommissionBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CommissionBatchId>0</CommissionBatchId>
  <Ledger>
    <LedgerExtended>
      <ASAPCharges>0</ASAPCharges>
      <Adjustments>0</Adjustments>
      <AgentId>0</AgentId>
      <BalanceForward>0</BalanceForward>
      <Clawbacks>0</Clawbacks>
      <CommissionBatchId>0</CommissionBatchId>
      <Commissions>0</Commissions>
      <LedgerId>0</LedgerId>
      <Payout>0</Payout>
      <PreviousBalance>0</PreviousBalance>
      <Rank>String</Rank>
      <AgentFirstName>String</AgentFirstName>
      <AgentLastName>String</AgentLastName>
      <AgentLevel>0</AgentLevel>
      <AgentName>String</AgentName>
      <PayChexId>String</PayChexId>
    </LedgerExtended>
  </Ledger>
</CommissionBatchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommissionBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ReportData>
    <LedgerExtended>
      <ASAPCharges>0</ASAPCharges>
      <Adjustments>0</Adjustments>
      <AgentId>0</AgentId>
      <BalanceForward>0</BalanceForward>
      <Clawbacks>0</Clawbacks>
      <CommissionBatchId>0</CommissionBatchId>
      <Commissions>0</Commissions>
      <LedgerId>0</LedgerId>
      <Payout>0</Payout>
      <PreviousBalance>0</PreviousBalance>
      <Rank>String</Rank>
      <AgentFirstName>String</AgentFirstName>
      <AgentLastName>String</AgentLastName>
      <AgentLevel>0</AgentLevel>
      <AgentName>String</AgentName>
      <PayChexId>String</PayChexId>
    </LedgerExtended>
  </ReportData>
  <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>
</CommissionBatchResponse>