# CreditNoteDto

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

Read DTO for a credit note.

## Fields
- `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)
- `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.
- `creditNoteNumber` (string): (nullable)
- `originalInvoiceId` (string(uuid))
- `customerId` (string(uuid)): (nullable)
- `reason` (string): (nullable)
- `lineItems` (array<[CreditNoteLineItemDto](https://devportal.demo.winkpg.io/docs/api/models/CreditNoteLineItemDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `originalLineItemId` (string(uuid)): (nullable)
  - `description` (string): (nullable)
  - `quantity` (number(double))
  - `unitPrice` (number(double))
  - `taxAmount` (number(double)): Tax credited on this line, as computed server-side.
  - `lineTotal` (number(double)): Net plus tax credited on this line, as computed server-side.
- `total` (number(double)): (nullable)
- `status` ([CreditNoteStatus](https://devportal.demo.winkpg.io/docs/api/models/CreditNoteStatus.md)): Lifecycle status of a credit note.
  Values:
  - `Draft`: Created, not yet issued.
  - `Issued`: Issued and available to apply.
  - `Applied`: Applied to the original invoice.
  - `Voided`: Voided and no longer valid.
- `issuedAt` (string(date-time)): (nullable)
- `appliedAt` (string(date-time)): (nullable)
- `concurrencyStamp` (string): (nullable)

## See also

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