com.bitpay.sdk.model.ledger.LedgerEntry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bitpay_sdk Show documentation
Show all versions of bitpay_sdk Show documentation
Full implementation of the BitPay Payment Gateway. This library implements BitPay's Cryptographically
Secure RESTful API.
The newest version!
/*
* Copyright (c) 2019 BitPay.
* All rights reserved.
*/
package com.bitpay.sdk.model.ledger;
import com.bitpay.sdk.util.serializer.Iso8601ToZonedDateTimeDeserializer;
import com.bitpay.sdk.util.serializer.ZonedDateTimeToIso8601Serializer;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.math.BigInteger;
import java.time.ZonedDateTime;
/**
* The type Ledger entry.
*
* @see REST API Ledgers
*/
@JsonIgnoreProperties(ignoreUnknown = true)
public class LedgerEntry {
protected String type;
protected BigInteger amount;
protected Integer code;
protected String description;
protected ZonedDateTime timestamp;
protected String txType;
protected BigInteger scale;
protected String invoiceId;
protected Buyer buyer;
protected Double invoiceAmount;
protected String invoiceCurrency;
protected String transactionCurrency;
protected String id;
protected String supportRequest;
protected String currency;
/**
* Instantiates a new Ledger entry.
*/
public LedgerEntry() {
}
/**
* Gets type of Ledger entry name.
*
* @return the type
*
* @see Ledger entry codes
*/
@JsonIgnore
public String getType() {
return this.type;
}
/**
* Sets type of Ledger entry name.
*
* @param type the type
*
* @see Ledger entry codes
*/
@JsonProperty("type")
public void setType(final String type) {
this.type = type;
}
/**
* Gets amount.
* Ledger entry amount, relative to the scale.
* The decimal amount can be obtained by dividing the amount field by the scale parameter.
*
* @return the amount
*/
@JsonIgnore
public BigInteger getAmount() {
return this.amount;
}
/**
* Sets amount.
* Ledger entry amount, relative to the scale.
* The decimal amount can be obtained by dividing the amount field by the scale parameter.
*
* @param amount the amount
*
*
*/
@JsonProperty("amount")
public void setAmount(final BigInteger amount) {
this.amount = amount;
}
/**
* Gets Ledger entry code.
* Contains the Ledger entry code. See the list of Ledger Entry Codes.
*
* @return the code
*
* @see Ledger entry codes
*/
@JsonIgnore
public Integer getCode() {
return this.code;
}
/**
* Sets Ledger entry code.
* Contains the Ledger entry code. See the list of Ledger Entry Codes.
*
* @param code the code
*
* @see Ledger entry codes
*/
@JsonProperty("code")
public void setCode(final Integer code) {
this.code = code;
}
/**
* Gets description.
* Ledger entry description.
* Also contains an id depending on the type of entry
* (for instance payout id, settlement id, invoice orderId etc...).
*
* @return the description
*/
@JsonIgnore
public String getDescription() {
return this.description;
}
/**
* Sets description.
* Ledger entry description.
* Also contains an id depending on the type of entry
* (for instance payout id, settlement id, invoice orderId etc...).
*
* @param description the description
*/
@JsonProperty("description")
public void setDescription(final String description) {
this.description = description;
}
/**
* Gets date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
*
* @return the timestamp
*/
@JsonIgnore
@JsonSerialize(using = ZonedDateTimeToIso8601Serializer.class)
public ZonedDateTime getTimestamp() {
return this.timestamp;
}
/**
* Sets date and time of the ledger entry (UTC). ISO-8601 format yyyy-mm-ddThh:mm:ssZ.
*
* @param timestamp the timestamp
*/
@JsonProperty("timestamp")
@JsonDeserialize(using = Iso8601ToZonedDateTimeDeserializer.class)
public void setTimestamp(final ZonedDateTime timestamp) {
this.timestamp = timestamp;
}
/**
* Gets tx type.
*
* @return the tx type
* @deprecated see type
*/
@Deprecated
@JsonIgnore
public String getTxType() {
return this.txType;
}
/**
* Sets tx type.
*
* @param txType the tx type
* @deprecated see type
*/
@JsonProperty("txType")
public void setTxType(final String txType) {
this.txType = txType;
}
/**
* Gets power of 10 used for conversion.
*
* @return the scale
*/
@JsonIgnore
public BigInteger getScale() {
return this.scale;
}
/**
* Sets power of 10 used for conversion.
*
* @param scale the scale
*/
@JsonProperty("scale")
public void setScale(final BigInteger scale) {
this.scale = scale;
}
/**
* Gets BitPay invoice Id.
*
* @return the invoice id
*/
@JsonIgnore
public String getInvoiceId() {
return this.invoiceId;
}
/**
* Sets BitPay invoice Id.
*
* @param invoiceId the invoice id
*/
@JsonProperty("invoiceId")
public void setInvoiceId(final String invoiceId) {
this.invoiceId = invoiceId;
}
/**
* Gets Buyer.
*
* @return the buyer
*/
@JsonIgnore
public Buyer getBuyer() {
return this.buyer;
}
/**
* Sets Buyer.
*
* @param buyer the buyer
*/
@JsonProperty("buyerFields")
public void setBuyer(final Buyer buyer) {
this.buyer = buyer;
}
/**
* Gets invoice price in the invoice original currency.
*
* @return the invoice amount
*/
@JsonIgnore
public Double getInvoiceAmount() {
return this.invoiceAmount;
}
/**
* Sets invoice price in the invoice original currency.
*
* @param invoiceAmount the invoice amount
*/
@JsonProperty("invoiceAmount")
public void setInvoiceAmount(final Double invoiceAmount) {
this.invoiceAmount = invoiceAmount;
}
/**
* Gets currency used for invoice creation.
*
* @return the invoice currency
*/
@JsonIgnore
public String getInvoiceCurrency() {
return this.invoiceCurrency;
}
/**
* Sets currency used for invoice creation.
*
* @param invoiceCurrency the invoice currency
*/
@JsonProperty("invoiceCurrency")
public void setInvoiceCurrency(final String invoiceCurrency) {
this.invoiceCurrency = invoiceCurrency;
}
/**
* Gets transaction currency.
* Cryptocurrency selected by the consumer when paying an invoice.
*
* @return the transaction currency
*/
@JsonIgnore
public String getTransactionCurrency() {
return this.transactionCurrency;
}
/**
* Sets transaction currency.
* Cryptocurrency selected by the consumer when paying an invoice.
*
* @param transactionCurrency the transaction currency
*/
@JsonProperty("transactionCurrency")
public void setTransactionCurrency(final String transactionCurrency) {
this.transactionCurrency = transactionCurrency;
}
/**
* Gets Ledger resource Id.
*
* @return the id
*/
@JsonIgnore
public String getId() {
return this.id;
}
/**
* Sets Ledger resource Id.
*
* @param id the id
*/
@JsonProperty("id")
public void setId(final String id) {
this.id = id;
}
/**
* Gets the refund requestId.
*
* @return refund requestId
*/
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
public String getSupportRequest() {
return this.supportRequest;
}
/**
* Sets the refund requestId.
*
* @param supportRequest refund request id
*/
@JsonProperty("supportRequest")
public void setSupportRequest(final String supportRequest) {
this.supportRequest = supportRequest;
}
/**
* Gets ledger entry currency for the corresponding amount.
*
* @return currency
*/
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
public String getCurrency() {
return this.currency;
}
/**
* Sets ledger entry currency for the corresponding amount.
*
* @param currency currency
*/
@JsonProperty("currency")
public void setCurrency(final String currency) {
this.currency = currency;
}
}