Credit Account Services Data Model

Table of Contents

Data Diagram
Credit Account
- BLC_CREDIT_ACCOUNT
Transaction
- BLC_TRANSACTION
Broadleaf Common Data Features

Data Diagram

The Credit Account Services data model stores the credit accounts and credit account transactions.

Figure 1. Credit Account Entities Data Model

Credit Account

The Credit Account is an alternative form of payment which has been granted to the customer (or account). Customers can use it like any other form of payment. Typical use cases are store credit, account credit (i.e. B2B buy on credit), & digital gift cards.

BLC_CREDIT_ACCOUNT

Field	Description
ID	Unique row ID
TYPE	The type of this credit account.
ACCOUNT_NUMBER	Generated code that can be used to reference the credit account.
OWNING_USER_TYPE	Describes the owning user type of the credit account. For example, the credit account could belong to a customer, account, or an anonymous user, therefore this value might be BLC_CUSTOMER, BLC_ACCOUNT, or ANONYMOUS.
OWNING_USER_REF	The reference to the user that owns this credit account. For example, this may be a customer id, an account id, or the anonymous user’s email address.
BALANCE	The current balance for this credit account.
CURRENCY	The currency of the credit account.
VERSION	The JPA managed version of this payment.

Field

Description

Unique row ID

TYPE

The type of this credit account.

ACCOUNT_NUMBER

Generated code that can be used to reference the credit account.

OWNING_USER_TYPE

Describes the owning user type of the credit account. For example, the credit account could belong to a customer, account, or an anonymous user, therefore this value might be BLC_CUSTOMER, BLC_ACCOUNT, or ANONYMOUS.

OWNING_USER_REF

The reference to the user that owns this credit account. For example, this may be a customer id, an account id, or the anonymous user’s email address.

BALANCE

The current balance for this credit account.

CURRENCY

The currency of the credit account.

VERSION

The JPA managed version of this payment.

Transaction

Transactions represent the transaction information a the credit account.

BLC_TRANSACTION

Field	Description
ID	Unique row ID
CREDIT_ACCOUNT_ID	A reference to the credit account this transaction belongs to.
TRANSACTION_REFERENCE_ID	The transaction id known by the payment gateway. This reference can be used to link the request to the gateway’s record of the transaction in the case that the calling application does not receive a response from the gateway.
REQUEST_ID	The id used to represent the request that produced this transaction.
TYPE	The type of this transaction.
SOURCE	The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs. ORDER_OPERATION_SERVICES.
SOURCE_USER_TYPE	The type of user who initiated the transaction.
SOURCE_USER_ID	The id of user who initiated the transaction.
SOURCE_ENTITY_TYPE	The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
SOURCE_ENTITY_ID	The ID of the source entity associated with the transaction. For example, if source entity type is ORDER_FULFILLMENT, this would be the ID of the order fulfillment.
REASON	The reason for this transaction.
REASON_DESCRIPTION	Description for the reason for this transaction.
DATE_RECORDED	The timestamp when this transaction response was recorded.
AMOUNT	The amount related to this transaction.

Field

Description

Unique row ID

CREDIT_ACCOUNT_ID

A reference to the credit account this transaction belongs to.

TRANSACTION_REFERENCE_ID

The transaction id known by the payment gateway.

This reference can be used to link the request to the gateway’s record of the transaction in the case that the calling application does not receive a response from the gateway.

REQUEST_ID

The id used to represent the request that produced this transaction.

TYPE

The type of this transaction.

SOURCE

The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs. ORDER_OPERATION_SERVICES.

SOURCE_USER_TYPE

The type of user who initiated the transaction.

SOURCE_USER_ID

The id of user who initiated the transaction.

SOURCE_ENTITY_TYPE

The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".

SOURCE_ENTITY_ID

The ID of the source entity associated with the transaction. For example, if source entity type is ORDER_FULFILLMENT, this would be the ID of the order fulfillment.

REASON

The reason for this transaction.

REASON_DESCRIPTION

Description for the reason for this transaction.

DATE_RECORDED

The timestamp when this transaction response was recorded.

AMOUNT

The amount related to this transaction.

Broadleaf Common Data Features

Credit Account and Transaction are Tenant Trackable.