BillingRunBatchStatusDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Live status of an admin all-resellers billing fan-out batch. Returned by `TriggerAllResellersAsync` (immediately, before the run finishes) and by `GetActiveOrLatestBatchAsync` (the grid's Refresh/poll surface). When the batch is terminal, the counts + `outcomes` carry the completion summary the UI renders.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
batchId
required |
string (uuid) | Batch document id (the tracking id returned at trigger time).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
orchestrationInstanceId
required |
string | Identifier of the background job processing the batch. Null until processing has started.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
periodKey
required |
string | Billing period key (yyyyMM) the batch is running for.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
isDryRun
required |
boolean | True when charges are previewed without generating invoices/charges.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
status
required |
MerchantBillingRunBatchStatus MerchantBillingRunBatchStatus | Current batch status.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
triggeredByUserId
required |
string (uuid) | User that triggered the batch.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
triggeredByUserName
required |
string | Display name of the user that triggered the batch.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
startedAt
required |
string (date-time) | When the fan-out workflow started processing.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
completedAt
required |
string (date-time) | When the batch reached a terminal status.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
clearedByUserName
required |
string | Display name of the admin that force-cleared the batch, when
`status` is `Cleared`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersConsidered
required |
integer (int32) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersRun
required |
integer (int32) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersSkipped
required |
integer (int32) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersFailed
required |
integer (int32) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
totalMerchantsBilled
required |
integer (int32) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
totalMerchantsFailed
required |
integer (int32) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
outcomes
required |
array of BillingRunResellerOutcomeDto array of BillingRunResellerOutcomeDto | Per-reseller outcomes (populated once the batch completes).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
Fields of each BillingRunResellerOutcomeDto:
This body has no documented fields. | ||||||||||||||||||||||||||||||||||||||||
isInProgress
required |
boolean | True while the batch is non-terminal (Pending or Running).
read only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
This model has no documented fields.