Documentation
Documentation
Analytics Schema BETA
account account

Account

  • accounttype  
     
    string  
  • createdby  
    The ID of the user the account was created by.  
    bigint  
  • createdon  
    The date and time when the account was created.  
    timestamp  
  • deletedby  
    The ID of a user the account was deleted by.  
    bigint  
  • deletedon  
    The date and time when the account was deleted.  
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • lastmodifieddate  
    The date and time when the object was last modified.  
    timestamp  
  • name  
    The name used to identify the account.  
    string  
  • parentaccount_id
    Parent account ID  
    bigint  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • scope_id
    Scope ID  
    bigint  
  • state  
    The object's current state.  
    string  
  • statechangeevent  
     
    string  
  • subaccountlimit  
    The number of sub-accounts that can be created within this account.  
    bigint  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
banktransaction banktransaction

Bank Transaction

  • _db_id  
     
    int  
  • amountsnormalized  
     
    int  
  • banktransactiontype  
     
    bigint  
  • createdby  
    The ID of the user the bank transaction was created by.  
    bigint  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • currencybankaccount_id  
     
    bigint  
  • externalid  
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • paymentdate  
    The payment date specifies the date on which the payment was processed.  
    timestamp  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • postingamount  
    The posting amount refers to the monetary value recorded for the bank transaction prior to any adjustments.  
    decimal(19,8)  
  • reference  
    A unique reference to identify the bank transaction.  
    string  
  • source  
    The source indicates how the bank transaction was created.  
    bigint  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • valueamount  
    The value amount represents the net monetary value of the transaction after applicable deductions.  
    decimal(19,8)  
  • valuedate  
    The value date indicates the date on which the transaction amount becomes effective.  
    timestamp  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
charge charge

Charge

  • _db_id  
     
    int  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • failurereason  
    The reason for the failure of the charge.  
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • timeouton  
    The date and time when the charge will expire.  
    timestamp  
  • transaction_id  
     
    bigint  
  • type  
    The type specifying how the customer was charged.  
    string  
  • userfailuremessage  
    The message that can be displayed to the customer explaining why the charge failed, in the customer's language.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
chargeattempt chargeattempt

Charge Attempt

  • _db_id  
     
    int  
  • charge_id
    Charge ID  
    bigint  
  • completionbehavior  
    The behavior that controls when the transaction is completed.  
    string  
  • connectorconfiguration_id
    Connector Configuration ID  
    bigint  
  • connectorplugin  
     
    bigint  
  • connectorprocessingresulttype  
     
    string  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • customerspresence  
    The customer's presence indicates whether and in what way the charge attempt's customer is present.  
    string  
  • environment  
    The environment in which the charge attempt is executed.  
    string  
  • failedon  
    The date and time when the charge attempt failed.  
    timestamp  
  • failurereason  
    The reason for the failure of the charge attempt.  
    bigint  
  • httpmessagebody  
     
    binary  
  • httpmessageheaders  
     
    binary  
  • httpmessagestatuscode  
     
    int  
  • id  
    A unique identifier for the object.  
    bigint  
  • initializingtokenversion  
    Whether a new token version is being initialized.  
    boolean  
  • invocation_id  
     
    bigint  
  • nextupdateon  
    The date and time when the next update of the object's state is planned.  
    timestamp  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • redirectionurl  
    The URL to redirect the customer to after payment processing.  
    string  
  • saleschannel  
    The sales channel through which the charge attempt was made.  
    bigint  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • succeededon  
    The date and time when the charge attempt succeeded.  
    timestamp  
  • terminal_id
    Payment Terminal ID  
    bigint  
  • timeouton  
    The date and time when the object will expire.  
    timestamp  
  • tokenversion_id  
     
    bigint  
  • userfailuremessage  
    The message that can be displayed to the customer explaining why the charge attempt failed, in the customer's language.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
  • wallet  
    The type of wallet used to make the charge attempt.  
    bigint  
customer customer

Customer

  • _db_id  
     
    int  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • customerid  
    The customer's ID in the merchant's system.  
    string  
  • emailaddress  
    The customer's email address.  
    string  
  • familyname  
    The customer's family or last name.  
    string  
  • givenname  
    The customer's given or first name.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • language  
    The language that is linked to the object.  
    string  
  • preferredcurrency  
    The customer's preferred currency.  
    string  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
legalorganizationform legalorganizationform

Legal Organization Form. Legal organization form details

  • country  
    The two-letter code of the country the legal organization form is used in (ISO 3166-1 alpha-2 format).  
    string  
  • descriptions  
     
    array<map<string,string>>  
  • englishdescription  
    The English name of the legal organization form.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • shortcut  
    The localized shortcuts of the legal organization form.  
    array<map<string,string>>  
space space

Space

  • account_id
    Account ID  
    bigint  
  • address_city  
     
    string  
  • address_country  
     
    string  
  • address_dependentlocality  
     
    string  
  • address_emailaddress  
     
    string  
  • address_familyname  
     
    string  
  • address_givenname  
     
    string  
  • address_mobilephonenumber  
     
    string  
  • address_organizationname  
     
    string  
  • address_phonenumber  
     
    string  
  • address_postalstate  
     
    string  
  • address_postcode  
     
    string  
  • address_salestaxnumber  
     
    string  
  • address_salutation  
     
    string  
  • address_sortingcode  
     
    string  
  • address_street  
     
    string  
  • createdby  
    The ID of the user the space was created by.  
    bigint  
  • createdon  
    The date and time when the space was created.  
    timestamp  
  • database_id  
     
    bigint  
  • deletedby  
    The ID of the user the space was deleted by.  
    bigint  
  • deletedon  
    The date and time when the space was deleted.  
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • lastmodifieddate  
    The date and time when the object was last modified.  
    timestamp  
  • name  
    The name used to identify the space.  
    string  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • primarycurrency  
    The currency that is used to display aggregated amounts in the space.  
    string  
  • requestlimit  
    The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.  
    bigint  
  • state  
    The object's current state.  
    string  
  • statechangeevent  
     
    string  
  • timezone  
    The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
spacereference spacereference

Space Reference

  • _db_id  
     
    int  
  • accountid  
     
    bigint  
  • billingaccountid  
     
    bigint  
  • createdon  
     
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • scopeid  
     
    bigint  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
transaction transaction

Transaction

  • _db_id  
     
    int  
  • acceptheader  
    The 'Accept' header of the customer's web browser.  
    string  
  • acceptlanguageheader  
    The 'Accept Language' header of the customer's web browser.  
    string  
  • authorizationamount  
    The sum of all line item prices including taxes in the transaction's currency.  
    decimal(19,8)  
  • authorizationenvironment  
    The environment in which the transaction was authorized.  
    string  
  • authorizationsaleschannel  
    The sales channel through which the transaction was placed.  
    bigint  
  • authorizationtimeouton  
    The date and time when the transaction must be authorized, otherwise it will canceled.  
    timestamp  
  • authorizedon  
    The date and time when the transaction was authorized.  
    timestamp  
  • autoconfirmationenabled  
    Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.  
    boolean  
  • billingaddresscity  
     
    string  
  • billingaddresscommercialregisternumber  
     
    string  
  • billingaddresscountry  
     
    string  
  • billingaddressdateofbirth  
     
    string  
  • billingaddressdependentlocality  
     
    string  
  • billingaddressemailaddress  
     
    string  
  • billingaddressfamilyname  
     
    string  
  • billingaddressgender  
     
    string  
  • billingaddressgivenname  
     
    string  
  • billingaddressmobilephonenumber  
     
    string  
  • billingaddressorganizationform  
     
    bigint  
  • billingaddressorganizationname  
     
    string  
  • billingaddressphonenumber  
     
    string  
  • billingaddresspostalstate  
     
    string  
  • billingaddresspostcode  
     
    string  
  • billingaddresssalestaxnumber  
     
    string  
  • billingaddresssalutation  
     
    string  
  • billingaddresssocialsecuritynumber  
     
    string  
  • billingaddresssortingcode  
     
    string  
  • billingaddressstreet  
     
    string  
  • chargeretryenabled  
    Whether the customer can make further payment attempts if the first one has failed. Default is true.  
    boolean  
  • completedamount  
    The total amount that was completed, in the transaction's currency.  
    decimal(19,8)  
  • completedon  
    The date and time when the transaction was completed.  
    timestamp  
  • completionbehavior  
    The behavior that controls when the transaction is completed.  
    string  
  • completionretries  
     
    int  
  • completiontimeouton  
    The date and time when the transaction is completed automatically.  
    timestamp  
  • confirmedby  
    The ID of the user the transaction was confirmed by.  
    bigint  
  • confirmedon  
    The date and time when the transaction was created.  
    timestamp  
  • createdby  
    The ID of the user the transaction was created by.  
    bigint  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • currency  
    The three-letter code (ISO 4217 format) of the transaction's currency.  
    string  
  • customeremailaddress  
    The customer's email address.  
    string  
  • customerid  
    The unique identifier of the customer in the external system.  
    string  
  • customerspresence  
    The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.  
    string  
  • deliverydecisionmadeon  
    This date and time when the decision was made as to whether the order should be shipped.  
    timestamp  
  • devicesessionidentifier  
    Allows to link the transaction to the data collected from the customer's device.  
    string  
  • emailsdisabled  
    Whether email sending is deactivated for the transaction. Default is false.  
    boolean  
  • endoflife  
    The date and time when the transaction reaches its end of live. No further actions can be carried out at this time.  
    timestamp  
  • environment  
    The environment used when rendering resources.  
    string  
  • environmentselectionstrategy  
    The strategy for determining whether the transaction is to be processed in the test or production environment.  
    string  
  • failedon  
    The date and time when the transaction failed.  
    timestamp  
  • failedurl  
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.  
    string  
  • failurereason  
    The reason for the failure of the transaction.  
    bigint  
  • group_id
    Transaction Group ID  
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • internetprotocoladdress  
    The IP address of the customer's device.  
    string  
  • internetprotocoladdresscountry  
    The country determined from the IP address of the customer's device.  
    string  
  • invoicemerchantreference  
    The merchant's reference used to identify the invoice.  
    string  
  • javaenabled  
    Whether Java is enabled on the customer's web browser.  
    boolean  
  • language  
    The language that is linked to the object.  
    string  
  • lastuseractivitydate  
     
    timestamp  
  • locktimeout  
     
    timestamp  
  • merchantreference  
    The merchant's reference used to identify the transaction.  
    string  
  • migration  
     
    int  
  • parent_id
    Transaction ID  
    bigint  
  • paymentconnectorconfiguration_id
    Payment Connector Configuration ID  
    bigint  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • processingon  
    The date and time when the processing of the transaction was started.  
    timestamp  
  • refundedamount  
    The total amount that was refunded, in the transaction's currency.  
    decimal(19,8)  
  • screencolordepth  
    The screen color depth of the customer's web browser.  
    string  
  • screenheight  
    The screen height of the customer's web browser.  
    string  
  • screenwidth  
    The screen width of the customer's web browser.  
    string  
  • shippingaddresscity  
     
    string  
  • shippingaddresscommercialregisternumber  
     
    string  
  • shippingaddresscountry  
     
    string  
  • shippingaddressdateofbirth  
     
    string  
  • shippingaddressdependentlocality  
     
    string  
  • shippingaddressemailaddress  
     
    string  
  • shippingaddressfamilyname  
     
    string  
  • shippingaddressgender  
     
    string  
  • shippingaddressgivenname  
     
    string  
  • shippingaddressmobilephonenumber  
     
    string  
  • shippingaddressorganizationform  
     
    bigint  
  • shippingaddressorganizationname  
     
    string  
  • shippingaddressphonenumber  
     
    string  
  • shippingaddresspostalstate  
     
    string  
  • shippingaddresspostcode  
     
    string  
  • shippingaddresssalestaxnumber  
     
    string  
  • shippingaddresssalutation  
     
    string  
  • shippingaddresssocialsecuritynumber  
     
    string  
  • shippingaddressssortingcode  
     
    string  
  • shippingaddressstreet  
     
    string  
  • shippingmethod  
    The name of the shipping method used to ship the products.  
    string  
  • spaceid  
     
    bigint  
  • spaceviewid  
    The ID of the space view this object is linked to.  
    bigint  
  • state  
    The object's current state.  
    string  
  • successurl  
    The URL to redirect the customer back to after they successfully authenticated their payment.  
    string  
  • terminal_id
    Payment Terminal ID  
    bigint  
  • timezone  
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.  
    string  
  • tokenizationmode  
    The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.  
    string  
  • totalappliedfees  
    The total of all fees charged, in the transaction's currency.  
    decimal(19,8)  
  • totalsettledamount  
    The total amount that was settled, in the transaction's currency.  
    decimal(19,8)  
  • useragentheader  
    The 'User Agent' header of the customer's web browser.  
    string  
  • userfailuremessage  
    The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.  
    string  
  • userinterfacetype  
    The type of user interface the customer used to provide the payment information.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
  • windowheight  
    The window height of the customer's web browser.  
    string  
  • windowwidth  
    The window width of the customer's web browser.  
    string  
  • yearstokeep  
    The number of years the transaction is kept after its authorization.  
    int  
transactioninvoice transactioninvoice

Invoice

  • _db_id  
     
    int  
  • amount  
    The total sum of all line items on the invoice, including taxes.  
    decimal(19,8)  
  • billingaddresscity  
     
    string  
  • billingaddresscommercialregisternumber  
     
    string  
  • billingaddresscountry  
     
    string  
  • billingaddressdateofbirth  
     
    string  
  • billingaddressdependentlocality  
     
    string  
  • billingaddressemailaddress  
     
    string  
  • billingaddressfamilyname  
     
    string  
  • billingaddressgender  
     
    string  
  • billingaddressgivenname  
     
    string  
  • billingaddressmobilephonenumber  
     
    string  
  • billingaddressorganizationform  
     
    bigint  
  • billingaddressorganizationname  
     
    string  
  • billingaddressphonenumber  
     
    string  
  • billingaddresspostalstate  
     
    string  
  • billingaddresspostcode  
     
    string  
  • billingaddresssalestaxnumber  
     
    string  
  • billingaddresssalutation  
     
    string  
  • billingaddresssocialsecuritynumber  
     
    string  
  • billingaddresssortingcode  
     
    string  
  • billingaddressstreet  
     
    string  
  • completion_id
    Transaction Completion ID  
    bigint  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • derecognizedby  
    The ID of the user the invoice was derecognized by.  
    bigint  
  • derecognizedon  
    The date and time when the invoice was derecognized, meaning it is no longer considered outstanding or valid in the system.  
    timestamp  
  • dueon  
    The due date for payment of the invoice.  
    timestamp  
  • externalid  
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • merchantreference  
    The merchant's reference used to identify the invoice.  
    string  
  • outstandingamount  
    The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.  
    decimal(19,8)  
  • paidon  
    The date and time when the invoice was recorded as paid. May differ from the actual payment date due to processing delays.  
    timestamp  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • taxamount  
    The portion of the invoiced amount that corresponds to taxes.  
    decimal(19,8)  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
transactionlineitemversion transactionlineitemversion

Line Item Version

  • _db_id  
     
    int  
  • amount  
    The total amount of the updated line items, including taxes.  
    decimal(19,8)  
  • authorizationamountincrease  
     
    decimal(19,8)  
  • createdby  
    The ID of the user the line item version was created by.  
    bigint  
  • createdon  
    The date and time when the object was created.  
    timestamp  
  • executedon  
     
    timestamp  
  • externalid  
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.  
    string  
  • failedon  
    The date and time when the processing of the line item version failed.  
    timestamp  
  • failurereason  
     
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • nextupdateon  
    The date and time when the next update of the line item version's state is planned.  
    timestamp  
  • plannedpurgedate  
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.  
    timestamp  
  • processingon  
    The date and time when the processing of the line item version was started.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    The object's current state.  
    string  
  • succeededon  
    The date and time when the line item version was processed successfully.  
    timestamp  
  • taxamount  
    The portion of the total amount that corresponds to taxes.  
    decimal(19,8)  
  • timeouton  
    The date and time by when the line item version is expected to be processed.  
    timestamp  
  • transaction_id
    Transaction ID  
    bigint  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
wallettype wallettype

Wallet Type. Wallet type details.

  • description  
    The localized description of the object.  
    map<string,string>  
  • id  
    A unique identifier for the object.  
    bigint  
  • name  
    The localized name of the object.  
    map<string,string>