| 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. |
|
