PHP Class PayPal\Api\TemplateData

Detailed template information.
Inheritance: extends PayPal\Common\PayPalModel
Exibir arquivo Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addAttachment ( FileAttachment $fileAttachment ) Append Attachments to the list.
addBillingInfo ( BillingInfo $billingInfo ) Append BillingInfo to the list.
addCcInfo ( string $email ) Append CcInfo to the list.
addItem ( InvoiceItem $invoiceItem ) Append Items to the list.
getAllowPartialPayment ( ) : boolean 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.
getAttachments ( ) : FileAttachment[] List of files attached to the invoice.
getBillingInfo ( ) : BillingInfo[] The required invoice recipient email address and any optional billing information. One recipient is supported.
getCcInfo ( ) : string[] 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.
getCustom ( ) : CustomAmount The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
getDiscount ( ) : Cost The invoice level discount, as a percent or an amount value.
getItems ( ) : InvoiceItem[] The list of items to include in the invoice. Maximum value is 100 items per invoice.
getLogoUrl ( ) : string Full URL of an external image to use as the logo. Maximum length is 4000 characters.
getMerchantInfo ( ) : PayPal\Api\MerchantInfo Information about the merchant who is sending the invoice.
getMerchantMemo ( ) : string A private bookkeeping memo for the merchant. Maximum length is 150 characters.
getMinimumAmountDue ( ) : PayPal\Api\Currency If allow_partial_payment is set to true, the minimum amount allowed for a partial payment.
getNote ( ) : string Note to the payer. 4000 characters max.
getPaymentTerm ( ) : PaymentTerm Optional. The payment deadline for the invoice. Value is either term_type or due_date but not both.
getReference ( ) : string Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
getShippingCost ( ) : ShippingCost The shipping cost, as a percent or an amount value.
getShippingInfo ( ) : ShippingInfo The shipping information for entities to whom items are being shipped.
getTaxCalculatedAfterDiscount ( ) : boolean 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 ( ) : boolean Indicates whether the unit price includes tax. Default is false.
getTerms ( ) : string General terms of the invoice. 4000 characters max.
getTotalAmount ( ) : PayPal\Api\Currency The total amount of the invoice.
removeAttachment ( FileAttachment $fileAttachment ) Remove Attachments from the list.
removeBillingInfo ( BillingInfo $billingInfo ) Remove BillingInfo from the list.
removeCcInfo ( string $email ) Remove CcInfo from the list.
removeItem ( InvoiceItem $invoiceItem ) Remove Items from the list.
setAllowPartialPayment ( boolean $allow_partial_payment ) 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.
setAttachments ( FileAttachment[] $attachments ) List of files attached to the invoice.
setBillingInfo ( BillingInfo[] $billing_info ) The required invoice recipient email address and any optional billing information. One recipient is supported.
setCcInfo ( string[] $cc_info ) 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.
setCustom ( CustomAmount $custom ) The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
setDiscount ( Cost $discount ) The invoice level discount, as a percent or an amount value.
setItems ( InvoiceItem[] $items ) The list of items to include in the invoice. Maximum value is 100 items per invoice.
setLogoUrl ( string $logo_url ) Full URL of an external image to use as the logo. Maximum length is 4000 characters.
setMerchantInfo ( PayPal\Api\MerchantInfo $merchant_info ) Information about the merchant who is sending the invoice.
setMerchantMemo ( string $merchant_memo ) A private bookkeeping memo for the merchant. Maximum length is 150 characters.
setMinimumAmountDue ( PayPal\Api\Currency $minimum_amount_due ) If allow_partial_payment is set to true, the minimum amount allowed for a partial payment.
setNote ( string $note ) Note to the payer. 4000 characters max.
setPaymentTerm ( PaymentTerm $payment_term ) Optional. The payment deadline for the invoice. Value is either term_type or due_date but not both.
setReference ( string $reference ) Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
setShippingCost ( ShippingCost $shipping_cost ) The shipping cost, as a percent or an amount value.
setShippingInfo ( ShippingInfo $shipping_info ) The shipping information for entities to whom items are being shipped.
setTaxCalculatedAfterDiscount ( boolean $tax_calculated_after_discount ) 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.
setTaxInclusive ( boolean $tax_inclusive ) Indicates whether the unit price includes tax. Default is false.
setTerms ( string $terms ) General terms of the invoice. 4000 characters max.
setTotalAmount ( PayPal\Api\Currency $total_amount ) The total amount of the invoice.

Method Details

addAttachment() public method

Append Attachments to the list.
public addAttachment ( FileAttachment $fileAttachment )
$fileAttachment FileAttachment

addBillingInfo() public method

Append BillingInfo to the list.
public addBillingInfo ( BillingInfo $billingInfo )
$billingInfo BillingInfo

addCcInfo() public method

Append CcInfo to the list.
public addCcInfo ( string $email )
$email string

addItem() public method

Append Items to the list.
public addItem ( InvoiceItem $invoiceItem )
$invoiceItem InvoiceItem

getAllowPartialPayment() public method

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.
public getAllowPartialPayment ( ) : boolean
return boolean

getAttachments() public method

List of files attached to the invoice.
public getAttachments ( ) : FileAttachment[]
return FileAttachment[]

getBillingInfo() public method

The required invoice recipient email address and any optional billing information. One recipient is supported.
public getBillingInfo ( ) : BillingInfo[]
return BillingInfo[]

getCcInfo() public method

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.
public getCcInfo ( ) : string[]
return string[]

getCustom() public method

The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
public getCustom ( ) : CustomAmount
return CustomAmount

getDiscount() public method

The invoice level discount, as a percent or an amount value.
public getDiscount ( ) : Cost
return Cost

getItems() public method

The list of items to include in the invoice. Maximum value is 100 items per invoice.
public getItems ( ) : InvoiceItem[]
return InvoiceItem[]

getLogoUrl() public method

Full URL of an external image to use as the logo. Maximum length is 4000 characters.
public getLogoUrl ( ) : string
return string

getMerchantInfo() public method

Information about the merchant who is sending the invoice.
public getMerchantInfo ( ) : PayPal\Api\MerchantInfo
return PayPal\Api\MerchantInfo

getMerchantMemo() public method

A private bookkeeping memo for the merchant. Maximum length is 150 characters.
public getMerchantMemo ( ) : string
return string

getMinimumAmountDue() public method

If allow_partial_payment is set to true, the minimum amount allowed for a partial payment.
public getMinimumAmountDue ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getNote() public method

Note to the payer. 4000 characters max.
public getNote ( ) : string
return string

getPaymentTerm() public method

Optional. The payment deadline for the invoice. Value is either term_type or due_date but not both.
public getPaymentTerm ( ) : PaymentTerm
return PaymentTerm

getReference() public method

Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
public getReference ( ) : string
return string

getShippingCost() public method

The shipping cost, as a percent or an amount value.
public getShippingCost ( ) : ShippingCost
return ShippingCost

getShippingInfo() public method

The shipping information for entities to whom items are being shipped.
public getShippingInfo ( ) : ShippingInfo
return ShippingInfo

getTaxCalculatedAfterDiscount() public method

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 method

Indicates whether the unit price includes tax. Default is false.
public getTaxInclusive ( ) : boolean
return boolean

getTerms() public method

General terms of the invoice. 4000 characters max.
public getTerms ( ) : string
return string

getTotalAmount() public method

The total amount of the invoice.
public getTotalAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

removeAttachment() public method

Remove Attachments from the list.
public removeAttachment ( FileAttachment $fileAttachment )
$fileAttachment FileAttachment

removeBillingInfo() public method

Remove BillingInfo from the list.
public removeBillingInfo ( BillingInfo $billingInfo )
$billingInfo BillingInfo

removeCcInfo() public method

Remove CcInfo from the list.
public removeCcInfo ( string $email )
$email string

removeItem() public method

Remove Items from the list.
public removeItem ( InvoiceItem $invoiceItem )
$invoiceItem InvoiceItem

setAllowPartialPayment() public method

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.
public setAllowPartialPayment ( boolean $allow_partial_payment )
$allow_partial_payment boolean

setAttachments() public method

List of files attached to the invoice.
public setAttachments ( FileAttachment[] $attachments )
$attachments FileAttachment[]

setBillingInfo() public method

The required invoice recipient email address and any optional billing information. One recipient is supported.
public setBillingInfo ( BillingInfo[] $billing_info )
$billing_info BillingInfo[]

setCcInfo() public method

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.
public setCcInfo ( string[] $cc_info )
$cc_info string[]

setCustom() public method

The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
public setCustom ( CustomAmount $custom )
$custom CustomAmount

setDiscount() public method

The invoice level discount, as a percent or an amount value.
public setDiscount ( Cost $discount )
$discount Cost

setItems() public method

The list of items to include in the invoice. Maximum value is 100 items per invoice.
public setItems ( InvoiceItem[] $items )
$items InvoiceItem[]

setLogoUrl() public method

Full URL of an external image to use as the logo. Maximum length is 4000 characters.
public setLogoUrl ( string $logo_url )
$logo_url string

setMerchantInfo() public method

Information about the merchant who is sending the invoice.
public setMerchantInfo ( PayPal\Api\MerchantInfo $merchant_info )
$merchant_info PayPal\Api\MerchantInfo

setMerchantMemo() public method

A private bookkeeping memo for the merchant. Maximum length is 150 characters.
public setMerchantMemo ( string $merchant_memo )
$merchant_memo string

setMinimumAmountDue() public method

If allow_partial_payment is set to true, the minimum amount allowed for a partial payment.
public setMinimumAmountDue ( PayPal\Api\Currency $minimum_amount_due )
$minimum_amount_due PayPal\Api\Currency

setNote() public method

Note to the payer. 4000 characters max.
public setNote ( string $note )
$note string

setPaymentTerm() public method

Optional. The payment deadline for the invoice. Value is either term_type or due_date but not both.
public setPaymentTerm ( PaymentTerm $payment_term )
$payment_term PaymentTerm

setReference() public method

Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
public setReference ( string $reference )
$reference string

setShippingCost() public method

The shipping cost, as a percent or an amount value.
public setShippingCost ( ShippingCost $shipping_cost )
$shipping_cost ShippingCost

setShippingInfo() public method

The shipping information for entities to whom items are being shipped.
public setShippingInfo ( ShippingInfo $shipping_info )
$shipping_info ShippingInfo

setTaxCalculatedAfterDiscount() public method

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.
public setTaxCalculatedAfterDiscount ( boolean $tax_calculated_after_discount )
$tax_calculated_after_discount boolean

setTaxInclusive() public method

Indicates whether the unit price includes tax. Default is false.
public setTaxInclusive ( boolean $tax_inclusive )
$tax_inclusive boolean

setTerms() public method

General terms of the invoice. 4000 characters max.
public setTerms ( string $terms )
$terms string

setTotalAmount() public method

The total amount of the invoice.
public setTotalAmount ( PayPal\Api\Currency $total_amount )
$total_amount PayPal\Api\Currency