# InvoiceListDto

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

Lightweight list DTO for invoice grid views (excludes line items, payments, activities).

## Fields
- `extraProperties` (object): (nullable, read only)
- `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)
- `tenantId` (string(uuid)): (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.
- `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.
- `invoiceNumber` (string): (nullable)
- `status` ([InvoiceStatus](https://devportal.demo.winkpg.io/docs/api/models/InvoiceStatus.md)): Represents the lifecycle status of an invoice.
  Values:
  - `Draft`: Created, editable, not yet issued.
  - `Issued`: Locked and immutable from this point forward.
  - `Sent`: Delivered to recipient via a notification channel.
  - `Viewed`: Recipient opened/viewed the invoice.
  - `PartiallyPaid`: Some payments applied, balance remaining.
  - `Paid`: Fully paid (balance = 0).
  - `PastDue`: Due date passed with outstanding balance.
  - `Closed`: Manually closed (write-off).
  - `Uncollectible`: Auto-marked after dunning period exhausted (configurable: 30/60/90 days past due).
  - `Cancelled`: Voided (only from Draft).
  - `Refunded`: Full refund issued.
- `isLocked` (boolean): (nullable)
- `currency` (string): (nullable)
- `grandTotal` (number(double)): (nullable)
- `amountPaid` (number(double)): (nullable)
- `balanceDue` (number(double)): (nullable)
- `issueDate` (string(date-time)): (nullable)
- `dueDate` (string(date-time)): (nullable)
- `sentAt` (string(date-time)): (nullable)
- `paidAt` (string(date-time)): (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.
- `sourceType` ([InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md)): (nullable)
  Values:
  - `Manual`: Manually created by a user.
  - `UsageBilling`: Generated from usage billing data.
  - `RecurringBilling`: Generated from a recurring billing contract.
  - `Api`: Created via API by an external integration.
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Read DTO for denormalized biller/recipient info frozen at invoice issuance.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `concurrencyStamp` (string): (nullable)
- `entityVersion` (integer(int32))

## See also

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