# PagedResultDtoOfRecurringInvoiceScheduleDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

## Fields
- `items` (array<[RecurringInvoiceScheduleDto](https://devportal.demo.winkpg.io/docs/api/models/RecurringInvoiceScheduleDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `billerId` (string(uuid))
  - `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
    Values:
    - `GatewayOwner`: Platform-level gateway owner.
    - `Reseller`: Reseller entity.
    - `Merchant`: Merchant entity.
    - `Customer`: End customer.
  - `name` (string): (nullable)
  - `description` (string): (nullable)
  - `status` ([RecurringInvoiceScheduleStatus](https://devportal.demo.winkpg.io/docs/api/models/RecurringInvoiceScheduleStatus.md)): Lifecycle status of a recurring invoice schedule (series).
    Values:
    - `Active`: The series is active and generates invoices on each due run.
    - `Paused`: Generation is suspended; the series can be resumed later. No invoices are generated while paused.
    - `Cancelled`: The series has been cancelled. Terminal: no further generation.
    - `Completed`: The series reached its end (end date or max occurrences). Terminal: no further generation.
  - `schedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md))
  - `nextRunUtc` (string(date-time)): (nullable)
  - `lastRunUtc` (string(date-time)): (nullable)
  - `occurrenceCount` (integer(int32))
  - `endAfterOccurrences` (integer(int32)): (nullable)
  - `autoSend` (boolean)
  - `paymentLinkExpiryHours` (integer(int32)): (nullable)
  - `viewTokenExpiryDays` (integer(int32)): (nullable)
  - `customMessage` (string): (nullable)
  - `recipientId` (string(uuid))
  - `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
    Values:
    - `GatewayOwner`: Platform-level gateway owner.
    - `Reseller`: Reseller entity.
    - `Merchant`: Merchant entity.
    - `Customer`: End customer.
  - `currency` (string): (nullable)
  - `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): (nullable)
    Values:
    - `DueOnReceipt`: Payment due immediately upon receipt.
    - `Net15`: Payment due within 15 days of issue.
    - `Net30`: Payment due within 30 days of issue.
    - `Net45`: Payment due within 45 days of issue.
    - `Net60`: Payment due within 60 days of issue.
    - `Net90`: Payment due within 90 days of issue.
    - `Custom`: Custom number of days specified via InvoiceConsts.
  - `customPaymentDays` (integer(int32)): (nullable)
  - `allowPartialPayment` (boolean): (nullable)
  - `minimumPaymentAmount` (number(double)): (nullable)
  - `partialPaymentTolerance` (number(double)): (nullable)
  - `allowedPaymentMethods` (array<string>): (nullable)
  - `vaultRestriction` ([VaultRestriction](https://devportal.demo.winkpg.io/docs/api/models/VaultRestriction.md)): (nullable)
    Values:
    - `Any`: Allow any payment method (new or saved).
    - `AllowNewAndSaved`: Allow both new and saved payment methods.
    - `SavedOnly`: Only allow previously saved (vaulted) payment methods.
  - `hppPageId` (string(uuid)): (nullable)
  - `templateId` (string(uuid)): (nullable)
  - `invoiceLevelDiscount` ([InvoiceDiscountDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDiscountDto.md))
  - `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md))
  - `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md))
  - `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md))
  - `lineItems` (array<[InvoiceLineItemDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemDto.md)>): (nullable)
  - `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): (nullable)
  - `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): (nullable)
  - `recipientNote` (string): (nullable)
  - `footerText` (string): (nullable)
  - `concurrencyStamp` (string): (nullable)
- `totalCount` (integer(int64))

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.