Serialized Form

Package com.broadleafcommerce.creditaccount.domain

Class com.broadleafcommerce.creditaccount.domain.CreditAccount

class CreditAccount extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountNumber

String accountNumber

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

alternativeOwningUserRef

String alternativeOwningUserRef

Describes an alternative owning user reference for the credit account, that can be used instead of the CreditAccount.owningUserRef.

alternativeOwningUserType

String alternativeOwningUserType

Describes an alternative owning user type of the credit account, that can be used instead of the CreditAccount.owningUserType.

See Also:

• DefaultOwningUserType

attributes

Map<String,Object> attributes

Additional attributes associated with this credit account.

balance

javax.money.MonetaryAmount balance

The current balance for this credit account.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The id of this credit account.

owningUserRef

String owningUserRef

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.

owningUserType

String owningUserType

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

See Also:

• DefaultOwningUserType

type

String type

The type of this credit account.

See Also:

• DefaultCreditAccountType

version

Integer version

The version of this credit account. Used for checking that the requested version of the credit account is up-to-date before saving changes. Required for any request which results in an update being made to the credit account. This should never be manually incremented/decremented.

Class com.broadleafcommerce.creditaccount.domain.CreditAccountRef

class CreditAccountRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountNumber

String accountNumber

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

id

String id

The credit account's id.

owningUserRef

String owningUserRef

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.

owningUserType

String owningUserType

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

See Also:

• DefaultOwningUserType

type

String type

The type of this credit account.

See Also:

• DefaultCreditAccountType

Class com.broadleafcommerce.creditaccount.domain.RelatedTransactionDetail

class RelatedTransactionDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

javax.money.MonetaryAmount amount

The amount executed.

transactionId

String transactionId

The transaction id.

transactionType

String transactionType

The related transaction type.

Class com.broadleafcommerce.creditaccount.domain.Transaction

class Transaction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

javax.money.MonetaryAmount amount

The amount related to this transaction.

amountRemaining

javax.money.MonetaryAmount amountRemaining

The unused/unexpired amount related to this transaction. Note: this field is only applicable if this is an expiring credit transaction.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

creditAccountRef

CreditAccountRef creditAccountRef

The credit account reference to the credit account.

dateRecorded

Instant dateRecorded

The timestamp when this transaction response was recorded.

expirationDate

Instant expirationDate

The timestamp when this transaction will expire. Note: this field is only applicable for credit transactions.

id

String id

The id of this transaction.

reason

String reason

The reason for this transaction.

reasonDescription

String reasonDescription

Description for the reason for this transaction.

relatedTransactionDetails

List<RelatedTransactionDetail> relatedTransactionDetails

The child debit transactions for purchases or expirations. Note: These records should only be present on credit transactions.

requestId

String requestId

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

source

String source

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

sourceEntityId

String sourceEntityId

The ID of the source entity associated with the transaction.

For example, if Transaction.getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.

See Also:

• Transaction.getSourceEntityType()

sourceEntityType

String sourceEntityType

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

See Also:

• DefaultSourceEntityType

sourceUserId

String sourceUserId

The id of user who initiated the transaction.

sourceUserType

String sourceUserType

The type of user who initiated the transaction.

See Also:

• DefaultSourceUserType

subType

String subType

The sub-type of this transaction.

See Also:

• DefaultTransactionSubType

transactionReferenceId

String transactionReferenceId

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.

type

String type

The type of this transaction.

See Also:

• DefaultTransactionType

version

Integer version

The version of this transaction. Used for checking that the requested version of the transaction is up-to-date before saving changes. Required for any request which results in an update being made. This should never be manually incremented/decremented.

Package com.broadleafcommerce.creditaccount.exception

Exception com.broadleafcommerce.creditaccount.exception.CreateCreditAccountException

class CreateCreditAccountException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.creditaccount.exception.InvalidTransactionExecutionRequestException

class InvalidTransactionExecutionRequestException extends RuntimeException implements Serializable

Package com.broadleafcommerce.creditaccount.provider.jpa.domain

Class com.broadleafcommerce.creditaccount.provider.jpa.domain.JpaCreditAccount

class JpaCreditAccount extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountNumber

String accountNumber

See Also:

• CreditAccount.getAccountNumber()

alternativeOwningUserRef

String alternativeOwningUserRef

See Also:

• CreditAccount.getAlternativeOwningUserRef()

alternativeOwningUserType

String alternativeOwningUserType

See Also:

• CreditAccount.getAlternativeOwningUserType()

attributes

Map<String,Object> attributes

See Also:

• CreditAccount.getAttributes()

balance

BigDecimal balance

See Also:

• CreditAccount.getBalance()
• JpaCreditAccount.getBalance()
• JpaCreditAccount.setBalance(MonetaryAmount)

contextId

String contextId

The JPA primary key.

currency

javax.money.CurrencyUnit currency

The currency that is used to convert between a MonetaryAmount and a BigDecimal value.

owningUserRef

String owningUserRef

See Also:

• CreditAccount.getOwningUserRef()

owningUserType

String owningUserType

See Also:

• CreditAccount.getOwningUserType()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

See Also:

• ApplicationJpaTracking

type

String type

See Also:

• CreditAccount.getType()

version

int version

The JPA managed version of this credit account. This should not be modified by application code. See JPA's @Version.

Class com.broadleafcommerce.creditaccount.provider.jpa.domain.JpaTransaction

class JpaTransaction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

BigDecimal amount

See Also:

• Transaction.getAmount()
• JpaTransaction.getAmount()
• JpaTransaction.setAmount(MonetaryAmount)

amountRemaining

BigDecimal amountRemaining

contextId

String contextId

The JPA primary key.

creditAccount

JpaCreditAccount creditAccount

A reference to the credit account this transaction belongs to.

dateRecorded

Instant dateRecorded

See Also:

• Transaction.getDateRecorded()

expirationDate

Instant expirationDate

See Also:

• Transaction.getExpirationDate()

reason

String reason

See Also:

• Transaction.getReason()

reasonDescription

String reasonDescription

See Also:

• Transaction.getReasonDescription()

relatedTransactionDetails

List<RelatedTransactionDetail> relatedTransactionDetails

See Also:

• Transaction.getRelatedTransactionDetails()

requestId

String requestId

See Also:

• Transaction.getRequestId()

source

String source

See Also:

• Transaction.getSource()

sourceEntityId

String sourceEntityId

See Also:

• Transaction.getSourceEntityId()

sourceEntityType

String sourceEntityType

See Also:

• Transaction.getSourceEntityType()

sourceUserId

String sourceUserId

See Also:

• Transaction.getSourceUserId()

sourceUserType

String sourceUserType

See Also:

• Transaction.getSourceUserType()

subType

String subType

See Also:

• Transaction.getSubType()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

transactionReferenceId

String transactionReferenceId

See Also:

• Transaction.getTransactionReferenceId()

type

String type

See Also:

• Transaction.getType()

version

int version

The JPA managed version of this credit account. This should not be modified by application code. See JPA's @Version.

Package com.broadleafcommerce.creditaccount.web.endpoint.domain

Class com.broadleafcommerce.creditaccount.web.endpoint.domain.CreateCreditAccountRequest

class CreateCreditAccountRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

alternativeOwningUserRef

String alternativeOwningUserRef

Describes an alternative owning user reference for the credit account, that can be used instead of the CreateCreditAccountRequest.owningUserRef.

alternativeOwningUserType

String alternativeOwningUserType

Describes an alternative owning user type of the credit account, that can be used instead of the CreateCreditAccountRequest.owningUserType.

See Also:

• DefaultOwningUserType

attributes

Map<String,Object> attributes

Additional attributes associated with this credit account.

balance

javax.money.MonetaryAmount balance

See Also:

• CreditAccount.getBalance()

expirationDate

Instant expirationDate

See Also:

• Transaction.getExpirationDate()

owningUserRef

String owningUserRef

See Also:

• CreditAccount.getOwningUserRef()

owningUserType

String owningUserType

See Also:

• CreditAccount.getOwningUserType()

reason

String reason

See Also:

• Transaction.getReason()

reasonDescription

String reasonDescription

See Also:

• Transaction.getReasonDescription()

source

String source

See Also:

• Transaction.getSource()

sourceEntityId

String sourceEntityId

See Also:

• Transaction.getSourceEntityId()

sourceEntityType

String sourceEntityType

See Also:

• Transaction.getSourceEntityType()

type

String type

See Also:

• CreditAccount.getType()

Class com.broadleafcommerce.creditaccount.web.endpoint.domain.CurrencyContext

class CurrencyContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currency

javax.money.CurrencyUnit currency

The currency by which to retrieve the Credit account.

Class com.broadleafcommerce.creditaccount.web.endpoint.domain.ExpirationSourceInfo

class ExpirationSourceInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

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

source

String source

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

sourceEntityId

String sourceEntityId

The ID of the source entity associated with the transaction.

For example, if ExpirationSourceInfo.getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.

See Also:

• ExpirationSourceInfo.getSourceEntityType()

sourceEntityType

String sourceEntityType

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

See Also:

• DefaultSourceEntityType

Class com.broadleafcommerce.creditaccount.web.endpoint.domain.TransactionExecutionRequest

class TransactionExecutionRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

expirationDate

Instant expirationDate

See Also:

• Transaction.getExpirationDate()

reason

String reason

See Also:

• Transaction.getReason()

reasonDescription

String reasonDescription

See Also:

• Transaction.getReasonDescription()

requestId

String requestId

See Also:

• Transaction.getRequestId()

source

String source

See Also:

• Transaction.getSource()

sourceEntityId

String sourceEntityId

See Also:

• Transaction.getSourceEntityId()

sourceEntityType

String sourceEntityType

See Also:

• Transaction.getSourceEntityType()

sourceUserId

String sourceUserId

See Also:

• Transaction.getSourceUserId()

sourceUserType

String sourceUserType

See Also:

• Transaction.getSourceUserType()

transactionAmount

javax.money.MonetaryAmount transactionAmount

See Also:

• Transaction.getAmount()

transactionReferenceId

String transactionReferenceId

See Also:

• Transaction.getTransactionReferenceId()

transactionType

String transactionType

See Also:

• Transaction.getType()

Class com.broadleafcommerce.creditaccount.web.endpoint.domain.TransactionExecutionResponse

class TransactionExecutionResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

creditAccount

CreditAccount creditAccount

The updated CreditAccount for the executed Transaction.

transaction

Transaction transaction

The executed Transaction.