Documentazione
accountsubscriber accountsubscriber
  • accountId
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
accountsubscription accountsubscription
  • bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
boardingtrialsubscription boardingtrialsubscription
  • accountId
    bigint
     
  • couponCodes
    array
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • currency
    string
     
  • expireDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • lastNotifiedOn
    timestamp
     
  • bigint
     
  • selectedComponents
    array
     
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponentquantity subscriptionproductcomponentquantity
  • id
    bigint
    A unique identifier for the object.
  • quantity
    bigint
     
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
account account
  • active
    boolean
    Se questo conto e tutti i suoi conti padre sono attivi.
  • activeOrRestrictedActive
    boolean
    Se questo conto e tutti i suoi conti padre sono attivi o limitati.
  • createdBy
    bigint
    LID dellutente da cui è stato creato laccount.
  • createdOn
    timestamp
    La data e lora di creazione dellaccount.
  • deletedBy
    bigint
    LID di un utente da cui è stato eliminato laccount.
  • deletedOn
    timestamp
    La data e lora in cui laccount è stato eliminato.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La data e lora dellultima modifica delloggetto.
  • name
    string
    Il nome utilizzato per identificare il conto.
  • bigint
    Laccount padre responsabile dellamministrazione di questo account.
  • restrictedActive
    boolean
    Se questo conto e tutti i suoi conti padre sono attivi o attivi con restrizioni. Esiste almeno un conto attivo limitato.
  • scope
    bigint
    Lambito a cui appartiene il conto.
  • state
    string
    Lo stato attuale delloggetto.
  • subaccountLimit
    bigint
    Il numero di sottoconti che possono essere creati allinterno di questo conto.
  • type
    string
    Il tipo di conto che definisce il suo ruolo e le sue capacità.
failurereason failurereason
  • category
    string
     
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
labeldescriptor labeldescriptor
  • category
    string
    La categoria delletichetta.
  • description
    map
    La descrizione localizzata delloggetto.
  • bigint
    Il gruppo a cui appartiene questa etichetta.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
  • weight
    int
    Quando si elencano le etichette, queste possono essere ordinate in base a questo numero.
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
  • weight
    int
    Quando si elencano i gruppi di etichette, questi possono essere ordinati in base a questo numero.
space space
  • bigint
    Laccount a cui appartiene lo spazio.
  • active
    boolean
    Se questo spazio e tutti i suoi conti padre sono attivi.
  • activeOrRestrictedActive
    boolean
    Se questo spazio e tutti i suoi conti padre sono attivi o limitati.
  • createdBy
    bigint
    LID dellutente che ha creato lo spazio.
  • createdOn
    timestamp
    La data e lora di creazione dello spazio.
  • deletedBy
    bigint
    LID dellutente che ha cancellato lo spazio.
  • deletedOn
    timestamp
    La data e lora in cui lo spazio è stato eliminato.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La data e lora dellultima modifica delloggetto.
  • name
    string
    Il nome utilizzato per identificare lo spazio.
  • postalAddress
    struct
    Lindirizzo che viene utilizzato nelle comunicazioni con i clienti, ad esempio nelle e-mail, nei documenti, ecc.
  • postalAddress.city
    string
     
  • postalAddress.country
    string
     
  • postalAddress.dependentLocality
    string
     
  • postalAddress.emailAddress
    string
     
  • postalAddress.familyName
    string
     
  • postalAddress.givenName
    string
     
  • postalAddress.mobilePhoneNumber
    string
     
  • postalAddress.organizationName
    string
     
  • postalAddress.phoneNumber
    string
     
  • postalAddress.postalState
    string
     
  • postalAddress.postcode
    string
     
  • postalAddress.salesTaxNumber
    string
     
  • postalAddress.salutation
    string
     
  • postalAddress.sortingCode
    string
     
  • postalAddress.street
    string
     
  • primaryCurrency
    string
    La valuta utilizzata per visualizzare gli importi aggregati nello spazio.
  • requestLimit
    bigint
    Il numero massimo di richieste API accettate entro due minuti. Questo limite può essere modificato solo con privilegi speciali.
  • restrictedActive
    boolean
    Se questo spazio e tutti i suoi conti padre sono attivi o attivi con restrizioni. Cè almeno un conto padre che è attivo con restrizioni.
  • state
    string
    Lo stato attuale delloggetto.
  • technicalContactAddresses
    array
    Lindirizzo e-mail che riceverà i messaggi relativi ai problemi tecnici e agli errori che si verificano nello spazio.
  • timeZone
    string
    Il fuso orario utilizzato per pianificare ed eseguire i processi in background. Questo non influisce sulla formattazione delle date nellinterfaccia utente.
spacereference spacereference
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
legalorganizationform legalorganizationform
  • country
    string
    Il codice di due lettere del Paese in cui viene utilizzato il modulo di organizzazione legale (formato ISO 3166-1 alpha-2).
  • description
    array
    Le descrizioni localizzate della forma organizzativa legale.
  • englishDescription
    string
    Il nome inglese della forma giuridica dellorganizzazione.
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
    Le scorciatoie localizzate del modulo di organizzazione legale.
customer customer
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • customerId
    string
    LID del cliente nel sistema dellesercente.
  • emailAddress
    string
    Lindirizzo e-mail del cliente.
  • familyName
    string
    Il cognome o la famiglia del cliente.
  • givenName
    string
    Il nome o il cognome del cliente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sulloggetto.
  • preferredCurrency
    string
    La valuta preferita dal cliente.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
customeraddress customeraddress
  • address
    struct
    Lindirizzo postale effettivo.
  • address.city
    string
     
  • address.commercialRegisterNumber
    string
     
  • address.country
    string
     
  • address.dateOfBirth
    date
     
  • address.dependentLocality
    string
     
  • address.emailAddress
    string
     
  • address.familyName
    string
     
  • address.gender
    string
     
  • address.givenName
    string
     
  • bigint
     
  • address.mobilePhoneNumber
    string
     
  • address.organizationName
    string
     
  • address.phoneNumber
    string
     
  • address.postalState
    string
     
  • address.postcode
    string
     
  • address.salesTaxNumber
    string
     
  • address.salutation
    string
     
  • address.socialSecurityNumber
    string
     
  • address.sortingCode
    string
     
  • address.street
    string
     
  • addressType
    string
    Se lindirizzo è per la fatturazione, per la spedizione o per entrambi.
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • bigint
    Il cliente a cui appartiene loggetto.
  • defaultAddress
    boolean
    Se questo è lindirizzo predefinito del cliente.
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
taxclass taxclass
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome della classe fiscale viene utilizzato internamente per identificare la classe fiscale nelle interfacce amministrative. Ad esempio viene utilizzato nei campi di ricerca e deve quindi essere distinto e descrittivo.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
charge charge
  • createdOn
    timestamp
    Data in cui sono state registrate le spese.
  • bigint
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • spaceViewId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • bigint
     
  • type
    string
     
  • userFailureMessage
    string
    Il messaggio d’errore spiega all’utente finale il motivo per cui l’addebito non è andato a buon fine. Il messaggio d’errore viene lanciato soltanto se l’addebito non è andato a buon fine.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
chargeattempt chargeattempt
  • bigint
     
  • completionBehavior
    string
     
  • bigint
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • customersPresence
    string
    La presenza del cliente indica quale tipo di interazione con il cliente è stata utilizzata durante il tentativo di addebito.
  • environment
    string
     
  • failedOn
    timestamp
     
  • bigint
     
  • id
    bigint
    A unique identifier for the object.
  • initializingTokenVersion
    boolean
     
  • bigint
     
  • language
    string
    The language that is linked to the object.
  • bigint
     
  • nextUpdateOn
    timestamp
     
  • redirectionUrl
    string
     
  • bigint
     
  • spaceViewId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • succeededOn
    timestamp
     
  • bigint
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • userFailureMessage
    string
    Inserire un messaggio da mostrare al cliente in caso di transazione fallita. Il messaggio viene localizzato in base alla lingua selezionata.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
saleschannel saleschannel
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
  • bigint
     
  • sortOrder
    int
     
connectorinvocation connectorinvocation
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • stage
    string
     
  • timeTookInMilliseconds
    bigint
     
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
paymentconnector paymentconnector
  • dataCollectionType
    string
     
  • deprecated
    boolean
     
  • deprecationReason
    map
     
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
  • bigint
     
  • bigint
     
  • primaryRiskTaker
    string
     
  • bigint
     
  • supportedCurrencies
    array
     
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Questa proprietà indica se il connettore può essere utilizzato al momento per elaborare la transazione. Se non sono attivi né i metodi di pagamento assegnati né la configurazione del connettore assegnata, il gestore non viene utilizzato anche se attivo.
  • bigint
     
  • enabledSalesChannels
    array
    Definisce i canali di vendita per i quali la configurazione del connettore è abilitata. Se linsieme è vuoto, la configurazione del connettore è abilitata per tutti i canali di vendita.
  • enabledSpaceViews
    array
    La configurazione del connettore è attiva solo per determinate visualizzazioni degli spazi. Lasciando in bianco queste impostazioni, la configurazione viene attivata per tutti gli spazi.
  • id
    bigint
    A unique identifier for the object.
  • imagePath
    string
     
  • name
    string
    Il nome della configurazione del connettore viene utilizzato internamente per identificare la configurazione nelle interfacce amministrative, ad esempio nei campi di ricerca, e deve quindi essere chiaro e descrittivo.
  • bigint
     
  • priority
    int
    La priorità definisce la sequenza delle configurazioni del connettore. Tanto più basso è il valore, maggiore è la priorità. Tale valore può essere anche un numero negativo se si aggiungono ulteriori configurazioni con priorità alta e se non si desidera modificare i valori di tutte le configurazioni esistenti.
  • bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
paymentcontract paymentcontract
  • bigint
     
  • activatedOn
    timestamp
     
  • contractIdentifier
    string
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • externalId
    string
    Un nonce generato dal client che identifica lentità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece lentità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La data e lora dellultima modifica delloggetto.
  • rejectedOn
    timestamp
     
  • bigint
     
  • startTerminatingOn
    timestamp
     
  • state
    string
    Lo stato attuale delloggetto.
  • terminatedOn
    timestamp
     
paymentmethod paymentmethod
  • dataCollectionTypes
    array
     
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    Il nome localizzato delloggetto.
  • supportedCurrencies
    array
     
paymentmethodbrand paymentmethodbrand
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
  • bigint
     
paymentmethodconfiguration paymentmethodconfiguration

La configurazione della modalità di pagamento rappresenta il requisito necessario per collegare un gestore a una configurazione concreta.

La configurazione della modalità di pagamento rappresenta il requisito necessario per collegare un gestore a una configurazione concreta.
  • dataCollectionType
    string
    La tipologia di registrazione dei dati determina chi raccoglie le informazioni sui pagamenti. Questo può avvenire da parte del gestore (offsite) oppure tramite la nostra applicazione (onsite).
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome della configurazione del tipo di pagamento viene utilizzato internamente per identificare la configurazione del tipo di pagamento. Il nome sarà usato, ad esempio, nei campi di ricerca, quindi dovrebbe risultare chiaro e descrittivo.
  • oneClickPaymentMode
    string
    Quando l’acquirente inserisce i dettagli di pagamento nella pagina dei pagamenti, questi possono essere automaticamente salvati, in modo tale da poterli riutilizzare in un secondo momento per altri pagamenti. Se la transazione contiene già un token, questa opzione non ha alcuna importanza.
  • bigint
     
  • resolvedDescription
    map
    La descrizione risolta si rifà alla descrizione che è stata definita o, laddove non definita, alla descrizione standard.
  • resolvedTitle
    map
    Il titolo risolto si rifà al titolo che è stato definito o, laddove non definito, al titolo standard.
  • sortOrder
    int
    La sequenza delle modalità di pagamento definisce l’ordine in cui tali modalità vengono visualizzate dal cliente durante il processo di pagamento.
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
paymentprocessor paymentprocessor
  • companyName
    map
     
  • description
    map
    La descrizione localizzata delloggetto.
  • headquartersLocation
    map
     
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
  • productName
    map
     
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    La configurazione è gestita dallapplicazione e non può essere modificata tramite linterfaccia utente.
  • contractId
    bigint
    Il contratto collega la configurazione del gestore del pagamento con il relativo contratto di elaborazione dei pagamenti.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome delle configurazioni del gestore viene utilizzato internamente per identificare una specifica configurazione del gestore. Il nome sarà usato, ad esempio, nei campi di ricerca, quindi dovrebbe risultare chiaro e descrittivo.
  • bigint
    Un gestore è responsabile dell’elaborazione dei pagamenti (Payment Service Provider) nell’applicazione. Per ogni gestore è possibile impostare più configurazioni a scopi diversi.
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
refund refund

Un accredito rappresenta un rimborso a favore del cliente. Questo può essere effettuato dal commerciante o dal cliente (charge back).

Un accredito rappresenta un rimborso a favore del cliente. Questo può essere effettuato dal commerciante o dal cliente (charge back).
  • amount
    decimal
     
  • baseLineItems
    array
     
  • bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • environment
    string
     
  • externalId
    string
    L’ID esterno aiuta a identificare le chiamate ripetute al servizio accrediti. Per questo l’ID esterno dovrebbe essere unico per ogni transazione.
  • failedOn
    timestamp
     
  • bigint
     
  • id
    bigint
    A unique identifier for the object.
  • labels
    array
     
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • merchantReference
    string
     
  • nextUpdateOn
    timestamp
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • reducedLineItems
    array
     
  • reductions
    array
     
  • state
    string
    Lo stato attuale delloggetto.
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    Il totale delle tasse applicate è la somma di tutte le tasse che sono state applicate finora.
  • totalSettledAmount
    decimal
    Limporto totale liquidato è limporto totale che è stato liquidato finora.
  • bigint
     
  • type
    string
     
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
paymentterminal paymentterminal
  • defaultCurrency
    string
     
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    Lidentificatore identifica in modo univoco il terminale. Normalmente è visibile sul dispositivo o sul display del dispositivo.
  • name
    string
    Il nome del terminale viene utilizzato internamente per identificare il terminale nelle interfacce amministrative. Ad esempio, viene utilizzato nei campi di ricerca e quindi dovrebbe essere distinto e descrittivo.
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
paymentterminaltype paymentterminaltype
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
token token
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • customerEmailAddress
    string
    L’indirizzo e-mail del cliente coincide con l’indirizzo e-mail dell’acquirente.
  • customerId
    string
    L’ID cliente serve a identificare il cliente all’interno del sistema del commerciante. Nel caso in cui venga fornito un ID cliente, questo deve coincidere con l’ID cliente presente nella transazione. L’ID cliente non viene impostato o modificato automaticamente. L’ID cliente deve essere impostato dal sistema del commerciante.
  • enabledForOneClickPayment
    boolean
    Se il token per i pagamenti one-click è attivo, allora l’acquirente può utilizzarlo per pagare sulla pagina dei pagamenti. L’utilizzo del token riduce il numero di passaggi che l’acquirente deve completare. L’acquirente viene collegato alla transazione e al token tramite ID cliente. Per far sì che i pagamenti one-click funzionino, anche la modalità di pagamento deve risultare configurata per consentire i pagamenti one-click.
  • externalId
    string
    Un nonce generato dal client che identifica lentità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece lentità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • state
    string
    Lo stato attuale delloggetto.
  • timeZone
    string
    Il fuso orario indica il fuso orario in cui si trova il cliente. Esso incide sulla formattazione della data nella comunicazione con il cliente.
  • tokenReference
    string
    Utilizzare una descrizione dettagliata. Sarà utile per ritrovare il token (ad es. ID utente, indirizzo e-mail).
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
transaction transaction
  • acceptHeader
    string
     
  • acceptLanguageHeader
    string
    L’Accepted Language Header contiene la preferenza linguistica espressa dall’utente.
  • allowedPaymentMethodBrands
    array
     
  • allowedPaymentMethodConfigurations
    array
     
  • authorizationAmount
    decimal
     
  • authorizationEnvironment
    string
    L’ambiente in cui questa transazione è stata autorizzata con successo.
  • bigint
    Il canale di vendita attraverso il quale è stata effettuata la transazione.
  • authorizationTimeoutOn
    timestamp
    Questo è il time out che viene utilizzato quando viene autorizzata la transazione. Questo time out può cambiare nel tempo.
  • authorizedOn
    timestamp
     
  • autoConfirmationEnabled
    boolean
    Se la conferma automatica è attiva, la transazione viene automaticamente confermata, laddove richiesto dal processo. Se la conferma automatica è disattivata, occorre confermare la transazione manualmente.
  • billingAddress
    struct
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • chargeRetryEnabled
    boolean
    Se l’addebito al cliente non va a buon fine, possiamo riprovare. Ciò implica il reindirizzamento del cliente alla pagina dei pagamenti, dove questi può provare nuovamente a effettuare il pagamento. Il secondo tentativo è previsto per impostazione predefinita.
  • completedAmount
    decimal
    Limporto completato è limporto totale acquisito finora.
  • completedOn
    timestamp
     
  • completionBehavior
    string
    Il comportamento di completamento controlla quando la transazione viene completata.
  • completionTimeoutOn
    timestamp
     
  • confirmedBy
    bigint
     
  • confirmedOn
    timestamp
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • currency
    string
     
  • customerEmailAddress
    string
    L’indirizzo e-mail del cliente viene utilizzato quando non si hanno a disposizione né l’indirizzo e-mail per la consegna né quello per la fatturazione.
  • customerId
    string
     
  • customersPresence
    string
    La presenza del cliente indica il tipo di metodo di autenticazione utilizzato durante lautorizzazione della transazione. Se non viene fornito alcun valore, per impostazione predefinita viene utilizzato 'Virtualmente presente'.
  • deliveryDecisionMadeOn
    timestamp
    La data di decisione sulla consegna indica quando è stata presa la decisione in merito alla consegna.
  • deviceSessionIdentifier
    string
    L’ID sessione del dispositivo collega la transazione con l’ID sessione definito nell’URL del JavaScript. Questo consente il collegamento dei dati del dispositivo con la transazione.
  • emailsDisabled
    boolean
    Flag che indica se linvio di email è disabilitato per questa particolare transazione. Il valore predefinito è false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    La strategia di scelta dell’ambiente definisce il modo in cui viene selezionato l’ambiente (test o live).
  • failedOn
    timestamp
     
  • failedUrl
    string
    Se non è stato possibile autorizzare o completare una transazione, l’utente viene reindirizzato al failed URL. Se non è specificato alcun failed URL, viene visualizzato un failed URL standard.
  • bigint
    La motivazione dell’errore indica la causa per cui la transazione non è andata a buon fine. Tale motivazione viene lanciata soltanto se la transazione non è andata a buon fine.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    L’indirizzo Internet Protocol (IP) identifica il dispositivo dell’acquirente.
  • internetProtocolAddressCountry
    string
     
  • invoiceMerchantReference
    string
     
  • javaEnabled
    boolean
     
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • merchantReference
    string
     
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sulloggetto.
  • bigint
     
  • bigint
     
  • processingOn
    timestamp
     
  • refundedAmount
    decimal
    L’importo accreditato rappresenta il totale di tutti gli accrediti.
  • screenColorDepth
    string
     
  • screenHeight
    string
     
  • screenWidth
    string
     
  • shippingAddress
    struct
     
  • shippingAddress.city
    string
     
  • shippingAddress.commercialRegisterNumber
    string
     
  • shippingAddress.country
    string
     
  • shippingAddress.dateOfBirth
    date
     
  • shippingAddress.dependentLocality
    string
     
  • shippingAddress.emailAddress
    string
     
  • shippingAddress.familyName
    string
     
  • shippingAddress.gender
    string
     
  • shippingAddress.givenName
    string
     
  • bigint
     
  • shippingAddress.mobilePhoneNumber
    string
     
  • shippingAddress.organizationName
    string
     
  • shippingAddress.phoneNumber
    string
     
  • shippingAddress.postalState
    string
     
  • shippingAddress.postcode
    string
     
  • shippingAddress.salesTaxNumber
    string
     
  • shippingAddress.salutation
    string
     
  • shippingAddress.socialSecurityNumber
    string
     
  • shippingAddress.sortingCode
    string
     
  • shippingAddress.street
    string
     
  • shippingMethod
    string
     
  • spaceViewId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • successUrl
    string
    L’utente viene reindirizzato al success URL non appena la transazione viene autorizzata o completata. Se non è specificato alcun success URL, viene visualizzato un success URL standard.
  • bigint
    Il terminale su cui il pagamento è stato elaborato.
  • timeZone
    string
    Il fuso orario indica il fuso orario in cui si trova il cliente. Esso incide sulla formattazione della data nella comunicazione con il cliente.
  • bigint
     
  • tokenizationMode
    string
    La modalità di tokenizzazione controlla se e come la tokenizzazione delle informazioni di pagamento viene applicata alla transazione.
  • totalAppliedFees
    decimal
    Il totale delle tasse applicate è la somma di tutte le tasse che sono state applicate finora.
  • totalSettledAmount
    decimal
    Limporto totale liquidato è limporto totale che è stato liquidato finora.
  • userAgentHeader
    string
    Lo User Agent Header fornisce informazioni sul browser utilizzato dall’acquirente.
  • userFailureMessage
    string
    Il messaggio d’errore spiega all’utente finale il motivo per cui la transazione non è andata a buon fine. Il messaggio d’errore viene lanciato soltanto se la transazione non è andata a buon fine.
  • userInterfaceType
    string
    Il tipo di interfaccia utente definisce il modo in cui è stata creata e/o elaborata la transazione.
  • windowHeight
    string
     
  • windowWidth
    string
     
  • yearsToKeep
    int
    Il numero di anni in cui la transazione sarà conservata dopo essere stata autorizzata.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
transactioncompletion transactioncompletion
  • amount
    decimal
    Limporto che viene catturato. Limporto rappresenta la somma degli elementi pubblicitari, tasse incluse.
  • baseLineItems
    array
    Gli elementi pubblicitari di base su cui viene applicato il completamento.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • externalId
    string
    LID esterno aiuta a identificare lentità e una successiva creazione di unentità con lo stesso ID non creerà una nuova entità.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • invoiceMerchantReference
    string
     
  • labels
    array
     
  • language
    string
    The language that is linked to the object.
  • lastCompletion
    boolean
    Indica se questo è lultimo completamento. Dopo la creazione dellultimo completamento, la transazione non può più essere completata.
  • lineItems
    array
    Gli elementi pubblicitari acquisiti.
  • bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • statementDescriptor
    string
    Il descrittore dellestratto conto spiega gli addebiti o i pagamenti sugli estratti conto bancari.
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    La somma totale di tutte le tasse degli elementi pubblicitari.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
transactioninvoice transactioninvoice

La fattura della transazione rappresenta il documento di una transazione.

La fattura della transazione rappresenta il documento di una transazione.
  • amount
    decimal
     
  • billingAddress
    struct
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • bigint
     
  • createdOn
    timestamp
    Data in cui è stata creata la fattura.
  • derecognizedBy
    bigint
    Lid dellutente che ha segnato la fattura come non riconosciuta.
  • derecognizedOn
    timestamp
    La data in cui la fattura è contrassegnata come stornata.
  • dueOn
    timestamp
    Data in cui deve essere pagata la fattura.
  • environment
    string
     
  • externalId
    string
    LID esterno aiuta a identificare lentità e una successiva creazione di unentità con lo stesso ID non creerà una nuova entità.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • bigint
     
  • merchantReference
    string
     
  • outstandingAmount
    decimal
    L’importo in sospeso indica quanto il cliente deve al commerciante. Un importo negativo significa che il cliente ha pagato troppo.
  • paidOn
    timestamp
    La data in cui la fattura è stata contrassegnata come saldata. È possibile che questa data sia precedente alla data di pagamento attuale.
  • spaceViewId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
wallettype wallettype
  • description
    map
    La descrizione localizzata delloggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato delloggetto.
subscriptionaffiliate subscriptionaffiliate
  • externalId
    string
    Un nonce generato dal client che identifica lentità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece lentità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sulloggetto.
  • name
    string
     
  • reference
    string
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscription subscription
  • activatedOn
    timestamp
     
  • bigint
     
  • createdOn
    timestamp
     
  • bigint
     
  • description
    string
     
  • id
    bigint
    A unique identifier for the object.
  • initializedOn
    timestamp
     
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
     
  • reference
    string
     
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • terminatedBy
    bigint
     
  • terminatedOn
    timestamp
     
  • terminatingOn
    timestamp
     
  • terminationScheduledOn
    timestamp
     
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptioncomponentconfiguration subscriptioncomponentconfiguration
  • bigint
     
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionperiodbill subscriptionperiodbill
  • createdOn
    timestamp
     
  • effectivePeriodEndDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • periodStartDate
    timestamp
     
  • plannedPeriodEndDate
    timestamp
     
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionperiodbillitem subscriptionperiodbillitem
  • bigint
     
  • fee
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionversion subscriptionversion
  • activatedOn
    timestamp
     
  • billingCurrency
    string
    Labbonato viene addebitato nella valuta di fatturazione. La valuta di fatturazione deve essere una delle valute abilitate sul prodotto di abbonamento.
  • createdOn
    timestamp
     
  • expectedLastPeriodEnd
    timestamp
    La fine prevista dellultimo periodo è la data in cui si trova la data di fine prevista dellultimo periodo. Questa è solo una proiezione e come tale la data effettiva può essere diversa.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
     
  • bigint
     
  • selectedComponents
    array
     
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • terminatedOn
    timestamp
     
  • terminatingOn
    timestamp
     
  • terminationIssuedOn
    timestamp
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptioncharge subscriptioncharge

Il costo dellabbonamento rappresenta un unico addebito effettuato per un particolare abbonamento.

Il costo dellabbonamento rappresenta un unico addebito effettuato per un particolare abbonamento.
  • createdOn
    timestamp
     
  • discardedBy
    bigint
     
  • discardedOn
    timestamp
     
  • externalId
    string
    Un nonce generato dal client che identifica lentità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece lentità creata inizialmente.
  • failedOn
    timestamp
     
  • failedUrl
    string
    Se non è stato possibile autorizzare o completare una transazione, l’utente viene reindirizzato al failed URL. Se non è specificato alcun failed URL, viene visualizzato un failed URL standard.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • ledgerEntries
    array
     
  • plannedExecutionDate
    timestamp
     
  • processingType
    string
     
  • reference
    string
     
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
    Il campo abbonamento indica labbonamento a cui appartiene laddebito.
  • succeedOn
    timestamp
     
  • successUrl
    string
    L’utente viene reindirizzato al success URL non appena la transazione viene autorizzata o completata. Se non è specificato alcun success URL, viene visualizzato un success URL standard.
  • bigint
     
  • type
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionledgerentry subscriptionledgerentry

La voce del libro mastro degli abbonamenti rappresenta un singolo cambiamento sul saldo dellabbonamento.

La voce del libro mastro degli abbonamenti rappresenta un singolo cambiamento sul saldo dellabbonamento.
  • aggregatedTaxRate
    decimal
     
  • amountExcludingTax
    decimal
     
  • amountIncludingTax
    decimal
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La data e lora di creazione delloggetto.
  • discountIncludingTax
    decimal
     
  • externalId
    string
    Un nonce generato dal client che identifica lentità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece lentità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
     
  • state
    string
    Lo stato attuale delloggetto.
  • bigint
     
  • taxAmount
    decimal
     
  • taxes
    array
     
  • title
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
coupon coupon

I coupon sono un modo per concedere sconti sugli abbonamenti. Crea un nuovo coupon, configuralo con sconti e regole e poi condividilo con i tuoi clienti.

I coupon sono un modo per concedere sconti sugli abbonamenti. Crea un nuovo coupon, configuralo con sconti e regole e poi condividilo con i tuoi clienti.
  • createdBy
    bigint
    Il campo creato da indica lutente che ha creato il coupon.
  • createdOn
    timestamp
     
  • deletedBy
    bigint
    Il campo cancellato da indica lutente che ha cancellato il coupon.
  • deletedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome del coupon è usato solo per la gestione del coupon e non è mai mostrato allabbonato. Potrai dare a questo coupon una descrizione o un nome più dettagliato durante la configurazione del coupon in seguito.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
couponversion couponversion

La versione del coupon contiene un sottoinsieme delle proprietà del coupon che può cambiare nel tempo, ma solo una versione può essere attiva allo stesso tempo.

La versione del coupon contiene un sottoinsieme delle proprietà del coupon che può cambiare nel tempo, ma solo una versione può essere attiva allo stesso tempo.
  • activatedBy
    bigint
    Il campo attivato da indica lutente che ha attivato la versione del coupon.
  • activatedOn
    timestamp
     
  • bigint
    Il coupon a cui è collegata la versione del coupon.
  • createdBy
    bigint
    Il campo creato da indica lutente che ha creato la versione del coupon.
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Un nome significativo o una breve descrizione per comunicare lintento del coupon. Questo è ciò che labbonato vedrà sulla sua fattura o quando riscatterà il codice del coupon.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • obsoletedBy
    bigint
    Il campo obsoleto da indica lutente che ha obsoleto la versione del coupon.
  • obsoletedOn
    timestamp
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
abstractproductfee abstractproductfee
  • bigint
     
  • description
    struct
    La descrizione di una tariffa di un componente descrive la tariffa per labbonato. La descrizione può essere mostrata nei documenti o su alcune interfacce utente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome della tassa dovrebbe descrivere per labbonato in poche parole a cosa serve la tassa.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • type
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
productmeteredfee productmeteredfee
  • bigint
     
  • description
    struct
    La descrizione di una tariffa di un componente descrive la tariffa per labbonato. La descrizione può essere mostrata nei documenti o su alcune interfacce utente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • bigint
     
  • name
    struct
    Il nome della tassa dovrebbe descrivere per labbonato in poche parole a cosa serve la tassa.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • tierPricing
    string
    Il prezzo dei livelli determina il metodo di calcolo dei livelli. I prezzi dei diversi livelli possono essere applicati in modi diversi. Il tier pricing controlla questo calcolo.
  • type
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
productperiodfee productperiodfee
  • bigint
     
  • description
    struct
    La descrizione di una tariffa di un componente descrive la tariffa per labbonato. La descrizione può essere mostrata nei documenti o su alcune interfacce utente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntryTitle
    struct
    Il titolo della voce del libro mastro sarà usato per il titolo nella voce del libro mastro e nella fattura.
  • ledgerEntryTitle.availableLanguages
    array
     
  • ledgerEntryTitle.displayName
    string
     
  • ledgerEntryTitle.items
    array
     
  • name
    struct
    Il nome della tassa dovrebbe descrivere per labbonato in poche parole a cosa serve la tassa.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfFreeTrialPeriods
    int
    Il numero di periodi di prova gratuiti specifica quanti periodi sono gratuiti allinizio dellabbonamento.
  • periodFee
    array
    La tassa di periodo viene addebitata per ogni periodo dellabbonamento, ad eccezione dei periodi di prova.
  • type
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
productsetupfee productsetupfee
  • bigint
     
  • description
    struct
    La descrizione di una tariffa di un componente descrive la tariffa per labbonato. La descrizione può essere mostrata nei documenti o su alcune interfacce utente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome della tassa dovrebbe descrivere per labbonato in poche parole a cosa serve la tassa.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • onDowngradeCreditedAmount
    array
    Quando labbonamento è cambiato e il cambiamento è considerato come un downgrade, limporto definito da questa proprietà sarà accreditato allabbonato.
  • onUpgradeCreditedAmount
    array
    Quando labbonamento viene cambiato e la modifica è considerata come un aggiornamento, limporto definito da questa proprietà sarà accreditato allabbonato.
  • setupFee
    array
    Il costo di installazione viene addebitato quando labbonato si iscrive a questo componente. La tassa dinstallazione è addebitata con il primo addebito per gli abbonamenti.
  • type
    string
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionmetric subscriptionmetric

Una metrica rappresenta lutilizzo di una risorsa che può essere misurata.

Una metrica rappresenta lutilizzo di una risorsa che può essere misurata.
  • description
    struct
     
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
     
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionproduct subscriptionproduct

Un prodotto di abbonamento rappresenta un prodotto al quale un abbonato può abbonarsi. Un prodotto definisce quanto costa labbonamento e in quali cicli labbonamento viene addebitato.

Un prodotto di abbonamento rappresenta un prodotto al quale un abbonato può abbonarsi. Un prodotto definisce quanto costa labbonamento e in quali cicli labbonamento viene addebitato.
  • allowedPaymentMethodConfigurations
    array
    Le configurazioni dei metodi di pagamento consentiti controllano quali metodi di pagamento possono essere utilizzati con questo prodotto. Quando nessuno è selezionato, tutti i metodi saranno consentiti.
  • failedPaymentSuspensionPeriod
    string
    Quando un pagamento fallisce, labbonamento a cui appartiene il pagamento viene sospeso. Quando la sospensione non viene rimossa entro il periodo specificato, labbonamento viene terminato. Un pagamento è considerato fallito quando labbonato emette un rimborso o quando un addebito dellabbonamento fallisce.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome del prodotto è usato internamente per identificare la configurazione nelle interfacce amministrative. Per esempio viene usato nei campi di ricerca e quindi dovrebbe essere distinto e descrittivo.
  • productLocked
    boolean
    Segna il prodotto come bloccato. Significa che il cliente non può cambiare da questo prodotto o passare a questo prodotto in seguito.
  • reference
    string
    Il riferimento del prodotto identifica il prodotto per i sistemi esterni. Questo campo può contenere lo SKU del prodotto.
  • sortOrder
    int
    Lordine di ordinamento controlla in quale ordine il prodotto è elencato. Lordine viene utilizzato per ordinare i prodotti in ordine crescente.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponent subscriptionproductcomponent
  • componentChangeWeight
    int
    Se un componente del prodotto passa da uno con un livello inferiore (ad esempio 1) a uno con un livello superiore (ad esempio 3), è considerato un aggiornamento e potrebbe essere applicata una tassa una tantum.
  • bigint
     
  • defaultComponent
    boolean
    Quando un componente è contrassegnato come componente 'predefinito', è usato come componente predefinito nel suo gruppo e sarà preselezionato nella configurazione del prodotto.
  • description
    struct
    La descrizione del componente può contenere una descrizione più lunga che dà allabbonato una migliore comprensione di ciò che il componente contiene.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • maximalQuantity
    decimal
    La quantità massima definisce il valore massimo che deve essere inserito per la quantità.
  • minimalQuantity
    decimal
    La quantità minima definisce il valore minimo che deve essere inserito per la quantità.
  • name
    struct
    Il nome del componente viene mostrato allabbonato. Dovrebbe descrivere in poche parole ciò che il componente contiene.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • quantityStep
    decimal
    Il passo di quantità definisce a quale intervallo la quantità può essere aumentata.
  • bigint
    Il riferimento del componente è usato per identificare il componente da sistemi esterni e contrassegna i componenti per rappresentare lo stesso componente allinterno di diverse versioni del prodotto.
  • sortOrder
    int
    Lordine di ordinamento controlla in quale ordine viene elencato il componente. Lordinamento viene utilizzato per ordinare i componenti in ordine crescente.
  • bigint
    La classe fiscale del componente determina le tasse che sono applicabili su tutte le tasse collegate al componente.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponentgroup subscriptionproductcomponentgroup
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome del gruppo di componenti sarà mostrato quando i componenti sono selezionati. Questo può essere visibile allabbonato.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • optional
    boolean
    Il gruppo di componenti può essere opzionale. Ciò significa che nessun componente deve essere selezionato dallabbonato.
  • bigint
     
  • sortOrder
    int
    Lordine di ordinamento controlla in quale ordine il gruppo di componenti è elencato. Lordine viene usato per ordinare i gruppi di componenti in ordine crescente.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponentreference subscriptionproductcomponentreference

Il riferimento ai componenti del prodotto lega insieme i componenti di diverse versioni del prodotto. Legandoli insieme si può realizzare la migrazione della versione del prodotto.

Il riferimento ai componenti del prodotto lega insieme i componenti di diverse versioni del prodotto. Legandoli insieme si può realizzare la migrazione della versione del prodotto.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome di riferimento del componente è usato internamente per identificare il riferimento. Per esempio il nome viene usato nei campi di ricerca e quindi dovrebbe essere distinto e descrittivo.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriptionproductversion subscriptionproductversion
  • activatedOn
    timestamp
     
  • billingCycle
    string
    Il ciclo di fatturazione determina il ritmo con cui labbonato viene fatturato. La fatturazione può avere un ritmo diverso.
  • comment
    string
    Il commento permette di fornire un commento interno alla versione. Aiuta a documentare perché un prodotto è stato cambiato. Il commento non viene rivelato allabbonato.
  • createdOn
    timestamp
     
  • defaultCurrency
    string
    La valuta predefinita deve essere usata in tutte le tariffe.
  • enabledCurrencies
    array
    Le valute che sono abilitate possono essere selezionate per definire le tariffe dei componenti. Le valute che non sono abilitate non possono essere utilizzate per definire le tariffe.
  • id
    bigint
    A unique identifier for the object.
  • incrementNumber
    int
    Il numero di incremento rappresenta il numero di versione incrementato ogni volta che viene attivata una nuova versione.
  • minimalNumberOfPeriods
    int
    Il numero minimo di periodi determina la durata dellabbonamento prima che questo possa essere terminato.
  • name
    struct
    Il nome della versione del prodotto è il nome del prodotto che viene mostrato allutente per la versione. Quando il nome visibile del prodotto deve essere cambiato per un particolare prodotto, deve essere creata una nuova versione che contiene il nuovo nome del prodotto.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfNoticePeriods
    int
    Il numero di periodi di preavviso determina il numero di periodi che devono essere pagati tra la richiesta di cessazione dellabbonamento e il periodo finale.
  • obsoletedOn
    timestamp
     
  • bigint
    Ogni versione di prodotto è collegata a un prodotto.
  • reference
    string
    Il riferimento alla versione del prodotto aiuta a identificare la versione. Il riferimento è generato dal riferimento del prodotto.
  • retiringFinishedOn
    timestamp
     
  • retiringStartedOn
    timestamp
     
  • state
    string
    Lo stato attuale delloggetto.
  • taxCalculation
    string
    Strategia che viene utilizzata per il calcolo delle tasse nelle tasse.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscriber subscriber

Un abbonato rappresenta tutti coloro che sono iscritti a un prodotto.

Un abbonato rappresenta tutti coloro che sono iscritti a un prodotto.
  • additionalAllowedPaymentMethodConfigurations
    array
    I metodi di pagamento che sono permessi in aggiunta saranno disponibili anche quando il prodotto non permette questi metodi.
  • billingAddress
    struct
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • description
    string
    La descrizione dellabbonato può essere usata per aggiungere una descrizione allabbonato. Questa viene usata nel back office per identificare labbonato.
  • disallowedPaymentMethodConfigurations
    array
    I metodi di pagamento non consentiti non saranno disponibili per labbonato anche se il prodotto consente tali metodi.
  • emailAddress
    string
    Lindirizzo email viene utilizzato per comunicare con labbonato. Ci può essere un solo abbonato per spazio con lo stesso indirizzo e-mail.
  • externalId
    string
    Un nonce generato dal client che identifica lentità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece lentità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    La lingua dellabbonato determina la lingua che viene usata per comunicare con labbonato nelle e-mail e nei documenti (per esempio le fatture).
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sulloggetto.
  • reference
    string
    Il riferimento dellabbonato identifica labbonato nelle interfacce amministrative (per esempio lid del cliente).
  • shippingAddress
    struct
     
  • shippingAddress.city
    string
     
  • shippingAddress.commercialRegisterNumber
    string
     
  • shippingAddress.country
    string
     
  • shippingAddress.dateOfBirth
    date
     
  • shippingAddress.dependentLocality
    string
     
  • shippingAddress.emailAddress
    string
     
  • shippingAddress.familyName
    string
     
  • shippingAddress.gender
    string
     
  • shippingAddress.givenName
    string
     
  • bigint
     
  • shippingAddress.mobilePhoneNumber
    string
     
  • shippingAddress.organizationName
    string
     
  • shippingAddress.phoneNumber
    string
     
  • shippingAddress.postalState
    string
     
  • shippingAddress.postcode
    string
     
  • shippingAddress.salesTaxNumber
    string
     
  • shippingAddress.salutation
    string
     
  • shippingAddress.socialSecurityNumber
    string
     
  • shippingAddress.sortingCode
    string
     
  • shippingAddress.street
    string
     
  • state
    string
    Lo stato attuale delloggetto.
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.
subscribercustomer subscribercustomer
  • bigint
     
  • id
    bigint
    A unique identifier for the object.
  • bigint
     
  • linkedSpaceId
    bigint
    LID dello spazio a cui appartiene questo oggetto.