ListInvoices

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug StripeConnect > Invoice >

ListInvoices

Restituisce la lista di tutte le Invoice nella piattaforma di pagamento Stripe verso un recipentReference.

 

Metodo

PlugStripeConnect/ListInvoices

 

Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto).

String

Y

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

customerReference

Collegamento all'identità di cui si vuole ottenere la lista delle Invoice per il Recipient specificato nel parametro recipientReference.

Se non specificato, il metodo restituisce tutte le Invoice presenti su Stripe per il Recipient specificato nel parametro recipientReference per tutti i Customer.

Reference

Y

recipientReference

Collegamento all'identità o elemento organizzativo che riceve i pagamenti.

String

 

listData

Dato strutturato che permette di impostare filtri e paginazione sulle informazioni restituite dal metodo.

L'elenco dei parametri che è possibile specificare è riportato qui nella sezione Parameters. Se non specificato, i risultati verranno restituiti secondo la paginazione di default di Stripe indicata qui.

Dataset

Y

testMode

True se è richiesta l'esecuzione del metodo in modalità test di Stripe. Se non specificato, viene effettuata l'esecuzione del metodo in modalità live di Stripe.

La modalità testMode indicata deve essere ammessa dalla configurazione.

Boolean

Y

Output

 

Nome

Descrizione

Tipo

 

returnValue

Dato strutturato contenente la lista delle Invoice verso il recipientReference.

L'elenco delle proprietà degli elementi restituiti è riportato qui nella sezione Returns.

Dataset

 

 

Commenti

Il Customer, cui fa riferimento il parametro customerReference se valorizzato, deve essere associato al Recipient, cui fa riferimento il parametro recipientReference, nella modalità test prevista.

Le Invoice restituite sono ordinate per data di creazione, con l'ultima Invoice creata come primo elemento. Se la numerosità della lista di Invoice restituite dal metodo è alta, è opportuno impostare dei filtri tramite il parametro listData, in modo da agevolare l'elaborazione in un processo del dataset restituito dal metodo.

Il metodo si comporta come segue:

Restituisce

Condizione

Errore

Se testMode è valorizzato e non è presente, per l'identità o l'elemento organizzativo a cui fa riferimento RecipientReference, una configurazione che permette la chiamata nella modalità TestMode indicata.

Errore

Se customerReference non è associata al Recipient cui fa riferimento il parametro recipientReference.

Errore

Se customerReference è associata al Recipient cui fa riferimento il parametro recipientReference. ma il Customer non è presente in Stripe.

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla configurazione del Plug StripeConnect.