DESCRIZIONE

Le seguenti API si aspettano in input un JSON con token generato all’atto della login e il relativo userId

(idMittente) proprietario del token stesso, restituito sempre dalla login

L’output è un JSON contenuto a sua volta in “d” come di seguito riportato:

{

“d”: “{<json>}”

}

Tutte le API ritornano in output un errCode ed un errMsg (valorizzato col dettaglio dell’errore)

Valori di errCode:

“0” Operazione completata con successo

“-1” Errore server -> http status code = 500

“-2” Errore Applicativo -> http status code = 404

“-3” Token scaduto -> http status code = 401

La lista completa delle Api è disponibile al link http://fattura.effatta.it/FatturePA/webservice/restapi.asmx

Descrizione delle API esposte

Login

API per login, passando in input username e password restituisce il token per successive API chiamate

• End point: https://<dominio>/webservice/RestAPI.asmx/login
• HTTP Method: POST

·       Input JSON:

{

username: “usertest@test.com“, password: “test123”,

source: “App_name”

}

·       Output JSON:

{

“d”: “{

\”token\”:

\”xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\”,

\”userId\”:

\”yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy\”,

\”email\”:\”usertest@test.com\”,

\”appTemplate\”:\”ESERCENTE\”,

\”qrCode\”:

{\ “qrCodeAgEnt\”:\”NO\”,

\”anag\”:

{

\”naz\”:\”IT\”,

\”cf\”:\”XXXYYYNNANNHNNNE\”,

\”piva\”:\”11111111111\”,

\”denom\”:\”USER TEST\”,

\”domFisc\”:

{

\”prov\”:\”NA\”,

\”cap\”:\”80121\”,

\”com\”:\”NAPOLI\”,

\”ind\”:\”via roma\”,

\”naz\”:\”IT\”

}

},

\”SDI\”:

{

\”cod\”:\”0000000\”,

\”pec\”:\usertest@pec.it\

}

}

}”

}

Dati Intestazione Utente

API chiamata per avere i dati relativi ad un utente identificato da dataUserId.

Usata per valorizzare l’itestazione del mittente o del destinatario di una fattura

• End point: https://<dominio>/webservice/RestAPI.asmx/getUserData
• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”,

dataUserId: “zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz”                                                                                          ß userId a cui si riferiscono i dati solitamente = idMittente

}

• Output JSON:

{

“d”: “[

{

\”Denominazione\”:\”MARIO ROSSI\”,

\”PartitaIVA\”:\”12345678901\”,

\”Indirizzo\”:\”via col Vento, 36 – NAPOLI (NA) – 80133 \”

}

]”

}

Lista Fatture di un Utente

API chiamata per avere la lista delle fatture relative ad un utente identificato da dataUserId.

Il campo Tipo restituito nella lista indica se la fattura è stata emessa/inviata (“I”) o ricevuta (“R”)

• End point: https://<dominio>/webservice/RestAPI.asmx/getUserDocuments
• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”,

dataUserId: “zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz”                                                                                          ß userId a cui si riferiscono i dati solitamente = idMittente

}

·       Output JSON:

{“d”:”[

{

\”Tipo\”:\”I\”,

\”IdFattura\”:\”105\”,

\”CurrentState\”:\”10\”,

\”StatoDocumento\”:\”Invio in corso…\”,

\”Denominazione\”:\”Universita\\u0027 Degli Studi Suor Orsola Benincasa di Napoli\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_DataDocumento\”:\”2015-12-30\”,

\”fgen_Numero\”:\”1\”,

\”fgen_ImportoTotaleDocumento\”:\”1.07\”,

\”fgen_Causale\”:\”\”

},

{

\”Tipo\”:\”I\”,

\”IdFattura\”:\”67\”,

\”CurrentState\”:\”10\”,

\”StatoDocumento\”:\”Invio in corso…\”,

\”Denominazione\”:\”A.Di.S.U. L\\u0027Orientale\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_DataDocumento\”:\”2015-09-30\”,

\”fgen_Numero\”:\”1\”,

\”fgen_ImportoTotaleDocumento\”:\”106.88\”,

\”fgen_Causale\”:\”\”

},

{

\”Tipo\”:\”R\”

,\”IdFattura\”:\”30533\”,

\”CurrentState\”:\”0\”,

\”StatoDocumento\”:\”Creazione\”,

\”Denominazione\”:\”\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_Numero\”:\”223\”,

\”fgen_ImportoTotaleDocumento\”:\”12.20\”,

\”fgen_Causale\”:\”test fattura\”

},

{

\”Tipo\”:\”I\”,

\”IdFattura\”:\”340\”,

\”CurrentState\”:\”0\”,

\”StatoDocumento\”:\”Creazione\”,

\”Denominazione\”:\”\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_DataDocumento\”:\”2018-01-11\”,

\”fgen_Numero\”:\”\”,

\”fgen_ImportoTotaleDocumento\”:\”0.00\”,

\”fgen_Causale\”:\”\”

},

{

\”Tipo\”:\”R\”,

\”IdFattura\”:\”10489\”,

\”CurrentState\”:\”10\”,

\”StatoDocumento\”:\”Invio in corso…\”,

\”Denominazione\”:\”\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_DataDocumento\”:\”2018-06-10\”,

\”fgen_Numero\”:\”1\”,

\”fgen_ImportoTotaleDocumento\”:\”394.34\”,

\”fgen_Causale\”:\”completa\”

},

{

\”Tipo\”:\”R\”,

,\”CurrentState\”:\”10\”,

\”StatoDocumento\”:\”Invio in corso…\”,

\”Denominazione\”:\”\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_DataDocumento\”:\”2018-06-10\”,

\”fgen_Numero\”:\”1\”,

\”fgen_ImportoTotaleDocumento\”:\”394.34\”,

\”fgen_Causale\”:\”completa\”

}

]”

}

Crea Fattura per Esercente/Professionista

API chiamata per emettere una nuova fattura per Esercente e/o Professionista

Richiede che l’utente registrato abbia impostato una fattura come modello dall’applicazione web

Il campo in input idDestinatario rappresenta:

• la mail nel caso di utente privato che dovrà ricevere la fattura
• il codice univoco della pubblica amministrazione nel caso di PA

in alternativa bisogna passare il campo qrCode che contiene il json letto dal qrCode rilasciato dall’Agenzia delle Entrate o dalla App stessa se l’utente è registrato alla piattaforma.

• End point: https://<dominio>/webservice/RestAPI.asmx/creaDocumento
• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”, idDestinatario: “g.perillo@effatta.it“, isPrivato: “1”,

modalitaPagamento:”MP01″, causale:”test fattura”,

{

“list”:    [

{

“numeroLinea”: “1”,

“descrizione”:”descrizione 1″, “quantita”:”1″, “prezzoUnitario”:”10.00″, “prezzoTotale”:”10.00″, “aliquotaIVA”:”22.00″

}

]

},

qrCode:

{

“anag”:

{ “naz”:”IT”,

“cf”: “XXXYYY78A31H931E”, “piva”:”05058331215″,

“denom”:”EFFATTA”,

“domFisc”:

{

“prov”:”CE”,

“cap”:”81054″,

“com”:”SAN PRISCO”,

“ind”:”VIA AGOSTINO STELLATO 78″, “naz”:”IT”

}

},

“dtGenQr”:”2018-07-05T1536:59.916+0200″, “SDI”:

{ “cod”:”0000000″,

“pec”:giuseppeciro.perillo@pec.it

}

}

}

·       Output JSON:

{

“d”:

“{

\”errCode\”:\”0\”,

\”errMsg\”:\”\”,

\”idFattura\”:\”xxxxx\”

}”

}

Calcola Totale Documento

API chiamata per calcolare il totale del documento da mostrare data una lista di prodotti in input.

L’API tiene conto del profilo fiscale dell’utente oltre che a eventuali Casse Previdenziali e/o Ritenute di

Acconto impostate nell’anagrafica dell’utente.

End point: https://<dominio>/webservice/RestAPI.asmx/calcolaTotaleDocumento

• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”,

idDestinatario: “demo@gmail.com“, “isPrivato”: “1”,

“prodList”:{

“list”: [

{

“quantita”:”1″, “prezzoUnitario”:”1000.00″

}

]

}

}

·       Output JSON:

{

“d”:

“{

\”TotaleDocumento\”:\”819.67\”,

\”CPA\”:\”0.00\”,

\”Imponibile\”:\”819.67\”,

\”IVA\”:\”180.33\”,

\”RA\”:\”0.00\”,

\”NettoAPagare\”:\”1000.00\”

}”

}

Get Ricevute Documento

API chiamata per estrarre la lista delle ricevute di un documento. Si riceve in output un JSON con la lista delle ricevute.

End point: https://<dominio>/webservice/RestAPI.asmx/getEsitoDocument

• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”, idFattura: “522”

}

·       Output JSON:

{

“d”: “

\”Stato_Documento\”:\”OK\”,

\“Lista_Esiti\”: [

{

\”Titolo\”:\”INVIO SDI\”,

\”Stato_Documento\”:\”OK\”,

\”Identificativo_SdI\”:\”1614054\”,

\”Nome_File\”:\”IT05058331215_000EI.xml.p7m\”,

\”Errore_SDI\”:\”Nessuno\”,

\”Descrizione_Esito_SdI\”:\”522 – Invio al Sistema di Intescambio avvenuto con successo\”,

\”Data_Ora_Ricezione_SdI\”:\”28/08/2018 15:18:27\”

},

{

\”Titolo\”:\”NOTIFICA MANCATA CONSEGNA\”,

\”Identificativo_SdI\”:\”1614054\”,

\”Nome_File\”:\”IT05058331215_000EI.xml.p7m\”,

\”Message_Id\”:\”5371527\”,

\”Data_Ora_Ricezione\”:\”28/08/2018 Ore 15:18:27\”,

\”Data_Ora_Consegna\”:\”\”,

\”Note\”:\”\”,

\”Descrizione\”:\”\”

}

]”

}

Crea Nota Credito

API chiamata per emettere una nuova Nota credito per Esercente e/o Professionista

Richiede che l’utente registrato abbia impostato una fattura come modello dall’applicazione web

Il campo in input idDestinatario rappresenta:

• la mail nel caso di utente privato che dovrà ricevere la fattura
• il codice univoco della pubblica amministrazione nel caso di PA

in alternativa bisogna passare il campo qrCode che contiene il json letto dal qrCode rilasciato dall’Agenzia delle Entrate o dalla App stessa se l’utente è registrato alla piattaforma.

• End point: https:// <dominio>/webservice/RestAPI.asmx/creaNotaCredito
• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”, idDestinatario: “g.perillo@effatta.it“, isPrivato: “1”,

modalitaPagamento:”MP01″, causale:”test fattura”, prodList:

{

“list”:    [

{

“numeroLinea”: “1”,

“descrizione”:”descrizione 1″, “quantita”:”1″, “prezzoUnitario”:”10.00″,

“prezzoTotale”:”10.00″, “aliquotaIVA”:”22.00″

}

]

},

qrCode:

{

“anag”:

{ “naz”:”IT”,

“cf”: “XXXYYY78A31H931E”, “piva”:”05058331215″,

“denom”:”EFFATTA”,

“domFisc”:

{

“prov”:”CE”,

“cap”:”81054″,

“com”:”SAN PRISCO”,

“ind”:”VIA AGOSTINO STELLATO 78″, “naz”:”IT”

}

},

“dtGenQr”:”2018-07-05T1536:59.916+0200″, “SDI”:

{ “cod”:”0000000″,

“pec”:giuseppeciro.perillo@pec.it

}

}

}

·       Output JSON:

{

“d”:

“{

\”errCode\”:\”0\”,

\”errMsg\”:\”\”,

\”idNotaCredito\”:\”xxxxx\”

}”

}

Crea Nota Credito Totale

API chiamata per emettere una nuova nota di credito relativa ad una intera fattura esistente

• End point: https://<dominio>/webservice/RestAPI.asmx/creaNotaCreditoTotale
• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy”, idFattura:”y”   <- id fattura per cui creare la nota di credito

}

·       Output JSON:

{

“d”:

“{

\”errCode\”:\”0\”,

\”errMsg\”:\”\”,

\”idNotaCredito\”:\”xxxxx\”

}”

}

Crea Documento Full

API chiamata per emettere una nuova fattura con possibilità di specificare arrotondamento e tipologia pagamento

• End point: https://<dominio>/webservice/RestAPI.asmx/creaDocumentoFullRound
• HTTP Method: POST

·       Input JSON:

{“token”:”xxxxxxxx”, “idMittente”:”yyyyyyyyyyy”, “arrotondamento”: “0.00”,

idDestinatario: ”,isPrivato: ‘1’,

causale:’round rit 1′,

numeroDocumento:’661 / 18′, dataDocumento:’20/01/2019′, importoBollo:’0.00′,

datiPagamento:{‘list’:[{condizioniPagamento:’TP02′,modalitaPagamento:’MP01′,dataRiferimentoTe rminiPagamento:”,giorniTerminiPagamento:’0′,dataScadenzaPagamento:”,importoPagamento:’0.0 0′,codUfficioPostale:”,cognomeQuietanzante:”,nomeQuietanzante:”,CFQuietanzante:”,titoloQuieta nzante:”,istitutoFinanziario:”,IBAN:”,ABI:”,CAB:”,BIC:”,scontoPagamentoAnticipato:”,dataLimitePag amentoAnticipato:”,penalitaPagamentiRitardati:”,dataDecorrenzaPenale:”,codicePagamento:”,Onl yCode:’1′}]},

attachmentName: ”attachmentName’, attachmentContent: “<BASE 64 FILE>”, prodList:{‘list’: [

{numeroLinea: ‘1’, descrizione:’1′, quantita:’1.00′, prezzoUnitario:’31.75′, prezzoTotale:’31.75′, aliquotaIVA:’22.00′},

{numeroLinea: ‘2’, quantita:’1.00′, prezzoUnitario:’10.20′,’prezzoTotale’:’10.20′, aliquotaIVA:’0.00′, Natura:’N1′, RiferimentoNormativa:”}

] },

qrCode: { ‘anag’: { naz:’IT’,cf: ”,

piva: ‘00000000000’,

denom: ‘xxxxxxxx’,

domFisc:{prov: ‘PA’,cap: ‘90135’,com: ‘PALERMO’,ind: ‘VIA xxx‘,naz:’IT’}},dtGenQr:”, SDI:{cod: ‘UF5D7W’,pec:”}}

}

·       Output JSON:

{

“d”: “{

\”errCode\”:\”0\”,

\”errMsg\”:\”\”,

\”idDocumento\”:\”6190\”,

\”fileContent\”:\”<BASE 64 FILE>\”,

\”fileName\”:\”IT12345678901_004RY.xml\”,

\”numeroDocumento\”:\”661 / 18\”,

\”docInfo\”:{\”idDocumento\”:\”6190\”,

\”Tipo\”:\”I\”,\”CurrentState\”:\”10\”,

\”StatoDocumento\”:\”Invio in corso…\”,

\”Denominazione\”:\”xxxxxxxx\”,

\”fgen_TipoDocumento\”:\”TD01\”,

\”fgen_DataDocumento\”:\”2019-01-20\”,

\”fgen_Numero\”:\”661 / 18\”,

\”fgen_ImportoTotaleDocumento\”:\”130.00\”,

\”fgen_Causale\”:\”round rit 1\”}}”

}

Send XML

API chiamata per emettere una nuova fattura da XML

• End point: https://<dominio>/webservice/RestAPI.asmx/sendXML
• HTTP Method: POST

·       Input JSON:

{

token: “xxxxxxxxxxx”, idMittente: “yyyyyyyyyyyyyyyy”,

“dataUserId”:”zzzzzzzzzzzzzzzzzzzz”, “nomeFile”:”IT12345678901_2zzz.xml”, “base64File”:”<BASE 64 FILE>”

}

·       Output JSON:

{

“errCode” = “0”,

“errMsg” = “”,

idDocumento = “12345”

}