User Guide

Invoicing Service API Guide May 2012 13

Introduction to the Invoicing Service API

Sending Invoices on Behalf of a Merchant

You can send invoices on behalf of a merchant if you have permission to do so. There is no

difference in how you set up your request for CreateInvoice or

CreateAndSendInvoice, except that you specify the merchant’s email address instead of

your own in the request, and you include an additional header that indicates you have the

permission of the third party to send invoices on their behalf.

The merchant grants you permission using their PayPal profile, or you request permission

using the Permissions Service API. For more information about this API, see PayPal

Permissions Service at

PayPal Permissions Service.

Invoicing Service API Operations

The operations in the Invoicing Service API enable you to create and send invoices to your

customers, as well manage existing invoices, which may or may not have been sent.

NOTE: Although you do not need to register your application with PayPal, you must have a

valid app ID to use the Invoicing Service API. If you have an existing app ID, you can

reuse it. See

x.com to obtain an app ID.

Creating and Sending Invoices

Managing Invoices

API Operation Description

CreateInvoice Creates a new invoice.

SendInvoice Sends an invoice to a customer.

CreateAndSendInvoice Creates and sends an invoice, which is equivalent to the combination

of the CreateInvoice operation followed by the SendInvoice

operation.

API Operation Description

UpdateInvoice Updates an invoice.

GetInvoiceDetails Obtains the contents of an invoice.

CancelInvoice Cancels an invoice.

SearchInvoices Searches for invoices based on specified criteria.

MarkInvoiceAsPaid Marks an invoice as having been paid.