API di piattaforma > JamioPlug > JamioPlug StripeConnect > InvoiceItem

Crea un InvoiceItem nella piattaforma di pagamento Stripe.

Metodo

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à che effettua il pagamento.	Reference
recipientReference	Collegamento all'identità o elemento organizzativo che riceve i pagamenti.	Reference
invoiceItemData	Dato strutturato contenente i dati dell'InvoiceItem. L'elenco dei parametri che possono essere inseriti è consultabile qui. Tra questi è obbligatorio il parametro customer che viene ricavato in automatico dalla customerReference. E' necessario indicare anche il valore del parametro price o, in alternativa, amount e currency per specificare l'importo da addebitare.	Dataset
invoiceItemMetadata	Dato strutturato contenente dati aggiuntivi utili a valorizzare i metadati dell’InvoiceItem. Non può contenere dati annidati o liste. Può contenere massimo 50 campi, con nomi di campo lunghi fino a 40 caratteri e valori di tipo stringa lunghi fino a 500 caratteri.	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 le informazioni dell'InvoiceItem creata.	Dataset

Commenti

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

Si sconsiglia di specificare l'Id del Customer nel parametro invoiceItemData, nel campo customer, poiché il metodo in automatico lo valorizza con l'Id ricavato dal collegamento specificato nel parametro customerReference. Nel caso siano entrambi valorizzati, prevale il parametro customerReference.

Per logiche del servizio di pagamento Stripe, può accadere che se non viene specificata alcuna Invoice nel parametro invoiceItemMetadata, l'InvoiceItem creato sarà inserito in automatico nella prima Invoice utile creata per il Customer specificato.

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.
Errore	Se non viene indicato il valore del parametro price o, in alternativa, amount e currency per specificare l'importo da addebitare nel parametro invoiceItemData.
Errore	Se il price indicato nel dato strutturato del parametro invoiceItemData è di tipo ricorrente o nullo.

Autorizzazioni

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

CreateInvoiceItem

CreateInvoiceItem