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
LedgerRequest Parameters:
NameParameterData TypeRequiredDescription
LedgerbodyList<LedgerExtended>No
LedgerExtended Parameters:
NameParameterData TypeRequiredDescription
AgentFirstNameformstringNo
AgentLastNameformstringNo
AgentNameformstringNo
AgentLevelformdecimalNo
PayChexIdformstringNo
Ledger Parameters:
NameParameterData TypeRequiredDescription
LedgerIdformintNo
AgentIdformintNo
CommissionBatchIdformintNo
RankformstringNo
CommissionsformdecimalNo
ClawbacksformdecimalNo
AdjustmentsformdecimalNo
PreviousBalanceformdecimalNo
ASAPChargesformdecimalNo
PayoutformdecimalNo
BalanceForwardformdecimalNo
LedgerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LedgerformList<LedgerExtended>No

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