| 메소드 |
설명 |
|
|
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. |
|
