Class TemplateData

Detailed template information.

PayPal\Api\TemplateData

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/TemplateData.php

Methods summary

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

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

Namespaces

Classes

Class TemplateData

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters