Documentation
Documentation
Schéma danalyse BETA
account account
  • active
    boolean
    Si ce compte et tous ses comptes parents sont actifs.
  • activeOrRestrictedActive
    boolean
    Si ce compte et tous ses comptes parents sont actifs ou actifs restreints.
  • createdBy
    bigint
    LID de lutilisateur par lequel le compte a été créé.
  • createdOn
    timestamp
    La date et lheure de la création du compte.
  • deletedBy
    bigint
    LID dun utilisateur par lequel le compte a été supprimé.
  • deletedOn
    timestamp
    La date et lheure auxquelles le compte a été supprimé.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La date et lheure de la dernière modification de lobjet.
  • name
    string
    Nom utilisé pour identifier le compte.
  • parentAccount
    bigint
    Le compte parent responsable de ladministration de ce compte.
  • restrictedActive
    boolean
    Si ce compte et tous ses comptes parents sont actifs ou actifs restreints. Il y a au moins un compte qui est actif restreint.
  • scope
    bigint
    Létendue à laquelle le compte appartient.
  • state
    string
    Létat actuel de lobjet.
  • subaccountLimit
    bigint
    Nombre de sous-comptes pouvant être créés au sein de ce compte.
  • type
    string
    Le type de compte qui définit son rôle et ses capacités.
failurereason failurereason
  • category
    string
     
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
labeldescriptor labeldescriptor
  • category
    string
    La catégorie du label.
  • description
    map
    La description localisée de lobjet.
  • group
    bigint
    Le groupe auquel appartient cette étiquette.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
  • weight
    int
    Lors de létablissement de la liste des étiquettes, celles-ci peuvent être triées en fonction de ce numéro.
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
  • weight
    int
    Lors de létablissement de la liste des groupes détiquettes, il est possible de les trier en fonction de ce numéro.
space space
  • account
    bigint
    Le compte auquel appartient lespace.
  • active
    boolean
    Si cet espace et tous ses comptes parents sont actifs.
  • activeOrRestrictedActive
    boolean
    Si cet espace et tous ses comptes parents sont actifs ou actifs restreints.
  • createdBy
    bigint
    LID de lutilisateur qui a créé lespace.
  • createdOn
    timestamp
    La date et lheure de création de lespace.
  • deletedBy
    bigint
    LID de lutilisateur qui a supprimé lespace.
  • deletedOn
    timestamp
    La date et lheure auxquelles lespace a été supprimé.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La date et lheure de la dernière modification de lobjet.
  • name
    string
    Nom utilisé pour identifier lespace.
  • postalAddress
    struct
    Ladresse utilisée dans la communication avec les clients, par exemple dans les courriels, les documents, etc.
  • 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 devise utilisée pour afficher les montants agrégés dans lespace.
  • requestLimit
    bigint
    Nombre maximal de demandes dAPI acceptées en deux minutes. Cette limite ne peut être modifiée quavec des privilèges spéciaux.
  • restrictedActive
    boolean
    Si cet espace et tous ses comptes parents sont actifs ou actifs restreints. Il y a au moins un compte parent qui est actif restreint.
  • state
    string
    Létat actuel de lobjet.
  • technicalContactAddresses
    array
    Ladresse électronique qui recevra les messages concernant les problèmes techniques et les erreurs qui se produisent dans lespace.
  • timeZone
    string
    Le fuseau horaire utilisé pour planifier et exécuter les processus darrière-plan. Cela naffecte pas le formatage des dates dans linterface utilisateur.
legalorganizationform legalorganizationform
  • country
    string
    Code à deux lettres du pays dans lequel la forme dorganisation juridique est utilisée (format ISO 3166-1 alpha-2).
  • description
    array
    Les descriptions localisées de la forme dorganisation juridique.
  • englishDescription
    string
    Le nom anglais de la forme dorganisation légale.
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
    Les raccourcis localisés de la forme dorganisation juridique.
customer customer
  • createdOn
    timestamp
    La date et lheure de création de lobjet.
  • customerId
    string
    Lidentifiant du client dans le système du commerçant.
  • emailAddress
    string
    Ladresse électronique du client.
  • familyName
    string
    Le nom de famille du client.
  • givenName
    string
    Le nom ou le prénom du client.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Permet de stocker des informations supplémentaires sur lobjet.
  • preferredCurrency
    string
    La devise préférée du client.
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
customeraddress customeraddress
  • address
    struct
    Ladresse postale actuelle.
  • 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
     
  • address.legalOrganizationForm
    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
    Si ladresse est destinée à la facturation, à lexpédition ou aux deux.
  • createdOn
    timestamp
    La date et lheure de création de lobjet.
  • customer
    bigint
    Le client auquel lobjet appartient.
  • defaultAddress
    boolean
    Sil sagit de ladresse par défaut du client.
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
saleschannel saleschannel
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
  • parent
    bigint
     
  • sortOrder
    int
     
paymentconnector paymentconnector
  • dataCollectionType
    string
     
  • deprecated
    boolean
     
  • deprecationReason
    map
     
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
  • paymentMethod
    bigint
     
  • paymentMethodBrand
    bigint
     
  • primaryRiskTaker
    string
     
  • processor
    bigint
     
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Cette Property indique si le Connector peut être actuellement utilisé pour le traitement de transactions. Si ni le mode de paiement attribué ni la configuration du Connector attribuée ne sont activés, le processeur ne sera pas utilisé même s’il est activé.
  • connector
    bigint
     
  • enabledSalesChannels
    array
    Définit les canaux de vente pour lesquels la configuration du connecteur est activée. Si lensemble est vide, la configuration du connecteur est activée pour tous les canaux de vente.
  • enabledSpaceViews
    array
    La configuration du Connector n’est active que pour les Space Views sélectionnées. Si vous laissez ces paramètres vides, la configuration est active pour tous les Spaces.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Le nom de la configuration du Connector est utilisé en interne pour identifier la configuration dans les interfaces administratives. Ce nom est par exemple utilisé dans les champs de recherche. Il doit donc être clair et descriptif.
  • paymentMethodConfiguration
    bigint
     
  • priority
    int
    La priorité définit l’ordre de sélection des configurations de Connectors. Plus la valeur est basse, plus la priorité est élevée. Cette valeur peut également être un nombre négatif si vous souhaitez ajouter d’autres configurations qui doivent avoir une priorité élevée et si vous ne souhaitez pas modifier les valeurs de toutes les configurations existantes.
  • processorConfiguration
    bigint
     
  • state
    string
    Létat actuel de lobjet.
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
paymentmethod paymentmethod
  • dataCollectionTypes
    array
     
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    Le nom localisé de lobjet.
  • supportedCurrencies
    array
     
paymentmethodbrand paymentmethodbrand
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
  • paymentMethod
    bigint
     
paymentmethodconfiguration paymentmethodconfiguration

La configuration du mode de paiement est un prérequis pour associer un processeur à une configuration concrète.

La configuration du mode de paiement est un prérequis pour associer un processeur à une configuration concrète.
  • dataCollectionType
    string
    Le type de saisie des données définit qui recueille les informations de paiement. Cela peut être effectué par le processeur (offsite) ou par notre application (onsite).
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Le nom de la configuration du mode de paiement est utilisé en interne pour identifier la configuration dans les interfaces administratives. Ce nom est par exemple utilisé dans les champs de recherche. Il doit donc être clair et descriptif.
  • oneClickPaymentMode
    string
    Lorsque l’acheteur saisit les détails du paiement sur la Payment Page ou dans iFrame, ces détails peuvent être enregistrés automatiquement. L’acheteur pourra alors les réutiliser ultérieurement pour d’autres paiements. Lorsque la transaction contient déjà un Token, cette option n’a aucune incidence.
  • paymentMethod
    bigint
     
  • resolvedDescription
    map
    La description résolue utilise la description définie ou, si cette dernière n’a pas été définie, la description par défaut.
  • resolvedTitle
    map
    Le titre résolu utilise le titre défini ou, si ce dernier n’a pas été défini, le titre par défaut.
  • sortOrder
    int
    L’ordre de tri des modes de paiement définit l’ordre dans lequel les modes de paiement sont présentés au client pendant le processus de paiement.
  • state
    string
    Létat actuel de lobjet.
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
paymentprocessor paymentprocessor
  • companyName
    map
     
  • description
    map
    La description localisée de lobjet.
  • headquartersLocation
    map
     
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
  • productName
    map
     
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    La configuration est gérée par lapplication et ne peut être modifiée via linterface utilisateur.
  • contractId
    bigint
    Le contrat associe la configuration du processeur de paiement au contrat du processeur de paiement.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Le nom des configurations de processeur est utilisé en interne pour identifier une configuration de processeur particulière. Ce nom est par exemple utilisé dans les champs de recherche. Il doit donc être clair et descriptif.
  • processor
    bigint
    Un processeur représente un processeur de paiement (Payment Service Provider) dans l’application. Il s’agit d’une entreprise tierce qui gère la transaction sur le plan technique et qui par conséquent procède au paiement. Vous pouvez effectuer plusieurs configurations pour un processeur pour divers objectifs.
  • state
    string
    Létat actuel de lobjet.
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
refund refund

Un remboursement représente un crédit transféré en retour au client. Il peut être déclenché par le commerçant ou le client (chargeback).

Un remboursement représente un crédit transféré en retour au client. Il peut être déclenché par le commerçant ou le client (chargeback).
  • amount
    decimal
     
  • baseLineItems
    array
     
  • completion
    bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La date et lheure de création de lobjet.
  • environment
    string
     
  • externalId
    string
    L’External ID aide à identifier les appels répétés au service de remboursement. L’Extrernal ID doit donc être unique pour chaque transaction.
  • failedOn
    timestamp
     
  • failureReason
    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
    Létat actuel de lobjet.
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    Le total des frais appliqués est la somme de tous les frais qui ont été appliqués jusquà présent.
  • totalSettledAmount
    decimal
    Le montant total réglé est le montant total qui a été réglé jusquà présent.
  • transaction
    bigint
     
  • type
    string
     
  • updatedInvoice
    bigint
     
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
paymentterminal paymentterminal
  • defaultCurrency
    string
     
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    Lidentifiant permet didentifier le terminal de manière unique. Normalement, il est visible sur le terminal ou sur lécran du terminal.
  • name
    string
    Le nom du terminal est utilisé en interne pour identifier le terminal dans les interfaces administratives. Il est par exemple utilisé dans les champs de recherche et doit donc être distinct et descriptif.
  • state
    string
    Létat actuel de lobjet.
  • type
    bigint
     
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
paymentterminaltype paymentterminaltype
  • description
    map
    La description localisée de lobjet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de lobjet.
token token
  • createdOn
    timestamp
    La date et lheure de création de lobjet.
  • customerEmailAddress
    string
    L’adresse e-mail du client correspond à l’adresse e-mail de l’acheteur.
  • customerId
    string
    L’ID du client identifie le client dans le système du commerçant. Si une ID de client est proposée, elle doit correspondre à l’ID du client fournie sur la transaction. L’ID du client ne sera pas automatiquement activée ou modifiée. L’ID du client doit être fournie par le système du commerçant.
  • enabledForOneClickPayment
    boolean
    Lorsque le Token est activé pour les paiements One-Click, l’acheteur peut le sélectionner dans iFrame ou sur la Payment Page pour payer avec. L’utilisation du Token permet de réduire le nombre d’étapes par lesquelles l’acheteur doit passer. L’acheteur est lié à la transaction et au Token par l’ID client. Cela signifie que le Token sera visible pour les acheteurs ayant la même ID client. Pour que les paiements One-Click fonctionnent, il faut également que le mode de paiement autorisant les paiements One-Click soit configuré.
  • externalId
    string
    Un nonce généré par le client qui identifie lentité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront lentité initialement créée.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • state
    string
    Létat actuel de lobjet.
  • timeZone
    string
    Le fuseau horaire définit le fuseau horaire du client. Le fuseau horaire influe sur le formatage de la date dans la communication avec le client.
  • tokenReference
    string
    Utilisez une description claire. Cela vous aidera à retrouver le Token. (p. ex. ID de l’utilisateur, adresse e-mail).
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
transaction transaction
  • acceptHeader
    string
     
  • acceptLanguageHeader
    string
    L’Accepted Language Header contient la langue de préférence de l’utilisateur.
  • allowedPaymentMethodBrands
    array
     
  • allowedPaymentMethodConfigurations
    array
     
  • authorizationAmount
    decimal
     
  • authorizationEnvironment
    string
    L’environnement dans lequel cette transaction a été autorisée.
  • authorizationSalesChannel
    bigint
    Le canal de vente par lequel la transaction a été effectuée.
  • authorizationTimeoutOn
    timestamp
    Il s’agit du Timeout qui est utilisé lorsque la transaction est en cours d’autorisation. Ce Timeout peut changer au fil du temps.
  • authorizedOn
    timestamp
     
  • autoConfirmationEnabled
    boolean
    Lorsque la confirmation automatique est activée, la transaction est automatiquement confirmée quand son traitement l’exige. Lorsque la confirmation automatique est désactivée, la confirmation doit être effectuée manuellement.
  • 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
     
  • billingAddress.legalOrganizationForm
    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
    Si le débit du client échoue, nous pouvons essayer une nouvelle fois. Cela implique que nous redirigeons le client sur la Payment Page pour qu’il puisse essayer une nouvelle fois de clôturer le paiement. Les paramètres par défaut prévoient de nouvelles tentatives.
  • completedAmount
    decimal
    Le montant réalisé est le montant total qui a été capturé jusquà présent.
  • completedOn
    timestamp
     
  • completionBehavior
    string
    Le comportement dachèvement contrôle quand la transaction est terminée.
  • completionTimeoutOn
    timestamp
     
  • confirmedBy
    bigint
     
  • confirmedOn
    timestamp
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La date et lheure de création de lobjet.
  • currency
    string
     
  • customerEmailAddress
    string
    L’adresse e-mail du client est utilisée lorsqu’aucune adresse de livraison ou de facturation n’est disponible.
  • customerId
    string
     
  • customersPresence
    string
    La présence du client indique quel type de méthode dauthentification a finalement été utilisé lors de lautorisation de la transaction. Si aucune valeur nest fournie, 'Virtually Present' est utilisé par défaut.
  • deliveryDecisionMadeOn
    timestamp
    La date du bulletin de livraison indique la date à laquelle la décision d’effectuer la livraison ou pas a été prise.
  • deviceSessionIdentifier
    string
    Le Session Identifier relie la transaction au Session Identifier qui a été indiqué dans l’URL de JavaScript. Cela permet d’associer les données de l’appareil avec la transaction.
  • emailsDisabled
    boolean
    Drapeau indiquant si lenvoi de-mails est désactivé pour cette transaction particulière. La valeur par défaut est false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    La stratégie de sélection d’environnement définit la façon dont l’environnement (Test ou Live) est sélectionné.
  • failedOn
    timestamp
     
  • failedUrl
    string
    L’utilisateur est redirigé sur la Failed URL si la transaction n’est pas autorisée ou terminée. Si aucune Failed URL n’est précisée, une Failed URL par défaut est affichée.
  • failureReason
    bigint
    Le motif de l’erreur décrit la raison pour laquelle la transaction a échoué. Le motif n’est activé que lorsque la transaction a échoué.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    L’adresse Internet Protocol (IP) identifie l’appareil de l’acheteur.
  • internetProtocolAddressCountry
    string
     
  • invoiceMerchantReference
    string
     
  • javaEnabled
    boolean
     
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • merchantReference
    string
     
  • metaData
    map
    Permet de stocker des informations supplémentaires sur lobjet.
  • parent
    bigint
     
  • paymentConnectorConfiguration
    bigint
     
  • processingOn
    timestamp
     
  • refundedAmount
    decimal
    Le montant remboursé correspond au total de tous les remboursements effectués jusqu’à présent.
  • 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
     
  • shippingAddress.legalOrganizationForm
    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
    Létat actuel de lobjet.
  • successUrl
    string
    L’utilisateur est redirigé sur la Success URL dès que la transaction est autorisée ou terminée. Si aucune Success URL n’est précisée, une Success URL par défaut est affichée.
  • terminal
    bigint
    Le terminal sur lequel le paiement a été traité.
  • timeZone
    string
    Le fuseau horaire définit le fuseau horaire du client. Le fuseau horaire influe sur le formatage de la date dans la communication avec le client.
  • token
    bigint
     
  • tokenizationMode
    string
    Le mode de tokenisation contrôle si et comment la tokenisation des informations de paiement est appliquée à la transaction.
  • totalAppliedFees
    decimal
    Le total des frais appliqués est la somme de tous les frais qui ont été appliqués jusquà présent.
  • totalSettledAmount
    decimal
    Le montant total réglé est le montant total qui a été réglé jusquà présent.
  • userAgentHeader
    string
    Le User Agent Header indique le Browser utilisé par l’acheteur.
  • userFailureMessage
    string
    Le message d’erreur explique à l’utilisateur final dans sa langue la raison pour laquelle la transaction a échoué. Le message d’erreur n’est activé que lorsque la transaction a échoué.
  • userInterfaceType
    string
    Le type d’interface utilisateur définit la façon dont la transaction a été créée ou traitée.
  • windowHeight
    string
     
  • windowWidth
    string
     
  • yearsToKeep
    int
    Le nombre dannées pendant lesquelles la transaction sera conservée après avoir été autorisée.
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
transactioncompletion transactioncompletion
  • amount
    decimal
    Le montant qui est capturé. Le montant représente la somme des postes de la ligne, y compris les taxes.
  • baseLineItems
    array
    Les éléments de la ligne de base sur lesquels lachèvement est appliqué.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La date et lheure de création de lobjet.
  • externalId
    string
    LID externe aide à identifier lentité et la création ultérieure dune entité avec le même ID ne créera pas une nouvelle 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
    Indique sil sagit du dernier achèvement. Après la création du dernier achèvement, la transaction ne peut plus être achevée.
  • lineItems
    array
    Les postes qui sont capturés.
  • linkedTransaction
    bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
     
  • state
    string
    Létat actuel de lobjet.
  • statementDescriptor
    string
    Le descripteur de relevé explique les frais ou les paiements sur les relevés bancaires.
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    La somme totale de toutes les taxes des postes.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.
transactioninvoice transactioninvoice

La facture de transaction représente le document de facture d’une transaction.

La facture de transaction représente le document de facture d’une transaction.
  • 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
     
  • billingAddress.legalOrganizationForm
    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
     
  • completion
    bigint
     
  • createdOn
    timestamp
    La date à laquelle la facture est créée.
  • derecognizedBy
    bigint
    Lidentifiant de lutilisateur qui a marqué la facture comme étant décomptabilisée.
  • derecognizedOn
    timestamp
    La date à laquelle la facture est considérée comme décomptabilisée.
  • dueOn
    timestamp
    La date à laquelle la facture doit être payée.
  • environment
    string
     
  • externalId
    string
    Lidentifiant externe permet didentifier lentité et la création ultérieure dune entité avec le même identifiant ne créera pas une nouvelle entité.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • linkedTransaction
    bigint
     
  • merchantReference
    string
     
  • outstandingAmount
    decimal
    Le montant dû indique la somme que le client doit au commerçant. Un montant négatif signifie que le client a trop payé.
  • paidOn
    timestamp
    La date à laquelle la facture a été marquée comme payée. Il est possible que cette date soit quelque peu postérieure à la date de paiement effective.
  • spaceViewId
    bigint
     
  • state
    string
    Létat actuel de lobjet.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    LID de lespace auquel appartient cet objet.