Operazioni disponibili

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.10.0/openapi

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:

L'identificazione di eventuali duplicati si basa sugli identificativi IUPD, IUV, NAV e fiscalCode.

L'operazione di creazione della posizione debitoria potrebbe fallire se questa esiste già per l'EC chiamante e proprietario della stessa posizione debitoria.

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. La richiesta potrebbe fallire a causa di input non validi, per esempio numero di elementi richiesti per pagina maggiore rispetto al massimo previsto o intervalli di date non coerenti.

La lettura di una posizione debitoria si basa sull'identificativo in input (IUPD). In caso lo IUPD non sia esistente verrà emesso un errore.

In fase di aggiornamento, oltre ai già citati controlli in fase di creazione, si verifica, inoltre, 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 debitoria è già stata pagata, interamente o parzialmente, oppure rendicontata oppure invalidata non sarà possibile aggiornarla e verrà restituito un errore.

La cancellazione di una posizione debitoria prevede controlli sia sull'esistenza (IUPD) che sullo stato. Una posizione debitoria non sarà cancellabile se è già stata pagata.

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. Nel caso in cui allo IUPD indicato nella richiesta non corrisponda una posizione debitoria in stato DRAFT appartenente all'EC richiedente, la richiesta restituisce un errore.

L'invalidazione di una posizione debitore consiste di fatto in una cancellazione logica. E' possibile effettuarla solo se la posizione debitoria da invalidare si trova negli stati PUBLISHED e VALID. La funzionalità è utile quando si vuole dare evidenza all'utente, in fase di pagamento, della invalidazione della posizione debitoria. Nel caso in cui allo IUPD indicato nella richiesta non corrisponda una posizione debitoria appartenente all'EC richiedente, la richiesta restituisce un errore.

Sono messe a disposizione due API REST per il recupero delle ricevute di pagamento:

La lettura di un lista di ricevute di pagamento prevede sempre una paginazione. E' inoltre possibile filtrare per debitore o date di pagamento in modo da limitare i risultati.

La lettura di una ricevuta di pagamento si basa sull'identificativo in input (IUV). In caso lo IUV non sia esistente o non esiste una ricevuta ad esso associata verrà emesso un errore.

Sono messe a disposizione delle funzionalità di lettura dei flussi di rendicontazione:

La lettura di un lista di flussi di rendicontazione prevede sempre una paginazione. E' inoltre possibile indicare la data di inizio a partire dalla quale selezionare i flussi.

La lettura di un flusso di rendicontazione si basa sull'identificativo del reporting in input (id). In caso non esista un flusso di rendicontazione relativo all'id inserito nella richiesta verrà restituito un errore.