Lotti pacchetto api disponibili

Tramite api è possibile richiedere informazioni sul numero di lotti fattura consumati e quelli ancora disponibili.

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

GET https:// endpoint /api/v1/ stocks

Parametri della richiesta:

apiKey : API KEY associate alla partita iva del mittente della fattura che si vuole inviare;

Formato risposta valida:

{
” data ” : {
” type ” : ” M ” ,
” stocks ” : [
{
” validityBegin ” : ” 01/01/2019 ” ,
” validityExpiration ” : ” 31/12/2019 ” ,
” expired ” : true ,
” consumedOperationsByAccount ” : 50 ,
” operations ” : 1000 ,
” consumedOperationsByAllAccounts ” : 100 ,
” availableOperations ” : 900 ,
},
{
” validityBegin ” : ” 01/01/2020 ” ,
” validityExpiration ” : ” 31/12/2020 ” ,
” expired ” : false ,
” consumedOperationsByAccount ” : 0 ,
” operations ” : 1000 ,
” consumedOperationsByAllAccounts ” : 0 ,
” availableOperations ” : 1000 ,
}
]
}
}

Il valore type può assumere:

● M : se la chiamata viene effettuata da una api key “Master”;
● S : se la chiamata viene effettuata da una api key relativa a un sottoaccount.

Il numero di operazioni totali sarà disponibile solo per api key “Master”.

Dove stocks è una collezione di uno o più elementi (uno per ogni pacchetto api acquistato).

Dove:
● validityBegin : indica la data di inizio validità del pacchetto api;
● validityExpiration : indica la data di scadenza del pacchetto api;
● expired : indica se il pacchetto api è scaduto o meno;
● operations : (disponibile solo per api key Master) il numero di operazioni su fatture (invio/ricezione) del pacchetto;
● consumedOperationsByAccount : il numero di operazioni su fatture (invio/ricezione) del pacchetto utilizzate dall’api key richiedente;
● consumedOperationsByAllAccount : (disponibile solo per api key Master) il numero totale di operazioni su fatture invio/ricezione) del pacchetto utilizzate;
● availableOperations : il numero di operazioni su fatture (invio/ricezione) del pacchetto ancora disponibili;

Ad ogni richiesta di invio/ricezione fattura il valore “consumedOperationsByAccount” e “consumedOperationsByAllAccount” sarà decrementato di una unità. Sarà possibile continuare a inviare/ricevere fatture tramite api finchè esisterà almeno un pacchetto non scaduto e “availableOperations” maggiore di 0.

Questa guida è stata utile?

0
Articoli Correlati