openapi: 3.2.0 info: title: Pagopa Sender Read B2B API version: 1.0.0 contact: name: 'SEND: supporto enti' url: https://pagopa.atlassian.net/servicedesk/customer/portal/5 termsOfService: https://selfcare.notifichedigitali.it/termini-di-servizio x-api-id: api-external-b2b-pa x-summary: 'Piattaforma Notifiche: API B2B per le Pubbliche Amministrazioni' description: 'Operations tagged SenderReadB2B across 2 of this provider''s published API definitions: send-b2b-pa-bundle.yaml, pagopa-send-b2b-pa-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo security: - ApiKeyAuth: [] tags: - name: SenderReadB2B description: Invocazioni utilizzabili dai mittenti per verificare lo stato delle richieste di notifica inviate e delle notifiche accettate. paths: /delivery/v2.6/requests: get: operationId: retrieveNotificationRequestStatusV26 tags: - SenderReadB2B summary: Verifica accettazione richiesta notifica description: 'Questa operazione serve per verificare se la richiesta di notifica è stata accettata e ottenere lo IUN associato a tale richiesta. Bisogna specificare il parametro _requestId_ oppure la coppia costituita dai parametri _paProtocolNumber_ e _idempotenceToken_.' parameters: - $ref: '#/components/parameters/notificationRequestId' - $ref: '#/components/parameters/paProtocolNumber' - $ref: '#/components/parameters/idempotenceToken' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NewNotificationRequestStatusResponseV26' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.9/notifications/sent/{iun}: get: summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV29 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV29' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/notifications/sent/{iun}/attachments/documents/{docIdx}: get: summary: Download documento notificato tags: - SenderReadB2B operationId: retrieveSentNotificationDocument parameters: - $ref: '#/components/parameters/pathIun' - $ref: '#/components/parameters/pathDocumentIdx' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NotificationAttachmentDownloadMetadataResponse' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/notifications/sent/{iun}/attachments/payment/{recipientIdx}/{attachmentName}: get: summary: Download allegato per pagamento tags: - SenderReadB2B operationId: retrieveSentNotificationAttachment parameters: - $ref: '#/components/parameters/pathIun' - $ref: '#/components/parameters/pathRecipientIdx' - $ref: '#/components/parameters/pathAttachmentName' - $ref: '#/components/parameters/attachmentIdx' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NotificationAttachmentDownloadMetadataResponse' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/requests: get: deprecated: true operationId: retrieveNotificationRequestStatus tags: - SenderReadB2B summary: Verifica accettazione richiesta notifica description: 'Questa operazione serve per verificare se la richiesta di notifica è stata accettata e ottenere lo IUN associato a tale richiesta. Bisogna specificare il parametro _requestId_ oppure la coppia costituita dai parametri _paProtocolNumber_ e _idempotenceToken_.' parameters: - $ref: '#/components/parameters/notificationRequestId' - $ref: '#/components/parameters/paProtocolNumber' - $ref: '#/components/parameters/idempotenceToken' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NewNotificationRequestStatusResponse' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.1/requests: get: deprecated: true operationId: retrieveNotificationRequestStatusV21 tags: - SenderReadB2B summary: Verifica accettazione richiesta notifica description: 'Questa operazione serve per verificare se la richiesta di notifica è stata accettata e ottenere lo IUN associato a tale richiesta. Bisogna specificare il parametro _requestId_ oppure la coppia costituita dai parametri _paProtocolNumber_ e _idempotenceToken_.' parameters: - $ref: '#/components/parameters/notificationRequestId' - $ref: '#/components/parameters/paProtocolNumber' - $ref: '#/components/parameters/idempotenceToken' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NewNotificationRequestStatusResponseV21' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.3/requests: get: deprecated: true operationId: retrieveNotificationRequestStatusV23 tags: - SenderReadB2B summary: Verifica accettazione richiesta notifica description: 'Questa operazione serve per verificare se la richiesta di notifica è stata accettata e ottenere lo IUN associato a tale richiesta. Bisogna specificare il parametro _requestId_ oppure la coppia costituita dai parametri _paProtocolNumber_ e _idempotenceToken_.' parameters: - $ref: '#/components/parameters/notificationRequestId' - $ref: '#/components/parameters/paProtocolNumber' - $ref: '#/components/parameters/idempotenceToken' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NewNotificationRequestStatusResponseV23' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.4/requests: get: deprecated: true operationId: retrieveNotificationRequestStatusV24 tags: - SenderReadB2B summary: Verifica accettazione richiesta notifica description: 'Questa operazione serve per verificare se la richiesta di notifica è stata accettata e ottenere lo IUN associato a tale richiesta. Bisogna specificare il parametro _requestId_ oppure la coppia costituita dai parametri _paProtocolNumber_ e _idempotenceToken_.' parameters: - $ref: '#/components/parameters/notificationRequestId' - $ref: '#/components/parameters/paProtocolNumber' - $ref: '#/components/parameters/idempotenceToken' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NewNotificationRequestStatusResponseV24' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.5/requests: get: deprecated: true operationId: retrieveNotificationRequestStatusV25 x-pagopa-lambda-name: pn-delivery-versioning-v1v21-getnotificationrequeststatus-lambda:live x-pagopa-lambda-account: core tags: - SenderReadB2B summary: EXPERIMENTAL - Verifica accettazione richiesta notifica description: '(EXPERIMENTAL) Questa operazione serve per verificare se la richiesta di notifica è stata accettata e ottenere lo IUN associato a tale richiesta. Bisogna specificare il parametro _requestId_ oppure la coppia costituita dai parametri _paProtocolNumber_ e _idempotenceToken_.' parameters: - $ref: '#/components/parameters/notificationRequestId' - $ref: '#/components/parameters/paProtocolNumber' - $ref: '#/components/parameters/idempotenceToken' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NewNotificationRequestStatusResponseV25' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotification parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotification' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.0/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV20 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV20' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.1/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV21 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV21' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.3/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV23 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV23' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.4/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV24 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV24' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.5/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV25 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV25' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.6/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV26 parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV26' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.7/notifications/sent/{iun}: get: deprecated: true summary: 'EXPERIMENTAL - Mittente: lettura dettagli notifica versione 2' description: '(EXPERIMENTAL) Questa operazione permette di leggere tutti i dettagli di una notifica accettata.' tags: - SenderReadB2B operationId: retrieveSentNotificationV27 x-pagopa-lambda-name: pn-delivery-versioning-v1v2-getnotification-lambda:live x-pagopa-lambda-account: core parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV27' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo /delivery/v2.8/notifications/sent/{iun}: get: deprecated: true summary: 'Mittente: lettura dettagli notifica versione 2' description: Questa operazione permette di leggere tutti i dettagli di una notifica accettata. tags: - SenderReadB2B operationId: retrieveSentNotificationV28 x-pagopa-lambda-name: pn-delivery-versioning-v1v2-getnotification-lambda:live x-pagopa-lambda-account: core parameters: - $ref: '#/components/parameters/pathIun' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FullSentNotificationV28' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Internal error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.notifichedigitali.it description: Ambiente di produzione - url: https://api.uat.notifichedigitali.it description: Ambiente di collaudo components: schemas: TimelineElement: type: object additionalProperties: false properties: elementId: type: string description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string description: Momento in cui avviene l'evento descritto in questo elemento di timeline format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsId' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategory' details: $ref: '#/components/schemas/TimelineElementDetails' SentNotificationV24: description: Le informazioni riguardanti una richiesta di notifica accettata allOf: - $ref: '#/components/schemas/NewNotificationRequestV24' - type: object required: - iun - sentAt properties: senderPaId: type: string description: Identificativo (non IPA) della PA mittente che ha eseguito l'onboarding su SelfCare. La risoluzione di questo è ottenibile da /ext-registry/pa/v1/activated-on-pn pattern: ^.*$ maxLength: 256 iun: $ref: '#/components/schemas/IUN' sentAt: type: string description: Momento di ricezione della notifica da parte di PN format: date-time cancelledByIun: $ref: '#/components/schemas/IUN' documentsAvailable: type: boolean description: Indica se i documenti notificati sono ancora disponibili. NewNotificationRequestV23: description: I campi utilizzati per la creazione di una nuova Notifica. type: object required: - paProtocolNumber - subject - recipients - documents - physicalCommunicationType - notificationFeePolicy - senderDenomination - senderTaxId - taxonomyCode properties: idempotenceToken: description: Identificativo utilizzabile dal chiamante per disambiguare differenti "richieste di notificazione" effettuate con lo stesso numero di protocollo (campo _paProtocolNumber_). Questo può essere necessario in caso di "richiesta di notifica" rifiutata per errori nei codici di verifica degli allegati. type: string pattern: ^[ -~]*$ maxLength: 256 paProtocolNumber: description: Numero di protocollo che la PA mittente assegna alla notifica stessa type: string pattern: ^.*$ maxLength: 256 subject: type: string description: titolo della notifica maxLength: 134 pattern: ^.*$ abstract: type: string description: descrizione sintetica della notifica pattern: ^.*$ maxLength: 1024 recipients: type: array description: Informazioni sui destinatari items: $ref: '#/components/schemas/NotificationRecipientV23' minItems: 1 documents: type: array description: Documenti notificati items: $ref: '#/components/schemas/NotificationDocument' minItems: 1 notificationFeePolicy: $ref: '#/components/schemas/NotificationFeePolicy' cancelledIun: $ref: '#/components/schemas/IUN' physicalCommunicationType: type: string description: Tipologia comunicazione fisica enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 senderDenomination: $ref: '#/components/schemas/Denomination' senderTaxId: description: Sender PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ group: type: string description: Gruppo di utenti dell'ente mittente che può visualizzare la notifica pattern: ^[ -~]*$ maxLength: 1024 amount: type: integer format: int32 description: Importo della notifica in eurocent paymentExpirationDate: type: string minLength: 10 maxLength: 10 pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ description: Data di scadenza del pagamento nel formato YYYY-MM-DD riferito all'Italia taxonomyCode: type: string minLength: 7 maxLength: 7 pattern: ^([0-9]{6}[A-Z]{1})$ description: Codice tassonomico della notifica basato sulla definizione presente nell'allegato 2 capitolo C del bando [__AVVISO PUBBLICO MISURA 1.4.5 PIATTAFORMA NOTIFICHE DIGITALI__](https://pnrrcomuni.fondazioneifel.it/bandi_public/Bando/325) paFee: $ref: '#/components/schemas/PaFeeV23' vat: $ref: '#/components/schemas/VatV23' pagoPaIntMode: type: string description: 'Modalitá di integrazione pagoPA per l''attualizazione del costo della notifica.
- _NONE_: nessuna attualizzazione.
- _SYNC_: modalitá sincrona.
- _ASYNC_: modalitá asincrona.
' enum: - NONE - SYNC - ASYNC SendDigitalFeedbackDetails: type: object required: - recIndex - digitalAddress - responseStatus - notificationDate properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' responseStatus: $ref: '#/components/schemas/ResponseStatus' notificationDate: type: string description: data notifica format: date-time deliveryFailureCause: description: Codice errore, vuoto in caso di successo type: string deliveryDetailCode: type: string description: "Stato - Codice relativo all'evento - Descrizione:\n - PROGRESS C000 = PREACCETTAZIONE\n - PROGRESS C001 = ACCETTAZIONE\n - PROGRESS C005 = PRESA_IN_CARICO\n - PROGRESS C007 = PREAVVISO_ERRORE_CONSEGNA\n - PROGRESS DP00 = RE-INVIO PEC CAUSA FALLIMENTO TEMPORANEO\n - PROGRESS DP10 = TIMEOUT RICEZIONE RISULTATO\n - ERROR C002 = NON_ACCETTAZIONE\n - ERROR C004 = ERRORE_CONSEGNA\n - ERROR C006 = RILEVAZIONE_VIRUS\n - ERROR C008 = ERRORE_COMUNICAZIONE_SERVER_PEC\n - ERROR C009 = ERRORE_DOMINIO_PEC_NON_VALIDO\n - ERROR C010 = ERROR_INVIO_PEC\n - OK C003 = AVVENUTA_CONSEGNA\n" sendingReceipts: type: array items: $ref: '#/components/schemas/SendingReceipt' RequestRefusedDetailsV23: type: object properties: refusalReasons: type: array description: Motivazioni che hanno portato al rifiuto della notifica items: $ref: '#/components/schemas/NotificationRefusedErrorV23' TimelineElementDetailsV26: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetails' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23' - $ref: '#/components/schemas/NotificationViewedDetailsV23' - $ref: '#/components/schemas/NotificationRADDRetrievedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetailsV23' - $ref: '#/components/schemas/RequestRefusedDetailsV25' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetailsV23' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetailsV23' - $ref: '#/components/schemas/SendAnalogProgressDetailsV23' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' - $ref: '#/components/schemas/NotificationCancellationRequestDetails' - $ref: '#/components/schemas/NotificationCancelledDetails' - $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails' - $ref: '#/components/schemas/AnalogWorkflowRecipientDeceasedDetailsV26' IUN: description: Identificativo Univoco Notifica type: string minLength: 25 maxLength: 25 pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$ SimpleRegisteredLetterDetails: type: object required: - recIndex - physicalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' productType: type: string maxLength: 10 description: "Tipo di invio cartaceo effettivamente inviato\n - __RS__: Raccomandata nazionale Semplice (per Avviso di mancato Recapito)\n - __RIS__: Raccomandata internazionale Semplice\n" analogCost: type: integer description: costo in eurocent dell'invio format: int32 numberOfPages: type: integer description: numero delle pagina che compongono la spedizione cartacea format: int32 envelopeWeight: type: integer description: peso in grammi della busta format: int32 prepareRequestId: type: string description: request id della relativa richiesta di prepare maxLength: 512 LegalFactCategory: title: Tipi di atti opponibili a terzi description: "Tipi di atti opponibili a terzi che Piattaforma Notifiche mette a disposizione dei suoi utenti.\n - _SENDER_ACK_: atto di \"presa in carico\" di una notifica\n - _DIGITAL_DELIVERY_: ..." type: string enum: - SENDER_ACK - DIGITAL_DELIVERY - ANALOG_DELIVERY - RECIPIENT_ACCESS - PEC_RECEIPT - ANALOG_FAILURE_DELIVERY ProblemError: properties: code: description: Internal code of the error, in human-readable format example: PN_PARAMETER_TOO_LONG | PN_PARAMETER_TOO_SHORT | PN_DUPLICATE_ENTRY | etc... type: string element: description: Parameter or request body field name for validation error example: body.order.item[2].quantity type: string detail: description: A human readable explanation specific to this occurrence of the problem. example: Parameter not valid maxLength: 1024 type: string required: - code NotificationAttachmentDownloadMetadataResponse: title: Url e metadati per il download di un allegato di una notifica description: "I due campi più importanti sono __url__ e __retryAfter__.
\n - __url__ è presente se il file è pronto per essere scaricato ed indica l'url a cui fare GET.\n - __retryAfter__ indica che il file è stato archiviato e bisognerà aspettare un numero di\n secondi non inferiore a quanto indicato dal campo _retryAfter_.
" type: object required: - filename - contentType - contentLength - sha256 properties: filename: type: string contentType: type: string example: application/pdf contentLength: type: integer format: int32 example: 54092 description: dimensione, in byte, del contenuto. sha256: type: string description: SHA256 del contenuto del file. url: type: string description: URL preautorizzato a cui effettuare una richiesta GET per ottenere il contenuto del documento. Presente solo se il documento è pronto per il download. retryAfter: type: integer format: int32 description: Stima del numero di secondi da aspettare prima che il contenuto del documento sia disponibile per il download. NotificationCancellationRequestDetails: type: object required: - cancellationRequestId properties: cancellationRequestId: type: string description: Id della richiesta maxLength: 512 TimelineElementCategoryV28: type: string description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n * `ANALOG_WORKFLOW_RECIPIENT_DECEASED` - Destinatario deceduto\n * `PUBLIC_REGISTRY_VALIDATION_CALL` - Ricerca dell'indirizzo di spedizione in fase di validazione notifica\n * `PUBLIC_REGISTRY_VALIDATION_RESPONSE` - Recupero dell'indirizzo di spedizione dai registri nazionali\n * `NOTIFICATION_TIMELINE_REWORKED` - Invio richiesta di Rework della timeline per una notifica\n" enum: - SENDER_ACK_CREATION_REQUEST - VALIDATE_NORMALIZE_ADDRESSES_REQUEST - NORMALIZED_ADDRESS - REQUEST_ACCEPTED - SEND_COURTESY_MESSAGE - GET_ADDRESS - PUBLIC_REGISTRY_CALL - PUBLIC_REGISTRY_RESPONSE - SCHEDULE_ANALOG_WORKFLOW - SCHEDULE_DIGITAL_WORKFLOW - PREPARE_DIGITAL_DOMICILE - SEND_DIGITAL_DOMICILE - SEND_DIGITAL_PROGRESS - SEND_DIGITAL_FEEDBACK - REFINEMENT - SCHEDULE_REFINEMENT - DIGITAL_DELIVERY_CREATION_REQUEST - DIGITAL_SUCCESS_WORKFLOW - DIGITAL_FAILURE_WORKFLOW - ANALOG_SUCCESS_WORKFLOW - ANALOG_FAILURE_WORKFLOW - PREPARE_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER_PROGRESS - NOTIFICATION_VIEWED_CREATION_REQUEST - NOTIFICATION_VIEWED - PREPARE_ANALOG_DOMICILE - SEND_ANALOG_DOMICILE - SEND_ANALOG_PROGRESS - SEND_ANALOG_FEEDBACK - PAYMENT - COMPLETELY_UNREACHABLE - COMPLETELY_UNREACHABLE_CREATION_REQUEST - REQUEST_REFUSED - AAR_CREATION_REQUEST - AAR_GENERATION - NOT_HANDLED - PROBABLE_SCHEDULING_ANALOG_DATE - NOTIFICATION_CANCELLATION_REQUEST - NOTIFICATION_CANCELLED - PREPARE_ANALOG_DOMICILE_FAILURE - NOTIFICATION_RADD_RETRIEVED - ANALOG_WORKFLOW_RECIPIENT_DECEASED - PUBLIC_REGISTRY_VALIDATION_CALL - PUBLIC_REGISTRY_VALIDATION_RESPONSE - NOTIFICATION_TIMELINE_REWORKED RecipientType: type: string enum: - PF - PG VatV21: type: integer description: IVA espressa in percentuale imposta al mittente sulla notifica analogica.
Obbligatoria per notifiche con notificationFeePolicy=DELIVERY_MODE e modalità di integrazione Async o modalità di pagamento F24.
Il default nei casi di non obbligatorietà è 22
Per rispettare retro-compatibilitá campo non restituito nelle API v2.1
Esempio vat al 22% -> 22
format: int32 minimum: 0 maximum: 100 ScheduleDigitalWorkflowDetails: type: object required: - recIndex - digitalAddressSource - sentAttemptMade - lastAttemptDate properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' sentAttemptMade: type: integer format: int32 lastAttemptDate: type: string format: date-time NewNotificationRequestStatusResponseV26: allOf: - $ref: '#/components/schemas/NewNotificationRequestV26' - type: object required: - notificationRequestId - notificationRequestStatus properties: notificationRequestId: description: identificativo univoco di una richiesta di invio notifica, non è lo IUN type: string notificationRequestStatus: description: '- __WAITING__: in attesa di essere valutata - __ACCEPTED__: richiesta di notifica accettata, lo IUN è valorizzato - __REFUSED__: richiesta di notifica rifiutata, è valorizzato il campo _errors_' type: string retryAfter: type: integer format: int32 description: Numero di secondi da attendere prima di effettuare una nuova richiesta per la stessa entità; valorizzato quando lo status è __WAITING__. iun: $ref: '#/components/schemas/IUN' errors: description: Elenco degli errori che hanno causato il rifiuto della richiesta di notifica type: array items: $ref: '#/components/schemas/NotificationRequestRefusedProblemError' NewNotificationRequestV25: description: I campi utilizzati per la creazione di una nuova Notifica. type: object required: - paProtocolNumber - subject - recipients - documents - physicalCommunicationType - notificationFeePolicy - senderDenomination - senderTaxId - taxonomyCode properties: idempotenceToken: description: Identificativo utilizzabile dal chiamante per disambiguare differenti "richieste di notificazione" effettuate con lo stesso numero di protocollo (campo _paProtocolNumber_). Questo può essere necessario in caso di "richiesta di notifica" rifiutata per errori nei codici di verifica degli allegati. type: string pattern: ^[ -~]*$ maxLength: 256 paProtocolNumber: description: Numero di protocollo che la PA mittente assegna alla notifica stessa type: string pattern: ^.*$ maxLength: 256 subject: type: string description: titolo della notifica, NON inserire dati personali/sensibili maxLength: 134 pattern: ^.*$ abstract: type: string description: descrizione sintetica della notifica, NON inserire dati personali/sensibili pattern: ^.*$ maxLength: 1024 recipients: type: array description: Informazioni sui destinatari items: $ref: '#/components/schemas/NotificationRecipientV24' minItems: 1 documents: type: array description: Documenti notificati items: $ref: '#/components/schemas/NotificationDocument' minItems: 1 notificationFeePolicy: $ref: '#/components/schemas/NotificationFeePolicy' cancelledIun: $ref: '#/components/schemas/IUN' physicalCommunicationType: type: string description: Tipologia comunicazione fisica enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 senderDenomination: $ref: '#/components/schemas/Denomination' senderTaxId: description: Sender PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ group: type: string description: Gruppo di utenti dell'ente mittente che può visualizzare la notifica pattern: ^[ -~]*$ maxLength: 1024 amount: type: integer format: int32 description: Importo della notifica in eurocent paymentExpirationDate: type: string minLength: 10 maxLength: 10 pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ description: Data di scadenza del pagamento nel formato YYYY-MM-DD riferito all'Italia taxonomyCode: type: string minLength: 7 maxLength: 7 pattern: ^([0-9]{6}[A-Z]{1})$ description: Codice tassonomico della notifica basato sulla definizione presente nell'allegato 2 capitolo C del bando [__AVVISO PUBBLICO MISURA 1.4.5 PIATTAFORMA NOTIFICHE DIGITALI__](https://pnrrcomuni.fondazioneifel.it/bandi_public/Bando/325) paFee: $ref: '#/components/schemas/PaFeeV23' vat: $ref: '#/components/schemas/VatV23' pagoPaIntMode: type: string description: 'Modalitá di integrazione pagoPA per l''attualizazione del costo della notifica.
- _NONE_: nessuna attualizzazione.
- _SYNC_: modalitá sincrona.
- _ASYNC_: modalitá asincrona.
' enum: - NONE - SYNC - ASYNC additionalLanguages: description: 'In questo campo è possibile definire la lingua addizionale (oltre a quella italiana) da utilizzare per la generazione documenti, atti opponibili a terzi ecc.
Le lingue accettate e dunque i valori possibili degli item dell''array sono:
- DE
- SI
- FR
DE (tedesco), SI (sloveno), FR (francese) Attualmente è possibile indicare un solo item e dunque una sola lingua aggiuntiva. Se non vengono indicate lingue aggiuntive la lingua utilizzata per generare
documenti, atti opponibili a terzi ecc. sarà quella italiana.' type: array maxItems: 1 items: type: string EndWorkflowStatus: type: string description: Stato chiusura workflow enum: - SUCCESS - FAILURE BaseAnalogDetails: type: object required: - recIndex - physicalAddress - serviceLevel - sentAttemptMade properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' serviceLevel: $ref: '#/components/schemas/ServiceLevel' sentAttemptMade: type: integer description: numero dei tentativi effettuati format: int32 relatedRequestId: type: string description: Id relativo alla eventuale precedente richiesta di invio cartaceo maxLength: 512 DeliveryMode: type: string description: Tipologia Domiciliazione enum: - DIGITAL - ANALOG DigitalFailureWorkflowDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 paTaxId: description: Payment PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ ResponseStatus: type: string description: stato risposta ricevuta da externalChannel enum: - OK - KO SendAnalogFeedbackDetailsV25: type: object required: - recIndex - physicalAddress - serviceLevel - sentAttemptMade - responseStatus properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' serviceLevel: $ref: '#/components/schemas/ServiceLevel' sentAttemptMade: type: integer description: numero dei tentativi effettuati format: int32 newAddress: $ref: '#/components/schemas/PhysicalAddress' responseStatus: $ref: '#/components/schemas/ResponseStatus' notificationDate: type: string format: date-time deliveryFailureCause: type: string maxLength: 10 description: 'i codici delle motivazioni di mancata consegna possono essere consultati alla seguente [pagina](https://developer.pagopa.it/send/guides/knowledge-base/v2.5/readme/creazione-e-gestione-degli-stream/stream-di-timeline/decodifiche-send_analog#decodifica-deliveryfailurecause) ' deliveryDetailCode: type: string maxLength: 20 description: 'i codici di decodifica degli eventi di invio cartaceo possono essere consultati alla seguente [pagina](https://developer.pagopa.it/send/guides/knowledge-base/v2.5/readme/creazione-e-gestione-degli-stream/stream-di-timeline/decodifiche-send_analog#codici-send_analog_progress-comuni-a-tutte-le-tipologie) ' attachments: type: array items: $ref: '#/components/schemas/AttachmentDetails' sendRequestId: type: string description: RequestId della richiesta d'invio maxLength: 512 registeredLetterCode: type: string description: Codice della raccomandata maxLength: 128 NotificationPaymentInfo: title: Informazioni per effettuare il pagamento description: "Informazioni utili per effettuare il pagamento di una notifica, sono associate al destinatario perché le spese di notifica possono differire a seconda del canale di notifica utilizzato.
\n - _noticeCode_: \"codice avviso pagoPA\" di pagamento del sistema pagoPA, usato per pagamento online.
\n - _creditorTaxId_: codice fiscale dell'ente a cui fa riferimento il \"codice avviso pagoPA\".
\n - _pagoPaForm_: riferimento al PDF contenete il bollettino pagoPA
" type: object required: - noticeCode - creditorTaxId properties: noticeCode: $ref: '#/components/schemas/noticeCode' creditorTaxId: $ref: '#/components/schemas/paTaxId' noticeCodeAlternative: $ref: '#/components/schemas/noticeCode' pagoPaForm: $ref: '#/components/schemas/NotificationPaymentAttachment' FullSentNotificationV21: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV21' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatus' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistory' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV20' NotificationStatusHistoryInvalidatedElement: description: elenco degli avanzamenti effettuati dal processo di notifica type: object required: - status - activeFrom - relatedTimelineElements properties: status: $ref: '#/components/schemas/NotificationStatusV26' activeFrom: type: string description: data e ora di raggiungimento dello stato di avanzamento format: date-time relatedTimelineElements: type: array description: Eventi avvenuti nello stato items: $ref: '#/components/schemas/TimelineElementV28' RefinementDetailsV23: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 notificationCost: description: costo notifica in euro cents, può essere nullo se la notifica si è perfezionata prima per visualizzazione example: 1220 type: integer format: int64 eventTimestamp: type: string description: Data evento refinement format: date-time DigitalSuccessWorkflowDetails: type: object required: - recIndex - digitalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' NotificationRefusedError: type: object properties: errorCode: type: string description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND\n - FILE_SHA_ERROR\n - TAXID_NOT_VALID\n - SERVICE_UNAVAILABLE\n - FILE_PDF_INVALID_ERROR\n - FILE_PDF_TOOBIG_ERROR\n - NOT_VALID_ADDRESS\n - RECIPIENT_ID_NOT_VALID" detail: type: string Denomination: description: 'Denominazione ente o persona fisica / ragione sociale. La codifica prevede i caratteri ISO LATIN 1, senza | e senza i caratteri di controllo, ovvero la seguente regexp: ^[ -{}~\u00A0-ÿ]*$' type: string minLength: 1 maxLength: 88 pattern: ^.*$ NotificationRecipientV24: description: Informazioni sui destinatari required: - denomination - recipientType - taxId type: object additionalProperties: false properties: recipientType: type: string description: 'Tipologia di destinatario: Persona Fisica (PF) o Persona Giuridica (PG)' enum: - PF - PG taxId: $ref: '#/components/schemas/TaxId' denomination: $ref: '#/components/schemas/Denomination' digitalDomicile: $ref: '#/components/schemas/NotificationDigitalAddress' physicalAddress: $ref: '#/components/schemas/NotificationPhysicalAddress' payments: $ref: '#/components/schemas/NotificationPayments' NotificationStatusV26: type: string description: "stato di avanzamento del processo di notifica:\n * `IN_VALIDATION` - notifica depositata in attesa di validazione\n * `ACCEPTED` - L'ente ha depositato la notifica con successo\n * `REFUSED` - Notifica rifiutata a seguito della validazione\n * `DELIVERING` - L'invio della notifica è in corso\n * `DELIVERED` - La notifica è stata consegnata a tutti i destinatari\n * `VIEWED` - Il destinatario ha letto la notifica entro il termine stabilito\n * `EFFECTIVE_DATE` - Il destinatario non ha letto la notifica entro il termine stabilito\n * `UNREACHABLE` - Il destinatario non è reperibile\n * `CANCELLED` - L'ente ha annullato l'invio della notifica\n * `PAID` - [DEPRECATO] Uno dei destinatari ha pagato la notifica\n * `RETURNED_TO_SENDER` - La notifica è stata restituita al mittente\n" enum: - IN_VALIDATION - ACCEPTED - REFUSED - DELIVERING - DELIVERED - VIEWED - EFFECTIVE_DATE - PAID - UNREACHABLE - CANCELLED - RETURNED_TO_SENDER noticeCode: description: Payment notice number numero avviso example: '302000100000019421' type: string maxLength: 18 minLength: 18 pattern: ^\d+$ GetAddressInfoDetails: type: object required: - recIndex - digitalAddressSource - isAvailable - attemptDate properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' isAvailable: type: boolean description: Disponibilità indirizzo attemptDate: type: string description: Data tentativo format: date-time PublicRegistryResponseDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' physicalAddress: $ref: '#/components/schemas/PhysicalAddress' TimelineElementV26: type: object additionalProperties: false properties: elementId: type: string maxLength: 512 description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string deprecated: true description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp) format: date-time ingestionTimestamp: type: string description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND format: date-time eventTimestamp: type: string description: Istante in cui avviene l'evento descritto in questo elemento di timeline format: date-time notificationSentAt: type: string description: Momento di ricezione della richiesta di notifica da parte di SEND format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsIdV20' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV26' details: $ref: '#/components/schemas/TimelineElementDetailsV26' PhysicalAddress: type: object required: - address - municipality properties: at: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Campo "presso" dell'indirizzo address: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Indirizzo del domicilio fisico addressDetails: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Seconda riga dell'indirizzo fisico zip: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Codice di avviamento postale. In caso di invio estero diventa facoltativo municipality: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Comune in cui l'indirizzo si trova municipalityDetails: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Frazione o località province: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Provincia in cui si trova l'indirizzo foreignState: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: Denominazione paese estero description: Indirizzo fisico scoperto durante fase di consegna TimelineElementDetailsV20: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetails' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetails' - $ref: '#/components/schemas/NotificationViewedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetails' - $ref: '#/components/schemas/RequestRefusedDetailsV20' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetails' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetails' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetails' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetails' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetailsV20' - $ref: '#/components/schemas/SendAnalogProgressDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' - $ref: '#/components/schemas/NotificationCancellationRequestDetails' - $ref: '#/components/schemas/NotificationCancelledDetails' - $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails' TimelineElementCategoryV23: type: string description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n" enum: - SENDER_ACK_CREATION_REQUEST - VALIDATE_NORMALIZE_ADDRESSES_REQUEST - NORMALIZED_ADDRESS - REQUEST_ACCEPTED - SEND_COURTESY_MESSAGE - GET_ADDRESS - PUBLIC_REGISTRY_CALL - PUBLIC_REGISTRY_RESPONSE - SCHEDULE_ANALOG_WORKFLOW - SCHEDULE_DIGITAL_WORKFLOW - PREPARE_DIGITAL_DOMICILE - SEND_DIGITAL_DOMICILE - SEND_DIGITAL_PROGRESS - SEND_DIGITAL_FEEDBACK - REFINEMENT - SCHEDULE_REFINEMENT - DIGITAL_DELIVERY_CREATION_REQUEST - DIGITAL_SUCCESS_WORKFLOW - DIGITAL_FAILURE_WORKFLOW - ANALOG_SUCCESS_WORKFLOW - ANALOG_FAILURE_WORKFLOW - PREPARE_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER_PROGRESS - NOTIFICATION_VIEWED_CREATION_REQUEST - NOTIFICATION_VIEWED - PREPARE_ANALOG_DOMICILE - SEND_ANALOG_DOMICILE - SEND_ANALOG_PROGRESS - SEND_ANALOG_FEEDBACK - PAYMENT - COMPLETELY_UNREACHABLE - COMPLETELY_UNREACHABLE_CREATION_REQUEST - REQUEST_REFUSED - AAR_CREATION_REQUEST - AAR_GENERATION - NOT_HANDLED - PROBABLE_SCHEDULING_ANALOG_DATE - NOTIFICATION_CANCELLATION_REQUEST - NOTIFICATION_CANCELLED - PREPARE_ANALOG_DOMICILE_FAILURE - NOTIFICATION_RADD_RETRIEVED BaseRegisteredLetterDetails: type: object required: - recIndex - physicalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' RequestRefusedDetailsV25: type: object properties: refusalReasons: type: array description: Motivazioni che hanno portato al rifiuto della notifica items: $ref: '#/components/schemas/NotificationRefusedErrorV25' FullSentNotificationV25: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV24' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatus' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistory' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV25' NewNotificationRequestStatusResponseV21: allOf: - $ref: '#/components/schemas/NewNotificationRequestV21' - type: object required: - notificationRequestId - notificationRequestStatus properties: notificationRequestId: description: identificativo univoco di una richiesta di invio notifica, non è lo IUN type: string notificationRequestStatus: description: '- __WAITING__: in attesa di essere valutata - __ACCEPTED__: richiesta di notifica accettata, lo IUN è valorizzato - __REFUSED__: richiesta di notifica rifiutata, è valorizzato il campo _errors_' type: string retryAfter: type: integer format: int32 description: Numero di secondi da attendere prima di effettuare una nuova richiesta per la stessa entità; valorizzato quando lo status è __WAITING__. iun: $ref: '#/components/schemas/IUN' errors: description: Elenco degli errori che hanno causato il rifiuto della richiesta di notifica type: array items: $ref: '#/components/schemas/ProblemError' TimelineElementDetailsV28: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetailsV28' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetailsV28' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetailsV28' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV28' - $ref: '#/components/schemas/NotificationViewedDetailsV23' - $ref: '#/components/schemas/NotificationRADDRetrievedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetailsV23' - $ref: '#/components/schemas/RequestRefusedDetailsV27' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetailsV23' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetailsV23' - $ref: '#/components/schemas/SendAnalogProgressDetailsV23' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' - $ref: '#/components/schemas/NotificationCancellationRequestDetails' - $ref: '#/components/schemas/NotificationCancelledDetails' - $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails' - $ref: '#/components/schemas/AnalogWorkflowRecipientDeceasedDetailsV26' - $ref: '#/components/schemas/PublicRegistryValidationCallDetails' - $ref: '#/components/schemas/PublicRegistryValidationResponseDetails' - $ref: '#/components/schemas/NotificationTimelineReworkedDetails' RaddType: type: string description: 'tipo di Rete Anti Digital Divide
__FSU__: Fornitore Servizio Universale
' NormalizedAddressDetails: type: object required: - recIndex - oldAddress - normalizedAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 oldAddress: $ref: '#/components/schemas/PhysicalAddress' normalizedAddress: $ref: '#/components/schemas/PhysicalAddress' NotificationRADDRetrievedDetails: type: object required: - recIndex - raddType - raddTransactionId - eventTimestamp properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 raddType: $ref: '#/components/schemas/RaddTypeV23' raddTransactionId: $ref: '#/components/schemas/RaddTransactionId' eventTimestamp: type: string description: Data evento format: date-time LegalFactsIdV20: description: Chiavi dei documenti generati durante il processo di consegna cartacea type: object required: - key - category properties: key: description: Chiave dell'atto opponibile a terzi generato durante il processo di consegna type: string pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$ maxLength: 512 category: $ref: '#/components/schemas/LegalFactCategoryV20' NewNotificationRequestV21: description: I campi utilizzati per la creazione di una nuova Notifica. type: object required: - paProtocolNumber - subject - recipients - documents - physicalCommunicationType - notificationFeePolicy - senderDenomination - senderTaxId - taxonomyCode properties: idempotenceToken: description: Identificativo utilizzabile dal chiamante per disambiguare differenti "richieste di notificazione" effettuate con lo stesso numero di protocollo (campo _paProtocolNumber_). Questo può essere necessario in caso di "richiesta di notifica" rifiutata per errori nei codici di verifica degli allegati. type: string pattern: ^[ -~]*$ maxLength: 256 paProtocolNumber: description: Numero di protocollo che la PA mittente assegna alla notifica stessa type: string pattern: ^.*$ maxLength: 256 subject: type: string description: titolo della notifica maxLength: 134 pattern: ^.*$ abstract: type: string description: descrizione sintetica della notifica pattern: ^.*$ maxLength: 1024 recipients: type: array description: Informazioni sui destinatari items: $ref: '#/components/schemas/NotificationRecipientV21' documents: type: array description: Documenti notificati items: $ref: '#/components/schemas/NotificationDocument' minItems: 1 notificationFeePolicy: $ref: '#/components/schemas/NotificationFeePolicy' cancelledIun: $ref: '#/components/schemas/IUN' physicalCommunicationType: type: string description: Tipologia comunicazione fisica enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 senderDenomination: $ref: '#/components/schemas/Denomination' senderTaxId: description: Sender PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ group: type: string description: Gruppo di utenti dell'ente mittente che può visualizzare la notifica pattern: ^[ -~]*$ maxLength: 1024 amount: type: integer format: int32 description: Importo della notifica in eurocent paymentExpirationDate: type: string minLength: 10 maxLength: 10 pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ description: Data di scadenza del pagamento nel formato YYYY-MM-DD riferito all'Italia taxonomyCode: type: string minLength: 7 maxLength: 7 pattern: ^([0-9]{6}[A-Z]{1})$ description: Codice tassonomico della notifica basato sulla definizione presente nell'allegato 2 capitolo C del bando [__AVVISO PUBBLICO MISURA 1.4.5 PIATTAFORMA NOTIFICHE DIGITALI__](https://pnrrcomuni.fondazioneifel.it/bandi_public/Bando/325) paFee: $ref: '#/components/schemas/PaFeeV21' vat: $ref: '#/components/schemas/VatV21' pagoPaIntMode: type: string description: 'Modalitá di integrazione pagoPA per l''attualizazione del costo della notifica.
- _NONE_: nessuna attualizzazione.
- _SYNC_: modalitá sincrona.
- _ASYNC_: modalitá asincrona. (non ancora supportata)
' enum: - NONE - SYNC - ASYNC AnalogFailureWorkflowDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 generatedAarUrl: type: string maxLength: 128 description: Chiave per recupero da safe-storage del documento aar NotificationStatusHistoryElement: description: elenco degli avanzamenti effettuati dal processo di notifica type: object required: - status - activeFrom - relatedTimelineElements properties: status: $ref: '#/components/schemas/NotificationStatus' activeFrom: type: string description: data e ora di raggiungimento dello stato di avanzamento format: date-time relatedTimelineElements: type: array description: Eventi avvenuti nello stato items: $ref: '#/components/schemas/TimelineElementId' RaddTypeV23: type: string description: 'tipo di Rete Anti Digital Divide
__FSU__: Fornitore Servizio Universale
__ALT__: Fornitore RADD Alternativa
' NotificationStatusHistory: description: elenco degli avanzamenti effettuati dal processo di notifica type: array items: $ref: '#/components/schemas/NotificationStatusHistoryElement' SendDigitalProgressDetails: type: object properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 deliveryFailureCause: description: Codice errore, opzionale type: string deliveryDetailCode: type: string description: Vedi deliveryDetailCode in SendDigitalFeedbackDetails shouldRetry: type: boolean description: indica se il progress ha dato luogo ad un ritentativo digitalAddress: $ref: '#/components/schemas/DigitalAddress' digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' notificationDate: type: string description: data notifica format: date-time sendingReceipts: type: array items: $ref: '#/components/schemas/SendingReceipt' retryNumber: type: integer description: numero dei tentativi effettuati format: int32 FullSentNotificationV20: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotification' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatus' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistory' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV20' SendAnalogProgressDetailsV23: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 notificationDate: type: string format: date-time deliveryFailureCause: type: string maxLength: 10 description: Vedi deliveryFailureCause in SendAnalogFeedbackDetails deliveryDetailCode: type: string maxLength: 20 description: Vedi deliveryDetailCode in SendAnalogFeedbackDetails attachments: type: array items: $ref: '#/components/schemas/AttachmentDetails' sendRequestId: type: string description: RequestId della richiesta d'invio maxLength: 512 registeredLetterCode: type: string description: Codice della raccomandata maxLength: 128 serviceLevel: $ref: '#/components/schemas/ServiceLevel' NotHandledDetails: type: object required: - recIndex - reasonCode - reason properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 reasonCode: type: string description: Codice motivazione casistica non gestita maxLength: 10 reason: type: string description: Motivazione casistica non gestita maxLength: 2048 NewNotificationRequestStatusResponse: allOf: - $ref: '#/components/schemas/NewNotificationRequest' - type: object required: - notificationRequestId - notificationRequestStatus properties: notificationRequestId: description: identificativo univoco di una richiesta di invio notifica, non è lo IUN type: string notificationRequestStatus: description: '- __WAITING__: in attesa di essere valutata - __ACCEPTED__: richiesta di notifica accettata, lo IUN è valorizzato - __REFUSED__: richiesta di notifica rifiutata, è valorizzato il campo _errors_' type: string retryAfter: type: integer format: int32 description: Numero di secondi da attendere prima di effettuare una nuova richiesta per la stessa entità; valorizzato quando lo status è __WAITING__. iun: $ref: '#/components/schemas/IUN' errors: description: Elenco degli errori che hanno causato il rifiuto della richiesta di notifica type: array items: $ref: '#/components/schemas/ProblemError' NewNotificationRequestStatusResponseV25: allOf: - $ref: '#/components/schemas/NewNotificationRequestV25' - type: object required: - notificationRequestId - notificationRequestStatus properties: notificationRequestId: description: identificativo univoco di una richiesta di invio notifica, non è lo IUN type: string notificationRequestStatus: description: '- __WAITING__: in attesa di essere valutata - __ACCEPTED__: richiesta di notifica accettata, lo IUN è valorizzato - __REFUSED__: richiesta di notifica rifiutata, è valorizzato il campo _errors_' type: string retryAfter: type: integer format: int32 description: Numero di secondi da attendere prima di effettuare una nuova richiesta per la stessa entità; valorizzato quando lo status è __WAITING__. iun: $ref: '#/components/schemas/IUN' errors: description: Elenco degli errori che hanno causato il rifiuto della richiesta di notifica type: array items: $ref: '#/components/schemas/NotificationRequestRefusedProblemError' NotificationStatusHistoryV26: description: elenco degli avanzamenti effettuati dal processo di notifica type: array items: $ref: '#/components/schemas/NotificationStatusHistoryElementV26' TaxId: description: C.F. persona fisica o persona giuridica type: string minLength: 11 maxLength: 16 pattern: ^([A-Z]{6}[0-9LMNPQRSTUV]{2}[A-Z]{1}[0-9LMNPQRSTUV]{2}[A-Z]{1}[0-9LMNPQRSTUV]{3}[A-Z]{1})|([0-9]{11})$ NotificationPayments: title: Pagamenti collegati alla notifica per il destinatario description: Lista dei pagamenti collegati alla notifica per il destinatario. Possono essere pagamenti rateali o alternativi type: array items: $ref: '#/components/schemas/NotificationPaymentItem' RaddTransactionId: type: string description: Identificativo della pratica all'interno della rete RADD maxLength: 512 NotificationRequestRefusedProblemError: allOf: - $ref: '#/components/schemas/ProblemError' - type: object required: - code properties: recIndex: description: Index destinatario notifica digitale type: integer format: int32 RequestRefusedDetails: type: object properties: refusalReasons: type: array description: Motivazioni che hanno portato al rifiuto della notifica items: $ref: '#/components/schemas/NotificationRefusedError' NotificationPaidDetailsV20: type: object required: - recIndex - recipientType - paymentSourceChannel properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 recipientType: $ref: '#/components/schemas/RecipientType' amount: type: integer description: Importo di pagamento in eurocent format: int32 creditorTaxId: $ref: '#/components/schemas/paTaxId' noticeCode: $ref: '#/components/schemas/noticeCode' idF24: type: string description: un UUID che identifica un pagamento f24 paymentSourceChannel: type: string description: Canale sorgente della richiesta di pagamento uncertainPaymentDate: deprecated: true type: boolean description: Indica se la data di pagamento é certa DigitalDeliveryCreationRequestDetails: type: object required: - recIndex - digitalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' endWorkflowStatus: $ref: '#/components/schemas/EndWorkflowStatus' completionWorkflowDate: type: string description: Data chiusura workflow format: date-time legalfactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione NotificationRequestAcceptedDetailsV27: type: object properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 notificationRequestId: type: string description: identificativo univoco di una richiesta di invio notifica, non è lo IUN paProtocolNumber: type: string description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche. pattern: ^.*$ maxLength: 256 idempotenceToken: type: string description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo. pattern: ^[ -~]*$ maxLength: 256 NewNotificationRequestStatusResponseV23: allOf: - $ref: '#/components/schemas/NewNotificationRequestV23' - type: object required: - notificationRequestId - notificationRequestStatus properties: notificationRequestId: description: identificativo univoco di una richiesta di invio notifica, non è lo IUN type: string notificationRequestStatus: description: '- __WAITING__: in attesa di essere valutata - __ACCEPTED__: richiesta di notifica accettata, lo IUN è valorizzato - __REFUSED__: richiesta di notifica rifiutata, è valorizzato il campo _errors_' type: string retryAfter: type: integer format: int32 description: Numero di secondi da attendere prima di effettuare una nuova richiesta per la stessa entità; valorizzato quando lo status è __WAITING__. iun: $ref: '#/components/schemas/IUN' errors: description: Elenco degli errori che hanno causato il rifiuto della richiesta di notifica type: array items: $ref: '#/components/schemas/ProblemError' IoSendMessageResult: type: string description: Risultato invio messaggio su IO enum: - NOT_SENT_OPTIN_ALREADY_SENT - SENT_COURTESY - SENT_OPTIN NewNotificationRequest: description: I campi utilizzati per la creazione di una nuova Notifica. type: object required: - paProtocolNumber - subject - recipients - documents - physicalCommunicationType - notificationFeePolicy - senderDenomination - senderTaxId - taxonomyCode properties: idempotenceToken: description: Identificativo utilizzabile dal chiamante per disambiguare differenti "richieste di notificazione" effettuate con lo stesso numero di protocollo (campo _paProtocolNumber_). Questo può essere necessario in caso di "richiesta di notifica" rifiutata per errori nei codici di verifica degli allegati. type: string pattern: ^[ -~]*$ maxLength: 256 paProtocolNumber: description: Numero di protocollo che la PA mittente assegna alla notifica stessa type: string pattern: ^.*$ maxLength: 256 subject: type: string description: titolo della notifica, NON inserire dati personali/sensibili minLength: 10 maxLength: 134 pattern: ^.*$ abstract: type: string description: descrizione sintetica della notifica, NON inserire dati personali/sensibili pattern: ^.*$ maxLength: 1024 recipients: type: array description: Informazioni sui destinatari items: $ref: '#/components/schemas/NotificationRecipient' documents: type: array description: Documenti notificati items: $ref: '#/components/schemas/NotificationDocument' minItems: 1 notificationFeePolicy: $ref: '#/components/schemas/NotificationFeePolicy' cancelledIun: $ref: '#/components/schemas/IUN' physicalCommunicationType: type: string description: Tipologia comunicazione fisica enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 senderDenomination: $ref: '#/components/schemas/Denomination' senderTaxId: description: Sender PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ group: type: string description: Gruppo di utenti dell'ente mittente che può visualizzare la notifica pattern: ^[ -~]*$ maxLength: 1024 amount: type: integer format: int32 description: Importo della notifica in eurocent paymentExpirationDate: type: string minLength: 10 maxLength: 10 pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ description: Data di scadenza del pagamento nel formato YYYY-MM-DD riferito all'Italia taxonomyCode: type: string minLength: 7 maxLength: 7 pattern: ^([0-9]{6}[A-Z]{1})$ description: 'Codice tassonomico della notifica basato sulla definizione presente nell''allegato 2 capitolo C del bando [__AVVISO PUBBLICO MISURA 1.4.5 PIATTAFORMA NOTIFICHE DIGITALI__](https://pnrrcomuni.fondazioneifel.it/bandi_public/Bando/325) ' pagoPaIntMode: type: string description: 'Modalitá di integrazione pagoPA per l''attualizazione del costo della notifica.
- _NONE_: nessuna attualizzazione.
- _SYNC_: modalitá sincrona.
- _ASYNC_: modalitá asincrona. (Non ancora supportata)
' enum: - NONE - SYNC - ASYNC AnalogSuccessWorkflowDetails: type: object required: - recIndex - physicalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' NotificationCancelledDetails: type: object required: - notificationCost - notRefinedRecipientIndexes properties: notificationCost: description: costo notifica in euro cents, vale 100 * numero di recipient not refined example: 1220 type: integer format: int64 notRefinedRecipientIndexes: type: array items: description: indice del recipient non perfezionato type: integer format: int32 NotificationRefusedErrorV25: type: object properties: errorCode: type: string maxLength: 128 description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND - I riferimenti dei documenti nella notifica non sono corretti o i documenti non sono stati caricati con successo.\n - FILE_GONE - Allegato non disponibile: superati i termini di conservazione\n - FILE_SHA_ERROR - Il digest calcolato con algoritmi sha256 dei documenti inseriti non è corrispondete a quello del file referenziato.\n - FILE_PDF_INVALID_ERROR - Il file inserito non è in formato pdf.\n - FILE_PDF_TOOBIG_ERROR - Il file pdf ha una dimensione eccedente il limite di 200MB.\n - F24_METADATA_NOT_VALID - I dati contenuti del file dei metadati F24 non rispettano lo schema di validazione.\n - TAXID_NOT_VALID - Codice fiscale del destinatario non corretto (non ancora implementato).\n - RECIPIENT_ID_NOT_VALID - Destinatario non Valido (utilizzato solo per funzionalità non ancora implementate)\n - NOT_VALID_ADDRESS - L'indirizzo di invio cartaceo inserito per il destinatario non ha superato i controlli di correttezza.\n - PAYMENT_NOT_VALID - I dati del pagamento non sono sono registrati sulla piattaforma GPD (modalità asincrona di integrazione pagoPA)\n - SERVICE_UNAVAILABLE - Il sistema non è attualmente disponibile.\n ..." detail: type: string maxLength: 2048 AarGenerationDetails: type: object required: - recIndex - generatedAarUrl - numberOfPages properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 generatedAarUrl: type: string description: Chiave per recupero da safe-storage del documento aar maxLength: 128 numberOfPages: type: integer description: numero di pagine del PDF generato format: int32 PaFeeV21: type: integer description: Costo espresso in eurocent che la PA imputa per la notifica.
Obbligatoria per notifiche con notificationFeePolicy=DELIVERY_MODE e modalità di integrazione Async o modalità di pagamento F24.
Il default nei casi di non obbligatorietà è 100
Esempio paFee ad 1€ -> 100
format: int32 minimum: 0 maximum: 100 AnalogWorkflowRecipientDeceasedDetailsV26: type: object required: - recIndex - physicalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' notificationCost: description: costo notifica in euro cents, può essere nullo se la notifica è stata precedentemente visualizzata example: 1220 type: integer format: int64 NotificationViewedDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 notificationCost: description: costo notifica in euro cents, può essere nullo se la notifica si è perfezionata prima per decorrenza termini example: 1220 type: integer format: int64 raddType: $ref: '#/components/schemas/RaddType' raddTransactionId: $ref: '#/components/schemas/RaddTransactionId' delegateInfo: $ref: '#/components/schemas/DelegateInfo' NotificationPaidDetails: type: object required: - recIndex - recipientType - paymentSourceChannel properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 recipientType: $ref: '#/components/schemas/RecipientType' amount: type: integer description: Importo di pagamento in eurocent format: int32 creditorTaxId: $ref: '#/components/schemas/paTaxId' noticeCode: $ref: '#/components/schemas/noticeCode' idF24: type: string description: un UUID che identifica un pagamento f24 paymentSourceChannel: type: string description: Canale sorgente della richiesta di pagamento uncertainPaymentDate: type: boolean description: Indica se la data di pagamento é certa DigitalAddress: description: Indirizzo di invio della notifica required: - address - type type: object properties: type: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: tipo di indirizzo PEC, REM, SERCQ, SMS, EMAIL, APPIO ... address: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string description: account@domain NotificationViewedDetailsV23: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 notificationCost: description: costo notifica in euro cents, può essere nullo se la notifica si è perfezionata prima per decorrenza termini example: 1220 type: integer format: int64 raddType: $ref: '#/components/schemas/RaddTypeV23' raddTransactionId: $ref: '#/components/schemas/RaddTransactionId' delegateInfo: $ref: '#/components/schemas/DelegateInfo' eventTimestamp: type: string description: Data evento visualizzazione format: date-time TimelineElementDetailsV23: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetails' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23' - $ref: '#/components/schemas/NotificationViewedDetailsV23' - $ref: '#/components/schemas/NotificationRADDRetrievedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetailsV23' - $ref: '#/components/schemas/RequestRefusedDetailsV23' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetailsV23' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetails' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetailsV23' - $ref: '#/components/schemas/SendAnalogProgressDetailsV23' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' - $ref: '#/components/schemas/NotificationCancellationRequestDetails' - $ref: '#/components/schemas/NotificationCancelledDetails' - $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails' NotificationAttachmentDigests: description: Codici per la verifica del corretto caricamento di un allegato type: object required: - sha256 properties: sha256: type: string description: Digest "sha256" della codifica binaria dell'allegato in base64 example: jezIVxlG1M1woCSUngM6KipUN3/p8cG5RMIPnuEanlE= minLength: 44 maxLength: 44 pattern: ^[A-Za-z0-9+\/]{43}=|[A-Za-z0-9+\/]{44}$ TimelineElementV25: type: object additionalProperties: false properties: elementId: type: string maxLength: 512 description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string deprecated: true description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp) format: date-time ingestionTimestamp: type: string description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND format: date-time eventTimestamp: type: string description: Istante in cui avviene l'evento descritto in questo elemento di timeline format: date-time notificationSentAt: type: string description: Momento di ricezione della richiesta di notifica da parte di SEND format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsIdV20' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV23' details: $ref: '#/components/schemas/TimelineElementDetailsV25' FullSentNotificationV28: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV25' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatusV26' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistoryV26' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV28' TimelineElementV23: type: object additionalProperties: false properties: elementId: type: string maxLength: 512 description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string description: Momento in cui avviene l'evento descritto in questo elemento di timeline format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsId' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV23' details: $ref: '#/components/schemas/TimelineElementDetailsV23' SimpleRegisteredLetterProgressDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 notificationDate: type: string format: date-time deliveryFailureCause: type: string maxLength: 10 description: Vedi deliveryFailureCause in SendAnalogFeedbackDetails deliveryDetailCode: type: string maxLength: 20 description: Vedi deliveryDetailCode in SendAnalogFeedbackDetails attachments: type: array items: $ref: '#/components/schemas/AttachmentDetails' sendRequestId: type: string description: RequestId della richiesta d'invio maxLength: 512 registeredLetterCode: type: string description: Codice della raccomandata maxLength: 128 SentNotificationV26: description: Le informazioni riguardanti una richiesta di notifica accettata allOf: - $ref: '#/components/schemas/NewNotificationRequestV26' - type: object required: - iun - sentAt properties: senderPaId: type: string description: Identificativo (non IPA) della PA mittente che ha eseguito l'onboarding su SelfCare. pattern: ^.*$ maxLength: 256 iun: $ref: '#/components/schemas/IUN' sentAt: type: string description: Momento di ricezione della notifica da parte di PN format: date-time cancelledByIun: $ref: '#/components/schemas/IUN' documentsAvailable: type: boolean description: Indica se i documenti notificati sono ancora disponibili. usedServices: $ref: '#/components/schemas/UsedServices' TimelineElementV27: type: object additionalProperties: false properties: elementId: type: string maxLength: 512 description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string deprecated: true description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp) format: date-time ingestionTimestamp: type: string description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND format: date-time eventTimestamp: type: string description: Istante in cui avviene l'evento descritto in questo elemento di timeline format: date-time notificationSentAt: type: string description: Momento di ricezione della richiesta di notifica da parte di SEND format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsIdV20' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV27' details: $ref: '#/components/schemas/TimelineElementDetailsV27' FullSentNotificationV29: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV26' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatusV26' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistoryV26' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV28' NotificationRecipientV23: description: Informazioni sui destinatari required: - denomination - recipientType - taxId - physicalAddress type: object additionalProperties: false properties: recipientType: type: string description: 'Tipologia di destinatario: Persona Fisica (PF) o Persona Giuridica (PG)' enum: - PF - PG taxId: $ref: '#/components/schemas/TaxId' denomination: $ref: '#/components/schemas/Denomination' digitalDomicile: $ref: '#/components/schemas/NotificationDigitalAddress' physicalAddress: $ref: '#/components/schemas/NotificationPhysicalAddress' payments: $ref: '#/components/schemas/NotificationPayments' SendCourtesyMessageDetails: type: object required: - recIndex - digitalAddress - sendDate properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' sendDate: type: string description: data invio messaggio di cortesia format: date-time ioSendMessageResult: $ref: '#/components/schemas/IoSendMessageResult' ScheduleAnalogWorkflowDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 Problem: properties: type: description: URI reference of type definition type: string status: description: The HTTP status code generated by the origin server for this occurrence of the problem. type: integer format: int32 example: 503 minimum: 100 exclusiveMaximum: 600 title: description: A short, summary of the problem type. Written in english and readable example: Service Unavailable maxLength: 64 pattern: ^[ -~]{0,64}$ type: string detail: description: A human readable explanation of the problem. example: Request took too long to complete. maxLength: 4096 pattern: ^.{0,4096}$ type: string traceId: description: Internal support identifier associated to error example: 123e4567-e89b-12d3-a456-426614174000 type: string timestamp: description: date and time referred to UTC example: '2022-07-27T12:22:33.444Z' type: string format: date-time errors: type: array minItems: 1 items: $ref: '#/components/schemas/ProblemError' required: - status - errors SendDigitalDetails: type: object required: - recIndex - digitalAddress - digitalAddressSource - retryNumber properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' retryNumber: type: integer description: numero dei tentativi effettuati format: int32 FullSentNotification: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotification' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatus' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistory' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElement' NewNotificationRequestStatusResponseV24: allOf: - $ref: '#/components/schemas/NewNotificationRequestV24' - type: object required: - notificationRequestId - notificationRequestStatus properties: notificationRequestId: description: identificativo univoco di una richiesta di invio notifica, non è lo IUN type: string notificationRequestStatus: description: '- __WAITING__: in attesa di essere valutata - __ACCEPTED__: richiesta di notifica accettata, lo IUN è valorizzato - __REFUSED__: richiesta di notifica rifiutata, è valorizzato il campo _errors_' type: string retryAfter: type: integer format: int32 description: Numero di secondi da attendere prima di effettuare una nuova richiesta per la stessa entità; valorizzato quando lo status è __WAITING__. iun: $ref: '#/components/schemas/IUN' errors: description: Elenco degli errori che hanno causato il rifiuto della richiesta di notifica type: array items: $ref: '#/components/schemas/ProblemError' NotificationRefusedErrorV20: type: object properties: errorCode: type: string description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND\n - FILE_SHA_ERROR\n - TAXID_NOT_VALID\n - SERVICE_UNAVAILABLE\n - FILE_PDF_INVALID_ERROR\n - FILE_PDF_TOOBIG_ERROR\n - NOT_VALID_ADDRESS\n - RECIPIENT_ID_NOT_VALID\n - F24_METADATA_NOT_VALID\n - PAYMENT_NOT_VALID\n ..." detail: type: string AarCreationRequestDetails: type: object required: - recIndex - aarKey - numberOfPages properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 aarKey: type: string description: Chiave per recupero da safe-storage del documento aar maxLength: 128 numberOfPages: type: integer description: numero di pagine del PDF generato format: int32 SendAnalogDetails: type: object required: - recIndex - physicalAddress - serviceLevel - sentAttemptMade properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' serviceLevel: $ref: '#/components/schemas/ServiceLevel' sentAttemptMade: type: integer description: numero dei tentativi effettuati format: int32 relatedRequestId: type: string description: Id relativo alla eventuale precedente richiesta di invio cartaceo maxLength: 512 productType: type: string maxLength: 10 description: "Tipo di invio cartaceo effettivamente inviato\n - __AR__: Raccomandata nazionale Andata e Ritorno\n - __890__: Recapito a norma della legge 890/1982\n - __RIR__: Raccomandata internazionale Andata e Ritorno\n" analogCost: type: integer description: costo in eurocent dell'invio format: int32 numberOfPages: type: integer description: numero delle pagina che compongono la spedizione cartacea format: int32 envelopeWeight: type: integer description: peso in grammi della busta format: int32 prepareRequestId: type: string description: request id della relativa richiesta di prepare maxLength: 512 SendAnalogProgressDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 notificationDate: type: string format: date-time deliveryFailureCause: type: string description: Vedi deliveryFailureCause in SendAnalogFeedbackDetails deliveryDetailCode: type: string description: Vedi deliveryDetailCode in SendAnalogFeedbackDetails attachments: type: array items: $ref: '#/components/schemas/AttachmentDetails' sendRequestId: type: string description: RequestId della richiesta d'invio registeredLetterCode: type: string description: Codice della raccomandata UsedServices: description: Servizi utilizzati per la creazione della notifica type: object properties: physicalAddressLookup: type: boolean CompletelyUnreachableCreationRequestDetailsV28: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 legalFactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione endWorkflowStatus: $ref: '#/components/schemas/EndWorkflowStatus' completionWorkflowDate: type: string description: Data chiusura workflow format: date-time PrepareAnalogDomicileFailureDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 foundAddress: $ref: '#/components/schemas/PhysicalAddress' failureCause: type: string maxLength: 10 description: "__Motivazione fallimento prepare\n - __D00__ Indirizzo non trovato\n - __D01__ Indirizzo non valido\n - __D02__ Indirizzo coincidente con quello del primo tentativo\n" prepareRequestId: type: string description: RequestId della richiesta di prepare maxLength: 512 PagoPaPayment: title: Informazioni per effettuare il pagamento con sistema pagoPA description: "Informazioni utili per effettuare il pagamento di una notifica, sono associate al destinatario perché le spese di notifica possono differire a seconda del canale di notifica utilizzato.
\n - _noticeCode_: \"codice avviso pagoPA\" di pagamento del sistema pagoPA, usato per pagamento online.
\n - _creditorTaxId_: codice fiscale dell'ente a cui fa riferimento il \"codice avviso pagoPA\".
\n - _applyCost_: flag per indicare se l'avviso pagoPA deve contenere i costi di notifica.
\n - _pagoPaForm_: riferimento al PDF contenete il bollettino pagoPA
" type: object required: - noticeCode - creditorTaxId - applyCost properties: noticeCode: $ref: '#/components/schemas/noticeCode' creditorTaxId: $ref: '#/components/schemas/paTaxId' applyCost: type: boolean description: Flag per indicare se l'avviso pagoPa deve contenere i costi di notifica attachment: $ref: '#/components/schemas/NotificationPaymentAttachment' PublicRegistryValidationResponseDetails: allOf: - $ref: '#/components/schemas/PublicRegistryResponseDetails' - type: object properties: registry: type: string description: "Rappresenta il registro consultato per ottenere l'indirizzo. Può assumere i seguenti valori:\n - ANPR\n - REGISTRO_IMPRESE\n" maxLength: 128 NotificationRecipientV21: description: Informazioni sui destinatari required: - denomination - recipientType - taxId - physicalAddress type: object additionalProperties: false properties: recipientType: type: string description: 'Tipologia di destinatario: Persona Fisica (PF) o Persona Giuridica (PG)' enum: - PF - PG taxId: $ref: '#/components/schemas/TaxId' denomination: $ref: '#/components/schemas/Denomination' digitalDomicile: $ref: '#/components/schemas/NotificationDigitalAddress' physicalAddress: $ref: '#/components/schemas/NotificationPhysicalAddress' payments: $ref: '#/components/schemas/NotificationPayments' NotificationDocument: description: Un documento da notificare allOf: - $ref: '#/components/schemas/NotificationAttachment' - type: object properties: title: type: string description: Titolo del documento allegato. Stringa alfanumerica con caratteri utilizzabili in un nome file. minLength: 1 maxLength: 512 pattern: ^.*$ docIdx: type: string description: Indice del documento partendo da 0. maxLength: 3 pattern: ^\d+$ ScheduleAnalogWorkflowDetailsV23: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 schedulingDate: type: string description: Data prevista per l'inizio dell'invio analogico format: date-time NotificationViewedCreationRequestDetailsV23: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 legalfactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione eventTimestamp: type: string description: Data ricezione richiesta visualizzazione notifica format: date-time raddType: $ref: '#/components/schemas/RaddTypeV23' raddTransactionId: $ref: '#/components/schemas/RaddTransactionId' delegateInfo: $ref: '#/components/schemas/DelegateInfo' NotificationPaymentItem: minProperties: 1 additionalProperties: false properties: pagoPa: $ref: '#/components/schemas/PagoPaPayment' f24: $ref: '#/components/schemas/F24Payment' NotificationRequestAcceptedDetailsV28: type: object properties: notificationRequestId: type: string description: identificativo univoco di una richiesta di invio notifica, non è lo IUN paProtocolNumber: type: string description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche. pattern: ^.*$ maxLength: 256 idempotenceToken: type: string description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo. pattern: ^[ -~]*$ maxLength: 256 RequestRefusedDetailsV27: type: object properties: refusalReasons: type: array description: Motivazioni che hanno portato al rifiuto della notifica items: $ref: '#/components/schemas/NotificationRefusedErrorV27' notificationRequestId: type: string description: identificativo univoco di una richiesta di invio notifica, non è lo IUN paProtocolNumber: type: string description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche. pattern: ^.*$ maxLength: 256 idempotenceToken: type: string description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo. pattern: ^[ -~]*$ maxLength: 256 CompletelyUnreachableDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 legalFactGenerationDate: type: string description: Data generazione atto opponibile a terzi allegato format: date-time LegalFactsId: description: Chiavi dei documenti generati durante il processo di consegna cartacea type: object required: - key - category properties: key: description: Chiave dell'atto opponibile a terzi generato durante il processo di consegna type: string pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$ maxLength: 512 category: $ref: '#/components/schemas/LegalFactCategory' ServiceLevel: type: string description: Livello Servizio enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 NotificationAttachment: description: Un allegato della notifica. type: object required: - digests - contentType - ref properties: digests: $ref: '#/components/schemas/NotificationAttachmentDigests' contentType: type: string description: tipo di contenuto dell'allegato, supportato application/pdf minLength: 15 maxLength: 15 pattern: ^application\/pdf$ ref: $ref: '#/components/schemas/NotificationAttachmentBodyRef' TimelineElementV28: type: object additionalProperties: false properties: elementId: type: string maxLength: 512 description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string deprecated: true description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp) format: date-time ingestionTimestamp: type: string description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND format: date-time eventTimestamp: type: string description: Istante in cui avviene l'evento descritto in questo elemento di timeline format: date-time notificationSentAt: type: string description: Momento di ricezione della richiesta di notifica da parte di SEND format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsIdV20' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV28' details: $ref: '#/components/schemas/TimelineElementDetailsV28' TimelineElementCategory: type: string description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Ricezione da parte della Pubblica Amministrazione di un evento di chiusura di una o più posizioni debitorie di tipo PagoPA. La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n" enum: - SENDER_ACK_CREATION_REQUEST - VALIDATE_NORMALIZE_ADDRESSES_REQUEST - NORMALIZED_ADDRESS - REQUEST_ACCEPTED - SEND_COURTESY_MESSAGE - GET_ADDRESS - PUBLIC_REGISTRY_CALL - PUBLIC_REGISTRY_RESPONSE - SCHEDULE_ANALOG_WORKFLOW - SCHEDULE_DIGITAL_WORKFLOW - PREPARE_DIGITAL_DOMICILE - SEND_DIGITAL_DOMICILE - SEND_DIGITAL_PROGRESS - SEND_DIGITAL_FEEDBACK - REFINEMENT - SCHEDULE_REFINEMENT - DIGITAL_DELIVERY_CREATION_REQUEST - DIGITAL_SUCCESS_WORKFLOW - DIGITAL_FAILURE_WORKFLOW - ANALOG_SUCCESS_WORKFLOW - ANALOG_FAILURE_WORKFLOW - PREPARE_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER_PROGRESS - NOTIFICATION_VIEWED_CREATION_REQUEST - NOTIFICATION_VIEWED - PREPARE_ANALOG_DOMICILE - SEND_ANALOG_DOMICILE - SEND_ANALOG_PROGRESS - SEND_ANALOG_FEEDBACK - PAYMENT - COMPLETELY_UNREACHABLE - COMPLETELY_UNREACHABLE_CREATION_REQUEST - REQUEST_REFUSED - AAR_CREATION_REQUEST - AAR_GENERATION - NOT_HANDLED - PROBABLE_SCHEDULING_ANALOG_DATE TimelineElementId: type: string F24Payment: title: Informazioni per effettuare il pagamento tramite modello F24 description: "Informazioni utili per effettuare il pagamento di una notifica, sono associate al destinatario perché le spese di notifica possono differire a seconda del canale di notifica utilizzato.
\n - _title_: titolo del documento pdf da mostrare all'utente .
\n - _applyCost_: flag per indicare se il modello F24 deve contenere i costi di notifica.
\n - _metadataAttachment_: riferimento ai metadati per la generazione del modello F24.
" type: object required: - title - applyCost - metadataAttachment properties: title: description: Titolo del documento pdf da mostrare all'utente type: string applyCost: type: boolean description: Flag per indicare se il modello F24 deve contere i costi di notifica metadataAttachment: $ref: '#/components/schemas/NotificationMetadataAttachment' NewNotificationRequestV24: description: I campi utilizzati per la creazione di una nuova Notifica. type: object required: - paProtocolNumber - subject - recipients - documents - physicalCommunicationType - notificationFeePolicy - senderDenomination - senderTaxId - taxonomyCode properties: idempotenceToken: description: Identificativo utilizzabile dal chiamante per disambiguare differenti "richieste di notificazione" effettuate con lo stesso numero di protocollo (campo _paProtocolNumber_). Questo può essere necessario in caso di "richiesta di notifica" rifiutata per errori nei codici di verifica degli allegati. type: string pattern: ^[ -~]*$ maxLength: 256 paProtocolNumber: description: Numero di protocollo che la PA mittente assegna alla notifica stessa type: string pattern: ^.*$ maxLength: 256 subject: type: string description: titolo della notifica maxLength: 134 pattern: ^.*$ abstract: type: string description: descrizione sintetica della notifica pattern: ^.*$ maxLength: 1024 recipients: type: array description: Informazioni sui destinatari items: $ref: '#/components/schemas/NotificationRecipientV23' minItems: 1 documents: type: array description: Documenti notificati items: $ref: '#/components/schemas/NotificationDocument' minItems: 1 notificationFeePolicy: $ref: '#/components/schemas/NotificationFeePolicy' cancelledIun: $ref: '#/components/schemas/IUN' physicalCommunicationType: type: string description: Tipologia comunicazione fisica enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 senderDenomination: $ref: '#/components/schemas/Denomination' senderTaxId: description: Sender PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ group: type: string description: Gruppo di utenti dell'ente mittente che può visualizzare la notifica pattern: ^[ -~]*$ maxLength: 1024 amount: type: integer format: int32 description: Importo della notifica in eurocent paymentExpirationDate: type: string minLength: 10 maxLength: 10 pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ description: Data di scadenza del pagamento nel formato YYYY-MM-DD riferito all'Italia taxonomyCode: type: string minLength: 7 maxLength: 7 pattern: ^([0-9]{6}[A-Z]{1})$ description: Codice tassonomico della notifica basato sulla definizione presente nell'allegato 2 capitolo C del bando [__AVVISO PUBBLICO MISURA 1.4.5 PIATTAFORMA NOTIFICHE DIGITALI__](https://pnrrcomuni.fondazioneifel.it/bandi_public/Bando/325) paFee: $ref: '#/components/schemas/PaFeeV23' vat: $ref: '#/components/schemas/VatV23' pagoPaIntMode: type: string description: 'Modalitá di integrazione pagoPA per l''attualizzazione del costo della notifica.
- _NONE_: nessuna attualizzazione.
- _SYNC_: modalitá sincrona.
- _ASYNC_: modalitá asincrona.
' enum: - NONE - SYNC - ASYNC additionalLanguages: description: 'In questo campo è possibile definire la lingua addizionale (oltre a quella italiana) da utilizzare per la generazione documenti, atti opponibili a terzi ecc.
Le lingue accettate e dunque i valori possibili degli item dell''array sono:
- DE
- SI
- FR
DE (tedesco), SI (sloveno), FR (francese) Attualmente è possibile indicare un solo item e dunque una sola lingua aggiuntiva. Se non vengono indicate lingue aggiuntive la lingua utilizzata per generare
documenti, atti opponibili a terzi ecc. sarà quella italiana.' type: array maxItems: 1 items: type: string SentNotification: description: Le informazioni riguardanti una richiesta di notifica accettata allOf: - $ref: '#/components/schemas/NewNotificationRequest' - type: object required: - iun - sentAt properties: senderPaId: type: string description: Identificativo (non IPA) della PA mittente che ha eseguito l'onboarding su SelfCare. pattern: ^.*$ maxLength: 256 iun: $ref: '#/components/schemas/IUN' sentAt: type: string description: Momento di ricezione della notifica da parte di PN format: date-time cancelledByIun: $ref: '#/components/schemas/IUN' documentsAvailable: type: boolean description: Indica se i documenti notificati sono ancora disponibili. TimelineElementCategoryV20: type: string description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Ricezione da parte della Pubblica Amministrazione di un evento di chiusura di una o più posizioni debitorie di tipo PagoPA. La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n" enum: - SENDER_ACK_CREATION_REQUEST - VALIDATE_NORMALIZE_ADDRESSES_REQUEST - NORMALIZED_ADDRESS - REQUEST_ACCEPTED - SEND_COURTESY_MESSAGE - GET_ADDRESS - PUBLIC_REGISTRY_CALL - PUBLIC_REGISTRY_RESPONSE - SCHEDULE_ANALOG_WORKFLOW - SCHEDULE_DIGITAL_WORKFLOW - PREPARE_DIGITAL_DOMICILE - SEND_DIGITAL_DOMICILE - SEND_DIGITAL_PROGRESS - SEND_DIGITAL_FEEDBACK - REFINEMENT - SCHEDULE_REFINEMENT - DIGITAL_DELIVERY_CREATION_REQUEST - DIGITAL_SUCCESS_WORKFLOW - DIGITAL_FAILURE_WORKFLOW - ANALOG_SUCCESS_WORKFLOW - ANALOG_FAILURE_WORKFLOW - PREPARE_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER_PROGRESS - NOTIFICATION_VIEWED_CREATION_REQUEST - NOTIFICATION_VIEWED - PREPARE_ANALOG_DOMICILE - SEND_ANALOG_DOMICILE - SEND_ANALOG_PROGRESS - SEND_ANALOG_FEEDBACK - PAYMENT - COMPLETELY_UNREACHABLE - COMPLETELY_UNREACHABLE_CREATION_REQUEST - REQUEST_REFUSED - AAR_CREATION_REQUEST - AAR_GENERATION - NOT_HANDLED - PROBABLE_SCHEDULING_ANALOG_DATE - NOTIFICATION_CANCELLATION_REQUEST - NOTIFICATION_CANCELLED - PREPARE_ANALOG_DOMICILE_FAILURE SentNotificationV25: description: Le informazioni riguardanti una richiesta di notifica accettata allOf: - $ref: '#/components/schemas/NewNotificationRequestV25' - type: object required: - iun - sentAt properties: senderPaId: type: string description: Identificativo (non IPA) della PA mittente che ha eseguito l'onboarding su SelfCare. pattern: ^.*$ maxLength: 256 iun: $ref: '#/components/schemas/IUN' sentAt: type: string description: Momento di ricezione della notifica da parte di PN format: date-time cancelledByIun: $ref: '#/components/schemas/IUN' documentsAvailable: type: boolean description: Indica se i documenti notificati sono ancora disponibili. usedServices: $ref: '#/components/schemas/UsedServices' DigitalDeliveryCreationRequestDetailsV28: type: object required: - recIndex - digitalAddress properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' endWorkflowStatus: $ref: '#/components/schemas/EndWorkflowStatus' completionWorkflowDate: type: string description: Data chiusura workflow format: date-time legalFactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione NotificationViewedCreationRequestDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 legalfactId: type: string description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione eventTimestamp: type: string description: Data ricezione richiesta visualizzazione notifica format: date-time raddType: $ref: '#/components/schemas/RaddType' raddTransactionId: $ref: '#/components/schemas/RaddTransactionId' delegateInfo: $ref: '#/components/schemas/DelegateInfo' TimelineElementDetailsV27: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetailsV27' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23' - $ref: '#/components/schemas/NotificationViewedDetailsV23' - $ref: '#/components/schemas/NotificationRADDRetrievedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetailsV23' - $ref: '#/components/schemas/RequestRefusedDetailsV27' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetailsV23' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetailsV23' - $ref: '#/components/schemas/SendAnalogProgressDetailsV23' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' - $ref: '#/components/schemas/NotificationCancellationRequestDetails' - $ref: '#/components/schemas/NotificationCancelledDetails' - $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails' - $ref: '#/components/schemas/AnalogWorkflowRecipientDeceasedDetailsV26' - $ref: '#/components/schemas/PublicRegistryValidationCallDetails' - $ref: '#/components/schemas/PublicRegistryValidationResponseDetails' FullSentNotificationV24: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV23' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatus' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistory' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV24' DelegateInfo: type: object properties: internalId: type: string maxLength: 128 taxId: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string maxLength: 128 operatorUuid: type: string maxLength: 128 mandateId: type: string maxLength: 128 denomination: x-field-extra-annotation: '@lombok.ToString.Exclude' type: string maxLength: 128 delegateType: $ref: '#/components/schemas/RecipientType' NotificationDigitalAddress: description: Indirizzo di invio della notifica required: - address - type type: object properties: type: type: string description: tipo di indirizzo PEC, REM, SERCQ, ... enum: - PEC address: type: string example: account@domain.it description: Indirizzo PEC o REM che il mittente della notifica intende utilizzare per raggiungere il destinatario. pattern: ^(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$ maxLength: 320 NotificationStatus: type: string description: "stato di avanzamento del processo di notifica:\n * `IN_VALIDATION` - notifica depositata in attesa di validazione\n * `ACCEPTED` - L'ente ha depositato la notifica con successo\n * `REFUSED` - Notifica rifiutata a seguito della validazione\n * `DELIVERING` - L'invio della notifica è in corso\n * `DELIVERED` - La notifica è stata consegnata a tutti i destinatari\n * `VIEWED` - Il destinatario ha letto la notifica entro il termine stabilito\n * `EFFECTIVE_DATE` - Il destinatario non ha letto la notifica entro il termine stabilito\n * `UNREACHABLE` - Il destinatario non è reperibile\n * `CANCELLED` - L'ente ha annullato l'invio della notifica\n * `PAID` - [DEPRECATO] Uno dei destinatari ha pagato la notifica\n" enum: - IN_VALIDATION - ACCEPTED - REFUSED - DELIVERING - DELIVERED - VIEWED - EFFECTIVE_DATE - PAID - UNREACHABLE - CANCELLED NotificationFeePolicy: type: string description: 'Politica di addebitamento dei costi di notifica.
- _FLAT_RATE_: costo forfettario fisso. In questa modalità SEND non gestisce il costo della notifica per il destinatario.
- _DELIVERY_MODE_: costo calcolato in base all''effettivo percorso di notifica.
' enum: - FLAT_RATE - DELIVERY_MODE NewNotificationRequestV26: description: I campi utilizzati per la creazione di una nuova Notifica. type: object required: - paProtocolNumber - subject - recipients - documents - physicalCommunicationType - notificationFeePolicy - senderDenomination - senderTaxId - taxonomyCode properties: idempotenceToken: description: Identificativo utilizzabile dal chiamante per disambiguare differenti "richieste di notificazione" effettuate con lo stesso numero di protocollo (campo _paProtocolNumber_). Questo può essere necessario in caso di "richiesta di notifica" rifiutata per errori nei codici di verifica degli allegati. type: string pattern: ^[ -~]*$ maxLength: 256 paProtocolNumber: description: Numero di protocollo che la PA mittente assegna alla notifica stessa type: string pattern: ^.*$ maxLength: 256 subject: type: string description: titolo della notifica, NON inserire dati personali/sensibili maxLength: 134 pattern: ^.*$ abstract: type: string description: descrizione sintetica della notifica, NON inserire dati personali/sensibili pattern: ^.*$ maxLength: 1024 recipients: type: array description: Informazioni sui destinatari items: $ref: '#/components/schemas/NotificationRecipientV24' minItems: 1 documents: type: array description: Documenti notificati items: $ref: '#/components/schemas/NotificationDocument' minItems: 1 notificationFeePolicy: $ref: '#/components/schemas/NotificationFeePolicy' cancelledIun: $ref: '#/components/schemas/IUN' physicalCommunicationType: type: string description: Tipologia comunicazione fisica enum: - AR_REGISTERED_LETTER - REGISTERED_LETTER_890 senderDenomination: $ref: '#/components/schemas/Denomination' senderTaxId: description: Sender PA fiscal code example: '77777777777' type: string maxLength: 11 minLength: 11 pattern: ^\d+$ group: type: string description: Gruppo di utenti dell'ente mittente che può visualizzare la notifica pattern: ^[ -~]*$ maxLength: 1024 amount: type: integer format: int32 description: Importo della notifica in eurocent paymentExpirationDate: type: string minLength: 10 maxLength: 10 pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ description: Data di scadenza del pagamento nel formato YYYY-MM-DD riferito all'Italia taxonomyCode: type: string minLength: 7 maxLength: 7 pattern: ^([0-9]{6}[A-Z]{1})$ description: Codice tassonomico della notifica basato sulla definizione presente nell'allegato 2 capitolo C del bando [__AVVISO PUBBLICO MISURA 1.4.5 PIATTAFORMA NOTIFICHE DIGITALI__](https://pnrrcomuni.fondazioneifel.it/bandi_public/Bando/325) paFee: $ref: '#/components/schemas/PaFeeV23' vat: $ref: '#/components/schemas/VatV23' pagoPaIntMode: type: string description: 'Modalitá di integrazione pagoPA per l''attualizazione del costo della notifica.
- _NONE_: nessuna attualizzazione.
- _SYNC_: modalitá sincrona.
- _ASYNC_: modalitá asincrona.
' enum: - NONE - SYNC - ASYNC additionalLanguages: description: 'In questo campo è possibile definire la lingua addizionale (oltre a quella italiana) da utilizzare per la generazione documenti, atti opponibili a terzi ecc.
Le lingue accettate e dunque i valori possibili degli item dell''array sono:
- DE
- SI
- FR
DE (tedesco), SI (sloveno), FR (francese) Attualmente è possibile indicare un solo item e dunque una sola lingua aggiuntiva. Se non vengono indicate lingue aggiuntive la lingua utilizzata per generare
documenti, atti opponibili a terzi ecc. sarà quella italiana.' type: array maxItems: 1 items: type: string physicalCommunicationPriority: type: integer format: int32 description: Priorità del primo tentativo di recapito quando è attiva la funzionalità di gestione dei picchi, dove 100 rappresenta la priorità massima e 0 la minima. Regola l'ordine di affido delle spedizioni all'interno della sola quota mittente, dando precedenza a quelle più urgenti senza impattare sulle quote degli altri enti. minimum: 0 maximum: 100 default: 0 example: 0 TimelineElementCategoryV26: type: string description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n * `ANALOG_WORKFLOW_RECIPIENT_DECEASED` - Destinatario deceduto\n" enum: - SENDER_ACK_CREATION_REQUEST - VALIDATE_NORMALIZE_ADDRESSES_REQUEST - NORMALIZED_ADDRESS - REQUEST_ACCEPTED - SEND_COURTESY_MESSAGE - GET_ADDRESS - PUBLIC_REGISTRY_CALL - PUBLIC_REGISTRY_RESPONSE - SCHEDULE_ANALOG_WORKFLOW - SCHEDULE_DIGITAL_WORKFLOW - PREPARE_DIGITAL_DOMICILE - SEND_DIGITAL_DOMICILE - SEND_DIGITAL_PROGRESS - SEND_DIGITAL_FEEDBACK - REFINEMENT - SCHEDULE_REFINEMENT - DIGITAL_DELIVERY_CREATION_REQUEST - DIGITAL_SUCCESS_WORKFLOW - DIGITAL_FAILURE_WORKFLOW - ANALOG_SUCCESS_WORKFLOW - ANALOG_FAILURE_WORKFLOW - PREPARE_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER_PROGRESS - NOTIFICATION_VIEWED_CREATION_REQUEST - NOTIFICATION_VIEWED - PREPARE_ANALOG_DOMICILE - SEND_ANALOG_DOMICILE - SEND_ANALOG_PROGRESS - SEND_ANALOG_FEEDBACK - PAYMENT - COMPLETELY_UNREACHABLE - COMPLETELY_UNREACHABLE_CREATION_REQUEST - REQUEST_REFUSED - AAR_CREATION_REQUEST - AAR_GENERATION - NOT_HANDLED - PROBABLE_SCHEDULING_ANALOG_DATE - NOTIFICATION_CANCELLATION_REQUEST - NOTIFICATION_CANCELLED - PREPARE_ANALOG_DOMICILE_FAILURE - NOTIFICATION_RADD_RETRIEVED - ANALOG_WORKFLOW_RECIPIENT_DECEASED NotificationPhysicalAddress: description: Indirizzo fisico type: object required: - address - municipality properties: at: type: string description: Campo "presso" dell'indirizzo pattern: ^.*$ maxLength: 44 address: type: string description: Indirizzo del domicilio fisico pattern: ^.*$ minLength: 2 maxLength: 1024 addressDetails: type: string description: Seconda riga dell'indirizzo fisico pattern: ^.*$ maxLength: 1024 zip: type: string description: Codice di avviamento postale. In caso di invio estero diventa facoltativo minLength: 0 maxLength: 15 pattern: ^(\w|\ |\-)*$ municipality: type: string description: Comune pattern: ^.*$ minLength: 2 maxLength: 256 municipalityDetails: type: string description: Frazione o località pattern: ^.*$ maxLength: 256 province: type: string description: Provincia pattern: ^.*$ maxLength: 256 foreignState: type: string description: Denominazione paese estero pattern: ^.*$ maxLength: 256 ContactPhase: type: string description: Fase in cui è avvenuta la richiesta enum: - CHOOSE_DELIVERY - SEND_ATTEMPT NotificationStatusHistoryElementV26: description: elenco degli avanzamenti effettuati dal processo di notifica type: object required: - status - activeFrom - relatedTimelineElements properties: status: $ref: '#/components/schemas/NotificationStatusV26' activeFrom: type: string description: data e ora di raggiungimento dello stato di avanzamento format: date-time relatedTimelineElements: type: array description: Eventi avvenuti nello stato items: $ref: '#/components/schemas/TimelineElementId' FullSentNotificationV23: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV23' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatus' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistory' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV23' NotificationAttachmentBodyRef: description: Riferimento all'allegato precaricato required: - key - versionToken type: object properties: key: type: string description: Chiave in cui è stato salvato l'allegato maxLength: 512 pattern: ^(safestorage:\/\/)?[A-Za-z0-9._-]+$ versionToken: type: string description: Token per recuperare l'esatta istanza dell'allegato, che dovrà coincidere con l'__x-amz-version-id__ ottenuto nell'header della response in fase di upload del documento ad esso associato. pattern: ^.*$ maxLength: 256 NotificationTimelineReworkedDetails: type: object required: - recIndex - sentAttemptMade - invalidatedTimelineAndStatusHistory properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 sentAttemptMade: type: integer description: numero dei tentativi effettuati format: int32 invalidatedTimelineAndStatusHistory: description: elenco degli avanzamenti effettuati dal processo di notifica prima dell'invalidazione type: array items: $ref: '#/components/schemas/NotificationStatusHistoryInvalidatedElement' NotificationRequestAcceptedDetails: type: object properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 TimelineElementDetailsV25: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetails' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetailsV23' - $ref: '#/components/schemas/NotificationViewedDetailsV23' - $ref: '#/components/schemas/NotificationRADDRetrievedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetailsV23' - $ref: '#/components/schemas/RequestRefusedDetailsV25' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetailsV23' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetailsV23' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetailsV25' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetailsV23' - $ref: '#/components/schemas/SendAnalogProgressDetailsV23' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' - $ref: '#/components/schemas/NotificationCancellationRequestDetails' - $ref: '#/components/schemas/NotificationCancelledDetails' - $ref: '#/components/schemas/PrepareAnalogDomicileFailureDetails' FullSentNotificationV27: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV25' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatusV26' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistoryV26' timeline: description: elenco dettagliato di tutto ciò che è accaduto durrante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV27' ScheduleRefinementDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 schedulingDate: type: string format: date-time NotificationPaymentAttachment: description: Un modulo di pagamento allegato alla notifica allOf: - $ref: '#/components/schemas/NotificationAttachment' NotificationRefusedErrorV23: type: object properties: errorCode: type: string maxLength: 128 description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND\n - FILE_SHA_ERROR\n - TAXID_NOT_VALID\n - SERVICE_UNAVAILABLE\n - FILE_PDF_INVALID_ERROR\n - FILE_PDF_TOOBIG_ERROR\n - NOT_VALID_ADDRESS\n - RECIPIENT_ID_NOT_VALID\n - F24_METADATA_NOT_VALID\n - PAYMENT_NOT_VALID\n ..." detail: type: string maxLength: 2048 TimelineElementCategoryV27: type: string description: "stato di avanzamento del processo di notifica:`\n * `SENDER_ACK_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa in carico per il mittente a safe storage\n * `VALIDATE_NORMALIZE_ADDRESSES_REQUEST` - Invio della richiesta di validazione e normalizzazione indirizzi fisici presenti nella richiesta di notifica\n * `NORMALIZED_ADDRESS` - Salvataggio indirizzi normalizzati\n * `REQUEST_ACCEPTED` - Richiesta di notifica accettata a seguito dei controlli di validazione\n * `REQUEST_REFUSED` - Richiesta di notifica rifiutata per fallimento di validazione\n * `SEND_COURTESY_MESSAGE` - Invio di un messaggio di cortesia\n * `GET_ADDRESS` - Disponibilità dell’indirizzo specifico (domicilio digitale di piattaforma, domicilio digitale speciale, domicilio digitale generale, indirizzo fisico sulla notifica o sui registri nazionali)\n * `PUBLIC_REGISTRY_CALL` - Richiesta ai registri pubblici per ottenere domicilio digitale generale o per ottenere indirizzo fisico da ANPR, da registro della imprese, da anagrafe tributaria.\n * `PUBLIC_REGISTRY_RESPONSE` - Ricevuta la risposta dei registri pubblici\n * `SCHEDULE_ANALOG_WORKFLOW` - Pianificazione del workflow per invio cartaceo\n * `SCHEDULE_DIGITAL_WORKFLOW` -Pianificazione del workflow per invio digitale (PEC) del secondo tentativo in caso di fallimento del primo.\n * `PREPARE_DIGITAL_DOMICILE` - Preparazione per l’invio dell’avviso digitale.Va a valutare la timeline per capire quale sarà il prossimo indirizzo da usare.\n * `SEND_DIGITAL_DOMICILE` - Invio digitale dell’avviso di notifica\n * `SEND_DIGITAL_PROGRESS` - Tentativo di Invio PEC ad un determinato indirizzo.\n * `SEND_DIGITAL_FEEDBACK` - Ottenuto esito ad un invio digitale\n * `SCHEDULE_REFINEMENT` - Pianificato il perfezionamento per decorrenza termini\n * `REFINEMENT` - Perfezionamento per decorrenza termini\n * `DIGITAL_DELIVERY_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di chiusura del workflow digitale a safe storage\n * `DIGITAL_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio digitale\n * `DIGITAL_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti.\n * `ANALOG_SUCCESS_WORKFLOW` - Completato con successo il workflow di invio cartaceo\n * `ANALOG_FAILURE_WORKFLOW` - Completato con fallimento il workflow di invio cartaceo NOTA: se per tutti i destinatari si conclude il workflow con fallimento verrà scatenato l’evento COMPLETELY_UNREACHABLE\n * `PREPARE_SIMPLE_REGISTERED_LETTER` - Invio richiesta di prepare (preparazione ad invio) raccomandata semplice a paperChannel\n * `SEND_SIMPLE_REGISTERED_LETTER` - Invio di raccomandata semplice\n * `SEND_SIMPLE_REGISTERED_LETTER_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea semplice\n * `NOTIFICATION_VIEWED_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto opponibile a terzi di presa visione a safe storage\n * `NOTIFICATION_VIEWED` - Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)\n * `PREPARE_ANALOG_DOMICILE` - Invio richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `SEND_ANALOG_DOMICILE` - Invio cartaceo dell’avviso di notifica\n * `SEND_ANALOG_PROGRESS` - Ricezione informazioni intermedia relative ad una notificazione cartacea\n * `SEND_ANALOG_FEEDBACK` - Ricezione esito dell'invio cartaceo\n * `COMPLETELY_UNREACHABLE_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'atto (simile a opponibile a terzi) di completamento con fallimento del workflow di invio cartaceo\n * `COMPLETELY_UNREACHABLE` - Tutti i destinatari risultano irraggiungibili\n * `AAR_CREATION_REQUEST` - Invio della richiesta di creazione, firma e marca dell'AAR (Avviso di Avvenuta Ricezione) a safe storage\n * `AAR_GENERATION` - Generazione dell’AAR (Avviso di Avvenuta Ricezione)\n * `PAYMENT` - Evento di ricezione __dal mittente__ dell'informazione di chiusura di uno o più pagamenti di tipo pagoPA (vedi #/components/schemas/PagoPaPayment). La presenza di questo evento inibisce l'invio di eventuali comunicazioni analogiche future ma non perfeziona la notifica.\n * `NOT_HANDLED` - [DEPRECATO] Per la sperimentazione l'invio analogico non è previsto, viene inserito tale elemento di timeline\n * `PROBABLE_SCHEDULING_ANALOG_DATE` - Data probabile di inizio del flusso analogico\n * `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica\n * `NOTIFICATION_CANCELLED` - Notifica annullata\n * `PREPARE_ANALOG_DOMICILE_FAILURE` - Fallimento della richiesta di prepare (preparazione ad invio) cartaceo a paperChannel\n * `NOTIFICATION_RADD_RETRIEVED` - Accesso alla notifica tramite la rete RADD. Non perfeziona la notifica.\n * `ANALOG_WORKFLOW_RECIPIENT_DECEASED` - Destinatario deceduto\n * `PUBLIC_REGISTRY_VALIDATION_CALL` - Ricerca dell'indirizzo di spedizione in fase di validazione notifica\n * `PUBLIC_REGISTRY_VALIDATION_RESPONSE` - Recupero dell'indirizzo di spedizione dai registri nazionali\n" enum: - SENDER_ACK_CREATION_REQUEST - VALIDATE_NORMALIZE_ADDRESSES_REQUEST - NORMALIZED_ADDRESS - REQUEST_ACCEPTED - SEND_COURTESY_MESSAGE - GET_ADDRESS - PUBLIC_REGISTRY_CALL - PUBLIC_REGISTRY_RESPONSE - SCHEDULE_ANALOG_WORKFLOW - SCHEDULE_DIGITAL_WORKFLOW - PREPARE_DIGITAL_DOMICILE - SEND_DIGITAL_DOMICILE - SEND_DIGITAL_PROGRESS - SEND_DIGITAL_FEEDBACK - REFINEMENT - SCHEDULE_REFINEMENT - DIGITAL_DELIVERY_CREATION_REQUEST - DIGITAL_SUCCESS_WORKFLOW - DIGITAL_FAILURE_WORKFLOW - ANALOG_SUCCESS_WORKFLOW - ANALOG_FAILURE_WORKFLOW - PREPARE_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER - SEND_SIMPLE_REGISTERED_LETTER_PROGRESS - NOTIFICATION_VIEWED_CREATION_REQUEST - NOTIFICATION_VIEWED - PREPARE_ANALOG_DOMICILE - SEND_ANALOG_DOMICILE - SEND_ANALOG_PROGRESS - SEND_ANALOG_FEEDBACK - PAYMENT - COMPLETELY_UNREACHABLE - COMPLETELY_UNREACHABLE_CREATION_REQUEST - REQUEST_REFUSED - AAR_CREATION_REQUEST - AAR_GENERATION - NOT_HANDLED - PROBABLE_SCHEDULING_ANALOG_DATE - NOTIFICATION_CANCELLATION_REQUEST - NOTIFICATION_CANCELLED - PREPARE_ANALOG_DOMICILE_FAILURE - NOTIFICATION_RADD_RETRIEVED - ANALOG_WORKFLOW_RECIPIENT_DECEASED - PUBLIC_REGISTRY_VALIDATION_CALL - PUBLIC_REGISTRY_VALIDATION_RESPONSE RequestRefusedDetailsV20: type: object properties: refusalReasons: type: array description: Motivazioni che hanno portato al rifiuto della notifica items: $ref: '#/components/schemas/NotificationRefusedErrorV20' NotificationPaidDetailsV23: type: object required: - recIndex - recipientType - paymentSourceChannel properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 recipientType: $ref: '#/components/schemas/RecipientType' amount: type: integer description: Importo di pagamento in eurocent format: int32 creditorTaxId: $ref: '#/components/schemas/paTaxId' noticeCode: $ref: '#/components/schemas/noticeCode' idF24: type: string description: un UUID che identifica un pagamento f24 maxLength: 512 paymentSourceChannel: type: string description: Canale sorgente della richiesta di pagamento maxLength: 512 uncertainPaymentDate: deprecated: true type: boolean description: Indica se la data di pagamento é certa eventTimestamp: type: string description: Data evento pagamento format: date-time SentNotificationV23: description: Le informazioni riguardanti una richiesta di notifica accettata allOf: - $ref: '#/components/schemas/NewNotificationRequestV23' - type: object required: - iun - sentAt properties: senderPaId: type: string description: Identificativo (non IPA) della PA mittente che ha eseguito l'onboarding su SelfCare. La risoluzione di questo è ottenibile da /ext-registry/pa/v1/activated-on-pn pattern: ^.*$ maxLength: 256 iun: $ref: '#/components/schemas/IUN' sentAt: type: string description: Momento di ricezione della notifica da parte di PN format: date-time cancelledByIun: $ref: '#/components/schemas/IUN' documentsAvailable: type: boolean description: Indica se i documenti notificati sono ancora disponibili. NotificationRefusedErrorV27: type: object properties: errorCode: type: string maxLength: 128 description: "Errori di rifiuto della notifica.\n - FILE_NOTFOUND - I riferimenti dei documenti nella notifica non sono corretti o i documenti non sono stati caricati con successo.\n - FILE_GONE - Allegato non disponibile: superati i termini di conservazione\n - FILE_SHA_ERROR - Il digest calcolato con algoritmi sha256 dei documenti inseriti non è corrispondete a quello del file referenziato.\n - FILE_PDF_INVALID_ERROR - Il file inserito non è in formato pdf.\n - FILE_PDF_TOOBIG_ERROR - Il file pdf ha una dimensione eccedente il limite di 200MB.\n - F24_METADATA_NOT_VALID - I dati contenuti del file dei metadati F24 non rispettano lo schema di validazione.\n - TAXID_NOT_VALID - Codice fiscale del destinatario non corretto (non ancora implementato).\n - RECIPIENT_ID_NOT_VALID - Destinatario non Valido (utilizzato solo per funzionalità non ancora implementate)\n - NOT_VALID_ADDRESS - L'indirizzo di invio cartaceo inserito per il destinatario non ha superato i controlli di correttezza.\n - PAYMENT_NOT_VALID - I dati del pagamento non sono sono registrati sulla piattaforma GPD (modalità asincrona di integrazione pagoPA)\n - SERVICE_UNAVAILABLE - Il sistema non è attualmente disponibile.\n - ADDRESS_NOT_FOUND - La ricerca dell’indirizzo effettuata con il servizio di LookupAddress non ha prodotto risultati.\n - ADDRESS_SEARCH_FAILED - C'è stato un problema con la ricerca dell'indirizzo effettuata con il servizio di LookupAddess.\n ..." detail: type: string maxLength: 2048 recIndex: type: integer description: Index destinatario notifica digitale con errore che ha portato al rifiuto della notifica format: int32 DigitalAddressSource: type: string description: sorgente indirizzo di invio della notifica enum: - PLATFORM - SPECIAL - GENERAL SendDigitalProgressDetailsV23: type: object properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 deliveryFailureCause: description: Codice errore, opzionale type: string deliveryDetailCode: type: string description: Vedi deliveryDetailCode in SendDigitalFeedbackDetails shouldRetry: type: boolean description: indica se il progress ha dato luogo ad un ritentativo digitalAddress: $ref: '#/components/schemas/DigitalAddress' digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' notificationDate: type: string description: data notifica format: date-time sendingReceipts: type: array items: $ref: '#/components/schemas/SendingReceipt' retryNumber: type: integer description: numero dei tentativi effettuati format: int32 eventTimestamp: type: string description: Data evento format: date-time SendAnalogFeedbackDetails: type: object required: - recIndex - physicalAddress - serviceLevel - sentAttemptMade - responseStatus properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 physicalAddress: $ref: '#/components/schemas/PhysicalAddress' serviceLevel: $ref: '#/components/schemas/ServiceLevel' sentAttemptMade: type: integer description: numero dei tentativi effettuati format: int32 newAddress: $ref: '#/components/schemas/PhysicalAddress' responseStatus: $ref: '#/components/schemas/ResponseStatus' notificationDate: type: string format: date-time deliveryFailureCause: type: string maxLength: 10 description: "__Motivazione di mancata consegna__ obbligatorie negli stati di mancata consegna\n - __M01__ destinatario irreperibile\n - __M02__ destinatario deceduto\n - __M03__ destinatario sconosciuto\n - __M04__ destinatario trasferito\n - __M05__ invio rifiutato\n - __M06__ indirizzo inesatto\n - __M07__ indirizzo inesistente\n - __M08__ indirizzo insufficiente\n - __F01__ - in caso di furto\n - __F02__ - in caso di smarrimento\n - __F03__ - in caso di deterioramento\n" deliveryDetailCode: type: string maxLength: 20 description: "Formato: - __deliveryDetailCode__- [prodotto] - [statusCode] - statusDescription\n - __CON080__- [ALL] - [PROGRESS] - Stampato ed Imbustato\n - __RECRS001C__- [RS] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRS002C__- [RS] - [KO] - Mancata consegna - Fascicolo Chiuso\n - __RECRS002F__- [RS] - [KO] - Irreperibilità Assoluta - Fascicolo Chiuso\n - __RECRS003C__- [RS] - [OK] - Consegnato presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRS004C__- [RS] - [OK] - Mancata consegna presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRS005C__- [RS] - [OK] - Compiuta giacenza - Fascicolo Chiuso\n - __RECRS006__- [RS] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECRN001C__- [AR] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRN002C__- [AR] - [KO] - Mancata consegna - Fascicolo Chiuso\n - __RECRN002F__- [AR] - [KO] - Irreperibilità Assoluta - Fascicolo Chiuso\n - __RECRN003C__- [AR] - [OK] - Consegnato presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRN004C__- [AR] - [KO] - Mancata consegna presso Punti di Giacenza - Fascicolo Chiuso\n - __RECRN005C__- [AR] - [OK] - Compiuta giacenza - Fascicolo Chiuso\n - __RECRN006__- [AR] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECAG001C__- [890] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECAG002C__- [890] - [OK] - Consegnato a persona abilitata - Fascicolo Chiuso\n - __RECAG003C__- [890] - [KO] - Mancata consegna - Fascicolo Chiuso\n - __RECAG003F__- [890] - [KO] - Irreperibilità Assoluta - Fascicolo Chiuso\n - __RECAG004__- [890] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECAG005C__- [890] - [OK | PROGRESS] - Consegnato presso Punti di Giacenza - Fascicolo Chiuso\n - __RECAG006C__- [890] - [OK | PROGRESS] - Consegna a persona abilitata presso Punti di Giacenza - Fas. Ch.\n - __RECAG007C__- [890] - [KO | PROGRESS] - Mancata consegna presso Punti di Giacenza - Fascicolo Chiuso\n - __RECAG008C__- [890] - [PROGRESS] - Compiuta giacenza - Fascicolo Chiuso\n - __PNAG012__- [890] - [KO] - Distacco d'ufficio 23L - Fascicolo Chiuso\n - __RECRI003C__- [RIR] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRI004C__- [RIR] - [KO] - Non Consegnato - fascicolo Chiuso\n - __RECRI005__- [RIR] - [PROGRESS] - Furto/Smarrimento/deterioramento\n - __RECRSI003C__- [RIS] - [OK] - Consegnato - Fascicolo Chiuso\n - __RECRSI004C__- [RIS] - [KO] - Non Consegnato - fascicolo Chiuso\n - __RECRSI005__- [RIS] - [PROGRESS] - Furto/Smarrimento/deterioramento\n" attachments: type: array items: $ref: '#/components/schemas/AttachmentDetails' sendRequestId: type: string description: RequestId della richiesta d'invio maxLength: 512 registeredLetterCode: type: string description: Codice della raccomandata maxLength: 128 PublicRegistryCallDetails: type: object required: - recIndex - deliveryMode - contactPhase - sentAttemptMade - sendDate properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 deliveryMode: $ref: '#/components/schemas/DeliveryMode' contactPhase: $ref: '#/components/schemas/ContactPhase' sentAttemptMade: type: integer description: Numero di tentativi di notificazione già effettuati format: int32 sendDate: type: string description: Data invio richiesta ai public registry format: date-time TimelineElementDetails: description: The raw event payload that will be different based on the event. oneOf: - $ref: '#/components/schemas/SenderAckCreationRequestDetails' - $ref: '#/components/schemas/NormalizedAddressDetails' - $ref: '#/components/schemas/NotificationRequestAcceptedDetails' - $ref: '#/components/schemas/AnalogFailureWorkflowDetails' - $ref: '#/components/schemas/AnalogSuccessWorkflowDetails' - $ref: '#/components/schemas/CompletelyUnreachableCreationRequestDetails' - $ref: '#/components/schemas/CompletelyUnreachableDetails' - $ref: '#/components/schemas/DigitalDeliveryCreationRequestDetails' - $ref: '#/components/schemas/DigitalFailureWorkflowDetails' - $ref: '#/components/schemas/DigitalSuccessWorkflowDetails' - $ref: '#/components/schemas/GetAddressInfoDetails' - $ref: '#/components/schemas/NotificationViewedCreationRequestDetails' - $ref: '#/components/schemas/NotificationViewedDetails' - $ref: '#/components/schemas/PublicRegistryCallDetails' - $ref: '#/components/schemas/PublicRegistryResponseDetails' - $ref: '#/components/schemas/RefinementDetails' - $ref: '#/components/schemas/RequestRefusedDetails' - $ref: '#/components/schemas/ScheduleAnalogWorkflowDetails' - $ref: '#/components/schemas/ScheduleDigitalWorkflowDetails' - $ref: '#/components/schemas/ScheduleRefinementDetails' - $ref: '#/components/schemas/SendCourtesyMessageDetails' - $ref: '#/components/schemas/PrepareDigitalDetails' - $ref: '#/components/schemas/SendDigitalDetails' - $ref: '#/components/schemas/SendDigitalFeedbackDetails' - $ref: '#/components/schemas/SendDigitalProgressDetails' - $ref: '#/components/schemas/BaseAnalogDetails' - $ref: '#/components/schemas/SendAnalogDetails' - $ref: '#/components/schemas/SendAnalogFeedbackDetails' - $ref: '#/components/schemas/BaseRegisteredLetterDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterDetails' - $ref: '#/components/schemas/AarCreationRequestDetails' - $ref: '#/components/schemas/AarGenerationDetails' - $ref: '#/components/schemas/NotHandledDetails' - $ref: '#/components/schemas/NotificationPaidDetails' - $ref: '#/components/schemas/SendAnalogProgressDetails' - $ref: '#/components/schemas/SimpleRegisteredLetterProgressDetails' - $ref: '#/components/schemas/ProbableDateAnalogWorkflowDetails' TimelineElementV24: type: object additionalProperties: false properties: elementId: type: string maxLength: 512 description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string deprecated: true description: Istante in cui avviene l'evento descritto in questo elemento di timeline (deprecato, fare riferimento al campo eventTimestamp) format: date-time ingestionTimestamp: type: string description: Istante in cui l'evento descritto in questo elemento di timeline è gestito da SEND format: date-time eventTimestamp: type: string description: Istante in cui avviene l'evento descritto in questo elemento di timeline format: date-time notificationSentAt: type: string description: Momento di ricezione della richiesta di notifica da parte di SEND format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsId' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV23' details: $ref: '#/components/schemas/TimelineElementDetailsV23' NotificationMetadataAttachment: description: Un metadato allegato della notifica. type: object required: - digests - contentType - ref properties: digests: $ref: '#/components/schemas/NotificationAttachmentDigests' contentType: type: string description: tipo di contenuto dell'allegato, supportato application/json minLength: 16 maxLength: 16 pattern: ^application\/json$ ref: $ref: '#/components/schemas/NotificationAttachmentBodyRef' PaFeeV23: type: integer description: Costo espresso in eurocent sostenuto dal mittente, per l'elaborazione degli atti, provvedimenti, avvisi e comunicazioni oggetto di notifica, per il relativo deposito sulla piattaforma e per la gestione degli esiti della notifica (Decreto 30 maggio 2022 - Art. 3, comma 1, lettera a).
Obbligatoria per notifiche con notificationFeePolicy=DELIVERY_MODE
Per le notifiche effettuate con versioni precedenti alla 2.3 si assume il valore di default 100.
Esempio paFee ad 1€ -> 100
format: int32 minimum: 0 maximum: 100 CompletelyUnreachableCreationRequestDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 legalfactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione endWorkflowStatus: $ref: '#/components/schemas/EndWorkflowStatus' completionWorkflowDate: type: string description: Data chiusura workflow format: date-time TimelineElementV20: type: object additionalProperties: false properties: elementId: type: string description: 'Identificativo dell''elemento di timeline: insieme allo IUN della notifica definisce in maniera univoca l''elemento di timeline' timestamp: type: string description: Momento in cui avviene l'evento descritto in questo elemento di timeline format: date-time legalFactsIds: type: array items: $ref: '#/components/schemas/LegalFactsId' description: Chiavi dei documenti che provano l'effettivo accadimento dell'evento descritto in timeline. Questo elemento category: $ref: '#/components/schemas/TimelineElementCategoryV20' details: $ref: '#/components/schemas/TimelineElementDetailsV20' NotificationViewedCreationRequestDetailsV28: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 legalFactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione eventTimestamp: type: string description: Data ricezione richiesta visualizzazione notifica format: date-time raddType: $ref: '#/components/schemas/RaddTypeV23' raddTransactionId: $ref: '#/components/schemas/RaddTransactionId' delegateInfo: $ref: '#/components/schemas/DelegateInfo' ProbableDateAnalogWorkflowDetails: type: object required: - recIndex - schedulingAnalogDate properties: recIndex: type: integer description: Index destinatario che ha effettuato il pagamento della notifica format: int32 schedulingAnalogDate: type: string format: date-time description: Data probabile di inizio del flusso analogico PublicRegistryValidationCallDetails: type: object required: - recIndexes - deliveryMode - sendDate properties: recIndexes: description: Lista destinatari notifica type: array items: type: integer format: int32 deliveryMode: $ref: '#/components/schemas/DeliveryMode' sendDate: type: string description: Data invio richiesta ai public registry format: date-time PrepareDigitalDetails: type: object required: - recIndex - digitalAddressSource - retryNumber properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' retryNumber: type: integer description: numero dei tentativi effettuati format: int32 attemptDate: type: string description: data tentativo precedente format: date-time nextDigitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' nextSourceAttemptsMade: type: integer description: numero del prossimo tentativo da effettuare format: int32 nextLastAttemptMadeForSource: type: string description: data tentativo precedente per prossimo source format: date-time VatV23: type: integer description: IVA espressa in percentuale sui costi degli avvisi in formato cartaceo.
Obbligatoria per notifiche con notificationFeePolicy=DELIVERY_MODE.
Per le notifiche effettuate con versioni precedenti alla 2.3 si assume il valore di default 22.
Esempio vat al 22% -> 22
format: int32 minimum: 0 maximum: 100 FullSentNotificationV26: description: Le informazioni riguardanti una notifica (richiesta di notifica accettata) e il processo di inoltro della notifica verso il cittadino. allOf: - $ref: '#/components/schemas/SentNotificationV24' - type: object required: - notificationStatus - notificationStatusHistory - timeline properties: notificationStatus: $ref: '#/components/schemas/NotificationStatusV26' notificationStatusHistory: $ref: '#/components/schemas/NotificationStatusHistoryV26' timeline: description: elenco dettagliato di tutto ciò che è accaduto durante il processo di notifica type: array items: $ref: '#/components/schemas/TimelineElementV26' NotificationRecipient: description: Informazioni sui destinatari required: - denomination - recipientType - taxId - physicalAddress type: object properties: recipientType: type: string description: 'Tipologia di destinatario: Persona Fisica (PF) o Persona Giuridica (PG)' enum: - PF - PG taxId: $ref: '#/components/schemas/TaxId' denomination: $ref: '#/components/schemas/Denomination' digitalDomicile: $ref: '#/components/schemas/NotificationDigitalAddress' physicalAddress: $ref: '#/components/schemas/NotificationPhysicalAddress' payment: $ref: '#/components/schemas/NotificationPaymentInfo' AttachmentDetails: type: object properties: id: type: string maxLength: 128 documentType: type: string maxLength: 20 description: 'Codici documentType: - Plico: Indica il plico cartaceo - AR: Indica la ricevuta di ritorno - Indagine: Indica la ricevuta dell''analisi dell''indagine - 23L: Indica la ricevuta 23L ' url: type: string maxLength: 128 date: type: string format: date-time SentNotificationV21: description: Le informazioni riguardanti una richiesta di notifica accettata allOf: - $ref: '#/components/schemas/NewNotificationRequestV21' - type: object required: - iun - sentAt properties: senderPaId: type: string description: Identificativo (non IPA) della PA mittente che ha eseguito l'onboarding su SelfCare. pattern: ^.*$ maxLength: 256 iun: $ref: '#/components/schemas/IUN' sentAt: type: string description: Momento di ricezione della notifica da parte di PN format: date-time cancelledByIun: $ref: '#/components/schemas/IUN' documentsAvailable: type: boolean description: Indica se i documenti notificati sono ancora disponibili. ScheduleDigitalWorkflowDetailsV23: type: object required: - recIndex - digitalAddressSource - sentAttemptMade - lastAttemptDate properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 digitalAddress: $ref: '#/components/schemas/DigitalAddress' digitalAddressSource: $ref: '#/components/schemas/DigitalAddressSource' sentAttemptMade: type: integer format: int32 lastAttemptDate: type: string format: date-time schedulingDate: type: string description: Data prevista prossimo tentativo d'invio digitale per quella specifica sorgente di indirizzo format: date-time SenderAckCreationRequestDetails: type: object properties: legalFactId: type: string maxLength: 128 description: Identificativo dell'atto opponibile a terzi del quale è stata richiesta la creazione RefinementDetails: type: object required: - recIndex properties: recIndex: type: integer description: Index destinatario notifica digitale format: int32 notificationCost: description: costo notifica in euro cents, può essere nullo se la notifica si è perfezionata prima per visualizzazione example: 1220 type: integer format: int64 SendingReceipt: type: object properties: id: type: string description: messageId del server mittente maxLength: 1024 system: type: string description: nome del server mittente maxLength: 128 LegalFactCategoryV20: title: Tipi di atti opponibili a terzi description: "Tipi di atti opponibili a terzi che Piattaforma Notifiche mette a disposizione dei suoi utenti.
\n - SENDER_ACK
\n - DIGITAL_DELIVERY
\n - ANALOG_DELIVERY
\n - RECIPIENT_ACCESS
\n - PEC_RECEIPT
\n - ANALOG_FAILURE_DELIVERY
\n - NOTIFICATION_CANCELLED
" type: string parameters: pathIun: description: Identificativo Univoco Notifica name: iun in: path required: true schema: type: string minLength: 25 maxLength: 25 pattern: ^[A-Z]{4}-[A-Z]{4}-[A-Z]{4}-[0-9]{6}-[A-Z]{1}-[0-9]{1}$ pathAttachmentName: name: attachmentName description: Tipologia del pagamento allegato alla notifica. Valori possibili PAGOPA|F24 in: path required: true schema: type: string minLength: 3 maxLength: 6 pattern: PAGOPA|F24 idempotenceToken: name: idempotenceToken description: token usato per disambiguare "richieste di notificazione" effettuate con lo stesso numero di protocollo. in: query required: false schema: type: string pattern: ^[ -~]*$ maxLength: 256 notificationRequestId: in: query required: false name: notificationRequestId description: identificativo della richiesta di notifica schema: type: string maxLength: 36 pattern: ^[A-Za-z0-9+/=]{36}$ attachmentIdx: in: query name: attachmentIdx description: indice del documento di pagamento partendo da 0 required: false schema: type: integer format: int32 pathRecipientIdx: name: recipientIdx description: indice del destinatario nella lista partendo da 0. in: path required: true schema: type: integer format: int32 paProtocolNumber: name: paProtocolNumber in: query required: false description: Numero di protocollo associato alla notifica, può essere riutilizzato per rettifiche. schema: type: string pattern: ^.*$ maxLength: 256 pathDocumentIdx: name: docIdx description: indice del documento nella lista partendo da 0. in: path required: true schema: type: integer format: int32 securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key x-refined-from: - send-b2b-pa-bundle.yaml - pagopa-send-b2b-pa-openapi.yml