# SurchargeNoticeRecordDto

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

Read-only data-transfer representation of a filed card-brand surcharge notice embedded in a
merchant's configuration. Notices are per network, each with its own effective date.

## Fields
- `noticeId` (string(uuid)): The notice's identifier, used to name it in an amendment. Null on a notice recorded before  notice identifiers were assigned; such a notice cannot be amended and is corrected by filing a  new one. (nullable)
- `network` (string): The card network the notice covers; null for an all-network notice. (nullable)
- `filedAt` (string(date-time)): When this record was created in WinkPG. (nullable)
- `attestedNoticeDate` (string(date-time)): The calendar date the merchant attested they filed notice with the card networks, when that  predates `filedAt`. Null when the notice was filed as of the record date. (nullable)
- `effectiveAt` (string(date-time)): When the notice becomes effective (the network is surchargeable at/after this instant). (nullable)
- `filedByUserId` (string): The user who filed the notice. (nullable)
- `filedByApiKeyId` (string(uuid)): The API key the notice was filed under, or null when it was not filed over the API (a notice  filed from the portal records neither this nor `filedByApiKeyName`, and so does every  notice recorded before provenance was captured). (nullable)
- `filedByApiKeyName` (string): The display name the API key carried when the notice was filed. Never re-resolved, so a key  renamed since keeps naming itself here the way it was named at the time. (nullable)
- `referenceNumber` (string): The notice reference number issued by the network / processor. The only field an amendment  changes. (nullable)
- `amendedAt` (string(date-time)): When the reference number was last amended, or null when it never has been. (nullable)
- `amendedBy` (string(uuid)): The user who last amended the reference number, or null when it has never been amended or the  amending caller carried no user id. (nullable)
- `processorAccountId` (string): The processor account the notice was filed under: a processor profile id from the merchant's  processing settings, or null for a notice that covers every processor. A value recorded before  filing checked it against the merchant's profiles reads back exactly as it was written. (nullable)
- `coversAllProcessors` (boolean): Whether the notice covers every card processor the merchant is boarded on, which is true when it  names no processor account.
- `coveredProcessorProfileIds` (array<string(uuid)>): The card processor profiles the notice covers: the one it names, or every card processor profile  on the merchant for a notice that names none. Empty when the stored processor account is not a  profile id, or when the merchant's profiles could not be read for an all-processor notice. (nullable)

## See also

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