Visualizzare i dettagli di una fattura

La chiamata che dovrai fare per visualizzare i dettagli di una fattura:

  • GET https://endpoint/api/v1/invoices/invoiceId

Parametri url:

  • invoiceId: identifica la fattura di cui si vuole visualizzare i dati.

Parametri della richiesta:

  • apiKey: API KEY associate alla partita iva del mittente della fattura che si vuole inviare;
  • withFile: (valori ammessi: “true”, “false”, default: “true”) se “true” nella risposta sarà presente il campo “invoiceFileBase64” contenente il file fattura firmato codificato in base64;
  • withFileXml: (valori ammessi: “true”, “false”, default: “true”) se “true” nella risposta sarà presente il campo invoiceFileXmlBase64” contenente il file fattura xml non firmato codificato in base64;
  • withFilePdf: (valori ammessi: “true”, “false”, default: “false”) se “true” nella risposta sarà presente il campo invoiceFilePdfBase64” contenente il file fattura in formato PDF codificato in base64;

Formato risposta valida :

{
"data": {
    "invoiceId": 14, 
    "invoiceKind": "ricavo", 
    "invoiceType": "FPR12", 
    "invoiceStatus": 8,
    "invoiceStatusName": "Consegnata", 
    "invoiceFileName": "IT01234567890_00000.xml.p7m",
    "sender": {
         "description": "MARIO ROSSI",
         "countryCode": "IT",
         "vatCode": "01234567890",
         "fiscalCode": "01234567890"
   },
   "receiver": {
        "description": "LUIGI VERDI", 
        "countryCode": "IT", 
        "vatCode": "98765432109",
        "fiscalCode": null
   },
  "invoiceBody": { 
       "documentType": "TD04", 
       "date": "2019-02-05",
       "number": "1"
  },
  "invoiceSdiTransmissionDateTime": "2019-02-05T12:42:22.000000Z",
  "timestamp": "2019-02-05T13:24:59.000000Z",
  "invoiceFileBase64": "MIAGCSqGSIb3DQEHAq...AA==",
  "invoiceFileXmlBase64": "PD94bWwgdmVyc2lbj0...YT4=",
  "invoiceMetadataFileName": null, 
  "invoiceMetadataFileBase64": null, 
  "notifications": [
        {
        "notificationId": "456def", 
        "notificationKind": "RicevutaConsegna", 
        "invoiceId": "584agd",
        "timestamp": "2018-01-01 13:10:00"
        }
     ]
  }
}

Dove :

  • invoiceKind: assume il valore “costo” per le fatture ricevute, “ricavo” per le fatture inviate;
  • invoiceStatus: indica lo stato della fattura;
  • invoiceFileBase64: contenuto del file xml della fattura firmato come trasmesso/ricevuto all’SdI
  • invoiceFileXmlBase64: contenuto del file xml della fattura privo di firma in base 64;
  • invoiceFileName: è il nome del file xml come trasmesso all’SdI;
  • metadatiFileBase64: (solo per fatture di tipo costo) contenuto del file metadati come ricevuto dall’SdI in base 64
  • invoiceFileName: è il nome del file xml come trasmesso/ricevuto all’SdI;
  • invoiceSdiTransmissionDateTime: (solo per fatture di tipo ricavo) se presente, indicata la data di trasmissione del file al SdI.

Possibili errori:

Codice Messaggio
000 Errore generico.
001 Api key mancante.
002 Api key non valida.
003 Api key non ancora attiva
004 Api key scaduta.
005 Parametro richiesta mancante.
006 Parametro richiesta errato.
300 Fattura non trovata.

Si noti che l’invio della fattura al Sistema di Interscambio dopo essere stata trasmessa tramite le API potrebbe non essere immediato. Durante questa fase di “elaborazione” i campi invoiceFileName e invoiceFileBase64 assumeranno valore null.

In sandbox

La fattura non sarà firmata. Il campo invoiceFileName conterrà sempre il IT01589730629_BOZZA.xml e il contenuto di invoiceFileBase64 sarà sempre il file fattura come trasmesso dall’utente (privo di firma). Allo stesso modo il campo invoiceMetadataFileName conterrà sempre IT01589730629_BOZZA_MT_001.xml e invoiceMetadataFileBase64 un file metadati con firma non vera.
Al contrario, in produzione invoiceFileName conterrà il nome effettivo della fattura con estensione “.xml” per i file firmati in XAdES-BES o “.xml.p7m” per i file firmati in CAdES-BES. Il contenuto di invoiceFileBase64 sarà sempre il file fattura firmato. Allo stesso modo il campo invoiceMetadataFileName conterrà sempre il nome del file metadati come ricevuto dal SdI e invoiceMetadataFileBase64 un file metadati con firma firmato in XAdES-BES dal SdI.

Questa guida è stata utile?

0
Articoli Correlati