| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/CommissionBatchSecurities/{CommissionBatchId} | ||
|---|---|---|---|
| GET,POST,OPTIONS | /v1/CommissionBatchSecurities |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommissionBatchId | path | int | No | |
| Ledger | body | List<LedgerExtended> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentFirstName | form | string | No | |
| AgentLastName | form | string | No | |
| AgentName | form | string | No | |
| AgentLevel | form | decimal | No | |
| PayChexId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LedgerId | form | int | No | |
| AgentId | form | int | No | |
| CommissionBatchId | form | int | No | |
| Rank | form | string | No | |
| Commissions | form | decimal | No | |
| Clawbacks | form | decimal | No | |
| Adjustments | form | decimal | No | |
| PreviousBalance | form | decimal | No | |
| ASAPCharges | form | decimal | No | |
| Payout | form | decimal | No | |
| BalanceForward | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| ReportData | form | List<LedgerExtended> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/CommissionBatchSecurities HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CommissionBatchId: 0,
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
}
},
ReportData:
[
{
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
}
]
}