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.*


open class CommissionBatchRequest
{
    open var CommissionBatchId:Int? = null
    open var Ledger:ArrayList<LedgerExtended> = ArrayList<LedgerExtended>()
}

open class LedgerExtended : Ledger()
{
    open var AgentFirstName:String? = null
    open var AgentLastName:String? = null
    open var AgentName:String? = null
    open var AgentLevel:BigDecimal? = null
    open var PayChexId:String? = null
}

open class Ledger
{
    open var LedgerId:Int? = null
    open var AgentId:Int? = null
    open var CommissionBatchId:Int? = null
    open var Rank:String? = null
    open var Commissions:BigDecimal? = null
    open var Clawbacks:BigDecimal? = null
    open var Adjustments:BigDecimal? = null
    open var PreviousBalance:BigDecimal? = null
    open var ASAPCharges:BigDecimal? = null
    open var Payout:BigDecimal? = null
    open var BalanceForward:BigDecimal? = null
}

open class CommissionBatchResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var ReportData:ArrayList<LedgerExtended> = ArrayList<LedgerExtended>()
}

Kotlin CommissionBatchRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"CommissionBatchId":0,"Ledger":[{"AgentFirstName":"String","AgentLastName":"String","AgentName":"String","AgentLevel":0,"PayChexId":"String","LedgerId":0,"AgentId":0,"CommissionBatchId":0,"Rank":"String","Commissions":0,"Clawbacks":0,"Adjustments":0,"PreviousBalance":0,"ASAPCharges":0,"Payout":0,"BalanceForward":0}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ReportData":[{"AgentFirstName":"String","AgentLastName":"String","AgentName":"String","AgentLevel":0,"PayChexId":"String","LedgerId":0,"AgentId":0,"CommissionBatchId":0,"Rank":"String","Commissions":0,"Clawbacks":0,"Adjustments":0,"PreviousBalance":0,"ASAPCharges":0,"Payout":0,"BalanceForward":0}]}