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

import Foundation
import ServiceStack

public class CommissionBatchRequest : Codable
{
    public var commissionBatchId:Int
    public var ledger:[LedgerExtended] = []

    required public init(){}
}

public class LedgerExtended : Ledger
{
    public var agentFirstName:String
    public var agentLastName:String
    public var agentName:String
    public var agentLevel:Double
    public var payChexId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case agentFirstName
        case agentLastName
        case agentName
        case agentLevel
        case payChexId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        agentFirstName = try container.decodeIfPresent(String.self, forKey: .agentFirstName)
        agentLastName = try container.decodeIfPresent(String.self, forKey: .agentLastName)
        agentName = try container.decodeIfPresent(String.self, forKey: .agentName)
        agentLevel = try container.decodeIfPresent(Double.self, forKey: .agentLevel)
        payChexId = try container.decodeIfPresent(String.self, forKey: .payChexId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if agentFirstName != nil { try container.encode(agentFirstName, forKey: .agentFirstName) }
        if agentLastName != nil { try container.encode(agentLastName, forKey: .agentLastName) }
        if agentName != nil { try container.encode(agentName, forKey: .agentName) }
        if agentLevel != nil { try container.encode(agentLevel, forKey: .agentLevel) }
        if payChexId != nil { try container.encode(payChexId, forKey: .payChexId) }
    }
}

public class Ledger : Codable
{
    public var ledgerId:Int
    public var agentId:Int
    public var commissionBatchId:Int
    public var rank:String
    public var commissions:Double
    public var clawbacks:Double
    public var adjustments:Double
    public var previousBalance:Double
    public var asapCharges:Double
    public var payout:Double
    public var balanceForward:Double

    required public init(){}
}

public class CommissionBatchResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var reportData:[LedgerExtended] = []

    required public init(){}
}

Swift CommissionBatchRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}]}