PHP Class PayPal\Api\Invoice

Detailed invoice information.
Inheritance: extends PayPal\Common\PayPalResourceModel
Mostrar archivo 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 ( Participant $participant ) Append CcInfo to the list.
addItem ( InvoiceItem $invoiceItem ) Append Items to the list.
addPayment ( PaymentDetail $paymentDetail ) Append Payments to the list.
addRefund ( RefundDetail $refundDetail ) Append Refunds to the list.
cancel ( CancelNotification $cancelNotification, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Cancels an invoice, by ID.
create ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Invoice Creates an invoice. Include invoice details including merchant information in the request.
delete ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Delete a particular invoice by passing the invoice ID to the request URI.
deleteExternalPayment ( $transactionId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Delete external payment.
deleteExternalRefund ( $transactionId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Delete external refund.
generateNumber ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : InvoiceNumber Generates the successive invoice number.
get ( string $invoiceId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Invoice Gets the details for a specified invoice, by ID.
getAdditionalData ( ) : string Any miscellaneous invoice data. Maximum length is 4000 characters.
getAll ( array $params = [], ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : PayPal\Api\InvoiceSearchResponse Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
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 ( ) : 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.
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.
getId ( ) : string The unique invoice resource identifier.
getInvoiceDate ( ) : string The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
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.
getMetadata ( ) : Metadata Audit information for the invoice.
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.
getNumber ( ) : string Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
getPaidAmount ( ) : PaymentSummary Payment summary of the invoice including amount paid through PayPal and other sources.
getPaymentTerm ( ) : PaymentTerm Optional. The payment deadline for the invoice. Value is either term_type or due_date but not both.
getPayments ( ) : PaymentDetail[] List of payment details for the invoice.
getReference ( ) : string Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
getRefundedAmount ( ) : PaymentSummary Payment summary of the invoice including amount refunded through PayPal and other sources.
getRefunds ( ) : RefundDetail[] List of refund details for the invoice.
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.
getStatus ( ) : string Status of the invoice.
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.
getTemplateId ( ) : string The template ID used for the invoice. Useful for copy functionality.
getTerms ( ) : string General terms of the invoice. 4000 characters max.
getTotalAmount ( ) : PayPal\Api\Currency The total amount of the invoice.
getUri ( ) : string URI of the invoice resource.
qrCode ( string $invoiceId, array $params = [], ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : PayPal\Api\Image Generate a QR code for an invoice by passing the invoice ID to the request URI. The request generates a QR code that is 500 pixels in width and height. You can change the dimensions of the returned code by specifying optional query parameters.
recordPayment ( PaymentDetail $paymentDetail, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Marks the status of a specified invoice, by ID, as paid. Include a payment detail object that defines the payment method and other details in the JSON request body.
recordRefund ( RefundDetail $refundDetail, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Marks the status of a specified invoice, by ID, as refunded. Include a refund detail object that defines the refund type and other details in the JSON request body.
remind ( Notification $notification, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Sends a reminder about a specific invoice, by ID, to a recipient. Include a notification object that defines the reminder subject and other details in the JSON request body.
removeAttachment ( FileAttachment $fileAttachment ) Remove Attachments from the list.
removeBillingInfo ( BillingInfo $billingInfo ) Remove BillingInfo from the list.
removeCcInfo ( Participant $participant ) Remove CcInfo from the list.
removeItem ( InvoiceItem $invoiceItem ) Remove Items from the list.
removePayment ( PaymentDetail $paymentDetail ) Remove Payments from the list.
removeRefund ( RefundDetail $refundDetail ) Remove Refunds from the list.
search ( Search $search, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : PayPal\Api\InvoiceSearchResponse Searches for an invoice or invoices. Include a search object that specifies your search criteria in the request.
send ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean Sends an invoice, by ID, to a recipient. Optionally, set the notify_merchant query parameter to send the merchant an invoice update notification. By default, notify_merchant is true.
setAdditionalData ( string $additional_data ) Any miscellaneous invoice data. Maximum length is 4000 characters.
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 ( Participant[] $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.
setId ( string $id ) The unique invoice resource identifier.
setInvoiceDate ( string $invoice_date ) The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
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.
setMetadata ( Metadata $metadata ) Audit information for the invoice.
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.
setNumber ( string $number ) Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
setPaidAmount ( PaymentSummary $paid_amount ) Payment summary of the invoice including amount paid through PayPal and other sources.
setPaymentTerm ( PaymentTerm $payment_term ) Optional. The payment deadline for the invoice. Value is either term_type or due_date but not both.
setPayments ( PaymentDetail[] $payments ) List of payment details for the invoice.
setReference ( string $reference ) Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
setRefundedAmount ( PaymentSummary $refunded_amount ) Payment summary of the invoice including amount refunded through PayPal and other sources.
setRefunds ( RefundDetail[] $refunds ) List of refund details for the invoice.
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.
setStatus ( string $status ) Status of the invoice.
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.
setTemplateId ( string $template_id ) The template ID used for the invoice. Useful for copy functionality.
setTerms ( string $terms ) General terms of the invoice. 4000 characters max.
setTotalAmount ( PayPal\Api\Currency $total_amount ) The total amount of the invoice.
setUri ( string $uri ) URI of the invoice resource.
update ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Invoice Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Partial updates are not supported.

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 ( Participant $participant )
$participant Participant

addItem() public method

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

addPayment() public method

Append Payments to the list.
public addPayment ( PaymentDetail $paymentDetail )
$paymentDetail PaymentDetail

addRefund() public method

Append Refunds to the list.
public addRefund ( RefundDetail $refundDetail )
$refundDetail RefundDetail

cancel() public method

Cancels an invoice, by ID.
public cancel ( CancelNotification $cancelNotification, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$cancelNotification CancelNotification
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

create() public method

Creates an invoice. Include invoice details including merchant information in the request.
public create ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Invoice
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return Invoice

delete() public method

Delete a particular invoice by passing the invoice ID to the request URI.
public delete ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

deleteExternalPayment() public method

Delete external payment.
public deleteExternalPayment ( $transactionId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

deleteExternalRefund() public method

Delete external refund.
public deleteExternalRefund ( $transactionId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

generateNumber() public static method

Generates the successive invoice number.
public static generateNumber ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : InvoiceNumber
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return InvoiceNumber

get() public static method

Gets the details for a specified invoice, by ID.
public static get ( string $invoiceId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Invoice
$invoiceId string
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return Invoice

getAdditionalData() public method

Any miscellaneous invoice data. Maximum length is 4000 characters.
Deprecation: Not publicly available
public getAdditionalData ( ) : string
return string

getAll() public static method

Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
public static getAll ( array $params = [], ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : PayPal\Api\InvoiceSearchResponse
$params array
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return PayPal\Api\InvoiceSearchResponse

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 ( ) : Participant[]
return Participant[]

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

getId() public method

The unique invoice resource identifier.
public getId ( ) : string
return string

getInvoiceDate() public method

The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
public getInvoiceDate ( ) : string
return string

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

getMetadata() public method

Audit information for the invoice.
public getMetadata ( ) : Metadata
return Metadata

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

getNumber() public method

Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
public getNumber ( ) : string
return string

getPaidAmount() public method

Payment summary of the invoice including amount paid through PayPal and other sources.
public getPaidAmount ( ) : PaymentSummary
return PaymentSummary

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

getPayments() public method

List of payment details for the invoice.
public getPayments ( ) : PaymentDetail[]
return PaymentDetail[]

getReference() public method

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

getRefundedAmount() public method

Payment summary of the invoice including amount refunded through PayPal and other sources.
public getRefundedAmount ( ) : PaymentSummary
return PaymentSummary

getRefunds() public method

List of refund details for the invoice.
public getRefunds ( ) : RefundDetail[]
return RefundDetail[]

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

getStatus() public method

Status of the invoice.
public getStatus ( ) : string
return string

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

getTaxInclusive() public method

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

getTemplateId() public method

The template ID used for the invoice. Useful for copy functionality.
public getTemplateId ( ) : string
return string

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

getUri() public method

URI of the invoice resource.
public getUri ( ) : string
return string

qrCode() public static method

Generate a QR code for an invoice by passing the invoice ID to the request URI. The request generates a QR code that is 500 pixels in width and height. You can change the dimensions of the returned code by specifying optional query parameters.
public static qrCode ( string $invoiceId, array $params = [], ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : PayPal\Api\Image
$invoiceId string
$params array
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return PayPal\Api\Image

recordPayment() public method

Marks the status of a specified invoice, by ID, as paid. Include a payment detail object that defines the payment method and other details in the JSON request body.
public recordPayment ( PaymentDetail $paymentDetail, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$paymentDetail PaymentDetail
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

recordRefund() public method

Marks the status of a specified invoice, by ID, as refunded. Include a refund detail object that defines the refund type and other details in the JSON request body.
public recordRefund ( RefundDetail $refundDetail, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$refundDetail RefundDetail
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

remind() public method

Sends a reminder about a specific invoice, by ID, to a recipient. Include a notification object that defines the reminder subject and other details in the JSON request body.
public remind ( Notification $notification, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$notification Notification
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

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 ( Participant $participant )
$participant Participant

removeItem() public method

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

removePayment() public method

Remove Payments from the list.
public removePayment ( PaymentDetail $paymentDetail )
$paymentDetail PaymentDetail

removeRefund() public method

Remove Refunds from the list.
public removeRefund ( RefundDetail $refundDetail )
$refundDetail RefundDetail

send() public method

Sends an invoice, by ID, to a recipient. Optionally, set the notify_merchant query parameter to send the merchant an invoice update notification. By default, notify_merchant is true.
public send ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : boolean
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return boolean

setAdditionalData() public method

Any miscellaneous invoice data. Maximum length is 4000 characters.
Deprecation: Not publicly available
public setAdditionalData ( string $additional_data )
$additional_data string

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 ( Participant[] $cc_info )
$cc_info Participant[]

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

setId() public method

The unique invoice resource identifier.
public setId ( string $id )
$id string

setInvoiceDate() public method

The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.
public setInvoiceDate ( string $invoice_date )
$invoice_date string

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

setMetadata() public method

Audit information for the invoice.
public setMetadata ( Metadata $metadata )
$metadata Metadata

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

setNumber() public method

Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
public setNumber ( string $number )
$number string

setPaidAmount() public method

Payment summary of the invoice including amount paid through PayPal and other sources.
public setPaidAmount ( PaymentSummary $paid_amount )
$paid_amount PaymentSummary

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

setPayments() public method

List of payment details for the invoice.
public setPayments ( PaymentDetail[] $payments )
$payments PaymentDetail[]

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

setRefundedAmount() public method

Payment summary of the invoice including amount refunded through PayPal and other sources.
public setRefundedAmount ( PaymentSummary $refunded_amount )
$refunded_amount PaymentSummary

setRefunds() public method

List of refund details for the invoice.
public setRefunds ( RefundDetail[] $refunds )
$refunds RefundDetail[]

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

setStatus() public method

Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING"]
public setStatus ( string $status )
$status string

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

setTemplateId() public method

The template ID used for the invoice. Useful for copy functionality.
public setTemplateId ( string $template_id )
$template_id string

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

setUri() public method

URI of the invoice resource.
public setUri ( string $uri )
$uri string

update() public method

Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Partial updates are not supported.
public update ( ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Invoice
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
return Invoice