public static class CreditNoteCreateParams.Line
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
CreditNoteCreateParams.Line.Builder |
static class |
CreditNoteCreateParams.Line.Type |
Modifier and Type | Method and Description |
---|---|
static CreditNoteCreateParams.Line.Builder |
builder() |
java.lang.Long |
getAmount()
The line item amount to credit.
|
java.lang.String |
getDescription()
The description of the credit note line item.
|
java.util.Map<java.lang.String,java.lang.Object> |
getExtraParams()
Map of extra parameters for custom features not available in this client library.
|
java.lang.String |
getInvoiceLineItem()
The invoice line item to credit.
|
java.lang.Long |
getQuantity()
The line item quantity to credit.
|
java.lang.Object |
getTaxRates()
The tax rates which apply to the credit note line item.
|
CreditNoteCreateParams.Line.Type |
getType()
Type of the credit note line item, one of
invoice_line_item or custom_line_item . |
java.lang.Long |
getUnitAmount()
The integer unit amount in %s of the credit note line item.
|
java.math.BigDecimal |
getUnitAmountDecimal()
Same as
unit_amount , but accepts a decimal value with at most 12 decimal places. |
public static CreditNoteCreateParams.Line.Builder builder()
public java.lang.Long getAmount()
type
is invoice_line_item
and
the referenced invoice line item does not have a quantity, only an amount.public java.lang.String getDescription()
type
is custom_line_item
.public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
@SerializedName
value. Instead, each
key/value pair is serialized as if the key is a root-level field (serialized) name in this
param object. Effectively, this map is flattened to its parent instance.public java.lang.String getInvoiceLineItem()
type
is invoice_line_item
.public java.lang.Long getQuantity()
public java.lang.Object getTaxRates()
type
is
custom_line_item
.public CreditNoteCreateParams.Line.Type getType()
invoice_line_item
or custom_line_item
.public java.lang.Long getUnitAmount()
unit_amount
will be multiplied by the quantity to get the full amount to credit for this
line item. Only valid when type
is custom_line_item
.public java.math.BigDecimal getUnitAmountDecimal()
unit_amount
, but accepts a decimal value with at most 12 decimal places. Only
one of unit_amount
and unit_amount_decimal
can be set.