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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class Ledger
    {
        public virtual int LedgerId { get; set; }
        public virtual int AgentId { get; set; }
        public virtual int CommissionBatchId { get; set; }
        public virtual string Rank { get; set; }
        public virtual decimal Commissions { get; set; }
        public virtual decimal Clawbacks { get; set; }
        public virtual decimal Adjustments { get; set; }
        public virtual decimal PreviousBalance { get; set; }
        public virtual decimal ASAPCharges { get; set; }
        public virtual decimal Payout { get; set; }
        public virtual decimal BalanceForward { get; set; }
    }

    public partial class LedgerExtended
        : Ledger
    {
        public virtual string AgentFirstName { get; set; }
        public virtual string AgentLastName { get; set; }
        public virtual string AgentName { get; set; }
        public virtual decimal AgentLevel { get; set; }
        public virtual string PayChexId { get; set; }
    }

    public partial class LedgerRequest
    {
        public virtual List<LedgerExtended> Ledger { get; set; } = [];
    }

    public partial class LedgerResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<LedgerExtended> Ledger { get; set; } = [];
    }

}

C# LedgerRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
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
		}
	]
}