BillingRunBatchResultDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Result of a `CreateAndRunAsync` call. A billing run is always reseller-scoped, so this batch wraps one-or-more per-reseller runs: <list type="bullet"> <item>A reseller user (or an admin acting inside a single reseller's operating context) produces a batch of exactly one (`wasFanOut` = false).</item> <item>An admin with no reseller context fans out across every reseller that has billable merchants for the period (`wasFanOut` = true). Resellers with nothing to bill are skipped without creating a run row.</item> </list>
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 | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
periodKey
required |
string | Billing period key (yyyyMM) the batch was run 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 were 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.
| ||||||||||||||||||||||||||||||||||||||
wasFanOut
required |
boolean | True when this was an admin cross-reseller fan-out; false for a single-reseller run.
Drives whether the UI shows the multi-reseller summary or the single-run message.
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.
| ||||||||||||||||||||||||||||||||||||||
isAsyncStarted
required |
boolean | True when the fan-out was started as a Durable background process rather than
run inline: the per-reseller counts in this result are not yet populated. Callers track
progress via `BillingRunBatchStatusDto` (`batchId`).
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.
| ||||||||||||||||||||||||||||||||||||||
batchId
required |
string (uuid) | The background batch id when `isAsyncStarted` is true; otherwise null.
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) | Number of resellers evaluated (the full set considered for the run).
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) | Number of resellers for which a billing run actually executed.
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) | Number of resellers skipped without running: no billable merchants for the period,
or a completed run already exists / is in progress for the period.
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) | Number of resellers whose run failed.
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) | Total merchants successfully billed across every reseller run in the batch.
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) | Total merchants that failed within the executed reseller runs. A run can complete at the
reseller level while individual merchants fail; this surfaces those so the toast severity
reflects them (a fan-out with merchant failures is not a clean success).
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.
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. | ||||||||||||||||||||||||||||||||||||||||
This model has no documented fields.