Tabella dei contenuti
Operazioni disponibili
Gestione posizioni debitorie
Nei seguenti sequence diagram si identifica con l'acronimo GPD il servizio di Gestione Posizioni Debitorie e con APD l'Archivio delle Posizioni Debitorie (base dati).
Per i dettagli https://github.com/pagopa/pagopa-api/tree/SANP3.8.0/openapi
Creazione di una posizione debitoria
.png)
In fase di creazione della posizione debitoria il servizio effettuerà controlli sui dati in input e controlli di eventuali duplicati.
Tra i controlli dei dati in input si rilevano:
- obbligatorietà dei dati
- coerenza date (ad esempio due_date ≥ validity_date)
- coerenza importi (ad esempio la somma degli importi dei versamenti deve essere uguale all'importo totale)
- validità della tassonomia
- validità degli IBAN (devono essere censiti sulla piattaforma pagoPA)
Tra i controlli dei duplicati ci si basa sugli identificativi di pagamento (IUPD, IUV e fiscalCode)
Il query parameter toPublish consente di pubblicare automaticamente una posizione debitoria in fase di creazione, impostando questo parametro a true e valorizzando contestualmente a null il campo validityDate, la posizione debitoria andrà direttamente nello stato VALID pronta per essere pagata.
Lettura di una lista di posizioni debitorie e di una singola posizione debitoria
.png)
La lettura di una lista di posizioni debitorie prevede sempre una paginazione. E' inoltre possibile filtrare per due_date in modo da limitare i risultati.
.png)
La lettura di una posizione debitoria si basa sull'identificativo in input (IUPD). In caso lo IUPD non sia esistente verrà emesso un errore.
Aggiornamento di una posizione debitoria
.png)
In fase di aggiornamento, oltre ai già citati controlli in fase di creazione , si verifica che la posizione sia esistente ed aggiornabile.
In particolare l'aggiornabilità della posizione debitoria dipende dallo stato della posizione stessa (ad esempio se una posizione è già stata pagata non sarà possibile aggiornarla)
Cancellazione di una Posizione Debitoria
.png)
La cancellazione di una posizione debitoria prevede controlli sia sull'esistenza (IUPD) che sullo stato (ad esempio, una posizione debitoria non sarà cancellabile se è già stata pagata)
Pubblicazione di una posizione debitoria
post
Parametri
.png)
La pubblicazione della posizione debitoria permette il passaggio dallo stato DRAFT allo stato PUBLISHED.
Una posizione in stato DRAFT (bozza) infatti non permette la normale operatività con la piattaforma pagoPA. Solo quando l'Ente Creditore pubblica la posizione, in coerenza con le date di validità e di scadenza, questa risulta pagabile sulla piattaforma.
Invalidazione di una posizione debitoria
post
Parametri
L'invalidazione di una posizione debitore consiste di fatto in una cancellazione logica. E' possibile solo partendo dagli stati PUBLISHED e VALID.
La funzionalità è utile quando si vuole dare evidenza all'utente, in fase di pagamento, della invalidazione della posizione debitoria.
Ricevute di pagamento
Sono messe a disposizione due API per il recupero delle ricevute di pagamento:
- lista ricevute di pagamento
- dettaglio singola ricevuta
Flussi di rendicontazione
Sono messe a disposizione delle funzionalità di lettura dei flussi di rendicontazione:
- Lista di flussi di rendicontazione per un Ente Creditore
- Dettaglio del flusso di rendicontazione
get
Parametri
get
Parametri
In questa pagina
Gestione posizioni debitorie
Creazione di una posizione debitoria
Lettura di una lista di posizioni debitorie e di una singola posizione debitoria
Aggiornamento di una posizione debitoria
Cancellazione di una Posizione Debitoria
Pubblicazione di una posizione debitoria
Invalidazione di una posizione debitoria
Ricevute di pagamento
Flussi di rendicontazione
Dicci cosa ne pensi
Per chiarimenti sulle specifiche d’implementazione, come SACI e SANP, puoi aprire una segnalazione su GitHub