Trendsic Platform Service

<back to all web services

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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CommissionBatchRequest
    {
        public Integer CommissionBatchId = null;
        public ArrayList<LedgerExtended> Ledger = new ArrayList<LedgerExtended>();
        
        public Integer getCommissionBatchId() { return CommissionBatchId; }
        public CommissionBatchRequest setCommissionBatchId(Integer value) { this.CommissionBatchId = value; return this; }
        public ArrayList<LedgerExtended> getLedger() { return Ledger; }
        public CommissionBatchRequest setLedger(ArrayList<LedgerExtended> value) { this.Ledger = value; return this; }
    }

    public static class LedgerExtended extends Ledger
    {
        public String AgentFirstName = null;
        public String AgentLastName = null;
        public String AgentName = null;
        public BigDecimal AgentLevel = null;
        public String PayChexId = null;
        
        public String getAgentFirstName() { return AgentFirstName; }
        public LedgerExtended setAgentFirstName(String value) { this.AgentFirstName = value; return this; }
        public String getAgentLastName() { return AgentLastName; }
        public LedgerExtended setAgentLastName(String value) { this.AgentLastName = value; return this; }
        public String getAgentName() { return AgentName; }
        public LedgerExtended setAgentName(String value) { this.AgentName = value; return this; }
        public BigDecimal getAgentLevel() { return AgentLevel; }
        public LedgerExtended setAgentLevel(BigDecimal value) { this.AgentLevel = value; return this; }
        public String getPayChexId() { return PayChexId; }
        public LedgerExtended setPayChexId(String value) { this.PayChexId = value; return this; }
    }

    public static class Ledger
    {
        public Integer LedgerId = null;
        public Integer AgentId = null;
        public Integer CommissionBatchId = null;
        public String Rank = null;
        public BigDecimal Commissions = null;
        public BigDecimal Clawbacks = null;
        public BigDecimal Adjustments = null;
        public BigDecimal PreviousBalance = null;
        public BigDecimal ASAPCharges = null;
        public BigDecimal Payout = null;
        public BigDecimal BalanceForward = null;
        
        public Integer getLedgerId() { return LedgerId; }
        public Ledger setLedgerId(Integer value) { this.LedgerId = value; return this; }
        public Integer getAgentId() { return AgentId; }
        public Ledger setAgentId(Integer value) { this.AgentId = value; return this; }
        public Integer getCommissionBatchId() { return CommissionBatchId; }
        public Ledger setCommissionBatchId(Integer value) { this.CommissionBatchId = value; return this; }
        public String getRank() { return Rank; }
        public Ledger setRank(String value) { this.Rank = value; return this; }
        public BigDecimal getCommissions() { return Commissions; }
        public Ledger setCommissions(BigDecimal value) { this.Commissions = value; return this; }
        public BigDecimal getClawbacks() { return Clawbacks; }
        public Ledger setClawbacks(BigDecimal value) { this.Clawbacks = value; return this; }
        public BigDecimal getAdjustments() { return Adjustments; }
        public Ledger setAdjustments(BigDecimal value) { this.Adjustments = value; return this; }
        public BigDecimal getPreviousBalance() { return PreviousBalance; }
        public Ledger setPreviousBalance(BigDecimal value) { this.PreviousBalance = value; return this; }
        public BigDecimal getAsapCharges() { return ASAPCharges; }
        public Ledger setAsapCharges(BigDecimal value) { this.ASAPCharges = value; return this; }
        public BigDecimal getPayout() { return Payout; }
        public Ledger setPayout(BigDecimal value) { this.Payout = value; return this; }
        public BigDecimal getBalanceForward() { return BalanceForward; }
        public Ledger setBalanceForward(BigDecimal value) { this.BalanceForward = value; return this; }
    }

    public static class CommissionBatchResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<LedgerExtended> ReportData = new ArrayList<LedgerExtended>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CommissionBatchResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<LedgerExtended> getReportData() { return ReportData; }
        public CommissionBatchResponse setReportData(ArrayList<LedgerExtended> value) { this.ReportData = value; return this; }
    }

}

Java 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>