public
|
#
setId( string $id )
The unique invoice resource identifier.
The unique invoice resource identifier.
Parameters
Returns
$this
|
public
string
|
#
getId( )
The unique invoice resource identifier.
The unique invoice resource identifier.
Returns
string
|
public
|
#
setNumber( string $number )
Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
Parameters
Returns
$this
|
public
string
|
#
getNumber( )
Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
Returns
string
|
public
|
#
setTemplateId( string $template_id )
The template ID used for the invoice. Useful for copy functionality.
The template ID used for the invoice. Useful for copy functionality.
Parameters
Returns
$this
|
public
string
|
#
getTemplateId( )
The template ID used for the invoice. Useful for copy functionality.
The template ID used for the invoice. Useful for copy functionality.
Returns
string
|
public
|
#
setUri( string $uri )
URI of the invoice resource.
URI of the invoice resource.
Parameters
Returns
$this
|
public
string
|
#
getUri( )
URI of the invoice resource.
URI of the invoice resource.
Returns
string
|
public
|
#
setStatus( string $status )
Status of the invoice.
Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING"]
Status of the invoice.
Valid Values: ["DRAFT", "SENT", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING"]
Parameters
Returns
$this
|
public
string
|
#
getStatus( )
Status of the invoice.
Returns
string
|
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
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
|
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
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
|
public
|
|
public
|
|
public
|
#
setCcInfo( PayPal\Api\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.
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
Returns
$this
|
public
PayPal\Api\Participant[]
|
#
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
|
public
|
|
public
|
|
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
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
|
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
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
|
public
|
|
public
|
|
public
|
|
public
string
|
|
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
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
|
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
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
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
|
public
|
|
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
|
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
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
|
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
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
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
|
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
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
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
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
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
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
|
|
public
PayPal\Api\Currency
|
#
getTotalAmount( )
The total amount of the invoice.
The total amount of the invoice.
Returns
|
public
|
|
public
PayPal\Api\PaymentDetail[]
|
#
getPayments( )
List of payment details for the invoice.
List of payment details for the invoice.
Returns
|
public
|
|
public
|
|
public
|
|
public
PayPal\Api\RefundDetail[]
|
#
getRefunds( )
List of refund details for the invoice.
List of refund details for the invoice.
Returns
|
public
|
|
public
|
|
public
|
|
public
PayPal\Api\Metadata
|
#
getMetadata( )
Audit information for the invoice.
Audit information for the invoice.
Returns
|
public
|
#
setAdditionalData( string $additional_data )
Any miscellaneous invoice data. Maximum length is 4000 characters.
Any miscellaneous invoice data. Maximum length is 4000 characters.
Deprecated
Not publicly available
Parameters
Returns
$this
|
public
string
|
#
getAdditionalData( )
Any miscellaneous invoice data. Maximum length is 4000 characters.
Any miscellaneous invoice data. Maximum length is 4000 characters.
Deprecated
Not publicly available
Returns
string
|
public
|
#
setPaidAmount( PayPal\Api\PaymentSummary $paid_amount )
Payment summary of the invoice including amount paid through PayPal and other sources.
Payment summary of the invoice including amount paid through PayPal and other sources.
Parameters
Returns
$this
|
public
PayPal\Api\PaymentSummary
|
#
getPaidAmount( )
Payment summary of the invoice including amount paid through PayPal and other sources.
Payment summary of the invoice including amount paid through PayPal and other sources.
Returns
|
public
|
#
setRefundedAmount( PayPal\Api\PaymentSummary $refunded_amount )
Payment summary of the invoice including amount refunded through PayPal and other sources.
Payment summary of the invoice including amount refunded through PayPal and other sources.
Parameters
Returns
$this
|
public
PayPal\Api\PaymentSummary
|
#
getRefundedAmount( )
Payment summary of the invoice including amount refunded through PayPal and other sources.
Payment summary of the invoice including amount refunded through PayPal and other sources.
Returns
|
public
|
|
public
PayPal\Api\FileAttachment[]
|
#
getAttachments( )
List of files attached to the invoice.
List of files attached to the invoice.
Returns
|
public
|
|
public
|
|
public
PayPal\Api\Invoice
|
#
create( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
Creates an invoice. Include invoice details including merchant information in the request.
Creates an invoice. Include invoice details including merchant information in the request.
Parameters
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public static
PayPal\Api\InvoiceSearchResponse
|
#
search( PayPal\Api\Search $search, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
Searches for an invoice or invoices. Include a search object that specifies your search criteria in the request.
Searches for an invoice or invoices. Include a search object that specifies your search criteria in the request.
Parameters
- $search
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public
boolean
|
#
send( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
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 .
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 .
Parameters
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
boolean
|
public
boolean
|
#
remind( PayPal\Api\Notification $notification, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
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.
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.
Parameters
- $notification
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
boolean
|
public
boolean
|
|
public
boolean
|
#
recordPayment( PayPal\Api\PaymentDetail $paymentDetail, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
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.
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.
Parameters
- $paymentDetail
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
boolean
|
public
boolean
|
#
recordRefund( PayPal\Api\RefundDetail $refundDetail, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
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.
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.
Parameters
- $refundDetail
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
boolean
|
public static
PayPal\Api\Invoice
|
#
get( string $invoiceId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
Gets the details for a specified invoice, by ID.
Gets the details for a specified invoice, by ID.
Parameters
- $invoiceId
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public static
PayPal\Api\InvoiceSearchResponse
|
#
getAll( array $params = array(), PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
Parameters
- $params
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public
PayPal\Api\Invoice
|
#
update( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
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.
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.
Parameters
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public
boolean
|
#
delete( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
Delete a particular invoice by passing the invoice ID to the request URI.
Delete a particular invoice by passing the invoice ID to the request URI.
Parameters
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
boolean
|
public
boolean
|
#
deleteExternalPayment( PayPal\Rest\ApiContext $transactionId, PayPal\Transport\PayPalRestCall $apiContext = null, $restCall = null )
Delete external payment.
Parameters
- $transactionId
- $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $apiContext
- $restCall is the Rest Call Service that is used to make rest calls
- $restCall
Returns
boolean
|
public
boolean
|
#
deleteExternalRefund( PayPal\Rest\ApiContext $transactionId, PayPal\Transport\PayPalRestCall $apiContext = null, $restCall = null )
Delete external refund.
Parameters
- $transactionId
- $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $apiContext
- $restCall is the Rest Call Service that is used to make rest calls
- $restCall
Returns
boolean
|
public static
PayPal\Api\Image
|
#
qrCode( array $invoiceId, string $params = array(), PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
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.
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.
Parameters
- $invoiceId
- $params
- $params
- $invoiceId
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|
public static
PayPal\Api\InvoiceNumber
|
#
generateNumber( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )
Generates the successive invoice number.
Generates the successive invoice number.
Parameters
- $apiContext
- is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
- $restCall
- is the Rest Call Service that is used to make rest calls
Returns
|