# PagedResultDtoOfCampaignDto

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<[CampaignDto](https://devportal.demo.winkpg.io/docs/api/models/CampaignDto.md)>): (nullable)
  Fields of each item:
  - `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)
  - `merchantId` (string(uuid)): The merchant that owns this campaign.
  - `name` (string): Operator-facing campaign name. (nullable)
  - `description` (string): Free-text description of the campaign. (nullable)
  - `status` ([CampaignStatus](https://devportal.demo.winkpg.io/docs/api/models/CampaignStatus.md)): The campaign's status right now. A running campaign whose scheduled end has already passed  reads as `Ended` here, without anything having been written to it.
    Values:
    - `Draft`: Being prepared, and not yet running.
    - `Active`: Running. The campaign admits member links, subject to its schedule and to their own status.
    - `Paused`: Suspended by the merchant, and resumable back to Active.
    - `Ended`: Finished. Terminal, though the campaign stays editable and reportable.
    - `Archived`: Retired from the working set. No page or payment link may join it.
  - `endedReason` ([CampaignEndedReason](https://devportal.demo.winkpg.io/docs/api/models/CampaignEndedReason.md)): Why the campaign ended, or `null` while it has not ended. A campaign that ended only  because its window closed reports `Schedule`. (nullable)
    Values:
    - `Manual`: A merchant user ended it explicitly.
    - `Schedule`: Its scheduled window closed.
    - `CompletionCap`: Its configured completion count was reached.
    - `AmountCap`: Its configured collected-amount ceiling was reached.
  - `endedAtUtc` (string(date-time)): UTC moment the campaign was ended or archived out of a running state, or `null` while it  has not been. A campaign that reads as ended only because its window closed carries none: its  `endsAtUtc` is its end. (nullable)
  - `isAcceptingPayments` (boolean): Whether member payment links may transact through this campaign right now. False before the  scheduled start, and for any status other than active.
  - `startsAtUtc` (string(date-time)): UTC moment the campaign starts accepting payments. (nullable)
  - `endsAtUtc` (string(date-time)): UTC moment the campaign stops accepting payments. (nullable)
  - `inactiveMessage` (string): Payer-facing message shown while the campaign is not accepting payments. (nullable)
  - `externalReference` (string): The merchant's own identifier for this campaign. (nullable)
  - `overrides` ([CampaignOverridesDto](https://devportal.demo.winkpg.io/docs/api/models/CampaignOverridesDto.md)): Branding and text laid over every hosted page and payment link in the campaign when it  renders. A member that is `null` inherits each member page's own value.
  - `clonedFromCampaignId` (string(uuid)): The campaign this one was cloned from, or `null` for a campaign created from scratch.  The source may have been deleted since; the reference is kept either way. (nullable)
  - `maxCompletions` (integer(int32)): The number of approved payments at which the campaign ends on its own, or `null` for no completion cap. (nullable)
  - `maxTotalAmount` (number(double)): The net collected amount at which the campaign ends on its own, or `null` for no amount cap. (nullable)
  - `goalAmount` (number(double)): The amount the campaign is aiming to collect, or `null` for no goal. (nullable)
  - `refundsReduceTotal` (boolean): Whether refunds, voids and reversals reduce the collected total.
  - `showProgress` (boolean): Whether the campaign's progress is shown to payers and published anonymously.
  - `completedCount` (integer(int32)): Approved payments counted so far. Zero on a campaign that has taken none.
  - `approvedTotal` (number(double)): The approved base amount collected so far, before any refund.
  - `refundedTotal` (number(double)): The amount refunded, voided or reversed so far.
  - `netTotal` (number(double)): The total the caps and the goal are measured against: approved less refunded when refunds  reduce the total, approved otherwise.
  - `lastCompletedAtUtc` (string(date-time)): When the most recent approved payment was counted (UTC), or `null` before the first. (nullable)
  - `percentOfGoal` (integer(int32)): The net total as a whole percentage of the goal, not capped at 100, or `null` without a goal. (nullable)
  - `concurrencyStamp` (string): Optimistic concurrency token. (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.