DeleteInvoice

<< Fare clic per visualizzazione il sommario >>

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

DeleteInvoice

Elimina un'Invoice nella piattaforma di pagamento Stripe.

 

Metodo

JamioPlug StripeConnect/DeleteInvoice

 

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

recipientReference

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

Reference

 

invoiceId

Identificativo dell'Invoice da eliminare.

String

 

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 le informazioni dell’Invoice eliminata.

Dataset

 

 

 

Commenti

L'eliminazione di un Invoice è consentita se essa è in stato "draft".

 

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 l’Invoice che si vuole eliminare non esiste in Stripe.

Errore

Se l’Invoice è in uno stato diverso da "draft".

 

Autorizzazioni

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