TemplateData (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.api.payments.TemplateData

public class TemplateData
extends PayPalModel

Constructor Summary

Constructors
Constructor and Description

TemplateData()
Default Constructor

TemplateData(MerchantInfo merchantInfo)
Parameterized Constructor

Constructors
Constructor and Description
`TemplateData()` Default Constructor
`TemplateData(MerchantInfo merchantInfo)` Parameterized Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Boolean`	`getAllowPartialPayment()` Indicates whether the invoice allows a partial payment.
`java.util.List<FileAttachment>`	`getAttachments()` List of files attached to the invoice.
`java.util.List<BillingInfo>`	`getBillingInfo()` The required invoice recipient email address and any optional billing information.
`java.util.List<java.lang.String>`	`getCcInfo()` For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
`CustomAmount`	`getCustom()` The custom amount to apply on an invoice.
`Cost`	`getDiscount()` The invoice level discount, as a percent or an amount value.
`java.util.List<InvoiceItem>`	`getItems()` The list of items to include in the invoice.
`java.lang.String`	`getLogoUrl()` Full URL of an external image to use as the logo.
`MerchantInfo`	`getMerchantInfo()` Information about the merchant who is sending the invoice.
`java.lang.String`	`getMerchantMemo()` A private bookkeeping memo for the merchant.
`Currency`	`getMinimumAmountDue()` If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
`java.lang.String`	`getNote()` Note to the payer.
`PaymentTerm`	`getPaymentTerm()` Optional.
`java.lang.String`	`getReference()` Reference data, such as PO number, to add to the invoice.
`ShippingCost`	`getShippingCost()` The shipping cost, as a percent or an amount value.
`ShippingInfo`	`getShippingInfo()` The shipping information for entities to whom items are being shipped.
`java.lang.Boolean`	`getTaxCalculatedAfterDiscount()` Indicates whether tax is calculated before or after a discount.
`java.lang.Boolean`	`getTaxInclusive()` Indicates whether the unit price includes tax.
`java.lang.String`	`getTerms()` General terms of the invoice.
`Currency`	`getTotalAmount()` The total amount of the invoice.
`int`	`hashCode()`
`TemplateData`	`setAllowPartialPayment(java.lang.Boolean allowPartialPayment)` Indicates whether the invoice allows a partial payment.
`TemplateData`	`setAttachments(java.util.List<FileAttachment> attachments)` List of files attached to the invoice.
`TemplateData`	`setBillingInfo(java.util.List<BillingInfo> billingInfo)` The required invoice recipient email address and any optional billing information.
`TemplateData`	`setCcInfo(java.util.List<java.lang.String> ccInfo)` For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
`TemplateData`	`setCustom(CustomAmount custom)` The custom amount to apply on an invoice.
`TemplateData`	`setDiscount(Cost discount)` The invoice level discount, as a percent or an amount value.
`TemplateData`	`setItems(java.util.List<InvoiceItem> items)` The list of items to include in the invoice.
`TemplateData`	`setLogoUrl(java.lang.String logoUrl)` Full URL of an external image to use as the logo.
`TemplateData`	`setMerchantInfo(MerchantInfo merchantInfo)` Information about the merchant who is sending the invoice.
`TemplateData`	`setMerchantMemo(java.lang.String merchantMemo)` A private bookkeeping memo for the merchant.
`TemplateData`	`setMinimumAmountDue(Currency minimumAmountDue)` If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
`TemplateData`	`setNote(java.lang.String note)` Note to the payer.
`TemplateData`	`setPaymentTerm(PaymentTerm paymentTerm)` Optional.
`TemplateData`	`setReference(java.lang.String reference)` Reference data, such as PO number, to add to the invoice.
`TemplateData`	`setShippingCost(ShippingCost shippingCost)` The shipping cost, as a percent or an amount value.
`TemplateData`	`setShippingInfo(ShippingInfo shippingInfo)` The shipping information for entities to whom items are being shipped.
`TemplateData`	`setTaxCalculatedAfterDiscount(java.lang.Boolean taxCalculatedAfterDiscount)` Indicates whether tax is calculated before or after a discount.
`TemplateData`	`setTaxInclusive(java.lang.Boolean taxInclusive)` Indicates whether the unit price includes tax.
`TemplateData`	`setTerms(java.lang.String terms)` General terms of the invoice.
`TemplateData`	`setTotalAmount(Currency totalAmount)` The total amount of the invoice.

Methods inherited from class com.paypal.base.rest.PayPalModel
toJSON, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TemplateData
```
public TemplateData()
```
    Default Constructor
  - TemplateData
```
public TemplateData(MerchantInfo merchantInfo)
```
    Parameterized Constructor
- Method Detail
  - getMerchantInfo
```
public MerchantInfo getMerchantInfo()
```
    Information about the merchant who is sending the invoice.
  - getBillingInfo
```
public java.util.List<BillingInfo> getBillingInfo()
```
    The required invoice recipient email address and any optional billing information. One recipient is supported.
  - getCcInfo
```
public java.util.List<java.lang.String> getCcInfo()
```
    For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant.
  - getShippingInfo
```
public ShippingInfo getShippingInfo()
```
    The shipping information for entities to whom items are being shipped.
  - getItems
```
public java.util.List<InvoiceItem> getItems()
```
    The list of items to include in the invoice. Maximum value is 100 items per invoice.
  - getPaymentTerm
```
public PaymentTerm getPaymentTerm()
```
    Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both.
  - getReference
```
public java.lang.String getReference()
```
    Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
  - getDiscount
```
public Cost getDiscount()
```
    The invoice level discount, as a percent or an amount value.
  - getShippingCost
```
public ShippingCost getShippingCost()
```
    The shipping cost, as a percent or an amount value.
  - getCustom
```
public CustomAmount getCustom()
```
    The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
  - getAllowPartialPayment
```
public java.lang.Boolean getAllowPartialPayment()
```
    Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`.
  - getMinimumAmountDue
```
public Currency getMinimumAmountDue()
```
    If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
  - getTaxCalculatedAfterDiscount
```
public java.lang.Boolean getTaxCalculatedAfterDiscount()
```
    Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`.
  - getTaxInclusive
```
public java.lang.Boolean getTaxInclusive()
```
    Indicates whether the unit price includes tax. Default is `false`.
  - getTerms
```
public java.lang.String getTerms()
```
    General terms of the invoice. 4000 characters max.
  - getNote
```
public java.lang.String getNote()
```
    Note to the payer. 4000 characters max.
  - getMerchantMemo
```
public java.lang.String getMerchantMemo()
```
    A private bookkeeping memo for the merchant. Maximum length is 150 characters.
  - getLogoUrl
```
public java.lang.String getLogoUrl()
```
    Full URL of an external image to use as the logo. Maximum length is 4000 characters.
  - getTotalAmount
```
public Currency getTotalAmount()
```
    The total amount of the invoice.
  - getAttachments
```
public java.util.List<FileAttachment> getAttachments()
```
    List of files attached to the invoice.
  - setMerchantInfo
```
public TemplateData setMerchantInfo(MerchantInfo merchantInfo)
```
    Information about the merchant who is sending the invoice.
    
    Returns:
    
    this
  - setBillingInfo
```
public TemplateData setBillingInfo(java.util.List<BillingInfo> billingInfo)
```
    The required invoice recipient email address and any optional billing information. One recipient is supported.
    
    Returns:
    
    this
  - setCcInfo
```
public TemplateData setCcInfo(java.util.List<java.lang.String> ccInfo)
```
    For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant.
    
    Returns:
    
    this
  - setShippingInfo
```
public TemplateData setShippingInfo(ShippingInfo shippingInfo)
```
    The shipping information for entities to whom items are being shipped.
    
    Returns:
    
    this
  - setItems
```
public TemplateData setItems(java.util.List<InvoiceItem> items)
```
    The list of items to include in the invoice. Maximum value is 100 items per invoice.
    
    Returns:
    
    this
  - setPaymentTerm
```
public TemplateData setPaymentTerm(PaymentTerm paymentTerm)
```
    Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both.
    
    Returns:
    
    this
  - setReference
```
public TemplateData setReference(java.lang.String reference)
```
    Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
    
    Returns:
    
    this
  - setDiscount
```
public TemplateData setDiscount(Cost discount)
```
    The invoice level discount, as a percent or an amount value.
    
    Returns:
    
    this
  - setShippingCost
```
public TemplateData setShippingCost(ShippingCost shippingCost)
```
    The shipping cost, as a percent or an amount value.
    
    Returns:
    
    this
  - setCustom
```
public TemplateData setCustom(CustomAmount custom)
```
    The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
    
    Returns:
    
    this
  - setAllowPartialPayment
```
public TemplateData setAllowPartialPayment(java.lang.Boolean allowPartialPayment)
```
    Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`.
    
    Returns:
    
    this
  - setMinimumAmountDue
```
public TemplateData setMinimumAmountDue(Currency minimumAmountDue)
```
    If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
    
    Returns:
    
    this
  - setTaxCalculatedAfterDiscount
```
public TemplateData setTaxCalculatedAfterDiscount(java.lang.Boolean taxCalculatedAfterDiscount)
```
    Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`.
    
    Returns:
    
    this
  - setTaxInclusive
```
public TemplateData setTaxInclusive(java.lang.Boolean taxInclusive)
```
    Indicates whether the unit price includes tax. Default is `false`.
    
    Returns:
    
    this
  - setTerms
```
public TemplateData setTerms(java.lang.String terms)
```
    General terms of the invoice. 4000 characters max.
    
    Returns:
    
    this
  - setNote
```
public TemplateData setNote(java.lang.String note)
```
    Note to the payer. 4000 characters max.
    
    Returns:
    
    this
  - setMerchantMemo
```
public TemplateData setMerchantMemo(java.lang.String merchantMemo)
```
    A private bookkeeping memo for the merchant. Maximum length is 150 characters.
    
    Returns:
    
    this
  - setLogoUrl
```
public TemplateData setLogoUrl(java.lang.String logoUrl)
```
    Full URL of an external image to use as the logo. Maximum length is 4000 characters.
    
    Returns:
    
    this
  - setTotalAmount
```
public TemplateData setTotalAmount(Currency totalAmount)
```
    The total amount of the invoice.
    
    Returns:
    
    this
  - setAttachments
```
public TemplateData setAttachments(java.util.List<FileAttachment> attachments)
```
    List of files attached to the invoice.
    
    Returns:
    
    this
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class PayPalModel
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
    Overrides:
    
    canEqual in class PayPalModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PayPalModel

Class TemplateData

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

TemplateData

TemplateData

Method Detail

getMerchantInfo

getBillingInfo

getCcInfo

getShippingInfo

getItems

getPaymentTerm

getReference

getDiscount

getShippingCost

getCustom

getAllowPartialPayment

getMinimumAmountDue

getTaxCalculatedAfterDiscount

getTaxInclusive

getTerms

getNote

getMerchantMemo

getLogoUrl

getTotalAmount

getAttachments

setMerchantInfo

setBillingInfo

setCcInfo

setShippingInfo

setItems

setPaymentTerm

setReference

setDiscount

setShippingCost

setCustom

setAllowPartialPayment

setMinimumAmountDue

setTaxCalculatedAfterDiscount

setTaxInclusive

setTerms

setNote

setMerchantMemo

setLogoUrl

setTotalAmount

setAttachments

equals

canEqual

hashCode