Trendsic Platform Service

<back to all web services

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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Ledger() = 
        member val LedgerId:Int32 = new Int32() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val CommissionBatchId:Int32 = new Int32() with get,set
        member val Rank:String = null with get,set
        member val Commissions:Decimal = new Decimal() with get,set
        member val Clawbacks:Decimal = new Decimal() with get,set
        member val Adjustments:Decimal = new Decimal() with get,set
        member val PreviousBalance:Decimal = new Decimal() with get,set
        member val ASAPCharges:Decimal = new Decimal() with get,set
        member val Payout:Decimal = new Decimal() with get,set
        member val BalanceForward:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type LedgerExtended() = 
        inherit Ledger()
        member val AgentFirstName:String = null with get,set
        member val AgentLastName:String = null with get,set
        member val AgentName:String = null with get,set
        member val AgentLevel:Decimal = new Decimal() with get,set
        member val PayChexId:String = null with get,set

    [<AllowNullLiteral>]
    type LedgerResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Ledger:ResizeArray<LedgerExtended> = new ResizeArray<LedgerExtended>() with get,set

    [<AllowNullLiteral>]
    type LedgerRequest() = 
        member val Ledger:ResizeArray<LedgerExtended> = new ResizeArray<LedgerExtended>() with get,set

F# LedgerRequest 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/Ledger HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"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"}},"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}]}