Data Models

Docs

Basic Features
Payment
Debt Collection
- Debt Collection
- Debt Collectors
Subscription
Customize
Connect
- Connected Services
- Printing
- Slack
- Lightspeed eCom
- Shopify
- Ecwid
- Webhooks
API Reference

Documentation

Data Models

API

Bulk Operation Result

Represents the result of a single operation in a bulk request.
Error Response
List Response
Search Response

Account

Account

Accounting

Analytics

Analytics Query
Analytics Query Execution Request
Analytics Query Execution Response
Analytics Schema Column Info

Meta information about a column within a table.
Analytics Schema Info

The schema of a single table in Analytics.
Analytics Table Column Info

Meta information about a column within a table.
Analytics Table Info

The schema of a single table in Analytics.
Query Execution

Represents the execution of a query which has been submitted to Analytics.
Query Result Batch

A batch of the result of a query executed in Analytics.
Query execution statistics for account

Query execution statistics for account
Recurring Analytics Query
Recurring Analytics Query Dispatch
Recurring Analytics Query Execution
Recurring Analytics Query Schedule
Result Portion Model
Submitted Analytics Query Execution

Bank

Base

Express Checkout Wallet Type
Payment Connector
Payment Connector Configuration
Payment Connector Feature
Payment Method
Payment Method Brand
Payment Method Configuration
Payment Processor

Payment processors serve as intermediaries that establish connections with third-party companies, known as payment service providers. These providers are responsible for managing the technical aspects of payment transactions, ensuring seamless and secure payment processing.
Payment Processor Configuration

Base

Charge

Condition

Condition Type
Connector Condition

A connector condition defines criteria that a transaction must meet for a connector configuration to process the payment.

Connect

Customer.io Integration

The Customer.io integration allows to connect a specific Customer.io Workspace to synchronize customer data and events with their service.
Slack Integration

Contract

Core

Customer

Debt Collection

Debt Collection Case

The debt collection case represents a try to collect the money from the debtor.
Debt Collection Case Document
Debt Collection Case Source

The debt collection case source represents the origin of the case. It allows to understand where the amount receivable is coming from.
Debt Collection Receipt
Debt Collection Receipt Source

The debt collection receipt source represents the origin of a particular part of the collected amount. It allows to understand from where the amount is coming from, e.g. if it was added manually or in some other way.
Debt Collector

The debt collector connects to an external service to process debt collection cases and directs the debt collection process.
Debt Collector Condition

A condition controls under which circumstances a collector configuration is applied to a debt collection case.
Debt Collector Condition Type
Debt Collector Configuration

The debt collector configuration defines the behavior of the collection process for a particular collector.

Document

Document Target Media Type
Document Template

A document template contains the customizations for a particular document template type.
Document Template Type
Document Template Type Group
Rendered Document

Dunning

Dunning Case
Dunning Case Level
Dunning Condition

A dunning condition determines which dunning flow is applied on a dunning case.
Dunning Condition Type
Dunning Flow
Dunning Flow Level
Dunning Flow Level Processor
Dunning Flow Type

Attachment Resource

The attachment resource allows the attachment of resources to emails.
Email Sender
Email Sender Type
Email Sending Job

An email sending job is a try to send an email.
Email Template
Email Template Type
Email Template Type Group

Entity Query

Entity Export Request

The entity property export request contains the information required to create an export of a list of entities.
Entity Query

The entity query allows to search for specific entities by providing filters. This is similar to a SQL query.
Entity Query Filter

The query filter allows to restrict the entities which are returned.
Entity Query Order By

The 'order by' allows to order the returned entities.

Error

Client Error

An error that is returned as the result of a bad user request or a misconfiguration.
Localized Error Message

Localized error message.
Server Error

This error is thrown when something unexpected happens on our side.
Websocket Error

This error is thrown if an exception occurs during the processing of a websocket request.

Installment

Installment Calculated Plan
Installment Calculated Slice
Installment Payment

An installment payment represents a payment paid in multiple slices.
Installment Payment Slice

An installment payment slice represents a single transaction of money from the buyer to the merchant.
Installment Plan

The installment plan allows to setup a template for an installment.
Installment Plan Slice

The installment plan slice defines a single slice of an installment plan.

Internationalization

Label

Line Item

Manual Task

Manual Task

A manual task requires the manual intervention of a human.
Manual Task Action
Manual Task Notification

The manual task notification represents a single notification sent.
Manual Task Notification Delivery Type

The delivery type indicates how the notification is delivered.
Manual Task Notification Execution Type

The execution type defines if and when a notification is sent.
Manual Task Notification Subscription

The notification subscription controls when and how a notification is sent for a new manual task.
Manual Task Type

The manual task type indicates what kind of manual task is required to be executed by the human.

Merchant Onboarding

Metric

Metric

A metric represents the usage of a resource that can be measured.
Metric Type

The subscription metric type identifies the type of the metric.
Metric Usage Report

The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.

Payment

Account Payable

The account payable represents an outstanding amount which has to be paid by the merchant to the buyer. This represents typically a refund.
Account Receivable

The account receivable represents an outstanding amount which has to be paid by the buyer.
E Bill Contact Person
E Bill Registration Address
Final Balance Transaction Sums
Invoice Reconciliation Record
Invoice Reconciliation Record
Invoice Reconciliation Record Type
Invoice Reimbursement
Invoice Reimbursement
Pain File
Payment Facilitator Charge Attempt
Payment Initiation Advice File
Payment Reminder Condition

A payment reminder condition determines which payment reminder flow is applied on an invoice.
Payment Reminder Condition Type
Payment Reminder Flow Configuration
Payment Reminder Flow Level
Payment Reminder Flow Level
Payment Reminder Flow Level Type
Reconciliation Payment Fee Account
Reconciliation Sales Revenue Account
Reconciliation Tax Account
Reconciliation Tax Journal Entry
Rendered Terminal Transaction Summary
Terminal Receipt Fetch Request

The receipt fetch request allows to retrieve the receipt documents for a terminal transaction.
Transaction Line Item Update Request
Transaction Refunded Daily Turnover

The daily transaction turnover represents the daily report over successful refunded transactions' volume, turnover.
Transaction Summary DCC Transaction Sums
Transaction summary
eBill Invoice

Payment Link

Payment Link

Payment Web App

Charge Attempt Update

A request to update the state of a charge attempt. The charge attempt must be associated with a processor created by the invoking payment web app.
Charge Attempt Update Request

The charge attempt update request allows to change the state of a charge attempt. The charge attempt must be linked with a processor that was created by the payment Web App that invokes the operation.
Completion Configuration
Completion Update

A request to update the state of a completion. The completion must be associated with a processor created by the invoking payment web app.
Completion Update Request

The completion update request allows to change the state of a completion. The completion must be linked with a processor that was created by the payment Web App that invokes the operation.
Connector
Connector Creation Request
Connector Details
Processor
Processor Creation Request
Processor Details
Refund Configuration
Refund Update

A request to update the state of a refund. The refund must be associated with a processor created by the invoking payment web app.
Refund Update Request

The refund update request allows to change the state of a refund. The refund must be linked with a processor that was created by the payment Web App that invokes the operation.
Void Update

A request to update the state of a void. The void must be associated with a processor created by the invoking payment web app.
Void Update Request

The void update request allows to change the state of a void. The void must be linked with a processor that was created by the payment Web App that invokes the operation.

Printer

Printer

A printer allows to automatically schedule a print job onto a physical printer.
Printer Job

A print job is a try to send a document to a printer.
Printer Type

Product

Billing Cycle Model
Product

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.
Product Component
Product Component Group
Product Component Reference

The product component reference links components from different product versions, which makes it possible to carry out migrations.
Product Metered Fee
Product Metered Fee Tier
Product Period Fee
Product Retirement
Product Retirement Request
Product Setup Fee
Product Version
Product Version Retirement
Product Version Retirement Request

Shopify

Space

Metric Usage

The metric usage provides details about the consumption of a particular metric.
Space
Space Address
Space View

Subscription

Charge Strategy

A charge strategy controls when a charge is carried out.
Charge Strategy Condition

A charge strategy condition controls whether a charge strategy configuration is applied or not.
Charge Strategy Condition Type

A charge strategy condition type realize a particular condition which can be applied on the charge strategies.
Charge Strategy Type

A charge strategy controls the determination of the charge date for a subscription bill.
Coupon

Coupons are a way to grant subscription discounts. Create a new coupon, configure it with discounts and rules and then share it with your customers.
Coupon Application Rule Type

A coupon application rule restricts the application of coupons to subscription items.
Coupon Code

The coupon code which can be redeemed through a subscription.
Coupon Discount
Coupon End Date Redemption Rule

A rule which can be added to a coupon to restrict its redeemability to a point in time before a specific point in time.
Coupon Product Component References Application Rule

A rule which can be added to a coupon to restrict its applicability to a specific set of product component references.
Coupon Product Fee Type Application Rule

A rule which can be added to a coupon to restrict its applicability to a specific type of product fee.
Coupon Products Redemption Rule

A rule which can be added to a coupon to restrict its redeemability to a specific set of products.
Coupon Redemption Limit Redemption Rule

A rule which can be added to a coupon to restrict its redeemability to a maximum number of redemptions per coupon code.
Coupon Redemption Rule Type

A coupon redemption rule restricts redeemability of coupons.
Coupon Rule Type

A redemption or application coupon rule type
Coupon Start Date Redemption Rule

A rule which can be added to a coupon to restrict its redeemability to a point in time after a specific point in time.
Coupon Subscriber Limit Redemption Rule

A rule which can be added to a coupon to restrict its redeemability to a maximum number of subscribers.
Coupon Subscriber Redemption Rule

A rule which can be added to a coupon to restrict its redeemability to a specific set of subscribers.
Coupon Version

The coupon version contains a subset of the coupon properties which can change over time.Only one version can be active at the same time.
Discount Type

The type of the discount. Amount, percent, ...
Fixed Coupon Discount
Maximum Applications Limit Rule

Restrict the number of times a coupon can be applied to the same subscription.
Percentage Coupon Discount
Subscriber

A subscriber represents everyone who is subscribed to a product.
Subscription
Subscription Affiliate
Subscription Change Request

The subscription change request allows to change a subscription.
Subscription Charge

The subscription charge represents a single charge carried out for a particular subscription.
Subscription Component Configuration
Subscription Component Reference Configuration

The component reference configuration adjusts the product component for a particular subscription.
Subscription Create Request

The subscription create request holds all the data required to create a new subscription.
Subscription Creation Request
Subscription Initialization Request
Subscription Ledger Entry

The subscription ledger entry represents a single change on the subscription balance.
Subscription Period Bill
Subscription Period Bill Item
Subscription Update Request
Subscription Update Request
Subscription Version

Suspension

Tax

Terminal

Payment Terminal Device
Payment Terminal Device Manufacturer
Payment Terminal Device Model
Rendered Terminal Receipt
Terminal
Terminal Address
Terminal Configuration
Terminal Configuration Version
Terminal Location
Terminal Location Version
Terminal Receipt
Terminal Receipt Fetch Request

The receipt fetch request allows to retrieve the receipt documents for a terminal transaction.
Terminal Receipt Type
Terminal Reference
Terminal Type
Transaction Summary Reference

Token

Payment Information Hash

A payment information hash is generated from user input, ensuring consistent and collision-free results for identical inputs.
Payment Information Hash Type
Token
Token Version
Token Version Type

Transaction

Authenticated Card Data
Authenticated Card Request
Card Cryptogram
Card Data
Card Data . Create
Cardholder Authentication
Client Platform Information
Completion
Completion Details
Completion Line Item
Daily Turnover Execution

The daily turnover execution represents the insert of aggregated data on a daily basis.
Delivery Indication
Delivery Indication Decision Reason
Express Checkout Session
Express Checkout Shipping Option
Invoice
Invoice Comment
Invoice Replacement
Line Item Version
Payment Page Add-on Configuration
Payment Page Addon
Refund

A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a reversal.
Refund Comment
Tokenized Card Data
Tokenized Card Request
Transaction
Transaction Comment
Transaction Completion Request
Transaction Failed Daily Turnover

The daily transaction turnover represents the daily report over failed transactions' volume, turnover.
Transaction Fulfilled Daily Turnover

The daily transaction turnover represents the daily report over successful transactions' volume, turnover.
Transaction Group
Transaction Void
Wallet Type

User

User Interface

Web App

Web App Confirmation Response

The confirmation response provides details about the installation of the web app.

Webhook

Webhook Encryption Public Key

The webhook encryption public key is used to verify the webhook content signature.
Webhook Identity

The webhook identity represents a set of keys that will be used to sign the webhook messages.
Webhook Listener
Webhook Listener Entity
Webhook URL

API
Account
Accounting
Analytics
Bank
Base
Base
Charge
Condition
Connect
Contract
Core
Customer
Debt Collection
Document
Dunning
Email
Entity Query
Error
Installment
Internationalization
Label
Line Item
Manual Task
Merchant Onboarding
Metric
Payment
Payment Link
Payment Web App
Printer
Product
Shopify
Space
Subscription
Suspension
Tax
Terminal
Token
Transaction
User
User Interface
Web App
Webhook