Operazioni disponibili
Last updated
Last updated
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.3.1/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:
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 e IUV)
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 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 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)
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)
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.
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.
Nei seguenti sequence diagram si identifica con l'acronimo GPS il servizio di Gestione Pagamenti Spontanei.
Si identificano 2 entità:
Ente Creditore (adesione al servizio di pagamenti spontanei)
Servizio (sottoscrizione ad uno specifico servizio)
Con questa operazione è possibile aderire tecnicamente al servizio di gestione dei pagamenti spontanei. E' inoltre possibile, già in fase di adesione, definire l'iscrizione ai vari servizi.
Vengono effettuati controlli sintattici e semantici sui campi in input. In particolare, si segnalano controlli sulla bontà delle iscrizioni ai servizi (che devono essere presenti nell'elenco servizi)
Questa funzionalità permette la cancellazione di un adesione di un Ente Creditore al servizio di gestione dei pagamenti spontanei. Contestualmente vengono cancellate tutte le sottoscrizioni.
Questa operazione, per potere essere effettuata, deve essere preceduta da un adesione.
Con questa funzionalità è possibili aggiornare le proprietà dell'Ente Creditore in merito all'adesione al servizio.
Valgono gli stessi controlli definiti per la creazione dell' adesione, oltre ai controlli legati alla presenza di una precedente adesione.
Questa funzionalità permette di recuperare, oltre alle proprietà dell'ente creditore, tutte le sottoscrizioni ai servizi.
Con questa operazione è possibile aggiungere una sottoscrizione ad un servizio.
Vengono effettuati controlli in merito all'identificativo del servizio aggiunto (deve essere esistente e non deve essere già presente un sottoscrizione) oltre ai controlli sintattici e semantici sulle proprietà dell'adesione (IBAN, causale versamento, etc).
Con questa operazione è possibile recuperare le proprietà di una determinata sottoscrizione ad un servizio.
Con questa operazione è possibile aggiornare le proprietà di una sottoscrizione precedentemente aggiunta.
Non è possibile cambiare il servizio con questa operazione.
Con questa operazione è possibile cancellare la sottoscrizione ad un servizio precedentemente aggiunto.
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
The organization deletes the creditor institution.
The fiscal code of the Organization.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
Return all enrollments for a creditor institution.
The fiscal code of the Organization.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
Return the single enrollment to a service.
The fiscal code of the Organization.
The service id to enroll.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The organization deletes the enrollment to service for the creditor institution.
The fiscal code of the Organization.
The service id to enroll.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
Return the list of the organization debt positions.
Organization fiscal code, the fiscal code of the Organization.
Format - int32. Page number. Page value starts from 0
Format - date (as full-date in RFC3339). Filter from due_date (if provided use the format yyyy-MM-dd)
Format - date (as full-date in RFC3339). Filter to due_date (if provided use the format yyyy-MM-dd)
Format - int32. Number of elements on one page. Default = 50
50Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS
COMPANY_NAMEAvailable options: Direction of ordering
DESCAvailable options: This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
Return the details of a specific debt position.
Organization fiscal code, the fiscal code of the Organization.
IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The Organization deletes a debt position
Organization fiscal code, the fiscal code of the Organization.
IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The Organization publish a debt Position.
Organization fiscal code, the fiscal code of the Organization.
IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The Organization invalidate a debt Position.
Organization fiscal code, the fiscal code of the Organization.
IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The organization creates a creditor institution with possible enrollments to services.
The fiscal code of the Organization.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The organization updates the creditor institution.
The fiscal code of the Organization.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The organization creates an enrollment to a service for the creditor institution.
The fiscal code of the Organization.
The service id to enroll.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The organization updates an enrollment to a service for the creditor institution.
The fiscal code of the Organization.
The service id to enroll.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
The Organization creates a debt Position.
Organization fiscal code, the fiscal code of the Organization.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
feature flag to enable the debt position to expire after the due date
falseExample: falseThe Organization updates a debt position
Organization fiscal code, the fiscal code of the Organization.
IUPD (Unique identifier of the debt position). Format could be <Organization fiscal code + UUID> this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is true and if not, notify the EC.
This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
feature flag to enable the debt position to expire after the due date
falseExample: false