Package software.xdev.brevo.model

Class CreateBalanceDefinitionPayload

java.lang.Object

software.xdev.brevo.model.CreateBalanceDefinitionPayload

public class CreateBalanceDefinitionPayload
extends Object

Payload for creating a new balance definition, specifying expiration rules, rounding strategies, and constraints.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum	Defines when the balance expires within the selected duration.
static enum	CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum	Unit of time for balance validity.
static enum	CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum	Defines whether partial credit is allowed when reaching max balance.
static enum	CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum	Defines rounding strategy for credit transactions.
static enum	CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum	Defines rounding strategy for debit transactions.
static enum	CreateBalanceDefinitionPayload.UnitEnum	Unit of balance measurement.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_MODIFIER
static final String	JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_UNIT
static final String	JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_VALUE
static final String	JSON_PROPERTY_BALANCE_EXPIRATION_DATE
static final String	JSON_PROPERTY_BALANCE_OPTION_AMOUNT_OVERTAKING_STRATEGY
static final String	JSON_PROPERTY_BALANCE_OPTION_CREDIT_ROUNDING
static final String	JSON_PROPERTY_BALANCE_OPTION_DEBIT_ROUNDING
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_IMAGE_REF
static final String	JSON_PROPERTY_MAX_AMOUNT
static final String	JSON_PROPERTY_MAX_CREDIT_AMOUNT_LIMIT
static final String	JSON_PROPERTY_MAX_DEBIT_AMOUNT_LIMIT
static final String	JSON_PROPERTY_META
static final String	JSON_PROPERTY_MIN_AMOUNT
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_UNIT

Constructor Summary

Constructors

Constructor	Description
CreateBalanceDefinitionPayload()

Method Summary

Modifier and Type	Method	Description
CreateBalanceDefinitionPayload	balanceAvailabilityDurationModifier(CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)
CreateBalanceDefinitionPayload	balanceAvailabilityDurationUnit(CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)
CreateBalanceDefinitionPayload	balanceAvailabilityDurationValue(Integer balanceAvailabilityDurationValue)
CreateBalanceDefinitionPayload	balanceExpirationDate(LocalDate balanceExpirationDate)
CreateBalanceDefinitionPayload	balanceOptionAmountOvertakingStrategy(CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)
CreateBalanceDefinitionPayload	balanceOptionCreditRounding(CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)
CreateBalanceDefinitionPayload	balanceOptionDebitRounding(CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)
CreateBalanceDefinitionPayload	description(String description)
boolean	equals(Object o)
CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum	getBalanceAvailabilityDurationModifier()	Defines when the balance expires within the selected duration.
CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum	getBalanceAvailabilityDurationUnit()	Unit of time for balance validity.
Integer	getBalanceAvailabilityDurationValue()	Number of time units before the balance expires.
LocalDate	getBalanceExpirationDate()	Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry.
CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum	getBalanceOptionAmountOvertakingStrategy()	Defines whether partial credit is allowed when reaching max balance.
CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum	getBalanceOptionCreditRounding()	Defines rounding strategy for credit transactions.
CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum	getBalanceOptionDebitRounding()	Defines rounding strategy for debit transactions.
String	getDescription()	Short description of the balance definition.
String	getImageRef()	URL of an optional image reference.
BigDecimal	getMaxAmount()	Maximum allowable balance amount.
BigDecimal	getMaxCreditAmountLimit()	Maximum credit allowed per operation.
BigDecimal	getMaxDebitAmountLimit()	Maximum debit allowed per operation.
Object	getMeta()	Additional metadata for the balance definition.
BigDecimal	getMinAmount()	Minimum allowable balance amount.
String	getName()	Name of the balance definition.
CreateBalanceDefinitionPayload.UnitEnum	getUnit()	Unit of balance measurement.
int	hashCode()
CreateBalanceDefinitionPayload	imageRef(String imageRef)
CreateBalanceDefinitionPayload	maxAmount(BigDecimal maxAmount)
CreateBalanceDefinitionPayload	maxCreditAmountLimit(BigDecimal maxCreditAmountLimit)
CreateBalanceDefinitionPayload	maxDebitAmountLimit(BigDecimal maxDebitAmountLimit)
CreateBalanceDefinitionPayload	meta(Object meta)
CreateBalanceDefinitionPayload	minAmount(BigDecimal minAmount)
CreateBalanceDefinitionPayload	name(String name)
void	setBalanceAvailabilityDurationModifier(CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)
void	setBalanceAvailabilityDurationUnit(CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)
void	setBalanceAvailabilityDurationValue(Integer balanceAvailabilityDurationValue)
void	setBalanceExpirationDate(LocalDate balanceExpirationDate)
void	setBalanceOptionAmountOvertakingStrategy(CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)
void	setBalanceOptionCreditRounding(CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)
void	setBalanceOptionDebitRounding(CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)
void	setDescription(String description)
void	setImageRef(String imageRef)
void	setMaxAmount(BigDecimal maxAmount)
void	setMaxCreditAmountLimit(BigDecimal maxCreditAmountLimit)
void	setMaxDebitAmountLimit(BigDecimal maxDebitAmountLimit)
void	setMeta(Object meta)
void	setMinAmount(BigDecimal minAmount)
void	setName(String name)
void	setUnit(CreateBalanceDefinitionPayload.UnitEnum unit)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
CreateBalanceDefinitionPayload	unit(CreateBalanceDefinitionPayload.UnitEnum unit)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_MODIFIER

public static final String JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_MODIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_UNIT

public static final String JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_UNIT

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_VALUE

public static final String JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_EXPIRATION_DATE

public static final String JSON_PROPERTY_BALANCE_EXPIRATION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_OPTION_AMOUNT_OVERTAKING_STRATEGY

public static final String JSON_PROPERTY_BALANCE_OPTION_AMOUNT_OVERTAKING_STRATEGY

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_OPTION_CREDIT_ROUNDING

public static final String JSON_PROPERTY_BALANCE_OPTION_CREDIT_ROUNDING

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_OPTION_DEBIT_ROUNDING

public static final String JSON_PROPERTY_BALANCE_OPTION_DEBIT_ROUNDING

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_IMAGE_REF

public static final String JSON_PROPERTY_IMAGE_REF

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_AMOUNT

public static final String JSON_PROPERTY_MAX_AMOUNT

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_CREDIT_AMOUNT_LIMIT

public static final String JSON_PROPERTY_MAX_CREDIT_AMOUNT_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_DEBIT_AMOUNT_LIMIT

public static final String JSON_PROPERTY_MAX_DEBIT_AMOUNT_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_META

public static final String JSON_PROPERTY_META

See Also:

• Constant Field Values

JSON_PROPERTY_MIN_AMOUNT

public static final String JSON_PROPERTY_MIN_AMOUNT

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_UNIT

public static final String JSON_PROPERTY_UNIT

See Also:

• Constant Field Values

Constructor Details

CreateBalanceDefinitionPayload

public CreateBalanceDefinitionPayload()

Method Details

balanceAvailabilityDurationModifier

public CreateBalanceDefinitionPayload balanceAvailabilityDurationModifier(@Nullable
 CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)

getBalanceAvailabilityDurationModifier

@Nullable
public CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum getBalanceAvailabilityDurationModifier()

Defines when the balance expires within the selected duration.

Returns:

balanceAvailabilityDurationModifier

setBalanceAvailabilityDurationModifier

public void setBalanceAvailabilityDurationModifier(@Nullable
 CreateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)

balanceAvailabilityDurationUnit

public CreateBalanceDefinitionPayload balanceAvailabilityDurationUnit(@Nullable
 CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)

getBalanceAvailabilityDurationUnit

@Nullable
public CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum getBalanceAvailabilityDurationUnit()

Unit of time for balance validity.

Returns:

balanceAvailabilityDurationUnit

setBalanceAvailabilityDurationUnit

public void setBalanceAvailabilityDurationUnit(@Nullable
 CreateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)

balanceAvailabilityDurationValue

public CreateBalanceDefinitionPayload balanceAvailabilityDurationValue(@Nullable
 Integer balanceAvailabilityDurationValue)

getBalanceAvailabilityDurationValue

@Nullable
public Integer getBalanceAvailabilityDurationValue()

Number of time units before the balance expires.

Returns:

balanceAvailabilityDurationValue

setBalanceAvailabilityDurationValue

public void setBalanceAvailabilityDurationValue(@Nullable
 Integer balanceAvailabilityDurationValue)

balanceExpirationDate

public CreateBalanceDefinitionPayload balanceExpirationDate(@Nullable
 LocalDate balanceExpirationDate)

getBalanceExpirationDate

@Nullable
public LocalDate getBalanceExpirationDate()

Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry.

Returns:

balanceExpirationDate

setBalanceExpirationDate

public void setBalanceExpirationDate(@Nullable
 LocalDate balanceExpirationDate)

balanceOptionAmountOvertakingStrategy

public CreateBalanceDefinitionPayload balanceOptionAmountOvertakingStrategy(@Nullable
 CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)

getBalanceOptionAmountOvertakingStrategy

@Nullable
public CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum getBalanceOptionAmountOvertakingStrategy()

Defines whether partial credit is allowed when reaching max balance.

Returns:

balanceOptionAmountOvertakingStrategy

setBalanceOptionAmountOvertakingStrategy

public void setBalanceOptionAmountOvertakingStrategy(@Nullable
 CreateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)

balanceOptionCreditRounding

public CreateBalanceDefinitionPayload balanceOptionCreditRounding(@Nullable
 CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)

getBalanceOptionCreditRounding

@Nullable
public CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum getBalanceOptionCreditRounding()

Defines rounding strategy for credit transactions.

Returns:

balanceOptionCreditRounding

setBalanceOptionCreditRounding

public void setBalanceOptionCreditRounding(@Nullable
 CreateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)

balanceOptionDebitRounding

public CreateBalanceDefinitionPayload balanceOptionDebitRounding(@Nullable
 CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)

getBalanceOptionDebitRounding

@Nullable
public CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum getBalanceOptionDebitRounding()

Defines rounding strategy for debit transactions.

Returns:

balanceOptionDebitRounding

setBalanceOptionDebitRounding

public void setBalanceOptionDebitRounding(@Nullable
 CreateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)

description

public CreateBalanceDefinitionPayload description(@Nullable
 String description)

getDescription

@Nullable
public String getDescription()

Short description of the balance definition.

Returns:

description

setDescription

public void setDescription(@Nullable
 String description)

imageRef

public CreateBalanceDefinitionPayload imageRef(@Nullable
 String imageRef)

getImageRef

@Nullable
public String getImageRef()

URL of an optional image reference.

Returns:

imageRef

setImageRef

public void setImageRef(@Nullable
 String imageRef)

maxAmount

public CreateBalanceDefinitionPayload maxAmount(@Nullable
 BigDecimal maxAmount)

getMaxAmount

@Nullable
public BigDecimal getMaxAmount()

Maximum allowable balance amount.

Returns:

maxAmount

setMaxAmount

public void setMaxAmount(@Nullable
 BigDecimal maxAmount)

maxCreditAmountLimit

public CreateBalanceDefinitionPayload maxCreditAmountLimit(@Nullable
 BigDecimal maxCreditAmountLimit)

getMaxCreditAmountLimit

@Nullable
public BigDecimal getMaxCreditAmountLimit()

Maximum credit allowed per operation.

Returns:

maxCreditAmountLimit

setMaxCreditAmountLimit

public void setMaxCreditAmountLimit(@Nullable
 BigDecimal maxCreditAmountLimit)

maxDebitAmountLimit

public CreateBalanceDefinitionPayload maxDebitAmountLimit(@Nullable
 BigDecimal maxDebitAmountLimit)

getMaxDebitAmountLimit

@Nullable
public BigDecimal getMaxDebitAmountLimit()

Maximum debit allowed per operation.

Returns:

maxDebitAmountLimit

setMaxDebitAmountLimit

public void setMaxDebitAmountLimit(@Nullable
 BigDecimal maxDebitAmountLimit)

meta

public CreateBalanceDefinitionPayload meta(@Nullable
 Object meta)

getMeta

@Nullable
public Object getMeta()

Additional metadata for the balance definition.

Returns:

meta

setMeta

public void setMeta(@Nullable
 Object meta)

minAmount

public CreateBalanceDefinitionPayload minAmount(@Nullable
 BigDecimal minAmount)

getMinAmount

@Nullable
public BigDecimal getMinAmount()

Minimum allowable balance amount.

Returns:

minAmount

setMinAmount

public void setMinAmount(@Nullable
 BigDecimal minAmount)

name

public CreateBalanceDefinitionPayload name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

Name of the balance definition.

Returns:

name

setName

public void setName(@Nonnull
 String name)

unit

public CreateBalanceDefinitionPayload unit(@Nonnull
 CreateBalanceDefinitionPayload.UnitEnum unit)

getUnit

@Nonnull
public CreateBalanceDefinitionPayload.UnitEnum getUnit()

Unit of balance measurement.

Returns:

unit

setUnit

public void setUnit(@Nonnull
 CreateBalanceDefinitionPayload.UnitEnum unit)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string