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.
Pending |
Batch created and the workflow has been started but discovery has not run yet. | Running |
The fan-out workflow is running per-reseller billing runs. | Completed |
Every reseller that ran completed without a failed reseller run. | PartiallyCompleted |
At least one reseller ran successfully and at least one reseller run failed. | Failed |
No reseller ran successfully and at least one reseller run failed. | Cleared |
An admin force-cleared the batch from the Billing Runs page. A terminal, non-failure state distinct from Failed: it records a deliberate operator action (releasing a stuck or stale batch) rather than a run that errored. Like every other terminal status it is reclaimable by the next fan-out's lock-recovery, and is never treated as in-progress. |
|
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:
| Field |
Type |
Description |
resellerId
required |
string (uuid)
|
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.
| resellerName
required |
string
|
Display name of the reseller, when resolvable (admin fan-out only).
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.
| billingRunId
required |
string (uuid)
|
The created run's id, when a run executed (null for skipped resellers).
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.
| outcome
required |
BillingRunResellerOutcome
BillingRunResellerOutcome |
Classifies how a single reseller fared within an admin billing-run batch. Lives in
Domain.Shared so the Domain aggregate (`MerchantBillingRunBatch`'s embedded
outcome) and the Application.Contracts DTOs can both reference it without a layer violation.
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.
Completed |
A run executed for the reseller (may include per-merchant failures within it). | SkippedNoBillableMerchants |
No merchants were assigned to a price plan for the period: no run was created. | SkippedAlreadyRun |
A completed (non-dry) run already exists for this reseller and period. | SkippedRunInProgress |
A run is already in progress for this reseller. | Failed |
The reseller's run failed before completion (or failed to enqueue). | Scheduled |
The reseller's run was accepted and queued as a background job. Merchants are billed asynchronously; the run's final status (Completed, PartiallyCompleted or Failed) appears on the run once processing finishes. An all-resellers batch reports progress through the batch status instead. | SkippedMerchantBillingDisabled |
The reseller has the "Merchant Billing" master switch (ResellerFeatures.MerchantBilling) turned off, so no run was created and no invoices were generated for its merchants. |
| successCount
required |
integer (int32)
|
Merchants successfully billed in this reseller's 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.
| failureCount
required |
integer (int32)
|
Merchants that failed in this reseller's 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.
| totalBilledAmount
required |
number (double)
|
Total amount billed in this reseller's 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.
|
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.
|