Invoice Component

Properties   Methods   Events   Configuration Settings   Errors  

Invoice allows merchants to easily create, send, and manage invoices using PayPal.

Syntax

nsoftware.InPayPal.Invoice

Remarks

The Invoice component is used to create invoices and send them to the recipient via email. To create an invoice, the MerchantInfo, BillingInfo, ShippingInfo, InvoiceInfo, and InvoiceItems can be set to the desired invoice details. After entering the information to be contained on the invoice, you can then create it by calling CreateInvoice and send it by calling Send. If you wish to create an invoice and send it immediately, you can make a single call to CreateAndSend.

If you wish to alter invoice details after it has been created, you can set MerchantInfo, BillingInfo, ShippingInfo, InvoiceInfo, and InvoiceItems as desired and then call Update. This will update an existing invoice using the new details specified. Note that you can remove items from the invoice by removing it from InvoiceItems prior to calling Update.

To cancel an invoice, you can set CancellationInfo to provide details about the cancellation and then call Cancel.

To mark an invoice as paid, PaymentInfo can be set to the describe the payment and then MarkAsPaid can be called.

The Invoice component also provides search features which allows you to find and filter created invoices. To perform a search, just set SearchCriteria to the desired search parameters and call Search. The invoices that match the specified search parameters will be returned via SearchResults. If you happen to know the ID of the invoice you wish to retrieve details about, you can use GetDetails to obtain in depth details for the specified invoice.