Paypal Invoicing 2012 User Guide API Developer

Invoicing - 2012 - Service API Guide PP_InvoicingAPI_2012 Free User Guide for PayPal Software, Manual

: Paypal Paypal-Invoicing-2012-User-Guide-777953 paypal-invoicing-2012-user-guide-777953 paypal pdf

Open the PDF directly: View PDF .
Page Count: 122 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Invoicing Service API

Guide

Last updated: May 2012

Invoicing Service API Guide

Document Number: 10128.en_US-201205

© 2011-2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other

trademarks and brands are the property of their respective owners.

The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc.

Copyright © PayPal. All rights reserved. PayPal S.à r.l. et Cie, S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard Royal, L-

2449, Luxembourg, R.C.S. Luxembourg B 118 349

Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it does not require the approval

of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully.

Notice of non-liability:

PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express,

implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused

by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use

of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice.

Invoicing Service API Guide May 2012 3

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 1 Introduction to the Invoicing Service API . . . . . . . . . .11

Sending Invoices on Behalf of a Merchant. . . . . . . . . . . . . . . . . . . . . . . . . . 13

Invoicing Service API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Creating and Sending Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Managing Invoices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

IPN Variables for Invoicing API Operations . . . . . . . . . . . . . . . . . . . . . . . . . 14

Invoice Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Canceled Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 2 Invoicing Service API Examples. . . . . . . . . . . . . . .17

HTTP Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Specifying JSON, NVP, or XML Data Formats. . . . . . . . . . . . . . . . . . . . . . 18

SOAP Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Specifying Application and Device Information . . . . . . . . . . . . . . . . . . . . . 19

Creating an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Sending an Invoice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Creating and Sending an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Updating an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Obtaining Invoice Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Canceling an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Searching for Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Chapter 3 CreateInvoice API Operation . . . . . . . . . . . . . . . .25

CreateInvoiceRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

CreateInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

BusinessInfoType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Contents

4May 2012 Invoicing Service API Guide

BaseAddress Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

InvoiceItemListType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

CreateInvoiceResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

CreateInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

CreateInvoice API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 4 SendInvoice API Operation . . . . . . . . . . . . . . . . .37

SendInvoiceRequest Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

SendInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

SendInvoiceResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

SendInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Send Invoice API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 5 CreateAndSendInvoice API Operation. . . . . . . . . . . .43

CreateAndSendInvoiceRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . 43

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

CreateAndSendInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . 46

InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

BusinessInfoType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

BaseAddress Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

InvoiceItemListType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

CreateAndSendInvoiceResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . 50

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

CreateAndSendInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . 51

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Invoicing Service API Guide May 2012 5

Contents

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

CreateAndSendInvoice API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Chapter 6 UpdateInvoice API Operation . . . . . . . . . . . . . . . .55

UpdateInvoiceRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

UpdateInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

BusinessInfoType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

UpdateInvoiceResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

UpdateInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

UpdateInvoice API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Chapter 7 GetInvoiceDetails API Operation . . . . . . . . . . . . . .67

GetInvoiceDetailsRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

GetInvoiceDetailsRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

GetInvoiceDetailsResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

GetInvoiceDetailsResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

InvoiceDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

PaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

PayPalPaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

OtherPaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Contents

6May 2012 Invoicing Service API Guide

GetInvoiceDetails API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 8 CancelInvoice API Operation . . . . . . . . . . . . . . . .81

CancelInvoiceRequest Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

CancelInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

CancelInvoiceResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

CancelInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

CancelInvoice API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Chapter 9 SearchInvoices API Operation . . . . . . . . . . . . . . .87

SearchInvoicesRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

SearchInvoicesRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

SearchParametersType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

DateRangeType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

SearchInvoicesResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

SearchInvoicesResponse Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

InvoiceSummaryListType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

InvoiceSummaryType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

SearchInvoices API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Chapter 10 MarkInvoiceAsPaid API Operation . . . . . . . . . . . . .97

MarkInvoiceAsPaidRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

MarkInvoiceAsPaidRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

OtherPaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

MarkInvoiceAsPaidResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Invoicing Service API Guide May 2012 7

Contents

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

MarkInvoiceAsPaidResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . .100

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102

MarkInvoiceAsPaid API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102

Chapter 11 MarkInvoiceAsUnpaid API Operation . . . . . . . . . . . 105

MarkInvoiceAsUnpaidRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . .105

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

MarkInvoiceAsUnpaidRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . .106

MarkInvoiceAsUnpaidResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . .106

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106

MarkInvoiceAsUnpaidResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . .107

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

MarkInvoiceAsUnpaid API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110

Chapter 12 MarkInvoiceAsRefunded API Operation . . . . . . . . . . 111

MarkInvoiceAsRefundedRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . 111

RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

MarkInvoiceAsRefundedRequest Fields. . . . . . . . . . . . . . . . . . . . . . . . . 111

OtherRefundDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112

MarkInvoiceAsRefundedResponse Message . . . . . . . . . . . . . . . . . . . . . . . .112

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112

MarkInvoiceAsRefundedResponse Fields. . . . . . . . . . . . . . . . . . . . . . . .113

PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

MarkInvoiceAsRefunded API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116

Revision History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Contents

8May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 9

Preface

You can use the Invoicing Service API to create, send, and manage invoices using PayPal.

Documentation Feedback

Help us improve this guide by sending feedback to:

documentationfeedback@paypal.com

Documentation Feedback

10 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 11

1Introduction to the Invoicing

Service API

PayPal enables you to create and manage invoices. When you send an invoice, PayPal emails

the receipient and allows him or her to pay with PayPal.

The following diagram shows the basic execution flow for creating and sending an invoice:

The circled numbers indicate actions that you take as well as actions taken by PayPal and your

customer:

1. Specify the contents of the invoice in the CreateInvoice request and send the request to

the https://svcs.paypal.com/Invoice/CreateInvoice endpoint.

2. Examine the response and verify that the ACK field contains SUCCESS.

3. Using the invoice ID in the response, create a SendInvoice request and send it to the

https://svcs.paypal.com/Invoice/SendInvoice endpoint.

4. Examine the response and verify that the ACK field contains SUCCESS.

NOTE:You can combine the creation and transmission of an invoice in the same request,

which is CreateAndSend. After you create the request, send it to the

https://svcs.paypal.com/Invoice/CreateAndSendInvoice endpoint.

Introduction to the Invoicing Service API

1

12 May 2012 Invoicing Service API Guide

5. If the SendInvoice request was successful, PayPal sends an invoice by email to the payer

whose email you specified in the CreateInvoice or CreateAndSendInvoice request.

6. When your customer clicks Pay Invoice in the email, the customer’s browser is redirected

to PayPal and the customer is prompted to log in.

7. The customer can then pay on PayPal.

The contents of an invoice depend on what you specify in the CreateInvoice, or

CreateAndSend requests. Following is an example invoice:

Invoicing Service API Guide May 2012 13

Introduction to the Invoicing Service API

Sending Invoices on Behalf of a Merchant 1

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.

Introduction to the Invoicing Service API

IPN Variables for Invoicing API Operations

1

14 May 2012 Invoicing Service API Guide

IPN Variables for Invoicing API Operations

PayPal sends IPN messages for invoice payments and canceled invoices. For more

information about IPN, see the Instant Payment Notification Guide:

https://cms.paypal.com/cms_content/US/en_US/files/developer/IPNGuide.pdf.

Invoice Payments

mc_gross: 37.12

protection_eligibility: Eligible

address_status: confirmed

payer_id: ABF644D44GSPJ

address_street: 5656 South Market Street

payment_date: 15:57:39 Sep 12, 2011 PDT

payment_status: Completed

invoice_id: INV2-VMYW-LQKA-QBGC-6YDE

charset: windows-1252

address_zip: 95131

first_name: Nick

mc_fee: 1.38

address_country_code: US

address_name: Selling Fruits

notify_version: 3.4

payer_status: verified

business: jbui-us-business1@paypal.com

address_country: United States

address_city: San Jose

verify_sign: AFcWxV21C7fd0v3bYYYRCpSSRl31A23x28hwIQCThw2nNi2s8MlV2o10

payer_email: jbui-us-personal1@paypal.com

txn_id: 68H067535A2789915

payment_type: instant

last_name: Ronald

address_state: CA

MarkInvoiceAsUnpaid Marks an invoice as unpaid.

MarkInvoiceAsRefunded Marks an invoice as having been refunded.

API Operation Description

Invoicing Service API Guide May 2012 15

Introduction to the Invoicing Service API

IPN Variables for Invoicing API Operations 1

receiver_email: jbui-us-business1@paypal.com

payment_fee: 1.38

receiver_id: 9N3VVZS28ELHL

txn_type: invoice_payment

mc_currency: USD

residence_country: US

transaction_subject: Send the Reminder Soon.

invoice_number: 0151

payment_gross: 37.12

ipn_track_id: ogo4fwr-n.J7dGNgDiJzqg

Canceled Invoices

merchant_business_name: Fruits Packaging Inc.

merchant_first_name: Joan

notify_version: 3.4

txn_type: invoice_payer_cancel

invoice_number: 0021

charset: windows-1252

payer_email: jbui-us-personal1@paypal.com

payer_last_name: Bond

merchant_last_name: Joan

payer_first_name: Henry

merchant_email: jbui-us-business1@paypal.com

verify_sign: AiPC9BjkCyDFQXbSkoZcgqH3hpacAAV9zVNI.GLTI1sLOHpeeWp3oMQZ

invoice_id: INV2-UHWN-STXM-65B7-PT4R

ipn_track_id: 2eKZJ-cZftAHzSWbsS7qjQ

Introduction to the Invoicing Service API

IPN Variables for Invoicing API Operations

1

16 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 17

2Invoicing Service API Examples

You can use the Invoicing Service API to create, send, update, cancel, or obtain details of

invoices for yourself or third-party merchants. You can also search invoices, and mark them as

paid, unpaid, or refunded.

HTTP Headers

Each request message includes HTTP headers specifying authentication, the application ID,

the device ID or IP address, and the payload format or protocol (SOAP).

Adaptive Payments supports request bodies with JSON, NVP, and XML data formats for

REST implementations. You can specify different formats for the request and response, such

as sending the request in JSON and requesting an XML response.

For SOAP, you must also include a specific SOAP protocol header (see the SOAP messages

section).

The following is an example of HTTP headers for NVP in Java for a web implementation:

headers.put("X-PAYPAL-SECURITY-USERID", "tok261_biz_api.abc.com");

headers.put("X-PAYPAL-SECURITY-PASSWORD","1244612379");

headers.put("X-PAYPAL-SECURITY-SIGNATURE","lkfg9groingghb4uw5"

headers.put("X-PAYPAL-DEVICE-IPADDRESS", "168.212.226.204");

headers.put("X-PAYPAL-REQUEST-DATA-FORMAT", "NV");

headers.put("X-PAYPAL-RESPONSE-DATA-FORMAT", "NV");

headers.put("X-PAYPAL-APPLICATION-ID", "APP-80W284485P519543T");

NOTE:HTTP headers are case sensitive.

Authentication

Use your PayPal account API credentials to authenticate your application. Your API

credentials include an API username and API password. If you are using 3-token

authentication, you must also specify an API signature. If you are using a certificate, the

certificate is used with the username and password; the signature is not used. To specify API

credentials, include the following HTTP headers in your request message (observing case

sensitivity):

Invoicing Service API Examples

HTTP Headers

2

18 May 2012 Invoicing Service API Guide

HTTP Headers for Authentication

Specifying JSON, NVP, or XML Data Formats

Use the HTTP header X-PAYPAL-REQUEST-DATA-FORMAT to specify the data format the

request body. You can send messages using JSON, NVP or straight XML.

Use the and X-PAYPAL-RESPONSE-DATA-FORMAT headers to specify the data format for the

response.

For SOAP messages, refer to the next section.

HTTP Headers for JSON, NVP, and XML Data Formats

Header Description

X-PAYPAL-SECURITY-USERID Your API username

X-PAYPAL-SECURITY-PASSWORD Your API password

X-PAYPAL-SECURITY-SIGNATURE Your API signature, which is required only if you use 3-

token authorization; a certificate does not use a signature

X-PAYPAL-SECURITY-SUBJECT Third-party permission specification, which specifies the

email address or phone number (for mobile) of the party on

whose behalf you are calling the API operation. The subject

must grant you third-party access in their PayPal profile.

NOTE:Resources specified by the API operation, such as a

payment or preapproval identified by a key, must be

owned by the subject granting the third-party

permission.

Header Description

X-PAYPAL-REQUEST-DATA-FORMAT The payload format for the request.

Allowable values are:

-NV – Name-value pairs

-XML – Extensible markup language

-JSON – JavaScript object notation

X-PAYPAL-RESPONSE-DATA-FORMAT The payload format for the response.

Allowable values are:

-NV – Name-value pairs

-XML – Extensible markup language

-JSON – JavaScript object notation

Invoicing Service API Guide May 2012 19

Invoicing Service API Examples

HTTP Headers 2

SOAP Messages

To use Adaptive Payments with SOAP, include the HTTP headers for authentication as

described in the section Authentication and the application ID as described in the next section.

In addition, include the X-PAYPAL-MESSAGE-PROTOCOL header with a SOAP11 value.

The following is a header example for an Adaptive Payments API call for a SOAP message:

headers.put("X-PAYPAL-SECURITY-USERID", "tok261_biz_api.abc.com");

headers.put("X-PAYPAL-SECURITY-PASSWORD","1244612379");

headers.put("X-PAYPAL-SECURITY-SIGNATURE","lkfg9groingghb4uw5"

headers.put("X-PAYPAL-DEVICE-IPADDRESS", "168.212.226.204");

headers.put("X-PAYPAL-MESSAGE-PROTOCOL", "SOAP11");

headers.put("X-PAYPAL-APPLICATION-ID","APP-80W284485P519543T");

Below are the service name, port type, binding and location for SOAP as defined in the

Adaptive Payments WSDL.

<wsdl:service name="AdaptivePayments">

<wsdl:port name="AdaptivePaymentsSOAP11_http"

<binding="services:AdaptivePaymentsSOAP11Binding">

<soap:address location="https://svcs.paypal.com/AdaptivePayments" />

Specifying Application and Device Information

You also must identify the application. You can optionally identify other information

associated with the client and the API version:

HTTP Headers for Application and Device identification

Header Description

X-PAYPAL-APPLICATION-ID (Required) Your application’s identification, which is issued

by PayPal.

NOTE:Check X.com for which application ID must be

defined for working in the sandbox.

X-PAYPAL-DEVICE-ID (Optional) Client’s device ID, such as a mobile device’s

IMEI number or a web browser cookie.

X-PAYPAL-DEVICE-IPADDRESS (Required) Client’s IP address.

X-PAYPAL-SERVICE-VERSION (Optional) The version of an API operation to use. By

default, PayPal executes a request with the current version

of an API operation.

NOTE:PayPal recommends not specifying a version unless

it is absolutely required.

Invoicing Service API Examples

Creating an Invoice

2

20 May 2012 Invoicing Service API Guide

Creating an Invoice

This example shows how to create an invoice using CreateInvoice.

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DATA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://svcs.sandbox.paypal.com/Invoice/CreateInvoice

-d

"requestEnvelope.errorLanguage=en_US

&invoice.merchantEmail=merchant%40domain.com

&invoice.payerEmail=jbui-us-business2%40paypal.com

&invoice.currencyCode=USD

&invoice.itemList.item(0).name=Banana+Leaf+--+001

&invoice.itemList.item(0).description=Banana+Leaf

&invoice.itemList.item(0).quantity=1

&invoice.itemList.item(0).unitPrice=1

&invoice.itemList.item(0).taxName=Tax1

&invoice.itemList.item(0).taxRate=10.25

&invoice.paymentTerms=Net10

&invoice.logoUrl=https%3A%2F%2Fwww.example.com%2FYour_logo.jpg"

Sending an Invoice

This example shows how to send an invoice using SendInvoice. The invoice ID, which is in

the response to CreateInvoice, identifies the invoice to send.

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DATA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://svcs.sandbox.paypal.com/Invoice/SendInvoice

-d

"requestEnvelope.errorLanguage=en_US

&invoiceID=INV2-RVY9-UWTW-64HZ-BR9W"

Invoicing Service API Guide May 2012 21

Invoicing Service API Examples

Creating and Sending an Invoice 2

Creating and Sending an Invoice

This example shows how to create and send an invoice using CreateAndSendInvoice. It is

equivalent to creating an invoice and sending it.

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DATA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://svcs.sandbox.paypal.com/Invoice/CreateAndSendInvoice

-d

"requestEnvelope.errorLanguage=en_US

&invoice.merchantEmail=merchant%40domain.com

&invoice.payerEmail=jbui-us-business2%40paypal.com

&invoice.currencyCode=USD

&invoice.itemList.item(0).name=Banana+Leaf+--+001

&invoice.itemList.item(0).description=Banana+Leaf

&invoice.itemList.item(0).quantity=1

&invoice.itemList.item(0).unitPrice=1

&invoice.itemList.item(0).taxName=Tax1

&invoice.itemList.item(0).taxRate=10.25

&invoice.paymentTerms=Net10

&invoice.logoUrl=https%3A%2F%2Fwww.example.com%2FYour_logo.jpg"

Updating an Invoice

This example shows how to send an invoice using UpdateInvoice. If the invoice has not

been sent, the invoice continues to be a draft; otherwise, the invoice is resent.

NOTE:When updating an invoice, in addition to the updated fields, you must also provide all

of the original fields used to create the invoice.

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DATA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://sandbox.svcs.paypal.com/Invoice/UpdateInvoice

-d

"requestEnvelope.errorLanguage=en_US

&invoice.merchantEmail=merchant%40domain.com

Invoicing Service API Examples

Obtaining Invoice Details

2

22 May 2012 Invoicing Service API Guide

&invoice.payerEmail=jbui-us-business2%40paypal.com

&invoice.currencyCode=USD

&invoice.itemList.item(0).name=Banana+Leaf+--+001

&invoice.itemList.item(0).description=Banana+Leaf

&invoice.itemList.item(0).quantity=3

&invoice.itemList.item(0).unitPrice=1

&invoice.itemList.item(0).taxName=Tax1

&invoice.itemList.item(0).taxRate=10.25

&invoice.paymentTerms=Net10

&invoice.logoUrl=https%3A%2F%2Fwww.example.com%2FYour_logo.jpg"

Obtaining Invoice Details

This example shows how to obtain invoice details using GetInvoiceDetails.

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DATA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://svcs.sandbox.paypal.com/Invoice/GetInvoiceDetails

-d

"requestEnvelope.detailLevel=ReturnAll

&requestEnvelope.errorLanguage=en_US

&invoiceID=INV2-RVY9-UWTW-64HZ-BR9W"

Canceling an Invoice

This example shows how to cancel an invoice using CancelInvoice. PayPal can notifiy the

payer that the message has been canceled.

Invoicing Service API Guide May 2012 23

Invoicing Service API Examples

Searching for Invoices 2

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DA TA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://sandbox.svcs.paypal.com/Invoice/CancelInvoice

-d

"requestEnvelope.errorLanguage=en_US

&invoiceID=INV2-RVY9-UWTW-64HZ-BR9W"

&subject=Cancel+it

&noteForPayer=Cancel+it+now

&sendCopyToMerchant=true"

Searching for Invoices

This example shows how to create and send an invoice using CreateAndSendInvoice. You

must have created the original invoice either for yourself or on behalf of another merchant.

PayPal can return a maximum of 100 invoices per page. In this example, only the first 10

invoices that you created using the Invoicing Service API for the jb-us-

seller1@paypal.com account are returned:

curl -s --insecure

-H "X-PAYPAL-SECURITY-USERID: Your_API_username"

-H "X-PAYPAL-SECURITY-PASSWORD: Your_API_password"

-H "X-PAYPAL-SECURITY-SIGNATURE: Your_API_signature"

-H "X-PAYPAL-REQUEST-DATA-FORMAT: NV"

-H "X-PAYPAL-RESPONSE-DATA-FORMAT: NV"

-H "X-PAYPAL-APPLICATION-ID: Your_AppID"

https://svcs.sandbox.paypal.com/Invoice/SearchInvoices

-d

"requestEnvelope.errorLanguage=en_US

&merchantEmail=jb-us-seller1%40paypal.com

&parameters.origin=API

&parameters.email=jb-us-seller1%40paypal.com

&page=1

&pageSize=10"

Invoicing Service API Examples

Searching for Invoices

2

24 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 25

3CreateInvoice API Operation

Use the CreateInvoice API operation to create a new invoice. The call includes merchant,

payer, and API caller information, in addition to invoice detail. The response to the call

contains an invoice ID and URL.

CreateInvoiceRequest Message

Use the CreateInvoiceRequest message to create a new invoice. The merchant issuing the

invoice, and the partner, if any, making the call, must have a PayPal account in good standing.

CreateInvoice API Operation

CreateInvoiceRequest Message

3

26 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 27

CreateInvoice API Operation

CreateInvoiceRequest Message 3

CreateInvoice API Operation

CreateInvoiceRequest Message

3

28 May 2012 Invoicing Service API Guide

RequestEnvelope Fields

CreateInvoiceRequest Fields

InvoiceType Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

Field Description

invoice inv:InvoiceType

(Required) Merchant, payer, and invoice information.

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

Field Description

merchantEmail xs:string

(Required) Merchant email address.

payerEmail xs:string

(Required) Payer email address.

number xs:string

(Optional) Unique identifier for the invoice.

merchantInfo inv:BusinessInfoType

Company contact information of the merchant company sending the invoice.

itemList inv:InvoiceItemListType

(Required) List of items included in this invoice.

currencyCode xs:string

(Required) Currency used for all invoice item amounts and totals.

invoiceDate xs:dateTime

(Optional) Date on which the invoice is enabled.

Invoicing Service API Guide May 2012 29

CreateInvoice API Operation

CreateInvoiceRequest Message 3

dueDate xs:dateTime

(Optional) Date on which the invoice payment is due.

paymentTerms inv:PaymentTermsType

(Required) Terms by which the invoice payment is due. It is one of the

following values:

-DueOnReceipt – Payment is due when the payer receives the invoice.

-DueOnDateSpecified – Payment is due on the date specified in the

invoice.

-Net10 – Payment is due 10 days from the invoice date.

-Net15 – Payment is due 15 days from the invoice date.

-Net30 – Payment is due 30 days from the invoice date.

-Net45 – Payment is due 45 days from the invoice date.

discountPercent xs:decimal

(Optional) Discount percent applied to the invoice.

discountAmount xs:decimal

(Optional) Discount amount applied to the invoice, if any. If

discountPercent is provided, discountAmount is ignored.

terms xs:string

(Optional) General terms for the invoice.

note xs:string

(Optional) Note to the payer company.

merchantMemo xs:string

(Optional) Memo for bookkeeping that is private to the merchant.

billingInfo inv:BusinessInfoType

(Optional) Billing information for the payer.

shippingInfo inv:BusinessInfoType

(Optional) Shipping information for the payer.

shippingAmount xs:decimal

(Optional) Cost of shipping.

shippingTaxName xs:string

(Optional) Name of the applicable tax on shipping cost.

shippingTaxRate xs:decimal

(Optional) Rate of the applicable tax on shipping cost.

logoURL xs:string

(Optional) Complete URL to an external image used as the logo, if any.

ReferrerCode xs:string

(Optional) Build Notification (BN) code for tracking transactions with a

particular partner..

Field Description

CreateInvoice API Operation

CreateInvoiceRequest Message

3

30 May 2012 Invoicing Service API Guide

BusinessInfoType Fields

BaseAddress Fields

customAmountLabel xs:string

Label used to display custom amount value. If a value is entered for

customAmountLabel, then customAmountValue cannot be empty.

customAmountValue xs:decimal

Value of custom amount.If a value is entered for customAmountValue, then

customAmountLabel cannot be empty.

Field Description

firstName xs:string

(Optional) First name of the company contact.

lastName xs:string

(Optional) Last name of the company contact.

businessName xs:string

(Optional) Company business name.

phone xs:string

(Optional) Phone number for contacting the company.

fax xs:string

(Optional) Fax number used by the company.

website xs:string

(Optional) Website used by the company.

customValue xs:string

(Optional) Custom value to be displayed in the contact information details..

address common:BaseAddress

(Optional) Street address of the company.

Field Description

city xs:string

(Required) City of the address.

countryCode xs:string

(Required) Country code of the address.

Field Description

Invoicing Service API Guide May 2012 31

CreateInvoice API Operation

CreateInvoiceRequest Message 3

InvoiceItemListType Fields

InvoiceItemType Fields

line1 xs:string

(Required) First line of the address.

line2 xs:string

(Optional) Second line of the street address.

postalCode xs:string

(Optional) Postal code of the address.

state xs:string

(Optional) State for the address.

type xs:string

(Optional) Type of address.

Field Description

item inv:InvoiceItemType

(Required) Invoice item.

Field Description

name xs:string

(Required) SKU or name of the item.

Character length and limitations: 30 characters maximum

description xs:string,

(Optional) Item description.

date xs:dateTime

(Optional) Date on which the product or service was provided.

quantity xs:decimal

(Required) Item count. Valid values are 0 to 10.000.

unitPrice xs:decimal

(Required) Price of the item, in the currency specified by the invoice.

taxName xs:string

(Optional) Name of the applicable tax.

taxRate xs:decimal

(Optional) Rate of the applicable tax.

Field Description

CreateInvoice API Operation

CreateInvoiceResponse Message

3

32 May 2012 Invoicing Service API Guide

CreateInvoiceResponse Message

The CreateInvoiceResponse message contains information returned in response to a

CreateInvoiceRequest message. The response contains an invoice ID and the URL to the

invoice on the PayPal system.

ResponseEnvelope Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Invoicing Service API Guide May 2012 33

CreateInvoice API Operation

PPFault Message 3

CreateInvoiceResponse Fields

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceId xs:string

ID of the created invoice.

invoiceNumber xs:string

Invoice number of the created invoice.

invoiceURL xs:string

URL location where merchants view the invoice details.

totalAmount xs:long

The total amount of the invoice.

CreateInvoice API Operation

PPFault Message

3

34 May 2012 Invoicing Service API Guide

FaultMessage Fields

ErrorData Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

Invoicing Service API Guide May 2012 35

CreateInvoice API Operation

PPFault Message 3

ResponseEnvelope Fields

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

CreateInvoice API Operation

CreateInvoice API Errors

3

36 May 2012 Invoicing Service API Guide

CreateInvoice API Errors

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

570045 The number of items exceeds this allowed limit.

570046 The due date occurs before the invoice date.

570047 The invoice date is earlier than todays date.

570048 A tax name can only be associated with one unique tax rate on a

single invoice; the following tax name is associated to different

rates on this invoice.

570049 The total amount for the invoice cannot be negative.

570050 The merchant’s PayPal account cannot be the same as the

payer’s account; merchant and payer email addresses presently

link to the same account.

570051 Invoice cannot have more than 10 different taxes.

570054 Invalid token.

570058 Invalid token.

570059 Invoice number is too long.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580045 Merchant does not have a PayPal account associated with this

email address.

580046 An invoice already exists for the merchant with this invoice

number.

Invoicing Service API Guide May 2012 37

4SendInvoice API Operation

Use the SendInvoice API operation to send an invoice to a payer, and notify the payer of the

pending invoice.

SendInvoiceRequest Message

Use the SendInvoiceRequest message to send an invoice to a payer, and notify the payer

of the pending invoice.

RequestEnvelope Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

SendInvoice API Operation

SendInvoiceResponse Message

4

38 May 2012 Invoicing Service API Guide

SendInvoiceRequest Fields

The table below lists the fields for the SendInvoiceRequest message.

SendInvoiceResponse Message

The SendInvoiceResponse message contains information returned in response to a

SendInvoiceRequest message. It indicates whether the invoice was sent successfully.

ResponseEnvelope Fields

Field Description

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

invoiceID xs:string

(Required) ID of the invoice to send.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

Invoicing Service API Guide May 2012 39

SendInvoice API Operation

SendInvoiceResponse Message 4

SendInvoiceResponse Fields

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceID xs:string

ID of the invoice being sent.

invoiceURL xs:string

Location where merchants view the invoice details.

Field Description

SendInvoice API Operation

PPFault Message

4

40 May 2012 Invoicing Service API Guide

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

FaultMessage Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Invoicing Service API Guide May 2012 41

SendInvoice API Operation

PPFault Message 4

ErrorData Fields

ResponseEnvelope Fields

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

SendInvoice API Operation

Send Invoice API Errors

4

42 May 2012 Invoicing Service API Guide

Send Invoice API Errors

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570052 You cannot send this invoice because it has already been paid.

570053 You cannot send this invoice because it has already been

canceled.

570058 Invalid token.

570064 An invoice that has already been sent cannot be sent again.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580047 Invoice does not exist.

Field Description

Invoicing Service API Guide May 2012 43

5CreateAndSendInvoice API

Operation

Use the CreateAndSendInvoice API operation to create and send an invoice.

CreateAndSendInvoiceRequest Message

Use the CreateAndSendInvoiceRequest message to create and send a new invoice. The

requester should authenticate the caller and verify that the merchant requesting the invoice has

an existing PayPal account in good standing. Once the invoice is created, PayPal sends it to the

specified payer, who is notified of the pending invoice.

CreateAndSendInvoice API Operation

CreateAndSendInvoiceRequest Message

5

44 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 45

CreateAndSendInvoice API Operation

CreateAndSendInvoiceRequest Message 5

CreateAndSendInvoice API Operation

CreateAndSendInvoiceRequest Message

5

46 May 2012 Invoicing Service API Guide

RequestEnvelope Fields

CreateAndSendInvoiceRequest Fields

InvoiceType Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

Field Description

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

invoice inv:InvoiceType

(Required) Merchant, payer, and invoice information.

Field Description

merchantEmail xs:string

(Required) Merchant email address.

payerEmail xs:string

(Required) Payer email address.

number xs:string

(Optional) Unique identifier for the invoice.

merchantInfo inv:BusinessInfoType

Company contact information of the merchant company sending the invoice.

itemList inv:InvoiceItemListType

(Required) List of items included in this invoice.

currencyCode xs:string

(Required) Currency used for all invoice item amounts and totals.

invoiceDate xs:dateTime

(Optional) Date on which the invoice is enabled.

Invoicing Service API Guide May 2012 47

CreateAndSendInvoice API Operation

CreateAndSendInvoiceRequest Message 5

dueDate xs:dateTime

(Optional) Date on which the invoice payment is due.

paymentTerms inv:PaymentTermsType

(Required) Terms by which the invoice payment is due. It is one of the

following values:

-DueOnReceipt – Payment is due when the payer receives the invoice.

-DueOnDateSpecified – Payment is due on the date specified in the

invoice.

-Net10 – Payment is due 10 days from the invoice date.

-Net15 – Payment is due 15 days from the invoice date.

-Net30 – Payment is due 30 days from the invoice date.

-Net45 – Payment is due 45 days from the invoice date.

discountPercent xs:decimal

(Optional) Discount percent applied to the invoice.

discountAmount xs:decimal

(Optional) Discount amount applied to the invoice, if any. If

discountPercent is provided, discountAmount is ignored.

terms xs:string

(Optional) General terms for the invoice.

note xs:string

(Optional) Note to the payer company.

merchantMemo xs:string

(Optional) Memo for bookkeeping that is private to the merchant.

billingInfo inv:BusinessInfoType

(Optional) Billing information for the payer.

shippingInfo inv:BusinessInfoType

(Optional) Shipping information for the payer.

shippingAmount xs:decimal

(Optional) Cost of shipping.

shippingTaxName xs:string

(Optional) Name of the applicable tax on shipping cost.

shippingTaxRate xs:decimal

(Optional) Rate of the applicable tax on shipping cost.

logoURL xs:string

(Optional) Complete URL to an external image used as the logo, if any.

ReferrerCode xs:string

(Optional) Build Notification (BN) code for tracking transactions with a

particular partner..

Field Description

CreateAndSendInvoice API Operation

CreateAndSendInvoiceRequest Message

5

48 May 2012 Invoicing Service API Guide

BusinessInfoType Fields

BaseAddress Fields

customAmountLabel xs:string

Label used to display custom amount value. If a value is entered for

customAmountLabel, then customAmountValue cannot be empty.

customAmountValue xs:decimal

Value of custom amount.If a value is entered for customAmountValue, then

customAmountLabel cannot be empty.

Field Description

firstName xs:string

(Optional) First name of the company contact.

lastName xs:string

(Optional) Last name of the company contact.

businessName xs:string

(Optional) Company business name.

phone xs:string

(Optional) Phone number for contacting the company.

fax xs:string

(Optional) Fax number used by the company.

website xs:string

(Optional) Website used by the company.

customValue xs:string

(Optional) Custom value to be displayed in the contact information details..

address common:BaseAddress

(Optional) Street address of the company.

Field Description

city xs:string

(Required) City of the address.

countryCode xs:string

(Required) Country code of the address.

Field Description

Invoicing Service API Guide May 2012 49

CreateAndSendInvoice API Operation

CreateAndSendInvoiceRequest Message 5

InvoiceItemListType Fields

InvoiceItemType Fields

line1 xs:string

(Required) First line of the address.

line2 xs:string

(Optional) Second line of the street address.

postalCode xs:string

(Optional) Postal code of the address.

state xs:string

(Optional) State for the address.

type xs:string

(Optional) Type of address.

Field Description

item inv:InvoiceItemType

(Required) Invoice item.

Field Description

name xs:string

(Required) SKU or name of the item.

Character length and limitations: 30 characters maximum

description xs:string,

(Optional) Item description.

date xs:dateTime

(Optional) Date on which the product or service was provided.

quantity xs:decimal

(Required) Item count. Valid values are 0 to 10.000.

unitPrice xs:decimal

(Required) Price of the item, in the currency specified by the invoice.

taxName xs:string

(Optional) Name of the applicable tax.

taxRate xs:decimal

(Optional) Rate of the applicable tax.

Field Description

CreateAndSendInvoice API Operation

CreateAndSendInvoiceResponse Message

5

50 May 2012 Invoicing Service API Guide

CreateAndSendInvoiceResponse Message

The CreateAndSendInvoiceResponse message contains information returned in response

to a CreateAndSendInvoiceRequest message. The response contains an invoice ID and

the URL to the invoice on the PayPal system, and indicates whether the invoice was sent

successfully.

ResponseEnvelope Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Invoicing Service API Guide May 2012 51

CreateAndSendInvoice API Operation

PPFault Message 5

CreateAndSendInvoiceResponse Fields

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceID xs:string

ID of the created invoice.

invoiceNumber xs:string

Number of the created invoice.

invoiceURL xs:string

URL location where merchants view the invoice details.

totalAmount xs:long

The total amount of the invoice.

CreateAndSendInvoice API Operation

PPFault Message

5

52 May 2012 Invoicing Service API Guide

FaultMessage Fields

ErrorData Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

Invoicing Service API Guide May 2012 53

CreateAndSendInvoice API Operation

CreateAndSendInvoice API Errors 5

ResponseEnvelope Fields

CreateAndSendInvoice API Errors

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

Field Description

CreateAndSendInvoice API Operation

CreateAndSendInvoice API Errors

5

54 May 2012 Invoicing Service API Guide

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

570045 The number of items exceeds this allowed limit.

570046 The due date occurs before the invoice date.

570047 The invoice date is earlier than todays date.

570048 A tax name can only be associated with one unique tax rate on a

single invoice; the following tax name is associated to different

rates on this invoice.

570049 The total amount for the invoice cannot be negative.

570050 The merchant’s PayPal account cannot be the same as the

payer’s account; merchant and payer email addresses presently

link to the same account.

570051 Invoice cannot have more than 10 different taxes.

570054 Invalid token.

570058 Invalid token.

570059 Invoice number is too long.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580045 Merchant does not have a PayPal account associated with this

email address.

580046 An invoice already exists for the merchant with this invoice

number.

Code Message Additional Information

Invoicing Service API Guide May 2012 55

6UpdateInvoice API Operation

Use the UpdateInvoice API operation to update an invoice.

UpdateInvoiceRequest Message

Use the UpdateInvoiceRequest message to update an invoice.

UpdateInvoice API Operation

UpdateInvoiceRequest Message

6

56 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 57

UpdateInvoice API Operation

UpdateInvoiceRequest Message 6

UpdateInvoice API Operation

UpdateInvoiceRequest Message

6

58 May 2012 Invoicing Service API Guide

RequestEnvelope Fields

UpdateInvoiceRequest Fields

InvoiceType Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

Field Description

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

invoiceID xs:string

(Required) ID of the invoice to update.

invoice inv:InvoiceType

(Required) Merchant, payer, and invoice information.

Field Description

merchantEmail xs:string

(Required) Merchant email address.

payerEmail xs:string

(Required) Payer email address.

number xs:string

(Optional) Unique identifier for the invoice.

merchantInfo inv:BusinessInfoType

Company contact information of the merchant company sending the invoice.

itemList inv:InvoiceItemListType

(Required) List of items included in this invoice.

currencyCode xs:string

(Required) Currency used for all invoice item amounts and totals.

Invoicing Service API Guide May 2012 59

UpdateInvoice API Operation

UpdateInvoiceRequest Message 6

invoiceDate xs:dateTime

(Optional) Date on which the invoice is enabled.

dueDate xs:dateTime

(Optional) Date on which the invoice payment is due.

paymentTerms inv:PaymentTermsType

(Required) Terms by which the invoice payment is due. It is one of the

following values:

-DueOnReceipt – Payment is due when the payer receives the invoice.

-DueOnDateSpecified – Payment is due on the date specified in the

invoice.

-Net10 – Payment is due 10 days from the invoice date.

-Net15 – Payment is due 15 days from the invoice date.

-Net30 – Payment is due 30 days from the invoice date.

-Net45 – Payment is due 45 days from the invoice date.

discountPercent xs:decimal

(Optional) Discount percent applied to the invoice.

discountAmount xs:decimal

(Optional) Discount amount applied to the invoice, if any. If

discountPercent is provided, discountAmount is ignored.

terms xs:string

(Optional) General terms for the invoice.

note xs:string

(Optional) Note to the payer company.

merchantMemo xs:string

(Optional) Memo for bookkeeping that is private to the merchant.

billingInfo inv:BusinessInfoType

(Optional) Billing information for the payer.

shippingInfo inv:BusinessInfoType

(Optional) Shipping information for the payer.

shippingAmount xs:decimal

(Optional) Cost of shipping.

shippingTaxName xs:string

(Optional) Name of the applicable tax on shipping cost.

shippingTaxRate xs:decimal

(Optional) Rate of the applicable tax on shipping cost.

logoURL xs:string

(Optional) Complete URL to an external image used as the logo, if any.

Field Description

UpdateInvoice API Operation

UpdateInvoiceRequest Message

6

60 May 2012 Invoicing Service API Guide

BusinessInfoType Fields

InvoiceItemType Fields

ReferrerCode xs:string

(Optional) Build Notification (BN) code for tracking transactions with a

particular partner..

customAmountLabel xs:string

Label used to display custom amount value. If a value is entered for

customAmountLabel, then customAmountValue cannot be empty.

customAmountValue xs:decimal

Value of custom amount.If a value is entered for customAmountValue, then

customAmountLabel cannot be empty.

Field Description

firstName xs:string

(Optional) First name of the company contact.

lastName xs:string

(Optional) Last name of the company contact.

businessName xs:string

(Optional) Company business name.

phone xs:string

(Optional) Phone number for contacting the company.

fax xs:string

(Optional) Fax number used by the company.

website xs:string

(Optional) Website used by the company.

customValue xs:string

(Optional) Custom value to be displayed in the contact information details..

address common:BaseAddress

(Optional) Street address of the company.

Field Description

item inv:InvoiceItemType

(Required) Invoice item.

Field Description

Invoicing Service API Guide May 2012 61

UpdateInvoice API Operation

UpdateInvoiceResponse Message 6

InvoiceItemType Fields

UpdateInvoiceResponse Message

The UpdateInvoiceResponse message contains information returned in response to an

UpdateInvoiceRequest message.

Field Description

name xs:string

(Required) SKU or name of the item.

Character length and limitations: 30 characters maximum

description xs:string,

(Optional) Item description.

date xs:dateTime

(Optional) Date on which the product or service was provided.

quantity xs:decimal

(Required) Item count. Valid values are 0 to 10.000.

unitPrice xs:decimal

(Required) Price of the item, in the currency specified by the invoice.

taxName xs:string

(Optional) Name of the applicable tax.

taxRate xs:decimal

(Optional) Rate of the applicable tax.

UpdateInvoice API Operation

UpdateInvoiceResponse Message

6

62 May 2012 Invoicing Service API Guide

ResponseEnvelope Fields

UpdateInvoiceResponse Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceId xs:string

ID of the updated invoice.

invoiceNumber xs:string

Invoice number of the updated invoice.

invoiceURL xs:string

URL location where merchants view the updated invoice details.

totalAmount xs:long

The total amount of the invoice.

Invoicing Service API Guide May 2012 63

UpdateInvoice API Operation

PPFault Message 6

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

FaultMessage Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

UpdateInvoice API Operation

PPFault Message

6

64 May 2012 Invoicing Service API Guide

ErrorData Fields

ResponseEnvelope Fields

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

Invoicing Service API Guide May 2012 65

UpdateInvoice API Operation

UpdateInvoice API Errors 6

UpdateInvoice API Errors

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570045 The number of items exceeds this allowed limit.

570046 The due date occurs before the invoice date.

570047 The invoice date is earlier than todays date.

570048 A tax name can only be associated with one unique tax rate on a

single invoice; the following tax name is associated to different

rates on this invoice.

570049 The total amount for the invoice cannot be negative.

570050 The merchant’s PayPal account cannot be the same as the

payer’s account; merchant and payer email addresses presently

link to the same account.

570051 Invoice cannot have more than 10 different taxes.

Field Description

UpdateInvoice API Operation

UpdateInvoice API Errors

6

66 May 2012 Invoicing Service API Guide

570058 Invalid token.

570059 Invoice number is too long.

570060 The status of the invoice is such that it can no longer be updated.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580046 An invoice already exists for the merchant with this invoice

number.

580047 Invoice does not exist.

Code Message Additional Information

Invoicing Service API Guide May 2012 67

7GetInvoiceDetails API Operation

Use the GetInvoiceDetails API operation to get detailed information about an invoice.

GetInvoiceDetailsRequest Message

Use the GetInvoiceDetailsRequest message to get detailed information about an

invoice.

RequestEnvelope Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message

7

68 May 2012 Invoicing Service API Guide

GetInvoiceDetailsRequest Fields

GetInvoiceDetailsResponse Message

Field Description

invoiceID xs:string

(Required) ID of the invoice to retrieve.

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

Invoicing Service API Guide May 2012 69

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message 7

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message

7

70 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 71

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message 7

ResponseEnvelope Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message

7

72 May 2012 Invoicing Service API Guide

GetInvoiceDetailsResponse Fields

InvoiceType Fields

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoice xs:string

ID of the created invoice.

invoiceDetails inv:InvoiceDetailsType

Details about the invoice status and state change dates.

paymentDetails inv:PaymentDetailsType

Payment details about the invoice.

refundDetails inv:PaymentRefundDetailsType

The requested invoice refund details.

invoiceURL xs:string

URL location where merchants view the invoice details.

Field Description

merchantEmail xs:string

Merchant email address.

payerEmail xs:string

Payer email address.

number xs:string

Unique identifier for the invoice.

merchantInfo inv:BusinessInfoType

Company contact information of the merchant company sending the invoice.

Field Description

Invoicing Service API Guide May 2012 73

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message 7

itemList inv:InvoiceItemListType

List of items included in this invoice.

currencyCode xs:string

Currency used for all invoice item amounts and totals.

invoiceDate xs:dateTime

Date on which the invoice is enabled.

dueDate xs:dateTime

Date on which the invoice payment is due.

paymentTerms inv:PaymentTermsType

Terms by which the invoice payment is due. It is one of the following values:

-DueOnReceipt – Payment is due when the payer receives the invoice.

-DueOnDateSpecified – Payment is due on the date specified in the

invoice.

-Net10 – Payment is due 10 days from the invoice date.

-Net15 – Payment is due 15 days from the invoice date.

-Net30 – Payment is due 30 days from the invoice date.

-Net45 – Payment is due 45 days from the invoice date.

discountPercent xs:decimal

Discount percent applied to the invoice.

discountAmount xs:decimal

Discount amount applied to the invoice, if any. If discountPercent is

provided, discountAmount is ignored.

terms xs:string

General terms for the invoice.

note xs:string

Note to the payer company.

merchantMemo xs:string

Memo for bookkeeping that is private to the merchant.

billingInfo inv:BusinessInfoType

Billing information for the payer.

shippingInfo inv:BusinessInfoType

Shipping information for the payer.

shippingAmount xs:decimal

Cost of shipping.

shippingTaxName xs:string

Name of the applicable tax on shipping cost.

Field Description

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message

7

74 May 2012 Invoicing Service API Guide

InvoiceDetailsType Fields

shippingTaxRate xs:decimal

Rate of the applicable tax on shipping cost.

logoURL xs:string

External image URL of the invoice logo, if any.

referrerCode xs:string

Build Notification (BN) code for tracking transactions with a particular

partner.

Field Description

status inv:StatusType

Status of the invoice.

totalAmount xs:decimal

Total amount of the invoice (cost of items, shipping, and tax, less any

discount). The invoicing system sets this field and ignores any changes made

by API callers.

origin inv:OriginType

Indicates whether the invoice was created by the website or an API call.

createdDate xs:dateTime

Date when the invoice was created.

createdBy xs:string

Account that created the invoice.

canceledDate xs:dateTime

Date when the invoice was canceled, if canceled.

canceledByActor xs:ActorType

Actor who canceled the invoice.

canceledBy xs:string

Account that canceled the invoice.

lastUpdatedDate xs:dateTime

Date when the invoice was last updated.

lastUpdatedBy xs:string

Account that last edited the invoice.

firstSentDate xs:dateTime

Date when the invoice was first sent.

Field Description

Invoicing Service API Guide May 2012 75

GetInvoiceDetails API Operation

GetInvoiceDetailsResponse Message 7

PaymentDetailsType Fields

PayPalPaymentDetailsType Fields

lastSentDate xs:dateTime

Date when the invoice was last sent.

lastSentBy xs:string

Account that last sent the invoice.

paidDate xs:dateTime

Date when the invoice was paid, if paid.

Field Description

viaPayPal xs:boolean

Returns True if the invoice was paid by PayPal.

paypalPayment inv:PayPalPaymentDetailsType

PayPal payment details about the invoice.

otherPayment inv:OtherPaymentDetailsType

Offline payment details about the invoice.

Field Description

transactionID xs:string

Transaction ID of the PayPal payment.

date xs:dateTime

Date when the invoice was paid.

Field Description

GetInvoiceDetails API Operation

PPFault Message

7

76 May 2012 Invoicing Service API Guide

OtherPaymentDetailsType Fields

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

Field Description

method inv:PaymentMethodsType

(Optional) Method that can be used to mark an invoice as paid when the payer

pays offline. It is one of the following values:

-BankTransfer – Payment is made by a bank transfer.

-Cash – Payment is made in cash.

-Check – Payment is made by check.

-CreditCard – Payment is made by a credit card.

-DebitCard – Payment is made by a debit card.

-Other – Payment is made by a method not specified in this list.

-PayPal – Payment is made by PayPal.

-WireTransfer – Payment is made by a wire transfer.

note xs:string

(Optional) Optional note associated with the payment.

date xs:dateTime

(Required) Date when the invoice was paid.

Invoicing Service API Guide May 2012 77

GetInvoiceDetails API Operation

PPFault Message 7

FaultMessage Fields

ErrorData Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

GetInvoiceDetails API Operation

GetInvoiceDetails API Errors

7

78 May 2012 Invoicing Service API Guide

ResponseEnvelope Fields

GetInvoiceDetails API Errors

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

Field Description

Invoicing Service API Guide May 2012 79

GetInvoiceDetails API Operation

GetInvoiceDetails API Errors 7

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570058 Invalid token.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580047 Invoice does not exist.

Code Message Additional Information

GetInvoiceDetails API Operation

GetInvoiceDetails API Errors

7

80 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 81

8CancelInvoice API Operation

Use the CancelInvoice API operation to cancel an invoice.

CancelInvoiceRequest Message

Use the CancelInvoiceRequest message to cancel an invoice.

RequestEnvelope Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

CancelInvoice API Operation

CancelInvoiceResponse Message

8

82 May 2012 Invoicing Service API Guide

CancelInvoiceRequest Fields

CancelInvoiceResponse Message

Use the CancelInvoiceResponse message to cancel an invoice.

Field Description

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

invoiceID xs:string

(Optional) ID of the invoice.

subject xs:string

(Optional) Subject of the cancelation notification.

noteForPayer xs:string

(Optional) Note to send payer within the cancelation notification.

sendCopyToMerchant xs:boolean

(Optional) Indicates whether to send a copy of the cancelation notification to

the merchant. It is one of the following values:

-false – Do not send a copy of the cancelation notification to the merchant

(default).

-true – Send a copy of the cancelation notification to the merchant.

Invoicing Service API Guide May 2012 83

CancelInvoice API Operation

CancelInvoiceResponse Message 8

ResponseEnvelope Fields

CancelInvoiceResponse Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceID xs:string

ID of the canceled invoice.

invoiceNumber xs:string

Number of the canceled invoice.

invoiceURL xs:string

URL location where merchants view the invoice details.

CancelInvoice API Operation

PPFault Message

8

84 May 2012 Invoicing Service API Guide

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

FaultMessage Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Invoicing Service API Guide May 2012 85

CancelInvoice API Operation

PPFault Message 8

ErrorData Fields

ResponseEnvelope Fields

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

CancelInvoice API Operation

CancelInvoice API Errors

8

86 May 2012 Invoicing Service API Guide

CancelInvoice API Errors

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570058 Invalid token.

570061 Invoice cannot be canceled since it has already been paid.

570062 The invoice has already been canceled.

570063 A draft invoice cannot be canceled.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580047 Invoice does not exist.

Field Description

Invoicing Service API Guide May 2012 87

9SearchInvoices API Operation

Use the SearchInvoice API operation to search an invoice.

SearchInvoicesRequest Message

Use the SearchInvoiceRequest message to search an invoice.

SearchInvoices API Operation

SearchInvoicesRequest Message

9

88 May 2012 Invoicing Service API Guide

RequestEnvelope Fields

SearchInvoicesRequest Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

Field Description

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

merchantEmail xs:string

(Required) Email address of invoice creator.

parameters inv:SearchParametersType

(Required) Parameters constraining the search.

Invoicing Service API Guide May 2012 89

SearchInvoices API Operation

SearchInvoicesRequest Message 9

SearchParametersType Fields

page xs:integer

(Required) Page number of result set, starting with 1.

pageSize xs:integer

(Required) Number of results per page, between 1 and 100.

Field Description

email xs:string

(Optional) Email search string.

recipientName xs:string

(Optional) Recipient search string.

businessName xs:string

(Optional) Company search string.

invoiceNumber xs:integer

(Optional) Invoice number search string.

status inv:statusType

(Optional) Invoice status search.

lowerAmount xs:decimal

(Optional) Invoice amount search. It specifies the smallest amount to be

returned. If you pass a value for this field, you must also pass a

currencyCode value.

upperAmount xs:decimal

(Optional) Invoice amount search. It specifies the largest amount to be

returned. If you pass a value for this field, you must also pass a

currencyCode value.

currencyCode xs:string

(Optional) Currency used for lower and upper amounts. It is required when

you specify lowerAmount or upperAmount.

memo xs:string

(Optional) Invoice memo search string.

origin inv:originType

(Optional) Indicates whether the invoice was created by the website or by an

API call. It is one of the following values:

-Web – The invoice was created on paypal.com.

-API – The invoice was created by an Invoicing Service API call.

Field Description

SearchInvoices API Operation

SearchInvoicesResponse Message

9

90 May 2012 Invoicing Service API Guide

DateRangeType Fields

SearchInvoicesResponse Message

The SearchInvoicesResponse message contains information returned in response to a

SearchInvoicesRequest message.

invoiceDate inv:dateRangeType

(Optional) Invoice date range filter.

dueDate inv:dateRangeType

(Optional) Invoice due date range filter.

paymentDate inv:dateRangeType

(Optional) Invoice payment date range filter.

creationDate inv:dateRangeType

(Optional) Invoice creation date range filter.

Field Description

startDate xs:dateTime

(Optional) Start of the date range.

endDate xs:dateTime

(Optional) End of the date range.

Field Description

Invoicing Service API Guide May 2012 91

SearchInvoices API Operation

SearchInvoicesResponse Message 9

ResponseEnvelope Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

SearchInvoices API Operation

SearchInvoicesResponse Message

9

92 May 2012 Invoicing Service API Guide

SearchInvoicesResponse Fields

InvoiceSummaryListType Fields

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

count xs:integer

Number of invoices that matched the request.

invoiceList inv:invoiceSummaryList

Page of invoice summaries that matched the list.

page xs:string

URL location where the merchant views invoice details.

hasNextPage xs:boolean

True if another page of invoice summary results exists.

hasPreviousPage xs:boolean

True if a previous page of the invoice summary results exists.

Field Description

invoice inv:InvoiceSummaryType

Summary of invoice contents.

Field Description

Invoicing Service API Guide May 2012 93

SearchInvoices API Operation

SearchInvoicesResponse Message 9

InvoiceSummaryType Fields

Field Description

invoiceID xs:string

ID of the invoice.

merchantEmail xs:string

Merchant email address.

payerEmail xs:string

Payer email address.

number xs:string

Unique identifier for the invoice.

billingBusinessName xs:string

Company contact information of the merchant company sending the invoice.

billingFirstName xs:string

First name of the business information.

billingLastName xs:string

shippingBusinessName xs:string

Business name of the shipping information.

shippingFirstName xs:string

First name of the shipping information.

shippingLastName xs:string

Last name of the shipping information.

totalAmount xs:decimal

Total amount of the invoice.

currencyCode xs:string

Currency used for all invoice item amounts and totals.

invoiceDate xs:dateTime

Date on which the invoice is enabled.

dueDate xs:dateTime

Date on which the invoice payment is due.

status xs:statusType

Status of the invoice.

referrerCode xs:string

Build Notification (BN) code for tracking transactions with a particular

partner.

origin inv:originType

Indicates whether the invoice was created by the website or by an API call.

SearchInvoices API Operation

PPFault Message

9

94 May 2012 Invoicing Service API Guide

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

FaultMessage Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Invoicing Service API Guide May 2012 95

SearchInvoices API Operation

PPFault Message 9

ErrorData Fields

ResponseEnvelope Fields

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

SearchInvoices API Operation

SearchInvoices API Errors

9

96 May 2012 Invoicing Service API Guide

SearchInvoices API Errors

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

570058 Invalid token.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

Field Description

Invoicing Service API Guide May 2012 97

10 MarkInvoiceAsPaid API Operation

Use the MarkInvoiceAsPaid API operation to mark an invoice as paid.

MarkInvoiceAsPaidRequest Message

Use the MarkInvoiceAsPaidRequest message to mark an invoice as paid.

RequestEnvelope Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

MarkInvoiceAsPaid API Operation

MarkInvoiceAsPaidRequest Message

10

98 May 2012 Invoicing Service API Guide

MarkInvoiceAsPaidRequest Fields

OtherPaymentDetailsType Fields

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

Field Description

invoiceID xs:string

(Required) ID of the invoice to mark as paid.

payment inv:OtherPaymentDetailsType

(Required) Details of the payment made against this type.

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

Field Description

method inv:PaymentMethodsType

(Optional) Method that can be used to mark an invoice as paid when the payer

pays offline. It is one of the following values:

-BankTransfer – Payment is made by a bank transfer.

-Cash – Payment is made in cash.

-Check – Payment is made by check.

-CreditCard – Payment is made by a credit card.

-DebitCard – Payment is made by a debit card.

-Other – Payment is made by a method not specified in this list.

-PayPal – Payment is made by PayPal.

-WireTransfer – Payment is made by a wire transfer.

note xs:string

(Optional) Optional note associated with the payment.

date xs:dateTime

(Required) Date when the invoice was paid.

Field Description

Invoicing Service API Guide May 2012 99

MarkInvoiceAsPaid API Operation

MarkInvoiceAsPaidResponse Message 10

MarkInvoiceAsPaidResponse Message

The MarkInvoiceAsPaidResponse message marks an invoice as paid.

ResponseEnvelope Fields

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

MarkInvoiceAsPaid API Operation

PPFault Message

10

100 May 2012 Invoicing Service API Guide

MarkInvoiceAsPaidResponse Fields

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceID xs:string

ID of the invoice marked as paid.

invoiceNumber xs:string

Number of the invoice marked as paid.

invoiceURL xs:string

URL location where merchants view the invoice details.

Invoicing Service API Guide May 2012 101

MarkInvoiceAsPaid API Operation

PPFault Message 10

FaultMessage Fields

ErrorData Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

MarkInvoiceAsPaid API Operation

MarkInvoiceAsPaid API Errors

10

102 May 2012 Invoicing Service API Guide

ResponseEnvelope Fields

MarkInvoiceAsPaid API Errors

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

Field Description

Invoicing Service API Guide May 2012 103

MarkInvoiceAsPaid API Operation

MarkInvoiceAsPaid API Errors 10

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570058 Invalid token.

570065 Invoice cannot be marked as paid since it has already been paid.

570066 The payment method of the invoice is invalid.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580047 Invoice does not exist.

Code Message Additional Information

MarkInvoiceAsPaid API Operation

MarkInvoiceAsPaid API Errors

10

104 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 105

11 MarkInvoiceAsUnpaid API

Operation

Use the MarkInvoiceAsUnpaid API operation to mark an invoice as unpaid.

MarkInvoiceAsUnpaidRequest Message

Use the MarkInvoiceAsUnpaidRequest message to mark an invoice as unpaid.

RequestEnvelope Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

MarkInvoiceAsUnpaid API Operation

MarkInvoiceAsUnpaidResponse Message

11

106 May 2012 Invoicing Service API Guide

MarkInvoiceAsUnpaidRequest Fields

MarkInvoiceAsUnpaidResponse Message

The MarkInvoiceAsUnpaidResponse message marks an invoice as unpaid.

ResponseEnvelope Fields

Field Description

invoiceID xs:string

(Required) ID of the invoice to mark as unpaid.

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Invoicing Service API Guide May 2012 107

MarkInvoiceAsUnpaid API Operation

MarkInvoiceAsUnpaidResponse Message 11

MarkInvoiceAsUnpaidResponse Fields

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceID xs:string

ID of the invoice marked as unpaid.

invoiceNumber xs:string

Number of the invoice marked as unpaid.

invoiceURL xs:string

URL location where merchants view the invoice details.

Field Description

MarkInvoiceAsUnpaid API Operation

PPFault Message

11

108 May 2012 Invoicing Service API Guide

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

FaultMessage Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Invoicing Service API Guide May 2012 109

MarkInvoiceAsUnpaid API Operation

PPFault Message 11

ErrorData Fields

ResponseEnvelope Fields

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

MarkInvoiceAsUnpaid API Operation

MarkInvoiceAsUnpaid API Errors

11

110 May 2012 Invoicing Service API Guide

MarkInvoiceAsUnpaid API Errors

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570058 Invalid token.

570079 Invoice must be marked as paid before it can be marked as

unpaid.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580047 Invoice does not exist.

Field Description

Invoicing Service API Guide May 2012 111

12 MarkInvoiceAsRefunded API

Operation

Use the MarkInvoiceAsRefunded API operation to mark an invoice as refunded. This API

operation can only be used for full refunds.

MarkInvoiceAsRefundedRequest Message

Use the MarkInvoiceAsRefundedRequest message to mark an invoice as refunded.

RequestEnvelope Fields

MarkInvoiceAsRefundedRequest Fields

Field Description

detailLevel common:DetailLevelCode

(Optional) Level of detail required by the client application for components. It

is one of the following values:

-ReturnAll – This value provides the maximum level of detail (default).

errorLanguage xs:string

(Required) RFC 3066 language in which error messages are returned; by

default it is en_US, which is the only language currently supported.

Field Description

invoiceID xs:string

(Required) ID of the invoice to mark as refunded.

refundDetail inv:OtherPaymentRefundDetailsType

(Required) Details of the refund made against this invoice.

MarkInvoiceAsRefunded API Operation

MarkInvoiceAsRefundedResponse Message

12

112 May 2012 Invoicing Service API Guide

OtherRefundDetailsType Fields

MarkInvoiceAsRefundedResponse Message

The MarkInvoiceAsRefundedResponse message marks an invoice as refunded.

ResponseEnvelope Fields

requestEnvelope common:requestEnvelope

(Required) Information common to each API operation, such as the language

in which an error message is returned.

Field Description

note xs:string

(Optional) Optional note associated with the refund.

date xs:dateTime

(Required) Date when the invoice was marked as refunded.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

Field Description

Invoicing Service API Guide May 2012 113

MarkInvoiceAsRefunded API Operation

MarkInvoiceAsRefundedResponse Message 12

MarkInvoiceAsRefundedResponse Fields

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Field Description

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

invoiceID xs:string

ID of the invoice marked as refunded.

invoiceNumber xs:string

Number of the invoice marked as refunded.

invoiceURL xs:string

The URL of the details page of the invoice that was marked as refunded.

Field Description

MarkInvoiceAsRefunded API Operation

PPFault Message

12

114 May 2012 Invoicing Service API Guide

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to

your application if an error occurs.

FaultMessage Fields

Field Description

error common:ErrorData

Detailed error information.

responseEnvelope common:ResponseEnvelope

Common response information, including a timestamp and the response

acknowledgement status.

Invoicing Service API Guide May 2012 115

MarkInvoiceAsRefunded API Operation

PPFault Message 12

ErrorData Fields

ResponseEnvelope Fields

Field Description

category common:ErrorCategory

The location where the error occurred.

Possible values are:

-System – The system encountered errors; try again

-Application – The application encountered errors; try again

-Request – The request was incorrect

domain xs:string

The domain to which this service belongs.

errorId xs:long

A 6-digit number that uniquely identifies a particular error.

exceptionID This field is not used.

message xs:string

A description of the error.

parameter common:ErrorParameter

Represents contextual information about the error.

severity common:ErrorSeverity

The severity of the error encountered.

Possible values are:

-Error – Processing of the request was interrupted

-Warning – Processing of the request was completed

subdomain This field is not used.

Field Description

ack common:AckCode

Acknowledgement code. It is one of the following values:

-Success – The operation completed successfully.

-Failure – The operation failed.

-SuccessWithWarning – The operation completed successfully;

however, there is a warning message.

-FailureWithWarning – The operation failed with a warning message.

build xs:string

Build number. It is used only by PayPal Merchant Technical Support.

MarkInvoiceAsRefunded API Operation

MarkInvoiceAsRefunded API Errors

12

116 May 2012 Invoicing Service API Guide

MarkInvoiceAsRefunded API Errors

correlationId xs:string

Correlation identifier. It is a 13-character, alphanumeric string (for example,

db87c705a910e) that is used only by PayPal Merchant Technical Support.

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

timestamp xs:datetime

Date on which the response was sent, for example:

2012-04-02T22:33:35.774-07:00

NOTE:You must log and store this data for every response you receive.

PayPal Technical Support uses the information to assist with reported

issues.

Code Message Additional Information

520002 Internal error.

520005 Authentication failed. API credentials are incorrect.

520009 Account is restricted.

550026 Partner did not create the invoice but attempted to access or

modify it; a merchant’s invoice can be accessed or modified only

by the partner who created it.

550027 Merchant cannot access or modify an invoice they did not create;

an invoice can only be accessed or modified by the party who

created it.

570058 Invalid token.

570080 Invoice must be marked as paid before it can be marked as

refunded.

570081 Refund date must occur after payment date.

580022 This error code corresponds to validation error messages that

deal with errors of supplied parameters.

580047 Invoice does not exist.

Field Description

Invoicing Service API Guide May 2012 117

Revision History

The revision history identifies changes to the PayPal Invoicing Service documentation at a

high level.

Date Description

05/22/2012 Added two new APIs: MarkInvoiceAsUnpaid, MarkInvoiceAsRefunded.

01/24/2012 Clarified use of and examples for image URL.

09/19/2011 Initial release draft.

118 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 119

Index

A

ack response field 32, 35, 38, 41, 50, 53, 62, 64, 71, 78,

83, 85, 91, 95, 99, 102, 106, 109, 112, 115

address request field 30, 48, 60

B

BaseAddress request fields 30, 48

billingBusinessName response field 93

billingFirstName response field 93

billingInfo request field 29, 47, 59

billingInfo response field 73

billingLastName response field 93

build response field 32, 35, 38, 41, 50, 53, 62, 64, 71,

78, 83, 85, 91, 95, 99, 102, 106, 109, 112, 115

businessName request field 30, 48, 60, 89

C

canceledBy response field 74

canceledByActor response field 74

canceledDate response field 74

CancelPreapproval API operation 25, 37, 43, 55, 67,

81, 97, 105, 111

CancelPreapprovalResponse fields 39, 51, 72

category field 34, 41, 52, 64, 77, 85, 95, 101, 109, 115

city response field 30, 31, 48, 49

correlationId response field 32, 35, 39, 42, 50, 53, 62,

65, 71, 78, 83, 86, 92, 96, 99, 102, 106, 110, 113,

116

count response field 92

countryCode response field 30, 48

createdBy response field 74

createdDate response field 74

creationDate request field 90

currencyCode request field 28, 46, 58, 89

currencyCode response field 73, 93

customValue request field 30, 48, 60

D

date request field 31, 49, 61, 76, 98, 112

description request field 31, 49, 61

detailLevel request field 28, 37, 46, 58, 67, 81, 88, 97,

105, 111

discountAmount response field 73

discountPercent response field 73

discouontAmount request field 29, 47, 59

discouontPercent request field 29, 47, 59

domain field 34, 41, 52, 64, 77, 85, 95, 101, 109, 115

dueDate request field 29, 47, 59, 90

dueDate response field 73, 93

E

email request field 89

endDate request field 90

error PPFault field 34, 40, 52, 63, 77, 84, 94, 101, 108,

114

ErrorData fields 34, 41, 52, 64, 77, 85, 95, 101, 109,

115

errorId field 34, 41, 52, 64, 77, 85, 95, 101, 109, 115

errorLanguage request field 28, 37, 46, 58, 67, 81, 88,

98, 105, 111

exceptionID field 34, 41, 52, 64, 77, 85, 95, 101, 109,

115

F

FaultMessage PPFault fields 34, 40, 52, 63, 77, 84, 94,

101, 108, 114

fax request field 30, 48, 60

firstName request field 30, 48, 60

firstSentDate response field 74

H

hasNextPage response field 92

hasPreviousPage response field 92

Index

120 May 2012 Invoicing Service API Guide

I

invoice request field 58

invoice response field 72, 92

invoiceDate request field 28, 46, 59, 90

invoiceDate response field 73, 93

invoiceDetails response field 72

invoiceID request field 38, 58, 68, 82, 98, 106, 111

invoiceID response field 33, 39, 51, 62, 83, 93, 100,

107, 113

invoiceList response field 92

invoiceNumber request field 89

invoiceNumber response field 33, 51, 62, 83, 100, 107,

113

InvoiceType 28, 46

invoiceURL response field 33, 39, 51, 62, 72, 83, 100,

107, 113

item request field 31, 49, 60

itemList request field 28, 46, 58

itemList response field 73

L

lastName request field 30, 48, 60

lastSentBy response field 75

lastSentDate response field 75

lastUpdatedBy response field 74

lastUpdatedDate response field 74

line1 response field 31, 49

line2 response field 31, 49

logoURL request field 29, 47, 59, 60

logoURL response field 74, 93

lowerAmount request field 89

M

memo request field 89

merchantEmail request field 28, 46, 58, 88

merchantEmail response field 72, 93

merchantInfo request field 28, 46, 58

merchantInfo response field 72

merchantMemo request field 29, 47, 59

merchantMemo response field 73

message field 34, 41, 52, 64, 77, 85, 95, 101, 109, 115

method request field 76, 98

N

name request field 31, 49, 61

note request field 29, 47, 59, 76, 98, 112

note response field 73

noteForPayer request field 82

number request field 28, 46, 58

number response field 72, 93

O

origin request field 89

origin response field 74, 93

otherPayment response field 75

P

page request field 89

page response field 92

pageSize request field 89

paidDate response field 75

parameter field 34, 41, 52, 64, 77, 85, 95, 101, 109, 115

parameters request field 88

payerEmail request field 28, 46, 58

payerEmail response field 72, 93

payment request field 98, 111

paymentDate request field 90

paymentDetails response field 72

paymentTerms request field 29, 47, 59

paymentTerms response field 73

paypalPayment response field 75

phone request field 30, 48, 60

PPFault message 33, 40, 51, 63, 76, 84, 94, 100, 108,

114

Q

quantity request field 31, 49, 61

R

recipientName request field 89

Refund details response field 72

requestEnvelope request field 28, 38, 46, 58, 68, 82, 88,

98, 106, 112

RequestEnvelope request fields 28, 37, 46, 58, 67, 81,

88, 97, 105, 111

Invoicing Service API Guide May 2012 121

Index

responseEnvelope PPFault field 34, 40, 52, 63, 77, 84,

94, 101, 108, 114

responseEnvelope response field 33, 39, 51, 62, 72, 83,

92, 100, 107, 113

ResponseEnvelope response fields 32, 35, 38, 41, 50,

53, 62, 64, 71, 78, 83, 85, 91, 95, 99, 102, 106,

109, 112, 115

S

sendCopyToMerchant request field 82

severity field 35, 41, 53, 64, 78, 85, 95, 102, 109, 115

shippingAmount request field 29, 47, 59

shippingAmount response field 73

shippingBusinessName response field 93

shippingFirstName response field 93

shippingInfo request field 29, 47, 59

shippingInfo response field 73

shippingLastName response field 93

shippingTaxName request field 29, 47, 59

shippingTaxName response field 73

shippingTaxRate request field 29, 47, 59

shippingTaxRate response field 74

startDate request field 90

state response field 31, 49

status request field 89

status response field 74, 93

subdomain field 35, 41, 53, 64, 78, 85, 95, 102, 109,

115

subject request field 82

T

taxName request field 31, 49, 61

taxRate request field 31, 49, 61

terms request field 29, 47, 59

terms response field 73

timestamp response field 32, 35, 39, 42, 50, 53, 62, 65,

72, 78, 83, 86, 92, 96, 99, 102, 107, 110, 113, 116

totalAmount response field 74, 93

type response field 31, 49

U

unitPrice request field 31, 49, 61

upperAmount request field 89

V

viaPayPal response field 75

W

website request field 30, 48, 60

Index

122 May 2012 Invoicing Service API Guide