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

export class Ledger
{
    public LedgerId: number;
    public AgentId: number;
    public CommissionBatchId: number;
    public Rank: string;
    public Commissions: number;
    public Clawbacks: number;
    public Adjustments: number;
    public PreviousBalance: number;
    public ASAPCharges: number;
    public Payout: number;
    public BalanceForward: number;

    public constructor(init?: Partial<Ledger>) { (Object as any).assign(this, init); }
}

export class LedgerExtended extends Ledger
{
    public AgentFirstName: string;
    public AgentLastName: string;
    public AgentName: string;
    public AgentLevel: number;
    public PayChexId: string;

    public constructor(init?: Partial<LedgerExtended>) { super(init); (Object as any).assign(this, init); }
}

export class LedgerResponse
{
    public ResponseStatus: ResponseStatus;
    public Ledger: LedgerExtended[] = [];

    public constructor(init?: Partial<LedgerResponse>) { (Object as any).assign(this, init); }
}

export class LedgerRequest
{
    public Ledger: LedgerExtended[] = [];

    public constructor(init?: Partial<LedgerRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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}]}