Property | Type | Description |
---|
Method | Description | |
---|---|---|
Cancel ( |
Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails.
|
|
Cancel ( |
Cancels an invoice.
|
|
Create ( |
||
Create ( |
Creates a draft invoice. You can optionally create an invoice [template](/docs/api/invoicing/#templates). Then, when you create an invoice from a template, the invoice is populated with the predefined data that the source template contains. To move the invoice from a draft to payable state, you must [send the invoice](/docs/api/invoicing/#invoices_send). In the JSON request body, include invoice details including merchant information. The `invoice` object must include an `items` array. Note: The merchant specified in an invoice must have a PayPal account in good standing.
|
|
Delete ( |
Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can [cancel the invoice](/docs/api/invoicing/#invoices_cancel). After you delete a draft invoice, you can no longer use it or show its details. However, you can reuse its invoice number.
|
|
Delete ( |
Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can [cancel the invoice](/docs/api/invoicing/#invoices_cancel). After you delete a draft invoice, you can no longer use it or show its details. However, you can reuse its invoice number.
|
|
DeleteExternalPayment ( |
Deletes an external payment, by invoice ID and transaction ID.
|
|
DeleteExternalRefund ( |
Deletes an external refund, by invoice ID and transaction ID.
|
|
GenerateNumber ( |
Generates the next invoice number that is available to the user.
|
|
Get ( |
Shows details for a specified invoice, by ID.
|
|
GetAll ( |
Lists merchant invoices. Optionally, you can specify one or more query parameters to filter the response.
|
|
QrCode ( |
Generates a QR code for an invoice, by ID.
|
|
RecordPayment ( |
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.
|
|
RecordPayment ( |
Mark the status of the invoice as paid.
|
|
RecordRefund ( |
Marks the status of an invoice, by ID, as refunded. In the JSON request body, include a payment detail object that defines the payment method and other details.
|
|
RecordRefund ( |
Mark the status of the invoice as refunded.
|
|
Remind ( |
Sends a reminder about an invoice, by ID, to a customer. In the JSON request body, include a `notification` object that defines the subject of the reminder and other details.
|
|
Remind ( |
Reminds the payer to pay the invoice.
|
|
Search ( |
Lists invoices that match search criteria. In the JSON request body, include a `search` object that specifies the search criteria.
|
|
Send ( |
Sends an invoice, by ID, to a customer. Note: After you send an invoice, you cannot resend it. Optionally, set the `notify_merchant` query parameter to also send the merchant an invoice update notification. Default is `true`.
|
|
Send ( |
Sends a legitimate invoice to the payer.
|
|
Update ( |
Full update of the invoice resource for the given identifier.
|
|
Update ( |
Fully updates an invoice, by ID. In the JSON request body, include a complete `invoice` object. This call does not support partial updates.
|
public Cancel ( |
||
apiContext | APIContext used for the API call. | |
cancelNotification | CancelNotification | |
return | void |
public static Cancel ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | ID of the invoice to cancel. |
cancelNotification | CancelNotification | |
return | void |
public Create ( |
||
apiContext | APIContext used for the API call. | |
return |
public static Create ( |
||
apiContext | APIContext used for the API call. | |
invoice | Invoice object to be used for creating the PayPal resource. | |
return |
public Delete ( |
||
apiContext | APIContext used for the API call. | |
return | void |
public static Delete ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | The ID of the invoice to delete. |
return | void |
public static DeleteExternalPayment ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | The ID of the invoice from which to delete a payment transaction. |
transactionId | string | The ID of the payment transaction to delete. |
return | void |
public static DeleteExternalRefund ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | The ID of the invoice from which to delete the refund transaction. |
transactionId | string | The ID of the refund transaction to delete. |
return | void |
public GenerateNumber ( |
||
apiContext | APIContext used for the API call. | |
return |
public static Get ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | The ID of the invoice for which to show details. |
return |
public static GetAll ( |
||
apiContext | APIContext used for the API call. | |
page | int | A *zero-relative* index of the list of merchant invoices. |
pageSize | int | The number of invoices to list beginning with the specified `page`. |
totalCountRequired | bool | Indicates whether the total count appears in the response. Default is `false`. |
return | PayPal.Api.InvoiceSearchResponse |
public static QrCode ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | The ID of the invoice for which to generate a QR code. |
width | int | The width, in pixels, of the QR code image. Valid value is from 150 to 500. Default is 500. |
height | int | The height, in pixels, of the QR code image. Valid value is from 150 to 500. Default is 500. |
action | string | The type of URL for which to generate a QR code. Default is `pay` and is the only supported value. |
return | Image |
public RecordPayment ( |
||
apiContext | APIContext used for the API call. | |
paymentDetail | PaymentDetail | |
return | void |
public static RecordPayment ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | ID of the invoice to mark as paid. |
paymentDetail | PaymentDetail | |
return | void |
public RecordRefund ( |
||
apiContext | APIContext used for the API call. | |
refundDetail | RefundDetail | |
return | void |
public static RecordRefund ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | ID fo the invoice to mark as refunded. |
refundDetail | RefundDetail | |
return | void |
public Remind ( |
||
apiContext | APIContext used for the API call. | |
notification | Notification | |
return | void |
public static Remind ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | ID of the invoice the payer will be reminded to pay. |
notification | Notification | |
return | void |
public static Search ( |
||
apiContext | APIContext used for the API call. | |
search | Search | |
return | PayPal.Api.InvoiceSearchResponse |
public Send ( |
||
apiContext | APIContext used for the API call. | |
notifyMerchant | bool | Indicates whether to send the invoice update notification to the merchant. Default is `true`. |
return | void |
public static Send ( |
||
apiContext | APIContext used for the API call. | |
invoiceId | string | ID of the invoice to send. |
notifyMerchant | bool | Specifies if the invoice send notification is needed for merchant |
return | void |
public static Update ( |
||
apiContext | APIContext used for the API call. | |
invoice | Invoice object to update. | |
notifyMerchant | bool | Specifies if the invoice update notification is needed for merchant |
return |
public Update ( |
||
apiContext | APIContext used for the API call. | |
notifyMerchant | bool | Indicates whether to send the invoice update notification to the merchant. Default is `true`. |
return |