RecurringBillingRunSummaryDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Summary DTO for a recurring billing run, used in history grid views.
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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) | The document ID.
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.
| ||||||||||
runId
required |
string (uuid) | Links all per-merchant run documents from the same workflow execution.
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.
| ||||||||||
merchantId
required |
string (uuid) | The merchant this run was executed for.
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.
| ||||||||||
runDate
required |
string (date-time) | The business date of this billing 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.
| ||||||||||
triggerType
required |
RecurringBillingTriggerType RecurringBillingTriggerType | Whether this run was auto or manually triggered.
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.
| ||||||||||
contractCount
required |
integer (int32) | Number of contracts processed.
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.
| ||||||||||
successCount
required |
integer (int32) | Number of successful billing attempts.
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.
| ||||||||||
failedCount
required |
integer (int32) | Number of failed billing attempts.
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.
| ||||||||||
skippedCount
required |
integer (int32) | Number of skipped contracts (already billed).
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.
| ||||||||||
totalAmount
required |
number (double) | Total amount billed across all contracts.
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 |
RecurringBillingRunStatus RecurringBillingRunStatus | Execution 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.
| ||||||||||
correlationId
required |
string (uuid) | Correlation identifier for distributed tracing.
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.
| ||||||||||
durationMs
required |
integer (int64) | Total duration of the run in milliseconds.
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.
| ||||||||||
creationTime
required |
string (date-time) | When this run was created.
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.