cs-test.teamsystem.comcs-test.teamsystem.com/.../doc/CS-WebServices-Specif… · Web viewWeb Services – Specifiche Tecniche 106 Versione 1.3.0 1 2 Novembre 2015 TeamSystem® Servizio

TeamSystem®

Servizio CCT

Servizio CCTWeb Services

Versione

1.3.012 Novembre 2015

Servizio CCTWeb Services – Specifiche Tecniche

Specifiche Tecniche

1



SommarioVersioni del documento 5

Parte 1 6

1 Introduzione 6

2 Terminologia 7

3 Logica generale di funzionamento 93.1 Tecnologia utilizzata 93.2 Convenzioni sui nomi utilizzati 93.3 Localizzazione messaggi 113.4 Parametri di input e output 113.5 Gestione delle Versioni 123.6 Modalità di test, documentazione ed esempi 133.7 Flusso operativo: schema generale ed esempio 14

Parte 2 15

4 Web Services del Servizio CCT 154.1 Utilizzo degli Endpoint 164.2 Servizio: UserAuthentication 16

4.2.1 Operazione: BasicAuthentication 174.2.2 Operazione: GetTicket 184.2.3 Operazione: DigestAuthentication 19

4.3 Servizio: FileTransfer 214.3.1 Operazione: UploadPdI 214.3.2 Operazione: UploadTypedPdI 234.3.3 Operazione: DownloadFile 25

4.4 Servizio: ServizioCS 264.4.1 Operazione: GetPdI 264.4.2 Operazione: GetTypedPdI 274.4.3 Operazione: SearchPdI 284.4.4 Operazione: SearchTypedPdI 30

Appendice A 33

5 Workflow del PdI 33

Appendice B 35

6 Parametri di tipo oggetto 356.1 ServiceInfo 356.2 NameValue 356.3 BaseUserIdentity 366.4 UserIdentity 366.5 BasicAuthentication 366.6 DigestAuthentication 366.7 SoggettoProduttore, SoggettoTitolare, SoggettoOrigine, SoggettoDestinazione 376.8 DatiDocumento 376.9 PdIBase 48

1


6.10 PdI1001 506.11 PdI1002 516.12 PdI1003 526.13 PdI1004 536.14 PdI1005 536.15 PdI2001 546.16 PdI2002 546.17 PdI2003 556.18 PdI2004 566.19 PdI2005 576.20 PdI2006 576.21 PdI2007 586.22 PdI2008 586.23 PdI2009 596.24 PdI2010 596.25 PdI2011 606.26 PdI2012 616.27 PdI2013 616.28 PdI2014 626.29 PdI2015 626.30 PdI2016 636.31 PdI2017 636.32 PdI2018 646.33 PdI2019 646.34 PdI2020 656.35 PdI2021 656.36 PdI2022 666.37 PdI2023 666.38 PdI2024 676.39 PdI2025 676.40 PdI2026 686.41 PdI2027 686.42 PdI2028 696.43 PdI2029 696.44 PdI2030 706.45 PdI2031 706.46 PdI2032 716.47 PdI2033 716.48 PdI2034 726.49 PdI2035 726.50 PdI2036 736.51 PdI2037 736.52 PdI2038 746.53 PdI2039 746.54 PdI2040 746.55 PdI2041 756.56 PdI2042 756.57 PdI2043 766.58 PdI2044 766.59 PdI2045 766.60 PdI2046 77

2


6.61 PdI2047 776.62 PdI2048 786.63 PdI2049 796.64 PdI2050 796.65 PdI2051 806.66 PdI2052 806.67 PdI2053 816.68 PdI2054 816.69 InfoPdI 826.70 InfoTypedPdI 856.71 InfoPdI1001 876.72 InfoPdI1002 886.73 InfoPdI1003 896.74 InfoPdI1004 896.75 InfoPdI1005 906.76 InfoPdI2001 906.77 InfoPdI2002 916.78 InfoPdI2003 916.79 InfoPdI2004 926.80 InfoPdI2005 926.81 InfoPdI2006 936.82 InfoPdI2007 936.83 InfoPdI2008 946.84 InfoPdI2009 946.85 InfoPdI2010 956.86 InfoPdI2011 956.87 InfoPdI2012 966.88 InfoPdI2013 966.89 InfoPdI2014 976.90 InfoPdI2015 976.91 InfoPdI2016 986.92 InfoPdI2017 986.93 InfoPdI2018 996.94 InfoPdI2019 996.95 InfoPdI2020 1006.96 InfoPdI2021 1006.97 InfoPdI2022 1016.98 InfoPdI2023 1016.99 InfoPdI2024 1026.100 InfoPdI2025 1026.101 InfoPdI2026 1036.102 InfoPdI2027 1036.103 InfoPdI2028 1036.104 InfoPdI2029 1046.105 InfoPdI2030 1046.106 InfoPdI2031 1056.107 InfoPdI2032 1056.108 InfoPdI2033 1056.109 InfoPdI2034 1066.110 InfoPdI2035 1066.111 InfoPdI2036 107

3


6.112 InfoPdI2037 1076.113 InfoPdI2038 1076.114 InfoPdI2039 1086.115 InfoPdI2040 1086.116 InfoPdI2041 1086.117 InfoPdI2042 1096.118 InfoPdI2043 1096.119 InfoPdI2044 1106.120 InfoPdI2045 1106.121 InfoPdI2046 1106.122 InfoPdI2047 1116.123 InfoPdI2048 1116.124 InfoPdI2049 1126.125 InfoPdI2050 1126.126 InfoPdI2051 1136.127 InfoPdI2052 1136.128 InfoPdI2053 1136.129 InfoPdI2054 1146.130 FileInfo 1146.131 SearchPdI 1156.132 SearchExpression 1176.133 SearchClause 1176.134 Argument 1176.135 OrderBy 1186.136 SearchPdIOutput 118

Appendice C 119

7 Valori enumerati 1197.1 PdIFileType 1197.2 HashType 1217.3 Operator 1217.4 ArgType 1227.5 Direction 122

Appendice C 123

8 Elenco errori 1238.1 Errori nei dati della richiesta 1248.2 Errori di sicurezza 1268.3 Errori in fase di elaborazione 126

4


Versioni del documento

Versione 1.3.0

Data 11/10/2015

Autori Davide Nani, Giampiero Levo

Descrizione

Aggiunta l’OperationContract UploadTypedPdI che consente l’upload di PdI tramite DataContract tipicizzati.Aggiunte le OperationContract GetTypedPdI e SearchTypedPdI che consentono di ricercare PdI ottenendo come risultato DataContract tipicizzati.

Versione 1.2.0

Data 20/10/2015


Descrizione

Aggiunto al DataContract SearchFEOutputDC il parametro PartialRecordCount.Aggiunte le spiegazioni relative al funzionamento dell’OperationContract SearchFE.

Versione 1.1

Data 17/09/2015


Descrizione

Correzione nome campo CodiceDestinazioneIPA in CodiceDestinatarioIPA.

Versione 1.0

Data 03/08/2015


Descrizione

Documentazione progetto.

5


6


1 IntroduzioneMotivazioni e finalità del presente documento

Lo scopo di questo documento è fornire la documentazione tecnica sui Web Services esposti dal Servizio di Conservazione Sostitutiva in Cloud di TeamSystem (Servizio CCT).

Questo documento è rivolto agli utenti accreditati che vogliono interfacciarsi programmaticamente al servizio per:

trasmettere documenti da conservare monitorare/scaricare pacchetti di archiviazione

7

Parte 1


2 TerminologiaSignificato dei termini utilizzati nel presente documento

Conservazione Sostitutiva

E’ la procedura prevista dalle attuali leggi in materia fiscale (DPR 59 del 12-3-2014)) che consente di dematerializzare i documenti cartacei e conservare gli equivalenti digitali rispettando certe regole (firma digitale, marcatura temporale, ecc.) in grado di garantire i requisiti di legge (autenticità, integrità, affidabilità, leggibilità, reperibilità) che attribuiscono piena validità ai fini legali e fiscali.

La normativa stabilisce anche le regole con cui devono essere conservati i documenti fiscali emessi direttamente in formato elettronico. Per questi non si ha una dematerializzazione ovvero una sostituzione del documento cartaceo originale e ultimamente ci si sta orientando verso il termine di Conservazione Digitale o in modo più neutro di Conservazione a Norma come sinonimi più qualificati per la Conservazione Sostitutiva.

Pacchetto Informativo E’ un contenitore che racchiude uno o più oggetti da conservare (documenti informatici, fascicoli informatici, aggregazioni documentali informatiche), o anche solo i metadati riferiti agli oggetti da conservare.

Pacchetto di Versamento (PdV)

E’ un pacchetto informativo inviato dal produttore al sistema di conservazione secondo un formato predefinito e concordato descritto nel manuale di conservazione.

Pacchetto di Archiviazione(PdA)

E’ un pacchetto informativo composto dalla trasformazione di uno o più pacchetti di versamento secondo le specifiche definite dall’attuale normativa.

Pacchetto di Distribuzione(PdD)

E’ un pacchetto informativo inviato dal sistema di conservazione all’utente in risposta ad una sua richiesta.

KnoS E’ il DMS che ospita le personalizzazioni richieste.

Pubblicazione E’ l’elemento base per l’organizzazione delle informazioni su KnoS. Una pubblicazione è un oggetto caratterizzato da attributi che può ospitare uno o più file allegati ed essere messo in relazione con altre pubblicazioni.

Tipologia Le tipologie definiscono categorie di pubblicazioni che hanno in comune gli stessi attributi e uno stesso workflow. Una pubblicazione è

8


sostanzialmente un’istanza di una certa tipologia.

Attributi Sono i metadati associati alle pubblicazioni definibili e valorizzabili dagli utenti o da programma.Gli attributi si dividono in due classi principali: gli attributi semplici (o mono valore) e gli attributi di tipo elenco (pubblicazioni o valori enumerati).

Documenti Sono i file allegati alle pubblicazioni dagli utenti o da programmi. Comprendono sia i file destinati alla Conservazione Sostitutiva che i file intermedi di indicizzazione, ecc.

Web Services CS Sono i web services esposti da KnoS per consentire l’accesso in via programmatica al servizio in alternativa all’interfaccia web.

9


3 Logica generale di funzionamentoA cosa servono i Web Services e qual è la logica di funzionamento

I Web Services sono stati introdotti sulla piattaforma del Servizio CCT per consentire ai clienti l’automatizzazione completa delle operazioni coinvolte nel processo della conservazione sostitutiva.

La logica di funzionamento del Servizio CCT non cambia con l’introduzione dei Web Services e vengono comunque mantenute le modalità tradizionali di upload e download da interfaccia web.

Oltre a sostituire le procedure manuali di upload e download i Web Services permetteranno anche il monitoraggio dello stato dei documenti conservati e l’ottenimento di dati statistici consentendo agli utenti di realizzare all’occorrenza una propria interfaccia completa verso il Servizio CCT.

3.1 Tecnologia utilizzataI Web Services del Servizio CCT TeamSystem sono realizzati utilizzando Microsoft WCF 4.5 come componente per l’infrastruttura di base.

Il protocollo di scambio implementato è SOAP 1.2.

Per lo scambio di file (upload/download) si utilizza MTOM (Message Transmission Optimization Mechanism).

I Web Services implementati restituiscono i dettagli sull’interfaccia implementata se richiamati con ?wsdl o ?singlewsdl.

Oltre alle informazioni contenute in questo documento e all’auto-documentazione restituita dai Web Services verrà fornito anche un progetto sviluppato in C# con esempi dettagliati di richiamo per tutte le operazioni disponibili.

3.2 Convenzioni sui nomi utilizzatiLa piattaforma su cui si basa l’applicativo utilizza nei propri Web Services interni una nomenclatura basata su termini inglesi. Dovendo mettere in comunicazione la terminologia inglese con la termilogia italiana relativa all’argomento conservazione sostitutiva si è adottato un approccio neutrale che cercasse di mantenere i nomi originali per semplificare la comprensione dei concetti che stanno alla base dei servizi, delle operazioni e dei parametri implementati.

10


Si è quindi ritenuto inutile operare una scelta per una lingua o per l’altra e quindi tradurre termini come “Soggetto Conservante”, “PdI”, ecc. in inglese o, viceversa, ritradurre in italiano una quantità di termini molto superiore che deriva dal DMS KnoS alla base del Servizio CCT. Questo approccio ha il pregio di mantenere la corrispondenza con i termini originali in entrambe le lingue ed elimina il rischio, sempre in agguato quando si procede a tradurre concetti locali specifici nella lingua di altre nazioni, di trovare parole non traducibili o almeno non traducibili in termini sintetici o con un significato perfettamente equivalente all’originale.

In conclusione la convenzione adottata è la seguente:

tutti i nomi relativi a concetti provenienti da KnoS sono espressi con i termini originali in inglese (IdStatus, StatusName, DateCreation, ecc.);

tutti i nomi relativi a concetti provenienti dalla conservazione sostitutiva hanno mantenuto il loro nome originale con l’eventuale aggiunta del suffisso o del prefisso PdI, PdD per rimarcarne la tipologia;

per i concetti generali che sono però collegati a concetti locali è ammesso l’uso di nomi ibridi quando il termine originato risulta chiaramente comprensibile e non eccessivamente stravagante. Ad esempio UploadPdI è stato utilizzato come nome del metodo atto all’invio di documenti da conservare poiché il termine upload è di uso generico ed è diventato comune anche nella lingua italiana.

nei casi ambigui si è lasciata agli sviluppatori la libertà di scelta dei nomi per cui ad esempio si sono preferiti termini come ElencoInfoPdI a cose tipo InfoPdIList, mentre per indicare gli elenchi dei file di un PdI il termine FileList è sembrato più appropriato in quanto facilmente comprensibile e già presente all’interno di KnoS

Ci auguriamo, con le scelte fatte, di non urtare troppo la sensibilità e il gusto linguistico degli utilizzatori dei nostri Web Services.

“Stat rosa pristina nomine, nomina nuda tenemus”(Umberto Eco – Il nome della rosa)

“What’s in a name? That which we call a roseBy any other name would smell as sweet.”

(William Shakespeare – Romeo and Juliet)

11


3.3 Localizzazione messaggi La lingua di default dei messaggi, tipicamente di eccezione, restituiti dai vari metodi dei web services è l’italiano.

È possibile però impostare i web services affinchè utilizzino la lingua inglese per i messaggi restituiti; per far ciò occorre aggiungere il nodo “Language” all’header della richiesta soap come illustrato di seguito:

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"><s:Header>

<Language xmlns="KnosCSServices">en</Language></s:Header><s:Body>

<BasicAuthentication xmlns="http://www.teamsystem.com/"><BasicAuthentication

xmlns:a="http://schemas.datacontract.org/2004/07/KnosCS.Services.DataContracts.Input" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

<a:Password>Password</a:Password><a:UserName>Username</a:UserName>

</BasicAuthentication></BasicAuthentication>

</s:Body></s:Envelope>Si vedano le applicazioni di demo in ASP.NET e Java per approfondire l’implementazione.

3.4 Parametri di input e outputTutti i Web Service del Servizio CCT sono auto-documentati tramite WSDL, in questo documento vengono fornite le specifiche in termini descrittivi ponendo l’accento sulle regole non specificabili tramite WSDL. I parametri di tipo semplice utilizzati sono:

o stringa stringa unicode con lunghezza massima fino a 200 caratterio testo testo unicode di lunghezza superiore ai 200 caratterio intero numero intero con segno a 32 bito data-ora data e ora o enumerato valore di tipo stringa preso da un elenco di valori predefinitio file file allegato alla richiesta/risposta

Per il tipo stringa la presenza di un eventuale numero tra parentesi indica la lunghezza massima accettata, ad esempio:

stringa (100) indica una stringa di testo di lunghezza massima di 100 caratteri unicode

Eventuali restrizioni o indicazioni sui caratteri utilizzabili (ad esempio per i nomi dei file) sono indicate nei capitoli che descrivono l’operazione specifica.

12


Per il tipo testo si indica sempre la dimensione massima accettata, che sarebbe altrimenti arbitraria e potenzialmente invasiva, con la stessa sintassi utilizzata per la stringa:

testo (1000) indica un testo di lunghezza massima di 1000 caratteri unicode

I parametri di tipo oggetto sono costituiti da insiemi di tipi semplici, elenchi di tipi semplici o elenchi di oggetti.

Il contenuto di questi tipi è dettagliato solo la prima volta che vengono descritti. L’appendice B documenta nel dettaglio i parametri di tipo oggetto utilizzati nei DataContract.

3.5 Gestione delle VersioniTutte le operazioni esposte dai servizi restituisco in output il parametro ServiceInfo che contiene nella proprietà ServiceVersion (di tipo stringa) la versione corrente del servizio.

Parametro di Output Tipo Descrizione

ServiceInfo oggetto Contenitore per la versione corrente del Servizio ed eventuali informazioni aggiuntive.

ServiceVersion stringa Versione corrente del servizio.

La versione è espressa come sequenza di tre numeri separati da punto:

VersionNumber . ReleaseNumber . BuildNumber

Ad esempio Version = “1.2.3” indica che:

VersionNumber = 1 è il numero di versioneReleaseNumber = 2 è il numero di rilascioBuildNumber = 3 è il numero di compilazione

La regola adottata internamente è che ogni volta che si ricompilano i Web Services a fronte di una modifica significativa si incrementa il numero di compilazione.

Se la modifica determina una variazione nell’interfaccia dei Web Services (ad esempio l’aggiunta di una operazione o di un parametro) che non altera la compatibilità con la versione precedente si incrementa il numero di rilascio e si azzera il numero di compilazione.

Se la modifica è tale da rendere incompatibile il servizio con la versione precedente allora si crea un nuovo servizio con lo stesso nome a cui si appende il numero di versione, fa eccezione a questa regola la versione iniziale del servizio che non riporta il numero di versione.

Ad esempio le operazioni del servizio ServizioCS restituiranno come versioni:

1.0.0, 1.0.1, … , 1.2.0, 1.2.1, …

13


Quando si renderà necessaria una modifica di versione (rottura della compatibilità con l’interfaccia precedente) si realizzerà il servizio ServizioCS2 le cui operazioni restituiranno come versioni:

2.0.0, 2.0.1, … , 2.2.0, 2.2.1, …

L’introduzione di una nuova versione non elimina (a meno che non sia indispensabile) la versione precedente, per cui il client sarà libero di richiamare il servizio ServizioCS o il servizio ServizioCS2. Ovviamente uno dei due servizi potrebbe non offrire tutte le funzionalità dell’altro.

È anche possibile avere scenari misti per cui un client continua a richiamare il servizio ServizioCS per le operazioni già implementate mentre richiama ServizioCS2 solo per le nuove funzionalità introdotte.

3.6 Modalità di test, documentazione ed esempiÈ disponibile un sito di test per lo sviluppo dell’integrazione. I Web Services del Servizio CCT sono ospitati nella cartella all’indirizzo:

http://CS-test.teamsystem.com/knos/wcf/CS

La cartella:http://CS-test.teamsystem.com/knos/wcf/CS/samples

contiene un progetto di esempio in Visual Studio 2013.

La cartella:http://CS-test.teamsystem.com/knos/wcf/CS/doc

contiene la documentazione di progetto nelle varie versioni, per semplificare il controllo su eventuali novità all’indirizzo:

http://CS-test.teamsystem.com/knos/wcf/CS/news.htm

è presente una semplice pagina HTML di testo che riepiloga lo stato di avanzamento.

Le credenziali di accesso al sito di demo vengono rilasciate su richiesta.

14

http://CS-test.teamsystem.com/knos/wcf/CS/news.htm

http://CS-test.teamsystem.com/knos/wcf/CS/doc

http://CS-test.teamsystem.com/knos/wcf/CS/samples

http://CS-test.teamsystem.com/knos/wcf/CS


3.7 Flusso operativo: schema generale ed esempioPrima di poter eseguire una qualunque altra operazione l’utente deve autenticarsi fornendo l’utente e la password rilasciati dagli operatori del Servizio CCT.

All’utente che esegue correttamente la procedura di autenticazione viene rilasciato un SecurityToken (Token di sicurezza) che andrà passato come parametro in tutte le richieste successive.

Ecco una sequenza tipica di richiamo Web Services per la gestione di una fattura:

15

Servizi CS Utente

UserAuthentication

UserName, Ticket, Digest Password/Digest Token di sicurezza

UploadPdISecurityToken, Documento da conservare

IdPdI

StatoPdI Stato PdI, notifiche, file

SecurityToken, IdPdI

RicercaPdI

SecurityToken, IdObject, IdDoc

File della conservazione sostitutiva

GetTicket

DigestAuthentication

BasicAuthentication

Ticket

ServizioCS

SecurityToken, Parametri di ricerca

Elenco PdI paginato

DownloadFile

FileTransfer

FileTransfer


4 Web Services del Servizio CCT Definizione e logica dei servizi implementati

L’architettura dei Web Services implementati dal Servizio CCT di TeamSystem prevede due servizi comuni per l’autenticazione e trasferimento file e poi servizi separati per tipologia di operazione o per classe di utenza che verranno rilasciati gradualmente.

L’implementazione completa dei Web Services avverrà in fasi successive. Allo stato attuale si prevede l’implementazione dei seguenti servizi:

UserAuthentication /knos/wcf/CS/UserAuthentication.svc

FileTransfer /knos/wcf/CS/FileTransfer.svc

ServizioCS /knos/wcf/CS/ServizioCS.svc

I primi due servizi sono di uso generale e consentono l’autenticazione e il trasferimento di file in upload e download.

Nella prima fase l’interazione via Web Services verrà offerta ai soli utenti degli Enti di Caricamento tramite ServizioCS.

In seguito verranno aggiunte nuove operazioni e/o servizi utili alla gestione amministrativa del servizio (recupero dei dati statistici, gestione dei dati di fatturazione, ecc.) alle altre categorie di utenti (amministratori, rivenditori, ecc.).

16

Parte 2


4.1 Utilizzo degli EndpointAttualmente i servizi sono raggiungibili sia via HTTP (solamente in ambiente di test) sia via HTTPS e per ciascun protocollo espongono 3 Endpoint: uno con codifica “classica” Text, uno con codifica MTOM (Message Transmission Optimization Mechanism) e una con codifica Binary.

L’utilizzo della codifica MTOM riduce la dimensione dei messaggi SOAP inviati/ricevuti e quindi è da preferirsi, soprattutto per l’upload/download di file, quando il client utilizzato lo supporta (ASP.NET, Java, ecc.); discorso analogo per la codifica Binary che è ancora più compatta di quella MTOM: essa però è utilizzabile solamente interfacciandosi da client sviluppati in ASP.NET.

Il servizio FileTransfer espone quindi i seguenti Endpoint:

/knos/wcf/CS/FileTransfer.svc/http

/knos/wcf/CS/FileTransfer.svc/http/mtom

/knos/wcf/CS/FileTransfer.svc/http/binary

/knos/wcf/CS/FileTransfer.svc/https

/knos/wcf/CS/FileTransfer.svc/https/mtom

/knos/wcf/CS/FileTransfer.svc/https/binary

Si vedano le applicazioni demo di esempio per l’utilizzo specifico.

4.2 Servizio: UserAuthenticationÈ un servizio trasversale a tutti gli utenti che consente di ottenere il Token di Sicurezza da utilizzare per tutte le chiamate successive ai web service esposti.

Per ottenere il Token di Sicurezza l’applicativo deve disporre delle credenziali (UserName e Password) dell’utente corrente. Il token ottenuto è valido a tempo indeterminato (salvo eventuali operazioni di reset eseguite sul server che sono però eventi eccezionali) e garantisce a chiunque ne sia in possesso le credenziali di accesso dell’utente per cui è stato rilasciato.

È cura dell’applicativo che ottiene il Token di Sicurezza mantenerlo segreto per evitare che possa essere utilizzato da soggetti diversi dall’utente autorizzato.

Le operazioni offerte dal servizio UserAuthentication sono:

BasicAuthentication GetTicket DigestAuthentication

17


18


4.2.1 Operazione: BasicAuthenticationL’autenticazione di base è fornita ai client che non intendono utilizzare la procedura di autenticazione con Digest SHA1. Questo tipo di autenticazione è normalmente sconsigliato perché la password viaggia in chiaro ma poiché il servizio CCT è offerto in HTTPS anche questo metodo di autenticazione è da considerarsi sufficientemente sicuro.

Parametri di Input Tipo Descrizione

BasicAuthentication oggetto Contenitore per i parametri di autenticazione di base

UserName stringa nome utente (non importa se LowerCase oppure no)

Password stringa password

e ottenendo in risposta:

Parametri di Output Tipo Descrizione

ServiceInfo oggetto Oggetto contenente la versione corrente del Servizio ed eventuali informazioni aggiuntive (vedi Appendice B).


Info elenco Elenco di oggetti di tipo NameValueDC contenenti eventuali informazioni aggiuntive relative all’operazione corrente (vedi Appendice B).

UserIdentity oggetto Contenitore per SecurityToken.

SecurityToken stringa Token di sicurezza utilizzato per l’autenticazione dell’utente.

oppure un errore SOAP.

19


4.2.2 Operazione: GetTicketQuesta operazione consente di ottenere dal server un Ticket da utilizzare nell’operazione di DigestAuthentication. Non è necessario richiamare questa operazione se l’autenticazione è fatta con l’operazione di BasicAuthentication.

La richiesta va formulata con i seguenti parametri:


BaseUserIdentity oggetto Contenitore per i parametri di base di identificazione dell’utente

Username stringa nome utente (non importa se LowerCase oppure no)

e la risposta restituisce:





Ticket stringa Ticket da utilizzare nell’operazione di DigestAuthentication.

ClientIPAddress Stringa Indirizzo IP del client che ha effettuato la richiesta


ServiceInfo è un contenitore per informazioni relative al servizio corrente. Ospita sempre almeno la proprietà ServiceVersion che indica la versione corrente del servizio.

20


4.2.3 Operazione: DigestAuthenticationLa DigestAuthentication viene eseguita in due passi:

- il client richiama l’operazione GetTicket per ottenere il Ticket- una volta ottenuto il Ticket viene utilizzato per produrre un Digest così calcolato:

Digest = SHA1(LowerCase(UserName) + clientIPAddress +

UpperCase(SHA1(LowerCase(UserName) + LowerCase(password))) + Ticket)

Dove:SHA1(argomento) indica l’applicazione dell’hashing SHA1 sull’argomento

LowerCase(argomento) indica la conversione in minuscolo dell’argomento

UpperCase(argomento) indica la conversione in maiuscolo dell’argomento

argomento1 + argomento2 indica la concatenazione dei due argomenti

La conversione in minuscole è richiesta perché nelle versioni attuali di KnoS sia il nome utente che la password sono Case Insensitive.

Per il calcolo dello SHA1 è inoltre richiesto l’utilizzo dell’encoding "ISO-8859-1".

Una volta ottenuto il Digest il client può invocare l’operazione di DigestAuthentication passando come parametri della richiesta:


DigestAuthentication oggetto Contenitore per UserName, Ticket e Digest.

UserName stringa Nome utente (non importa se LowerCase oppure no).

Ticket stringa Ticket fornito dall’operazione GetTicket.

Digest stringa Calcolato con la formula indicata sopra.

e ottenendo in risposta:





21


UserIdentity oggetto Contenitore per SecurityToken.

SecurityToken stringa Token di sicurezza utilizzato per l’autenticazione dell’utente.


22


4.3 Servizio: FileTransferÈ il servizio che gestisce le operazioni di upload e download via MTOM.Supporta le seguenti operazioni:

UploadPdI UploadTypedPdI DownloadFile

È possibile inviare una solo pacchetto di indicizzazione alla volta tramite l’operazione UploadPdI e UploadTypedPdI; l’upload è consentito solo agli utenti degli Enti di Caricamento abilitati.

UploadTypedPdI consente l’upload di documenti tramite DataContract tipicizzati (facilitando quindi l’identificazione delle proprietà da valorizzare a seconda del tipo di documento) mentre UploadPdI usa un unico DataContract generico per l’upload fornendo solamente 4 dictionary nei quali inserire i metadati tipici di ogni tipologia di documento.

Con l’operazione DownloadFile è possibile scaricare i file del PdI o delle notifiche associate.Per poter scaricare un file è necessario passare la coppia IdObject, IdDoc restituita dalle operazioni di ServizioCS.

Il download è un operazione disponibile a tutti gli utenti che hanno accesso al file richiesto.

4.3.1 Operazione: UploadPdIQuesta operazione consente l’invio di PdI al Servizio CCT TeamSystem.



UserIdentity oggetto Contiene l’identità dell’utente (vedi Appendice B).

UploadPdI oggetto Contiene gli estremi per l’upload del PdI.

Canale stringa Contiene le info sul canale di trasmissione.

SoggettoProduttore oggetto Soggetto che usufruisce del servizio e che può inviare in conservazione documenti propri o di terzi (Soggetti Deleganti) (Vedi Appendicie B).

SoggettoTitolare oggetto Soggetto che deve conservare il documento: coincide col SoggettoProduttore tranne nel caso di Studi o altri che eseguono la conservazione per conto terzi (Vedi Appendice B).

23


SoggettoOrigine oggetto Soggetto che ha originato il documento da conservare: normalmente coincide col SoggettoTitolare per i documenti attivi (Vedi Appendice B).

SoggettoDestinazione oggetto Soggetto a cui è destinato il documento: normalmente coincide con il SoggettoTitolare nel caso di documenti passivi o nel caso di documenti che non hanno una destinazione (Libri Giornali, Registri IVA, ecc.) (Vedi Appendice B).

DatiDocumento oggetto Contiene le informazioni relative al documento da conservare (Vedi Appendice B).

Se la creazione della pubblicazione ha esito positivo la risposta restituisce:





UploadPdI oggetto Contenitore per le informazioni relative alil PdI (vedi Appendice B).

IdPdI intero Identificativo univoco della del PdI.

IdDoc intero Identificativo univoco del documento allegato alla pubblicazione.

DateCreation data-ora Data e ora in cui il PdI è stato creato all’interno del Servizio CCT.

IdStatus intero Identificativo dello stato corrente del PdI.

StatusName stringa Nome dello stato corrente del PdI.

DateChangeStatus data-ora Data e ora in cui il PdI ha assunto lo stato corrente.


Il parametro IdPdI è utilizzabile come identificativo univoco in tutte le operazioni che lo richiedono.

24


4.3.2 Operazione: UploadTypedPdIQuesta operazione consente l’invio di PdI al Servizio CCT TeamSystem.

Si differenzia dal metodo UploadPdI in quanto utilizza DataContract tipicizzati contenente i metadati del PdI e non più un unico DataContract con i 4 Dictionary destinati a contenere di volta in volta i metadati specifici di ciascun PdI.




UploadPdI oggetto Contiene gli estremi per l’upload del PdI.




PdIBase oggetto Contiene le informazioni relative al documento da conservare (Vedi Appendice B).

Il tipo del parametro PdIBase è la classe base PdIBaseDC: a seconda della tipologia di documento che si vuole uplodare occorrerà istanziare la classa dedicata (PdI1001DC, PdI1002DC, PdI1003DC, ecc.).

Si veda l’Appendice B per l’elenco completo delle classi dedicate e quindi l’elenco delle tipologie al momento disponibili.

25


Se la creazione della pubblicazione ha esito positivo la risposta restituisce:





UploadPdI oggetto Contenitore per le informazioni relative alil PdI (vedi Appendice B).

IdPdI intero Identificativo univoco della del PdI.

IdDoc intero Identificativo univoco del documento allegato alla pubblicazione.

DateCreation data-ora Data e ora in cui il PdI è stato creato all’interno del Servizio CCT.





Il parametro IdPdI è utilizzabile come identificativo univoco in tutte le operazioni che lo richiedono.

26


4.3.3 Operazione: DownloadFileQuesta operazione consente il download del file precedentemente inviato al Servizio CCT TeamSystem.




DownloadFile oggetto Contenitore per le informazioni relative al file da scaricare (vedi Appendice B).

IdObject intero Id della pubblicazione (fattura, messaggio o altro che contiene il file).

IdDoc intero Identificativo del file all’interno della pubblicazione.

Se l’utente ha accesso al file richiesto la risposta restituisce:





FileInfo oggetto Oggetto contenente i metadati del file richiesto ed il file stesso (vedi Appendice B).


27


4.4 Servizio: ServizioCSÈ il Web Service offerto agli utenti per monitorare lo stato dei propri PdI. Offre le seguenti operazioni:

GetPdI GetTypedPdI SearchPdI SearchTypedPdI

Tramite le operazioni GetPdI e GetTypedPdI è possibile monitorare lo stato di un PdI di cui si conosce l’identificativo ed ottenere l’elenco dei file conservati.

In assenza dell’IdPdI è comunque sempre possibile ottenere l’elenco dei PdI presenti sul sistema tramite le operazioni SearchPdI e SearchTypedPdI che restituisce un elenco paginato dei PdI caricati dall’utente. L’operazione accetta alcuni parametri di ricerca per ottenere un elenco mirato.

Le due OperationContract “Typed” ritornano DataContract tipicizzati mentri le altre due ritornano un DataContract generico con solo 4 dictionary contenenti i metadati tipici di ogni tipologia di documento.

4.4.1 Operazione: GetPdIConsente di recuperare le informazioni relative ad un PdI inviato dall’utente.



IdPdI intero Identificativo del PdI di cui si vuole recuperare lo stato.

DownloadFile booleano

Flag che indica se scaricare o meno il file mandato in conservazione.

Se il PdI risulta valida la risposta restituisce l’oggetto GetPdIOutputDC:





28


InfoPdI oggetto Contenitore per i dati del PdI indicato (Vedi Appendice B).


4.4.2 Operazione: GetTypedPdIConsente di recuperare le informazioni relative ad un PdI inviato dall’utente.



IdPdI intero Identificativo del PdI di cui si vuole recuperare lo stato.

DownloadFile booleano

Flag che indica se scaricare o meno il file mandato in conservazione.

Se il PdI risulta valida la risposta restituisce l’oggetto GetPdIOutputDC - GetTypedPdI:





InfoTypedPdI oggetto Contenitore per i dati del PdI indicato (Vedi Appendice B).


29


4.4.3 Operazione: SearchPdIConsente di recuperare le informazioni relative ad un PdI inviato dall’utente.

Parametri di input Tipo Descrizione


SearchExpression oggetto Contenitore per le clausole di ricerca (Vedi Appendice B).

OrderBy oggetto Contenitore per le clausole di ordinamento (Vedi Appendice B).

PageSize intero Dimensione della pagina di dati richiesta

PageNumber intero Numero della pagina di dati richiesta

Per avere la massima flessibilità nelle ricerche sono previsti un oggetto di ricerca e un oggetto di ordinamento generici (vedasi appendice B).

La ricerca restituisce sempre risultati paginati in modo da limitare il più possibile il rischio di incappare in timeout del servizio causati dal recupero di una grande quantità di dati. I parametri PageSize e PageNumber indicano rispettivamente il numero di record che si desidera ricevere come risultato per pagina mentre PageNumber indica il numero di pagina richiesto.

PageSize ammette valori compresi tra 1 e 10: è quindi possibile chiedere come risultato dell’espressione di ricerca da un minimo di 1 record ad un massimo di 10 (valori esterni a tale range saranno quindi ricondotti all’interno di esso: PageNumber < 1 verrà rivalorizzato a 1, PageNumber > 10 verrà rivalorizzato a 10).

PageNumber ammette valori a partire da 0: la paginazione parte da 1, inserendo il valore 0 viene restituito il numero di record totali (parametro di ritorno RecordCount) e l’ultimo record ricavato dall’espressione di ricerca (il valore PageSize impostato viene quindi ignorato).

ATTENZIONE: con PageNumber > 0 il valore RecordCount resituito assume valore massimo di 1000, ovvero nel caso in cui la ricerca restituisca (complessivamente) più di 1000 record RecordCount varrà sempre 1000 non fornendo quindi il valore corretto del numero di record totali restituiti dall’espressione di ricerca. Conferma di tale comportamento è il parametro di output PartialRecordCount (presente dalla versione 1.2.0 del servizio) che assume il valore booleano true.

Ad esempio quindi per ciclare su tutte le pagine che soddisfano una determinata espressione di ricerca occorre:

- chiamare SearchFE con PageNumber a 0 in modo da ottenere il numero totale di record (RecordCount);

- chiamare SearchFE col PageSize desiderato impostando PageNumber dal valore 1 a RecordCount / PageSize + RecordCount % PageSize.

30


I filtri di ricerca che utilizzano SearchExpression e OrderBy specificano di volta in volta i nomi dei campi (FieldName) utilizzabili nella ricerca o nell’ordinamento.

Questo approccio sacrifica la possibilità dell’utente di utilizzare l’intellisense per i parametri di ricerca ma riduce al minimo le modifiche necessarie ad introdurre nuovi campi. L’operazione controlla sempre che i campi specificati siano validi e la richiesta è rifiutata se in SearchExpression o OrderBy compaiono campi diversi da quelli elencati.

Per tutti i parametri di ricerca elencati è possibile specificare condizioni di ricerca in termini di valore del campo, campo compreso in intervalli specificati, ecc. Il tipo del campo indica il prefisso per gli operatori nelle clausole di ricerca.

All’atto della richiesta viene verificato che l’utente abbia specificato nelle clausole di ricerca e ordinamento solo campi accettati dall’operazione invocata. Se la richiesta è valida viene restituita una risposta con l’elenco dei PdI trovate nel formato:





ElencoInfoPdI elenco Elenco di oggetti InfoPdI (vedi sopra o in Appendice B)

PageSize intero Dimesione della pagina restituita.

PageCount intero Numero di pagine totali restituite dalla ricerca.

RecordCount intero Numero di record totali restituiti dalla ricerca.

PartialRecordCount booleano Flag che indica se il valore RecordCount corrisponda o meno al numero totale di record restituito dalla ricerca.


31


4.4.4 Operazione: SearchTypedPdIConsente di recuperare le informazioni relative ad un PdI inviato dall’utente.

Parametri di input Tipo Descrizione






Per avere la massima flessibilità nelle ricerche sono previsti un oggetto di ricerca e un oggetto di ordinamento generici (vedasi appendice B).

La ricerca restituisce sempre risultati paginati in modo da limitare il più possibile il rischio di incappare in timeout del servizio causati dal recupero di una grande quantità di dati. I parametri PageSize e PageNumber indicano rispettivamente il numero di record che si desidera ricevere come risultato per pagina mentre PageNumber indica il numero di pagina richiesto.

PageSize ammette valori compresi tra 1 e 10: è quindi possibile chiedere come risultato dell’espressione di ricerca da un minimo di 1 record ad un massimo di 10 (valori esterni a tale range saranno quindi ricondotti all’interno di esso: PageNumber < 1 verrà rivalorizzato a 1, PageNumber > 10 verrà rivalorizzato a 10).

PageNumber ammette valori a partire da 0: la paginazione parte da 1, inserendo il valore 0 viene restituito il numero di record totali (parametro di ritorno RecordCount) e l’ultimo record ricavato dall’espressione di ricerca (il valore PageSize impostato viene quindi ignorato).

ATTENZIONE: con PageNumber > 0 il valore RecordCount resituito assume valore massimo di 1000, ovvero nel caso in cui la ricerca restituisca (complessivamente) più di 1000 record RecordCount varrà sempre 1000 non fornendo quindi il valore corretto del numero di record totali restituiti dall’espressione di ricerca. Conferma di tale comportamento è il parametro di output PartialRecordCount (presente dalla versione 1.2.0 del servizio) che assume il valore booleano true.

Ad esempio quindi per ciclare su tutte le pagine che soddisfano una determinata espressione di ricerca occorre:

- chiamare SearchFE con PageNumber a 0 in modo da ottenere il numero totale di record (RecordCount);

- chiamare SearchFE col PageSize desiderato impostando PageNumber dal valore 1 a RecordCount / PageSize + RecordCount % PageSize.

32


I filtri di ricerca che utilizzano SearchExpression e OrderBy specificano di volta in volta i nomi dei campi (FieldName) utilizzabili nella ricerca o nell’ordinamento.

Questo approccio sacrifica la possibilità dell’utente di utilizzare l’intellisense per i parametri di ricerca ma riduce al minimo le modifiche necessarie ad introdurre nuovi campi. L’operazione controlla sempre che i campi specificati siano validi e la richiesta è rifiutata se in SearchExpression o OrderBy compaiono campi diversi da quelli elencati.

Per tutti i parametri di ricerca elencati è possibile specificare condizioni di ricerca in termini di valore del campo, campo compreso in intervalli specificati, ecc. Il tipo del campo indica il prefisso per gli operatori nelle clausole di ricerca.

I campi di ordinamento accettati:

Nome Descrizione

IdPdI Identificativo univoco della pubblicazione che contiene il messaggio restituito da SdI.

DateCreation È la data di creazione del PdI

IdStatus Identificativo dello stato corrente del PdI.

DateChangeStatus Data e ora in cui il PdI ha assunto lo stato corrente.

Si noti che non sono riportati i tipi dei campi accettati perché l’ordinamento è sempre formulato indicando se ascendente ASC o discendente DESC, è possibile specificare più campi di ordinamento nell’ordine desiderato con le stesse regole previste dall’SQL.

All’atto della richiesta viene verificato che l’utente abbia specificato nelle clausole di ricerca e ordinamento solo campi accettati dall’operazione invocata. Se la richiesta è valida viene restituita una risposta con l’elenco dei PdI trovate nel formato:





ElencoInfoPdI elenco Elenco di oggetti InfoPdI (vedi sopra o in Appendice B)

PageSize intero Dimesione della pagina restituita.

PageCount intero Numero di pagine totali restituite dalla ricerca.

33


RecordCount intero Numero di record totali restituiti dalla ricerca.

PartialRecordCount booleano Flag che indica se il valore RecordCount corrisponda o meno al numero totale di record restituito dalla ricerca.


34


5 Workflow del PdIWorkflow interno delle Fatture Elettroniche inviate alle PA

Il workflow attuale per la conservazione sostitutiva gestita dal servizio CCT è descritto dal seguente schema:

Si tratta di uno schema semplificato che per maggiore chiarezza non riporta alcune transizioni di stato che vengono eseguite assegnando al PdI uno stato specifico a fronte di eventi.

La tabella degli stati del workflow dei file da mandare in conservazione è il seguente:

Stati del workflow del PdI

IdStatus

StatusName Tipo Descrizione

4740 Redazione Persistente Editing manuale da parte dell’utente.

4741 Ricezione Transitorio

35

Appendice A


4742 Ricevuto. Transitorio

4743 Annullato Persistente

4744 Scartato Persistente

4745 Acquisito Transitorio

4746 Accodato su PdA Transitorio

4747 Conservato in PdA Persistente

4748 Decorrenza termini

Finale

Gli stati indicati come transitori sono quelli in cui il PdI può cambiare di stato a seguito di elaborazioni da parte del Servizio CCT senza l’intervento di utenti od operatori.

Gli stati persistenti sono quelli in cui il PdI permane a tempo indeterminato fino a che non intervengono un operatore o un utente.

Gli stati finali sono quelli in cui il PdI non può cambiare di stato.

36


6 Parametri di tipo oggettoRaccolta completa dei parametri di tipo oggetto

Questa appendice raccoglie le tabelle di tutti i parametri di tipo oggetto utilizzati nelle operazioni esposte dai servizi. Gli oggetti sono elencati nell’ordine in cui sono stati presentati nella documentazione.

6.1 ServiceInfoÈ la classe base utilizzata da tutti i metodi dei servizi per restituire informazioni sul servizio stesso ed eventuali info aggiuntive.

ServiceInfo: Tipo Descrizione


Info elenco Elenco di oggetti di tipo NameValue contenente eventuali informazioni aggiuntive a fronte di richieste opzionali dell’utente.

6.2 NameValueÈ la classe contenente le info aggiuntive che l’utente può inviare o ricevere ai/dai servizi: essendo in ServiceInfo è presente in tutte le risposte dei Web Services mentre per le richieste a è presente nella classe UserIdentity.

NameValue: Tipo Descrizione

Name stringa Nome dell’informazione aggiuntiva inviata/richiesta.

Value stringa Valore dell’informazione aggiuntiva inviata/richiesta.

37

Appendice B


6.3 BaseUserIdentityÈ la classe base contenente le informazioni legate all’identità dell’utente necessarie a tutte le richieste effettuate ai Web Services.

BaseUserIdentity: Tipo Descrizione

Username stringa nome utente (non importa se LowerCase oppure no).

Options elenco Elenco di oggetti di tipo NameValue contenente eventuali richieste opzionali dell’utente.

6.4 UserIdentityÈ la classe che aggiunge informazioni a BaseUserIdentity legate all’identità dell’utente necessarie a tutte le richieste effettuate ai Web Services.

Attualmente contiene solamente il valore del SecurityToken in più a BaseUserIdenty.

UserIdentity: Tipo Descrizione

SecurityToken stringa Nome utente (non importa se LowerCase oppure no).

6.5 BasicAuthenticationÈ il contenitore utilizzato per le informazioni richieste dall’autenticazione di base.

BasicAuthentication: Tipo Descrizione

UserName stringa nome utente (non importa se LowerCase oppure no)

Password stringa password

6.6 DigestAuthenticationÈ il contenitore utilizzato per le informazioni richieste dall’autenticazione fatta con l’algoritmo di hashing SHA1 come descritta nel capitolo dedicato.

DigestAuthentication: Tipo Descrizione

UserName stringa Nome utente (non importa se LowerCase oppure no).

Ticket stringa Ticket fornito dall’operazione GetTicket.

Digest stringa Calcolato con la formula indicata nel capitolo dedicato.

38


6.7 SoggettoProduttore, SoggettoTitolare, SoggettoOrigine, SoggettoDestinazione

È il contenitore per i dati relativi ai vari soggetti.

UploadPdI: Tipo Descrizione

IdPaese stringa(2) Codice del Paese nello standard ISO 3166 alpha-2.

PartitaIVA stringa(50) Partita IVA del soggetto (lunghezza massima 50 caratteri).

CodiceFiscale stringa Codice fiscale del soggetto.

Denominazione stringa Denominazione del soggetto.

Nome stringa Nome del soggetto.

Cognome stringa Cognome del soggetto.

6.8 DatiDocumentoÈ il contenitore dei dati relativi al documento da conservare

InfoPdI: Tipo Descrizione

IdTipoDocumento intero Tipo di documento da conservare.Parametro obbligatorio.

FileType enumeratore Tipo del file (valori elencati nell’Appendice C).Parametro obbligatorio.

HashType enumeratore Tipo del di hash del file (valori elencati nell’Appendice C).Parametro obbligatorio.

HashValue stringa Valore dell’hash del file.Parametro obbligatorio.

FileName stringa Nome del file.Parametro obbligatorio.

FileSize stringa Dimensione del file.Parametro obbligatorio.

FileContent file File del PdI.Parametro obbligatorio.

Esercizio intero Esercizio del file da conservare.Parametro obbligatorio nel caso in cui il file inviato non sia una notifica (IdTipoDocumento

39


1005).

DataOra1 oggetto Oggetto contenente valori opzionali da conservare.

Name stringa Etichetta del valore opzionale da conservare.

Value data-ora Valore opzionale da conservare.







Testo1 oggetto Oggetto contenente valori opzionali da conservare.


Value stringa Valore opzionale da conservare.







Intero1 oggetto Oggetto contenente valori opzionali da conservare.


Value intero Valore opzionale da conservare.


40







Decimale1 oggetto Oggetto contenente valori opzionali da conservare.


Value decimale Valore opzionale da conservare.







AdditionalStringParameters elenco chiave-valore

Attributi specifici (obbligatori o meno) relativi allo specifico tipo di documento da conservare.

AdditionalIntParameters elenco chiave-valore


AdditionalDateTimeParameters elenco chiave-valore


AdditionalDecimalParameters elenco chiave-valore


Di seguito gli IdTipoDocumenti ammessi e i relativi valori addizionali consentiti.

1001: FatturaPA emessa Tipo Descrizione

41


DataDocumento data-ora Data in cui è stato emesso il documento dal soggetto emittente.Parametro obbligatorio.

NumeroDocumento stringa Numero con cui è stato emesso il documento dal soggetto emittente.Parametro obbligatorio.

ChiaveAssociazione stringa Nome originario del file di fatturaPA inviato allo SDI.Parametro obbligatorio.

Sezionale stringa Numero, codice o descrizione del registro sezionale di appartenenza di un documento o di un registro IVA.

CodiceDestinatarioIPA stringa Riferimento univoco dell'ente pubblico a cui è destinata la fatturaPA.

IdentificativoSdI stringa Codice attribuito dallo SdI alla fattura PA.

1002: FatturaPA ricevuta Tipo Descrizione



NumeroRegistrazione stringa Numero attribuito alla registrazione contabile del documento.Parametro obbligatorio.

DataRegistrazione data-ora Data in cui è stata effettuata la registrazione contabile del documento.Parametro obbligatorio.


NumeroFatturaOrigine stringa Numero con cui il origine ha emesso il documento.

DataEmissioneOrigine data-ora Data in cui il origine ha emesso il documento.

NumeroProtocollo stringa Numero di protocollo informatico attribuito dall’ente pubblico.

DataProtocollo data-ora Data di protocollo informatico attribuito dall’ente pubblico.

1003: Lotto FatturaPA emesso

Tipo Descrizione

42





DataDocumento data-ora Data in cui è stato emesso il documento dal soggetto emittente.


1004: Lotto FatturaPA ricevuto

Tipo Descrizione


DataRegistrazione data-ora Data in cui è stata effettuata la registrazione contabile del documento.



NumeroProtocollo stringa Numero di protocollo informatico attribuito dall’ente pubblico.

DataProtocollo data-ora Data di protocollo informatico attribuito dall’ente pubblico.

1005: Notifica FatturaPA Tipo Descrizione


DataDocumento data-ora Data in cui è stato emesso il documento dal soggetto emittente.

43


2001: Fattura emessa Tipo Descrizione




2002: Nota di variazione emessa

Tipo Descrizione


Sezionale stringa umero, codice o descrizione del registro sezionale di appartenenza di un documento o di un registro IVA.


2003: Fattura ricevuta Tipo Descrizione


DataRegistrazione data-ora Data in cui è stata effettuata la registrazione contabile del documentoParametro obbligatorio.




44


2004: Nota di variazione ricevuta

Tipo Descrizione


DataRegistrazione data-ora Data in cui è stata effettuata la registrazione contabile del documentoParametro obbligatorio.




2005: DDT emesso Tipo Descrizione




2006: DTT ricevuto Tipo Descrizione

NumeroRegistrazione stringa Numero attribuito alla registrazione contabile del documento.





45


2007: Bolla emessa Tipo Descrizione


Sezionale stringa umero, codice o descrizione del registro sezionale di appartenenza di un documento o di un registro IVA.


2008: Bolla ricevuta Tipo Descrizione






2009: Libro giornale Tipo Descrizione

PaginaIniziale numero Numero della prima pagina di un registro o libro contabile.

PaginaFinale numero Numero dell'ultima pagina di un registro o libro contabile.

DataInizio data-ora Data di inizio del periodo di competenza di un registro o libro contabile.

DataFine data-ora Data di fine del periodo di competenza di un registro o libro contabile.

46


2010: Registro IVA Tipo Descrizione






Tipo stringa Tipo di registro o libro contabile (per es. per i registri iva: acquisti o vendite o corrispettivi).

2011: Libro Mastro Tipo Descrizione






2012: Libro cespiti Tipo Descrizione






47


2013: Giornale di magazzino

Tipo Descrizione






2014: Registro di Protocollo Informatico

Tipo Descrizione


CodiceIPA stringa Codice Identificativo Amministrazione Titolare

DenominazioneAmministrazione

stringa

CodiceAOO stringa Codice Identificativo Area Organizzativa Omogenea

ResponsabileRegistro stringa Cognome, Nome, Codice Fiscale

CodiceIdentificativoRegistro stringa Codice Identificativo del Registro

NumeroProgressivoRegistro stringa

DataCreazioneRegistro data-ora

NumeroPrimaRegistrazione stringa

NumeroUltimaRegistrazione stringa

DataPrimaRegistrazione data-ora

DataUltimaRegistrazione data-ora

48


2015: Libro inventari Tipo Descrizione

PaginaIniziale numero Numero della prima pagina.

PaginaFinale numero Numero dell'ultima pagina.

DataInizio data-ora Data di inizio del periodo di competenza.

DataFine data-ora Data di fine del periodo di competenza.

Tipo stringa Tipo di libro inventari.

49


6.9 PdIBaseÈ il data contract di base dal quale quelli specifici dei vari tipi di documento derivano.

PdIBase: Tipo Descrizione

HashType enumeratore Tipo del di hash del file (valori elencati nell’Appendice C).Parametro obbligatorio.

HashValue stringa Valore dell’hash del file.Parametro obbligatorio.

FileName stringa Nome del file.Parametro obbligatorio.

FileSize stringa Dimensione del file.Parametro obbligatorio.

FileContent file File del PdI.Parametro obbligatorio.

DataOra1 oggetto Campo custom contente una data definita dall’utente.

Name stringa Etichetta del campo custom definito dall’utente.

Value data-ora Valore del campo custom definito dall’utente.







Decimale1 oggetto Campo custom contente un valore decimale

50


definito dall’utente.


Value numero Valore del campo custom definito dall’utente.

Decimale2 oggetto Campo custom contente un valore decimale definito dall’utente.






Intero1 oggetto Campo custom contente un valore intero definito dall’utente.









51


Testo1 oggetto Campo custom contente un valore testuale definito dall’utente.













AdditionalDateTimeParameters elenco chiave-valore


AdditionalDecimalParameters elenco chiave-valore


6.10PdI1001È il data contract deputato all’upload di PdI con codice 1001 (FatturaPA emessa).

PdI1001 Tipo Descrizione

52


SoggettoDestinatario oggetto Soggetto a cui è destinato il documento: normalmente coincide con il SoggettoTitolare nel caso di documenti passivi o nel caso di documenti che non hanno una destinazione (Libri Giornali, Registri IVA, ecc.)Parametro obbligatorio.

PeriodoImposta intero Esercizio del file da conservare.Parametro obbligatorio.

DataEmissione data-ora Data di emissione della fattura.Parametro obbligatorio.

NumeroFattura stringa Numero della fattura.Parametro obbligatorio.

NomeFileOriginale stringa Nome originario del file di fatturaPA inviato allo SDI.Parametro obbligatorio.


CodiceIPA stringa Riferimento univoco dell'ente pubblico a cui è destinata la fatturaPA.

CodiceSdI stringa Codice attribuito dallo SdI alla fattura PA.

FileType enumerato Tipo del file (valori elencati nell’Appendice C).

6.11PdI1002È il data contract deputato all’upload di PdI con codice 1002 (FatturaPA ricevuta).


SoggettoFornitore oggetto Soggetto che ha originato il documento da conservare: normalmente coincide col SoggettoTitolare per i documenti attivi.




53



NumeroFatturaFornitore stringa Numero con cui l’origine ha emesso il documento.

DataEmissioneFornitore data-ora Data in cui l’origine ha emesso il documento.

NumeroProtocolloInformatico stringa Numero di protocollo informatico attribuito dall’ente pubblico.

DataProtocolloInformatico data-ora Data di protocollo informatico attribuito dall’ente pubblico.




6.12PdI1003È il data contract deputato all’upload di PdI con codice 1003 (Lotto FatturaPA emesso).


SoggettoDestinatario oggetto Soggetto a cui è destinato il documento: normalmente coincide con il SoggettoTitolare nel caso di documenti passivi o nel caso di documenti che non hanno una destinazione (Libri Giornali, Registri IVA, ecc.).Parametro obbligatorio.


DataEmissione data-ora Data di emissione del lotto.





54



55


6.13PdI1004È il data contract deputato all’upload di PdI con codice 1004 (Lotto FatturaPA ricevuto).











6.14PdI1005È il data contract deputato all’upload di PdI con codice 1005 (Lotto FatturaPA ricevuto).


SoggettoFornitore oggetto Soggetto che ha originato il documento da conservare: normalmente coincide col

56


SoggettoTitolare per i documenti attivi.

SoggettoDestinatario oggetto Soggetto a cui è destinato il documento: normalmente coincide con il SoggettoTitolare nel caso di documenti passivi o nel caso di documenti che non hanno una destinazione (Libri Giornali, Registri IVA, ecc.)


DataDocumento data-ora Data in cui è stato emesso il documento.


6.15PdI2001È il data contract deputato all’upload di PdI con codice 2001 (Fattura emessa).




DataEmissione data-ora Data di emissione della fattura.Parametro obbligatorio.

NumeroFattura stringa Numero della fatturaParametro obbligatorio.



6.16PdI2002È il data contract deputato all’upload di PdI con codice 2002 (Nota di variazione emessa).


57




DataEmissione data-ora Data di emissione del documento.Parametro obbligatorio.

NumeroNota stringa Numero della nota.Parametro obbligatorio.



6.17PdI2003È il data contract deputato all’upload di PdI con codice 2003 (Fattura ricevuta).









58



6.18PdI2004 È il data contract deputato all’upload di PdI con codice 2004 (Nota di variazione ricevuta).










59


6.19PdI2005È il data contract deputato all’upload di PdI con codice 2005 (DDT emesso).


SoggettoDestinatario oggetto Soggetto a cui è destinato il documento: normalmente coincide con il SoggettoTitolare nel caso di documenti passivi o nel caso di documenti che non hanno una destinazione (Libri Giornali, Registri IVA, ecc.).



NumeroDDT stringa Numero del DDT.Parametro obbligatorio.



6.20PdI2006È il data contract deputato all’upload di PdI con codice 2006 (DDT ricevuto).






NumeroDocumentoFornitore stringa Numero con cui l’origine ha emesso il documento.

60





6.21PdI2007È il data contract deputato all’upload di PdI con codice 2007 (Bolla emessa).





NumeroBolla stringa Numero della bolla.Parametro obbligatorio.



6.22PdI2008È il data contract deputato all’upload di PdI con codice 2008 (Bolla ricevuta).



PeriodoImposta intero Esercizio del file da conservare.

61


Parametro obbligatorio.







6.23PdI2009È il data contract deputato all’upload di PdI con codice 2009 (Libro giornale).








6.24PdI2010È il data contract deputato all’upload di PdI con codice 2010 (Registro IVA).



62







Tipo stringa Tipo di registro o libro contabile (per es. per i registri iva: acquisti o vendite o corrispettivi).Parametro obbligatorio.


6.25PdI2011È il data contract deputato all’upload di PdI con codice 2011 (Libro mastro).









63


64


6.26PdI2012È il data contract deputato all’upload di PdI con codice 2012 (Libro cespiti).

2012: Tipo Descrizione








6.27PdI2013È il data contract deputato all’upload di PdI con codice 2012 (Giornale di magazzino).









65


6.28PdI2014È il data contract deputato all’upload di PdI con codice 2014 (Registro di Protocollo Informatico).


AnnoRegistro intero Anno del registro.Parametro obbligatorio.


DenominazioneAmministrazione stringa











6.29PdI2015È il data contract deputato all’upload di PdI con codice 2015 (Libro inventari).






66





6.30PdI2016È il data contract deputato all’upload di PdI con codice 2016 (Bilancio d'esercizio).


EsercizioFiscale intero Esercizio del file da conservare.Parametro obbligatorio.

DenominazioneSoggetto stringa Soggetto a cui si riferisce il bilancio d’esercizio.

DescrizioneDocumento stringa Utile ad esempio per indicare che si tratta del file nota integrativa rispetto al file relazione sulla gestione, ecc.

DataTrasmissioneTelematica data-ora




6.31PdI2017È il data contract deputato all’upload di PdI con codice 2017 (Dichiarazioni Unico persone fisiche).



Contribuente stringa Soggetto a cui si riferisce a cui si riferisce la dichiarazione.

SostitutoImposta stringa

DataTrasmissione data-ora




67



6.32PdI2018È il data contract deputato all’upload di PdI con codice 2018 (Dichiarazioni Unico società di persone).










6.33PdI2019È il data contract deputato all’upload di PdI con codice 2019 (Dichiarazioni Unico società di capitali).









68



6.34PdI2020È il data contract deputato all’upload di PdI con codice 2020 (Dichiarazioni Unico enti non commerciali).










6.35PdI2021È il data contract deputato all’upload di PdI con codice 2021 (Allegati dichiarazioni modello Unico).






TipoAllegato stringa Tipo di libro inventari.


69


6.36PdI2022È il data contract deputato all’upload di PdI con codice 2022 (Dichiarazioni IRAP).







ProtocolloEntratelFisconline stringa


6.37PdI2023È il data contract deputato all’upload di PdI con codice 2023 (Dichiarazioni 730).










70


6.38PdI2024È il data contract deputato all’upload di PdI con codice 2024 (Allegati dichiarazioni 730).








6.39PdI2025È il data contract deputato all’upload di PdI con codice 2025 (Dichiarazioni 730 precompilato).










71


72


6.40PdI2026È il data contract deputato all’upload di PdI con codice 2026 (Allegati dichiarazioni 730 precompilato).








6.41PdI2027È il data contract deputato all’upload di PdI con codice 2027 (Dichiarazioni 730/4).








73


74


6.42PdI2028È il data contract deputato all’upload di PdI con codice 2028 (Dichiarazioni consolidato nazionale e mondiale).









6.43PdI2029È il data contract deputato all’upload di PdI con codice 2029 (Dichiarazioni IVA).









75


6.44PdI2030È il data contract deputato all’upload di PdI con codice 2030 (Comunicazione annuale dati IVA).









6.45PdI2031È il data contract deputato all’upload di PdI con codice 2031 (Prospetto delle liquidazioni periodiche dell'IVA).









76


6.46PdI2032È il data contract deputato all’upload di PdI con codice 2032 (Dichiarazioni IVA 74 bis).









6.47PdI2033È il data contract deputato all’upload di PdI con codice 2033 (Dichiarazioni IVA 26).







77


78


6.48PdI2034È il data contract deputato all’upload di PdI con codice 2034 (Dichiarazioni 770 semplificato).










6.49PdI2035È il data contract deputato all’upload di PdI con codice 2035 (Dichiarazioni 770 ordinario).










79


6.50PdI2036È il data contract deputato all’upload di PdI con codice 2036 (Certificaziona unica).










6.51PdI2037È il data contract deputato all’upload di PdI con codice 2037 (Incarico per addebito telematico).


Anno intero Esercizio del file da conservare.Parametro obbligatorio.

Contribuente stringa

DataIncaricoRevoca data-ora

Tipo stringa


80


81


6.52PdI2038È il data contract deputato all’upload di PdI con codice 2038 (Impegno alla trasmissione telematica).




DataImpegno data-ora

TipoImpegno stringa


6.53PdI2039È il data contract deputato all’upload di PdI con codice 2039 (Ricevute AE presentazioni telematiche).




DataRicevuta data-ora

TipoRicevuta stringa


6.54PdI2040È il data contract deputato all’upload di PdI con codice 2040 (Studi di settore).





82






6.55PdI2041È il data contract deputato all’upload di PdI con codice 2041 (Istanze di rimborso IRAP).






ModalitaTrasmissione stringa




6.56PdI2042È il data contract deputato all’upload di PdI con codice 2042 (Scheda destinazione 8 - 5 - 2 per mille).







Tipo stringa

83



6.57PdI2043È il data contract deputato all’upload di PdI con codice 2043 (Domanda iscrizione 5 per mille).



Ente stringa

TipoComunicazione stringa




6.58PdI2044È il data contract deputato all’upload di PdI con codice 2044 (Dichiarazione di intento).





Tipo stringa


6.59PdI2045È il data contract deputato all’upload di PdI con codice 2045 (Modelli F24).



DataVersamento data-ora

84



SezioniF24 stringa



Tipo stringa


6.60PdI2046È il data contract deputato all’upload di PdI con codice 2046 (Modelli F23).





CodiciTributo stringa



Tipo stringa


6.61PdI2047È il data contract deputato all’upload di PdI con codice 2047 (Comunicazione polivalente).


PeriodoRiferimentoAnno intero Esercizio del file da conservare.Parametro obbligatorio.

PeriodoRiferimentoMeseTrimestre stringa

DestinatarioComunicazione stringa

OrigineComunicazione stringa

Tipo stringa

85


TipologiaComunicazione stringa

FormatoComunicazione stringa




6.62PdI2048È il data contract deputato all’upload di PdI con codice 2048 (Dichiarazione dell'imposta di bollo (virtuale)).



PeriodoRiferimentoTrimestre stringa Parametro obbligatorio se non è valorizzato PeriodoRiferimentoMese.

PeriodoRiferimentoMese Parametro obbligatorio se non è valorizzato PeriodoRiferimentoTrimestre.

SoggettoObbligato stringa

SoggettoDelegato stringa

TipoModello stringa


ProtocolloServizioTelematicoDoganale stringa


86


87


6.63PdI2049È il data contract deputato all’upload di PdI con codice 2049 (Dichiarazione dell'imposta di bollo (virtuale)).



PeriodoRiferimentoData data-ora Parametro obbligatorio.

SoggettoDichiarazione stringa

TipoDichiarazione stringa

EstremiAutorizzazione stringa

AnnoRilascioAutorizzazione numero




6.64PdI2050È il data contract deputato all’upload di PdI con codice 2050 (Comunicazione modelli AA5/AA6).


AnnoRichiesta intero Esercizio del file da conservare.Parametro obbligatorio.

SoggettoImposta stringa

TipoRichiesta stringa




88


6.65PdI2051È il data contract deputato all’upload di PdI con codice 2051 (Comunicazione modelli AA7/AA9).


AnnoRichiesta intero Esercizio del file da conservare.Parametro obbligatorio.






6.66PdI2052È il data contract deputato all’upload di PdI con codice 2052 (Dichiarazione sostitutiva unica (DSU)).



DataSottoscrizioneDSU data-ora

Dichiarante_CognomeNome stringa

Dichiarante_CodiceFiscale stringa

Tipo stringa


89


90


6.67PdI2053È il data contract deputato all’upload di PdI con codice 2053 (Dichiarazione RED).



DataSottoscrizioneModelloRED data-ora

Pensionato_CognomeNome stringa

Pensionato_CodiceFiscale stringa


Tipo stringa


6.68PdI2054È il data contract deputato all’upload di PdI con codice 2054 (Dichiarazione modelli INV.CIV).



DataSottoscrizioneModello data-ora

Titolare _CognomeNome stringa

Titolare _CodiceFiscale stringa


Tipo stringa


91


6.69InfoPdIÈ il datacontract contenente le informazioni di un PdI restituito all’utente.


IdPdI intero Identificativo da utilizzare per referenziare il PdI nelle operazioni che lo richiedono.

DateCreation data-ora Data e ora in cui la pubblicazione che contiene il PdI è stata creata all’interno del Servizio CCT








IdTipoDocumento intero Identificativo del tipo di documento da conservare.


Esercizio intero Anno chiusura dell’esercizio.




DataOra2 oggetto Campo custom contente una data definita

92


dall’utente.
























93















AdditionalDateTimeParameters

elenco chiave-valore


AdditionalDecimalParameters

elenco chiave-valore


FileInfo oggetto File inviato per la conservazione.

IdStatus e StatusName sono rispettivamente l’identificativo interno e il nome dello stato del Workflow della Conservazione Sostitutiva in Cloud (Vedi Appendice A). TeamSystem si riserva di applicare eventuali variazioni al Workflow (aggiunta o rimozione di stati), tuttavia IdStatus è da considerarsi un valore fisso che identifica con certezza uno stato. StatusName è va invece considerato come una stringa mnemonica associata allo stato ed eventualmente oggetto di modifiche.

94


6.70InfoTypedPdIÈ il data contract di base contenente le informazioni di un PdI restituito all’utente dal quale quelli specifici dei vari tipi di documento derivano.


IdPdI intero Identificativo da utilizzare per referenziare il PdI nelle operazioni che lo richiedono.

DateCreation data-ora Data e ora in cui la pubblicazione che contiene il PdI è stata creata all’interno del Servizio CCT








IdTipoDocumento intero Identificativo del tipo di documento da conservare.







95


























96









FileInfo oggetto File inviato per la conservazione.

IdStatus e StatusName sono rispettivamente l’identificativo interno e il nome dello stato del Workflow della Conservazione Sostitutiva in Cloud (Vedi Appendice A). TeamSystem si riserva di applicare eventuali variazioni al Workflow (aggiunta o rimozione di stati), tuttavia IdStatus è da considerarsi un valore fisso che identifica con certezza uno stato. StatusName è va invece considerato come una stringa mnemonica associata allo stato ed eventualmente oggetto di modifiche.

6.71InfoPdI1001È il data contract contenente le informazioni di PdI con codice 1001 (FatturaPA emessa).

InfoPdI1001 Tipo Descrizione



DataEmissione data-ora Data di emissione della fattura.

NumeroFattura stringa Numero della fattura

NomeFileOriginale stringa Nome originario del file di fatturaPA inviato allo SDI.



97



6.72InfoPdI1002È il data contract contenente le informazioni di PdI con codice 1002 (FatturaPA ricevuta).













98


6.73InfoPdI1003È il data contract contenente le informazioni di PdI con codice 1003 (Lotto FatturaPA emesso).




DataEmissione data-ora Data di emissione del lotto.





6.74InfoPdI1004È il data contract contenente le informazioni di PdI con codice 1004 (Lotto FatturaPA ricevuto).








99




6.75InfoPdI1005È il data contract contenente le informazioni di PdI con codice 1005 (Lotto FatturaPA ricevuto).





DataDocumento data-ora Data in cui è stato emesso il documento.

6.76InfoPdI2001È il data contract contenente le informazioni di PdI con codice 2001 (Fattura emessa).




DataEmissione data-ora Data di emissione della fattura.

NumeroFattura stringa Numero della fattura


100


6.77InfoPdI2002È il data contract contenente le informazioni di PdI con codice 2002 (Nota di variazione emessa).




DataEmissione data-ora Data di emissione del documento.

NumeroNota stringa Numero della nota.


6.78InfoPdI2003È il data contract contenente le informazioni di PdI con codice 2003 (Fattura ricevuta).









101


6.79InfoPdI2004 È il data contract contenente le informazioni di PdI con codice 2004 (Nota di variazione ricevuta).









6.80InfoPdI2005È il data contract contenente le informazioni di PdI con codice 2005 (DDT emesso).




NumeroDDT stringa Numero del DDT.


102


6.81InfoPdI2006È il data contract contenente le informazioni di PdI con codice 2006 (DDT ricevuto).









6.82InfoPdI2007È il data contract contenente le informazioni di PdI con codice 2007 (Bolla emessa).




DataEmissione data-ora Data di emissione del documento.

NumeroBolla stringa Numero della bolla.


103


6.83InfoPdI2008È il data contract contenente le informazioni di PdI con codice 2008 (Bolla ricevuta).









6.84InfoPdI2009È il data contract contenente le informazioni di PdI con codice 2009 (Libro giornale).







104


6.85InfoPdI2010È il data contract contenente le informazioni di PdI con codice 2010 (Registro IVA).








Tipo stringa Tipo di registro o libro contabile (per es. per i registri iva: acquisti o vendite o corrispettivi).Parametro obbligatorio.

6.86InfoPdI2011È il data contract contenente le informazioni di PdI con codice 2011 (Libro mastro).








105


6.87InfoPdI2012È il data contract contenente le informazioni di PdI con codice 2012 (Libro cespiti).

2012: Tipo Descrizione







6.88InfoPdI2013È il data contract contenente le informazioni di PdI con codice 2012 (Giornale di magazzino).








106


6.89InfoPdI2014È il data contract contenente le informazioni di PdI con codice 2014 (Registro di Protocollo Informatico).


AnnoRegistro intero Anno del registro


DenominazioneAmministrazione

stringa










6.90InfoPdI2015È il data contract contenente le informazioni di PdI con codice 2015 (Libro inventari).






107




108


6.91InfoPdI2016È il data contract contenente le informazioni di PdI con codice 2016 (Bilancio d'esercizio).


EsercizioFiscale intero Esercizio del file da conservare.

DenominazioneSoggetto stringa Soggetto a cui si riferisce il bilancio d’esercizio.

DescrizioneDocumento stringa Utile ad esempio per indicare che si tratta del file nota integrativa rispetto al file relazione sulla gestione, ecc.

DataTrasmissioneTelematica data-ora



6.92InfoPdI2017È il data contract contenente le informazioni di PdI con codice 2017 (Dichiarazioni Unico persone fisiche).









109


6.93InfoPdI2018È il data contract contenente le informazioni di PdI con codice 2018 (Dichiarazioni Unico società di persone).









6.94InfoPdI2019È il data contract contenente le informazioni di PdI con codice 2019 (Dichiarazioni Unico società di capitali).









110


6.95InfoPdI2020È il data contract contenente le informazioni di PdI con codice 2020 (Dichiarazioni Unico enti non commerciali).









6.96InfoPdI2021È il data contract contenente le informazioni di PdI con codice 2021 (Allegati dichiarazioni modello Unico).







111


6.97InfoPdI2022È il data contract contenente le informazioni di PdI con codice 2022 (Dichiarazioni IRAP).








6.98InfoPdI2023È il data contract contenente le informazioni di PdI con codice 2023 (Dichiarazioni 730).









112


6.99InfoPdI2024È il data contract contenente le informazioni di PdI con codice 2024 (Allegati dichiarazioni 730).







6.100 InfoPdI2025È il data contract contenente le informazioni di PdI con codice 2025 (Dichiarazioni 730 precompilato).









113


6.101 InfoPdI2026È il data contract contenente le informazioni di PdI con codice 2026 (Allegati dichiarazioni 730 precompilato).







6.102 InfoPdI2027È il data contract contenente le informazioni di PdI con codice 2027 (Dichiarazioni 730/4).







6.103 InfoPdI2028È il data contract contenente le informazioni di PdI con codice 2028 (Dichiarazioni consolidato nazionale e mondiale).







114



6.104 InfoPdI2029È il data contract contenente le informazioni di PdI con codice 2029 (Dichiarazioni IVA).








6.105 InfoPdI2030È il data contract contenente le informazioni di PdI con codice 2030 (Comunicazione annuale dati IVA).








115


6.106 InfoPdI2031È il data contract contenente le informazioni di PdI con codice 2031 (Prospetto delle liquidazioni periodiche dell'IVA).








6.107 InfoPdI2032È il data contract contenente le informazioni di PdI con codice 2032 (Dichiarazioni IVA 74 bis).








6.108 InfoPdI2033È il data contract contenente le informazioni di PdI con codice 2033 (Dichiarazioni IVA 26).





116



6.109 InfoPdI2034È il data contract contenente le informazioni di PdI con codice 2034 (Dichiarazioni 770 semplificato).









6.110 InfoPdI2035È il data contract contenente le informazioni di PdI con codice 2035 (Dichiarazioni 770 ordinario).









117


6.111 InfoPdI2036È il data contract contenente le informazioni PdI con codice 2036 (Certificaziona unica).









6.112 InfoPdI2037È il data contract contenente le informazioni di PdI con codice 2037 (Incarico per addebito telematico).


Anno intero Esercizio del file da conservare.


DataIncaricoRevoca data-ora

Tipo stringa

6.113 InfoPdI2038È il data contract contenente le informazioni di PdI con codice 2038 (Impegno alla trasmissione telematica).




DataImpegno data-ora

TipoImpegno stringa

118


6.114 InfoPdI2039È il data contract contenente le informazioni di PdI con codice 2039 (Ricevute AE presentazioni telematiche).




DataRicevuta data-ora

TipoRicevuta stringa

6.115 InfoPdI2040È il data contract contenente le informazioni di PdI con codice 2040 (Studi di settore).








6.116 InfoPdI2041È il data contract contenente le informazioni di PdI con codice 2041 (Istanze di rimborso IRAP).








119



6.117 InfoPdI2042È il data contract contenente le informazioni di PdI con codice 2042 (Scheda destinazione 8 - 5 - 2 per mille).







Tipo stringa

6.118 InfoPdI2043È il data contract contenente le informazioni di PdI con codice 2043 (Domanda iscrizione 5 per mille).



Ente stringa

TipoComunicazione stringa



120


6.119 InfoPdI2044È il data contract contenente le informazioni di PdI con codice 2044 (Dichiarazione di intento).





Tipo stringa

6.120 InfoPdI2045È il data contract contenente le informazioni di PdI con codice 2045 (Modelli F24).





SezioniF24 stringa



Tipo stringa

6.121 InfoPdI2046È il data contract contenente le informazioni di PdI con codice 2046 (Modelli F23).





CodiciTributo stringa


121



Tipo stringa

6.122 InfoPdI2047È il data contract contenente le informazioni di PdI con codice 2047 (Comunicazione polivalente).


PeriodoRiferimentoAnno intero Esercizio del file da conservare.

PeriodoRiferimentoMeseTrimestre stringa

DestinatarioComunicazione stringa

OrigineComunicazione stringa

Tipo stringa

TipologiaComunicazione stringa

FormatoComunicazione stringa



6.123 InfoPdI2048È il data contract contenente le informazioni di PdI con codice 2048 (Dichiarazione dell'imposta di bollo (virtuale)).



PeriodoRiferimentoTrimestre stringa

PeriodoRiferimentoMese

SoggettoObbligato stringa

SoggettoDelegato stringa

TipoModello stringa


ProtocolloServizioTelematicoDoganale stringa

122


6.124 InfoPdI2049È il data contract contenente le informazioni di PdI con codice 2049 (Dichiarazione dell'imposta di bollo (virtuale)).



PeriodoRiferimentoData data-ora

SoggettoDichiarazione stringa


EstremiAutorizzazione stringa

AnnoRilascioAutorizzazione numero



6.125 InfoPdI2050È il data contract contenente le informazioni di PdI con codice 2050 (Comunicazione modelli AA5/AA6).


AnnoRichiesta intero Esercizio del file da conservare.


TipoRichiesta stringa



123


6.126 InfoPdI2051È il data contract contenente le informazioni di PdI con codice 2051 (Comunicazione modelli AA7/AA9).


AnnoRichiesta intero Esercizio del file da conservare.





6.127 InfoPdI2052È il data contract deputato all’upload di PdI con codice 2052 (Dichiarazione sostitutiva unica (DSU)).



DataSottoscrizioneDSU data-ora

Dichiarante_CognomeNome stringa

Dichiarante_CodiceFiscale stringa

Tipo stringa

6.128 InfoPdI2053È il data contract contenente le informazioni di PdI con codice 2053 (Dichiarazione RED).



DataSottoscrizioneModelloRED data-ora

Pensionato_CognomeNome stringa

Pensionato_CodiceFiscale stringa


124


Tipo stringa

6.129 InfoPdI2054È il data contract contenente le informazioni PdI con codice 2054 (Dichiarazione modelli INV.CIV).



DataSottoscrizioneModello data-ora

Titolare _CognomeNome stringa

Titolare _CodiceFiscale stringa


Tipo stringa

6.130 FileInfoFileInfo contiene i seguenti dati:

FileInfo: Tipo Descrizione

IdObject intero Identificativo univoco della pubblicazione che contiene il file.

IdDoc intero Identificativo univoco del file all’interno della pubblicazione.

FileType enumerato

Tipo del file (valori elencati nell’Appendice C).

FileName stringa Nome del file

FileDescr stringa Eventuale descrizione del file

FileSize intero Dimensione del file in byte

FileMD5 stringa Hashing MD5 del file

FileContent file Contenuto del file

125


6.131 SearchPdIData contract contenente l’espressione di ricerca dei PdI.

SearchPdI: Tipo Descrizione





Per avere la massima flessibilità nelle ricerche sono previsti un oggetto di ricerca e uno di ordinamento generici (vedasi appendice B).

I filtri di ricerca che utilizzano SearchExpression e OrderBy specificano di volta in volta i campi (Field): questo approccio sacrifica la possibilità dell’utente di utilizzare l’intellisense per i parametri di ricerca ma riduce al minimo le modifiche necessarie ad introdurre nuovi campi. L’operazione controlla sempre che i campi specificati siano validi.

I campi di ricerca accettati dall’operazione RicercaPdI sono:

Nome campo Nome campo Nome campo

Produttore.Nome DataProtocollo SoggettoImposta

Produttore.Cognome DataRegistrazione SoggettoObbligato

Produttore.Denominazione DataRicevuta SostitutoImposta

Produttore.IdPaese DataSottoscrizioneDSU Tipo

Produttore.PartitaIVA DataSottoscrizioneModello TipoAllegato

Produttore.CodiceFiscale DataSottoscrizioneModelloRED TipoComunicazione

Titolare.Nome DataTrasmissione TipoImpegno

Titolare.Cognome DataTrasmissioneTelematica TipologiaComunicazione

Titolare.Denominazione DataUltimaRegistrazione TipoModello

Titolare.IdPaese DataVersamento TipoRicevuta

Titolare.PartitaIVA DenominazioneAmministrazione TipoRichiesta

Titolare.CodiceFiscale DenominazioneSoggetto DateChangeStatus

Destinazione.Nome DescrizioneDocumento DateCreation

126


Destinazione.Cognome Descrizione IdStatus

Destinazione.Denominazione DestinatarioComunicazione StatusName

Destinazione.IdPaese Dichiarante_CodiceFiscale FileName

Destinazione.PartitaIVA Dichiarante_CognomeNome HashValue

Destinazione.CodiceFiscale Ente IdPdI

Destinatario.Nome EsercizioFiscale IdTipoDocumento

Destinatario.Cognome EstremiAutorizzazione NumeroAnniConservazione

Destinatario.Denominazione FormatoComunicazione IdProvenienza

Destinatario.IdPaese ModalitaTrasmissione Provenienza

Destinatario.PartitaIVA ChiaveAssociazione DataOra1.Name

Destinatario.CodiceFiscale NomeFileOriginale DataOra1.Value

Fornitore.Nome NumeroBolla DataOra2.Name

Fornitore.Cognome NumeroDDT DataOra2.Value

Fornitore.Denominazione NumeroDocumentoFornitore DataOra3.Name

Fornitore.IdPaese NumeroFattura DataOra3.Value

Fornitore.PartitaIVA NumeroFatturaFornitore Decimale1.Name

Fornitore.CodiceFiscale NumeroFatturaOrigine Decimale1.Value

Origine.Nome NumeroDocumento Decimale2.Name

Origine.Cognome NumeroNota Decimale2.Value

Origine.Denominazione NumeroPrimaRegistrazione Decimale3.Name

Origine.IdPaese NumeroRegistrazioneIniziale Decimale3.Value

Origine.PartitaIVA NumeroProgressivoRegistro Intero1.Name

Origine.CodiceFiscale NumeroProtocolloInformatico Intero1.Value

Anno NumeroRegistrazione Intero2.Name

AnnoRegistro NumeroUltimaRegistrazione Intero2.Value

AnnoRichiesta NumeroRegistrazioneFinale Intero3.Name

AnnoRilascioAutorizzazione OrigineComunicazione Intero3.Value

CodiceAOO PaginaFinale Testo1.Name

CodiceIdentificativoRegistro PaginaIniziale Testo1.Value

CodiceIPA Pensionato_CodiceFiscale Testo2.Name

127


CodiceDestinatarioIPA Pensionato_CognomeNome Testo2.Value

CodiceAmministrazioneTitolare PeriodoImposta Testo3.Name

CodiceSdI Esercizio Testo3.Value

IdentificativoSdI PeriodoRiferimentoAnno

CodiciTributo PeriodoRiferimentoData

Contribuente PeriodoRiferimentoMese

DataCreazioneRegistro PeriodoRiferimentoMeseTrimestre

DataDocumento PeriodoRiferimentoTrimestre

DataEmissione ProtocolloEntratelFisconline

DataEmissioneFornitore ProtocolloServizioTelematicoDoganale

DataEmissioneOrigine NumeroProtocollo

DataFine ResponsabileRegistro

DataImpegno Sezionale

DataIncaricoRevoca SezioniF24

DataInizio SoggettoConservazione

DataPrimaRegistrazione SoggettoDelegato

DataProtocolloInformatico SoggettoDichiarazione

Per tutti i parametri di ricerca elencati è possibile specificare condizioni di ricerca in termini di valore del campo, campo compreso in intervalli specificati, ecc.

Sarà possibile formulare espressioni di ricerca arbitrarie ma limitate ai soli campi di ricerca ammessi utilizzando i seguenti operatori:

IsNull IsNotNull AND OR NOTLessThan LessEqual Equal NotEqual GreaterEqualGreaterThan StringLike StringStartWith StringEndWith StringContains

Per i dettagli logici sul funzionamento e le modalità di composizione della stringa di ricerca si rimanda all’appendice B.

Per i dettagli implementativi si rimanda invece al codice dei progetti di esempio.

128


6.132 SearchExpressionData contract contenente l’espressione di ricerca.

SearchExpression: Tipo Descrizione

SearchClause oggetto Contenitore della clausola di ricerca: viene utilizzata la notazione prefissa per la definizione di operatore ed operandi

6.133 SearchClauseData contract contenente la clausola dell’espressione di ricerca.

SearchClause: Tipo Descrizione

Operator enumerato Operatore dell’espressione di ricerca (Vedi Appendice C)

Arguments elenco Elenco degli argomenti dell’espressione di ricerca.Vedi tabella sotto per la definizione.

6.134 ArgumentData contract contenente un argomento (tipo e valore) di una clausola di ricerca.

Argument: Tipo Descrizione

ArgType enumerato

Tipo del valore dell’operando (Vedi Appendice C)

ArgValue oggetto Valore dell’operando

6.135 OrderByData contract contenente i parametri di ordinamento per l’espressione di ricerca dei PdI.

OrderBy: Tipo Descrizione

OrderByClauses elenco Elenco di contenitori di tipo OrderByClause contenenti le clausole di ordinamento

OrderByClause: Tipo Descrizione

FieldName stringa Nome del campo sul quale effettuare l’ordinamento

129


Direction enumerato

Tipo del valore di ordinamento (Vedi Appendice C)

È possibile ordinare per i seguenti campi:

Nome Descrizione

IdPdI Identificativo univoco della pubblicazione che contiene il messaggio restituito da SdI.

DateCreation È la data di creazione del PdI

IdStatus Identificativo dello stato corrente del PdI.

DateChangeStatus Data e ora in cui il PdI ha assunto lo stato corrente.

Si noti che non sono riportati i tipi dei campi accettati perché l’ordinamento è sempre formulato indicando se ascendente ASC o discendente DESC, è possibile specificare più campi di ordinamento nell’ordine desiderato con le stesse regole previste dall’SQL.

6.136 SearchPdIOutputData contract contenente il risultato di ricerca dei PdI:

SearchPdIOutput: Tipo Descrizione

ElencoInfoPdI elenco Elenco di oggetti InfoPdI.

PageNumber intero Numero della pagina di dati restituita.

PageSize intero Dimensione della pagina di dati restituita.

PageCount intero Numero di pagine totali recuperate dalla ricerca.

RecordCount intero Numero di record totali recuperati dalla ricerca.

130

Appendice C


7 Valori enumeratiTabelle dei parametri che assumono valori enumerati

Questa appendice elenca i parametri che assumono valori enumerati la cui codifica è stabilita dal Servizio CCT.

7.1 PdIFileTypeIl parametro PdIFileType (restituito all’interno di FileInfo e DatiDocumento) indica l’estensione del file contenuto nelle pubblicazioni:

FileType: Descrizione

pdf Estensione .pdf

pdf_p7m Estensione .pdf.p7m

pdf_m7m Estensione .pdf.m7m

tiff Estensione .tiff

tiff_p7m Estensione .tiff.p7m

tiff_m7m Estensione .tiff.m7m

jpg Estensione .jpg

jpg_p7m Estensione .jpg.p7m

jpg_m7m Estensione .jpg.m7m

xml Estensione .xml

xml_p7m Estensione .xml.p7m

xml_m7m Estensione .xml.m7m

txt Estensione .txt

txt_p7m Estensione .txt.p7m

txt_m7m Estensione .txt.m7m

eml Estensione .eml

eml_p7m Estensione .eml.p7m

131


eml_m7m Estensione .eml.m7m

tif Estensione .tif

tif_p7m Estensione .tif.p7m

tif_m7m Estensione .tif.m7m

jpeg Estensione .jpeg

jpeg_p7m Estensione .jpeg.p7m

jpeg_m7m Estensione .jpeg.m7m

xbrl Estensione .xbrl

xbrl_p7m Estensione .xbrl.p7m

xbrl_m7m Estensione .xbrl.m7m

ccf Estensione .ccf

ccf_p7m Estensione .ccf.p7m

ccf_m7m Estensione .ccf.m7m

fcf Estensione .fcf

fcf_p7m Estensione .fcf.p7m

fcf_m7m Estensione .fcf.m7m

rcc Estensione .rcc

rcc_p7m Estensione .rcc.p7m

rcc_m7m Estensione .rcc.m7m

7.2 HashTypeIl parametro HashType (contenuto all’interno di DatiDocumento) indica l’algoritmo di calcolo dell’hash di un array di byte

Tipo documento PdI: Descrizione

SHA-256 Algoritmo di crittografazione SHA-256

7.3 OperatorIl parametro Operator indica l’operatore da applicare all’espressione di ricerca:

132


Operator: Descrizione

IsNull Verifica che l’operando sia null

IsNotNull Verifica che l’operando non sia null

AND Concatena gli operatori specificati con un operatore AND

OR Concatena gli operatori specificati con un operatore OR

NOT Verifica che l’operando non rispetti la condizione specificata

LessThan Verifica che il primo operando abbia valore inferiore del secondo

LessEqual Verifica che il primo operando abbia valore inferiore od uguale del secondo

Equal Verifica che il primo operando abbia valore uguale del secondo

NotEqual Verifica che il primo operando abbia valore diverso dal secondo

GreaterEqual Verifica che il primo operando abbia valore maggiore od uguale del secondo

GreaterThan Verifica che il primo operando abbia valore maggiore del secondo

StringLike Verifica che il primo operando (di tipo stringa) abbia valore uguale del secondo

StringStartWith Verifica che il primo operando (di tipo stringa) abbia valore che coincide con l’inizio della stringa specificata come secondo operando

StringEndWith Verifica che il primo operando (di tipo stringa) abbia valore che coincide con la fine della stringa specificata come secondo operando

StringContains Verifica che il primo operando (di tipo stringa) abbia valore contenuto nella stringa specificata come secondo operando

7.4 ArgTypeIl parametro ArgType indica il tipo di dato utilizzato nell’espressione di ricerca e può valere:

ArgType: Descrizione

InnerSearchClause Il valore del parametro di ricerca è un ulteriore clausola di ricerca nidificata

FieldName Il valore del parametro è una stringa contenente il nome del campo sul quale effettuare la ricerca

IntValue Il valore del parametro è di tipo intero

133


StringValue Il valore del parametro è di tipo stringa

BooleanValue Il valore del parametro è di tipo booleano

DoubleValue Il valore del parametro è di tipo double

DateTimeValue Il valore del parametro è di tipo data

7.5 DirectionIl parametro Direction indica il tipo di ordinamento da effettuare sul campo specificato:

134

Direction: Descrizione

ASC Ordinamento crescente

DESC Ordinamento decrescente


8 Elenco erroriElenco completo degli errori restituiti dai Web Services

In questo capitolo vengono riepilogati tutti gli errori che possono essere restituiti dai Web Services del Servizio di Fatturazione Elettronica alla PA di TeamSystem.

In caso di errore il servizio invia al client una risposta del tipo:

<s:Envelope xmlns:s=http://www.w3.org/2003/05/soap-envelope xmlns:a="http://www.w3.org/2005/08/addressing"> <s:Header> <a:Action s:mustUnderstand="1">http://www.w3.org/2005/08/addressing/soap/fault</a:Action> <a:RelatesTo>urn:uuid:0d6ce642-c65e-4c5b-9933-2e5f7d23ccd3</a:RelatesTo> </s:Header> <s:Body> <s:Fault> <s:Code> <s:Value>s:Sender</s:Value>

<s:SubCode> <s:Value>s:1</s:Value> </s:SubCode>

</s:Code> <s:Reason> <s:Text xml:lang="it-IT">Id errore: [Guid dell’eccezione] - Parametro obbligatorio: UserName</s:Text> </s:Reason> </s:Fault> </s:Body></s:Envelope>dove il nodo <s:Code> contiene il FaultCode standard SOAP 1.2 Sender o Receiver a seconda che l’errore sia stato causato dai dati inviati dall’utente oppure da un errore del server ed il sottonodo <s:SubCode> contiene il codice di errore specifico; il nodo <s:Reason> invece contiene la

135

Appendice C

http://www.w3.org/2003/05/soap-envelope


FaultReason, un messaggio composto dall’id univoco dell’eccezione (un guid) e la descrizione testuale dell’errore.

Nel caso in cui dal FaultCode e dalla descrizione della FaultReason non si capisca la causa dell’errore è possibile contattare il gestore del servizio facendo riferimento all’id dell’eccezione.

È possibile che in alcuni casi la risposta contenga anche ulteriori informazioni di dettaglio relative all’errore ma queste sono da considerarsi opzionali e non garantite per cui il client può limitarsi alla sola decodifica di FaultCode e FaultReason.

Gli errori sono suddivisi per categoria e la FaultReason indicata potrebbe essere oggetto di modifiche nel testo ma che non alterano il significato logico legato al FaultCode.

8.1 Errori nei dati della richiestaFaultCode FaultReason

401 Il parametro { nome parametro } è di tipo { tipo parametro } invece che { tipo parametro }

402 Il parametro { nome parametro } supera la lunghezza massima di { max valore } caratteri

403 Il parametro { nome parametro } deve avere lunghezza compresa tra { min valore }-{ max valore } caratteri

404 Il parametro { nome parametro } è obbligatorio

405 Il parametro { nome parametro } è obbligatorio e non può essere vuoto

406 Il parametro { nome parametro } è obbligatorio quando il parametro { altro parametro } è valorizzato

407 Il parametro { nome parametro } è obbligatorio quando il parametro { altro parametro } è valorizzato e vale { valore parametro }

408 Il parametro { nome parametro } è obbligatorio quando il parametro { altro parametro } è valorizzato e non vale { valore parametro }

409 Il parametro { nome parametro } è obbligatorio quando i parametri { altri parametri } non sono valorizzati

410 Il parametro { nome parametro } ha valore non compreso nel range { min valore }-{ max valore }

411 Il parametro { nome parametro } ha valore minore di { max valore }.

412 Il parametro { nome parametro } ha valore maggiore di { min valore }.

413 Il parametro { nome parametro } ha un valore di hash che non corrisponde a

136


quando settato nel parametro { altro parametro }

414 Il parametro { nome parametro } dichiara un'estensione file che non corrisponde al parametro { altro parametro }

415 Il parametro { nome parametro } ha una dimensione che non corrisponde a quanto settato nel parametro { altro parametro }

416 Il nome campo { nome parametro } non è tra quelli consentiti nell'espressione di ricerca

417 Il parametro { nome parametro } per la clausola con operatore {1} e argomenti {2} ha un numero di argomenti non valido in quanto {3}

418 Il parametro { nome parametro } per la clausola con operatore { nome operatore } ha un argomento che vale { valore parametro } ma è stato dichiarato di tipo { tipo parametro }

419 Il parametro { nome parametro } per la clausola con operatore { nome parametro } ha l'argomento di valore { valore parametro } di tipo { tipo parametro } che ammette solo una singola parola

420 Il parametro { nome parametro } non è tra quelli consentiti nell'espressione di ordinamento

421 Il parametro { nome parametro } per la clausola con ordinamento { tipo di ordinamento } ha il nome del campo che vale { valore parametro } ma che ammette solo una singola parola

422 Il parametro { nome parametro } è obbligatorio quando il parametro { altro parametro } vale { valore parametro }

423 Il parametro { nome parametro } deve essere nullo quando il parametro { altro parametro } vale { valore parametro }

424 Il parametro { nome parametro } contiene i valori { valori parametri } non validi quando il parametro { altro parametro } vale { valore altro parametro }

425 Il parametro { nome parametro } non contiene i valori { valori parametri } obbligatori quando il parametro { altro parametro } vale { valore altro parametro }

426 Il parametro FileName { valore parametro } non è valido per IdTipoDocumento { valore parametro }: deve essere nella forma { forma corretta nome file }

427 Il parametro ChiaveAssociazione { valore parametro } non è valido per IdTipoDocumento { valore parametro }: deve essere nella forma { valore parametro 2} e devono coincidere coi valori settati nel parametro FieldName { valore parametro 3}.

428 Il parametro { nome parametro } ammette valori { valori parametri } quando il parametro { altro parametro } vale { valore altri parametri }

137


429 Il parametro { nome parametro } ha valore non compreso tra i seguenti: { valori parametri }.

430 PdI non valido

8.2 Errori di sicurezzaFaultCode FaultReason

501 Accesso negatoErrore restituito quando la richiesta non presenta un SecurityToken valido.

502 Operazione non autorizzataErrore restituito quando l’utente, pur avendo fornito un SecurityToken valido non ha i permessi per eseguire l’operazione richiesta.

503 Username o password errati.

8.3 Errori in fase di elaborazioneFaultCode FaultReason

500 Errore inaspettato

504 Il parametro { nome parametro } non è valido

505 Il file con nome { nome file } ha dimesione pari a { valore parametro } bytes che supera la soglia massima di { max valore }

506 Tipo di hash non supportato: { valore parametro }

507 Tipo di file non supportato: { valore parametro }

508 File corrotto: { valore parametro }

509 Nessuna fattura o lotto associato alla notifica inviata: occorre prima inviare in conservazione la fattura/lotto

510 IdTipoDocumento { valore parametro } non valido

138

Documents

cs-test.teamsystem.comcs-test.teamsystem.com/.../doc/CS-WebServices-Specif… · Web viewWeb Services – Specifiche Tecniche 106 Versione 1.3.0 1 2 Novembre 2015 TeamSystem® Servizio