| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| 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; } = [];
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>