openapi: 3.2.0
info:
  title: Pagopa Notification Price V23 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 NotificationPriceV23 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: NotificationPriceV23
paths:
  /delivery/v2.3/price/{paTaxId}/{noticeCode}:
    get:
      operationId: retrieveNotificationPriceV23
      summary: Retrieve notification partial price and total price with effective date
      description: Usata dagli enti per recuperare il costo di notificazione tramite l'identificativo della posizione debitoria paTaxId e noticeCode. Viene restituito sia il costo parziale che il costo totale di notificazione.
      tags:
      - NotificationPriceV23
      parameters:
      - name: paTaxId
        description: Payment PA fiscal code
        in: path
        required: true
        example: '77777777777'
        schema:
          $ref: '#/components/schemas/paTaxId'
      - name: noticeCode
        description: Payment notice number  numero avviso
        in: path
        required: true
        example: '302000100000019421'
        schema:
          $ref: '#/components/schemas/noticeCode'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPriceResponseV23'
        '400':
          description: Invalid input
          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 Server 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:
    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}$
    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). <br/> Obbligatoria per notifiche con notificationFeePolicy=DELIVERY_MODE <br/> Per le notifiche effettuate con versioni precedenti alla 2.3 si assume il valore di default 100.<br/> Esempio paFee ad 1€ -> 100 <br/>
      format: int32
      minimum: 0
      maximum: 100
    VatV23:
      type: integer
      description: IVA espressa in percentuale sui costi degli avvisi in formato cartaceo.<br/> Obbligatoria per notifiche con notificationFeePolicy=DELIVERY_MODE. <br/> Per le notifiche effettuate con versioni precedenti alla 2.3 si assume il valore di default 22. <br/> Esempio vat al 22% -> 22 <br/>
      format: int32
      minimum: 0
      maximum: 100
    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
    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
    paTaxId:
      description: Payment PA fiscal code
      example: '77777777777'
      type: string
      maxLength: 11
      minLength: 11
      pattern: ^\d+$
    NotificationPriceResponseV23:
      title: Notification price Response
      description: Notification price and effective date
      type: object
      properties:
        iun:
          $ref: '#/components/schemas/IUN'
        partialPrice:
          description: Costo totale di notificazione che non include la paFee e vat
          type: integer
          format: int32
        totalPrice:
          description: Costo totale di notificazione che include la paFee e vat applicato ai costi cartacei. Se vat e paFee non sono valorizzati, verranno usati i loro valori di default (vedi /components/schemas/VatV23 e /components/schemas/PaFeeV23).
          type: integer
          format: int32
        vat:
          $ref: '#/components/schemas/VatV23'
        paFee:
          $ref: '#/components/schemas/PaFeeV23'
        refinementDate:
          description: data di perfezionamento per decorrenza termini localizzata espressa alla mezzanotte del giorno in cui si verifica l'evento
          type: string
          format: date-time
        notificationViewDate:
          description: data di perfezionamento per presa visione espressa alla mezzanotte del giorno in cui si verifica l'evento
          type: string
          format: date-time
        sendFee:
          description: costo base di SeND per notificazione
          type: integer
          format: int32
        analogCost:
          description: costo totale dei prodotti postali
          type: integer
          format: int32
    noticeCode:
      description: Payment notice number  numero avviso
      example: '302000100000019421'
      type: string
      maxLength: 18
      minLength: 18
      pattern: ^\d+$
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
x-refined-from:
- send-b2b-pa-bundle.yaml
- pagopa-send-b2b-pa-openapi.yml