Class CreditNotePreviewParams.Line

Enclosing class:

public static class CreditNotePreviewParams.Line extends Object
  • Method Details

    • builder

      public static CreditNotePreviewParams.Line.Builder builder()
    • getAmount

      public Long getAmount()
      The line item amount to credit. Only valid when type is invoice_line_item.
    • getDescription

      public String getDescription()
      The description of the credit note line item. Only valid when the type is custom_line_item.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @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.
    • getInvoiceLineItem

      public String getInvoiceLineItem()
      The invoice line item to credit. Only valid when the type is invoice_line_item.
    • getQuantity

      public Long getQuantity()
      The line item quantity to credit.
    • getTaxAmounts

      public Object getTaxAmounts()
      A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with tax_rates.
    • getTaxRates

      public Object getTaxRates()
      The tax rates which apply to the credit note line item. Only valid when the type is custom_line_item and cannot be mixed with tax_amounts.
    • getType

      Required. Type of the credit note line item, one of invoice_line_item or custom_line_item
    • getUnitAmount

      public Long getUnitAmount()
      The integer unit amount in cents (or local equivalent) of the credit note line item. This 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.
    • getUnitAmountDecimal

      public BigDecimal getUnitAmountDecimal()
      Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.