Trendsic Platform Service

LedgerRequest

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

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

import Foundation
import ServiceStack

public class LedgerRequest : Codable
{
    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 LedgerResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var ledger:[LedgerExtended] = []

    required public init(){}
}

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

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

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

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