Package software.xdev.brevo.model

Class BalanceOrder

java.lang.Object
software.xdev.brevo.model.BalanceOrder
public class BalanceOrder extends Object
Represents an order linked to a balance definition, including amount, due date, and transaction details.

  • Field Details

  • Constructor Details

    • BalanceOrder

      public BalanceOrder()

  • Method Details

    • amount

      public BalanceOrder amount(@Nonnull BigDecimal amount)

    • getAmount

      @Nonnull public BigDecimal getAmount()
      Order amount (must not be zero).
      Returns:
      amount

    • setAmount

      public void setAmount(@Nonnull BigDecimal amount)

    • balanceDefinitionId

      public BalanceOrder balanceDefinitionId(@Nullable String balanceDefinitionId)

    • getBalanceDefinitionId

      @Nullable public String getBalanceDefinitionId()
      Optional unique identifier (UUID) of the associated balance definition.
      Returns:
      balanceDefinitionId

    • setBalanceDefinitionId

      public void setBalanceDefinitionId(@Nullable String balanceDefinitionId)

    • contactId

      public BalanceOrder contactId(@Nonnull Integer contactId)

    • getContactId

      @Nonnull public Integer getContactId()
      Unique identifier of the contact placing the order (must be ≥ 1). minimum: 1
      Returns:
      contactId

    • setContactId

      public void setContactId(@Nonnull Integer contactId)

    • createdAt

      public BalanceOrder createdAt(@Nonnull String createdAt)

    • getCreatedAt

      @Nonnull public String getCreatedAt()
      RFC3339 timestamp indicating when the order was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull String createdAt)

    • dueAt

      public BalanceOrder dueAt(@Nonnull String dueAt)

    • getDueAt

      @Nonnull public String getDueAt()
      RFC3339 timestamp specifying when the order is due in the future.
      Returns:
      dueAt

    • setDueAt

      public void setDueAt(@Nonnull String dueAt)

    • expiresAt

      public BalanceOrder expiresAt(@Nullable String expiresAt)

    • getExpiresAt

      @Nullable public String getExpiresAt()
      Optional RFC3339 timestamp defining order expiration in the future.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable String expiresAt)

    • id

      public BalanceOrder id(@Nullable String id)

    • getId

      @Nullable public String getId()
      Unique identifier for the balance order.
      Returns:
      id

    • setId

      public void setId(@Nullable String id)

    • loyaltyProgramId

      public BalanceOrder loyaltyProgramId(@Nonnull String loyaltyProgramId)

    • getLoyaltyProgramId

      @Nonnull public String getLoyaltyProgramId()
      Unique identifier of the loyalty program associated with the order.
      Returns:
      loyaltyProgramId

    • setLoyaltyProgramId

      public void setLoyaltyProgramId(@Nonnull String loyaltyProgramId)

    • meta

      public BalanceOrder meta(@Nullable Map<String,Object> meta)

    • putMetaItem

      public BalanceOrder putMetaItem(String key, Object metaItem)

    • getMeta

      @Nullable public Map<String,Object> getMeta()
      Optional metadata associated with the order.
      Returns:
      meta

    • setMeta

      public void setMeta(@Nullable Map<String,Object> meta)

    • processedAt

      public BalanceOrder processedAt(@Nullable String processedAt)

    • getProcessedAt

      @Nullable public String getProcessedAt()
      Optional RFC3339 timestamp indicating when the order was processed.
      Returns:
      processedAt

    • setProcessedAt

      public void setProcessedAt(@Nullable String processedAt)

    • transactionid

      public BalanceOrder transactionid(@Nullable String transactionid)

    • getTransactionid

      @Nullable public String getTransactionid()
      Optional reference to the associated transaction ID.
      Returns:
      transactionid

    • setTransactionid

      public void setTransactionid(@Nullable String transactionid)

    • updatedAt

      public BalanceOrder updatedAt(@Nonnull String updatedAt)

    • getUpdatedAt

      @Nonnull public String getUpdatedAt()
      RFC3339 timestamp indicating the last update to the order.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull String updatedAt)

    • 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