The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
API reference
/
Models
RecurringInvoiceGenerationResultDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Result of generating an invoice for a recurring schedule occurrence.
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 scheduleId
required string (uuid)
The schedule the invoice was generated 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.
invoiceId
required string (uuid)
The generated (or pre-existing) invoice id, when an occurrence was due.
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.
created
required boolean
True when a new invoice was created; false when the cycle already had one (idempotent).
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.
sent
required boolean
True when the invoice was auto-sent.
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.
charged
required boolean
True when an automatic charge was attempted against the generated invoice.
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.
chargeApproved
required boolean
True when the automatic charge was approved (only meaningful when `charged` is true).
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.
skipped
required boolean
True when no occurrence was due at the time of the call (nothing generated).
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.
skippedReason
required string
Optional human-readable reason when skipped.
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.
This model has no documented fields.
Next steps