Visualizzare i dettagli di una notifica

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

  • GET https://endpoint/api/v1/notifications/notificationId

Parametri url:

  • notificationId: identifica la notifica 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;

Formato risposta valida :

{
"data": {
     "notificationId": "456def",
     "invoiceId": "123abc",
     "fileName": "IT01234567890_00000_RC_001.xml",
     "fileBase64": "5hcmlvQ29tbWl0dGVudGU+PERhdGlB...FncmFmaWNpPj",
     "messageKind": "RicevutaConsegna",
     "timestamp": "2018-01-01 13:00:01"
}
}

Dove:

  • notificationId: identifica univocamente la notifica (coincide con quello inviato nella richiesta);
  • invoiceId: identifica univocamente la fattura a cui si riferisce la notifica;
  • fileName: nome del file notifica come trasmesso dal sistema di interscambio;
  • fileBase64: contenuto della notifica codificata in base 64;
  • messageKind: dichiara la tipologia del messaggio;
  • timestamp: l’ora in cui è stata aggiunta la notifica al sistema Free Invoice.

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.
400 Notifica non trovata.

In sandbox

Il campo fileName conterrà sempre IT01589730629_BOZZA_RC_001.xml e il contenuto di
notificationFileBase64 sarà sempre un file notifica con firma non vera.

Questa guida è stata utile?

0
Articoli Correlati