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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Ledger
            Public Overridable Property LedgerId As Integer
            Public Overridable Property AgentId As Integer
            Public Overridable Property CommissionBatchId As Integer
            Public Overridable Property Rank As String
            Public Overridable Property Commissions As Decimal
            Public Overridable Property Clawbacks As Decimal
            Public Overridable Property Adjustments As Decimal
            Public Overridable Property PreviousBalance As Decimal
            Public Overridable Property ASAPCharges As Decimal
            Public Overridable Property Payout As Decimal
            Public Overridable Property BalanceForward As Decimal
        End Class

        Public Partial Class LedgerExtended
            Inherits Ledger
            Public Overridable Property AgentFirstName As String
            Public Overridable Property AgentLastName As String
            Public Overridable Property AgentName As String
            Public Overridable Property AgentLevel As Decimal
            Public Overridable Property PayChexId As String
        End Class

        Public Partial Class LedgerRequest
            Public Overridable Property Ledger As List(Of LedgerExtended) = New List(Of LedgerExtended)
        End Class

        Public Partial Class LedgerResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Ledger As List(Of LedgerExtended) = New List(Of LedgerExtended)
        End Class
    End Namespace
End Namespace

VB.NET 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>