PayPal Invoicing - 2012 User's Guide

Invoicing Service API GuideLast updated: May 2012

Documentation Feedback 10 May 2012 Invoicing Service API Guide

MarkInvoiceAsPaid API OperationPPFault Message10100 May 2012 Invoicing Service API GuideMarkInvoiceAsPaidResponse FieldsPPFault MessageThe PPFaultMess

Invoicing Service API Guide May 2012 101MarkInvoiceAsPaid API OperationPPFault Message10FaultMessage FieldsErrorData FieldsField Descriptionerror comm

MarkInvoiceAsPaid API OperationMarkInvoiceAsPaid API Errors10102 May 2012 Invoicing Service API GuideResponseEnvelope FieldsMarkInvoiceAsPaid API Erro

Invoicing Service API Guide May 2012 103MarkInvoiceAsPaid API OperationMarkInvoiceAsPaid API Errors10520005 Authentication failed. API credentials are

MarkInvoiceAsPaid API OperationMarkInvoiceAsPaid API Errors10104 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 10511MarkInvoiceAsUnpaid API OperationUse the MarkInvoiceAsUnpaid API operation to mark an invoice as unpaid. Mar

MarkInvoiceAsUnpaid API OperationMarkInvoiceAsUnpaidResponse Message11106 May 2012 Invoicing Service API GuideMarkInvoiceAsUnpaidRequest FieldsMarkInv

Invoicing Service API Guide May 2012 107MarkInvoiceAsUnpaid API OperationMarkInvoiceAsUnpaidResponse Message11MarkInvoiceAsUnpaidResponse Fieldstimest

MarkInvoiceAsUnpaid API OperationPPFault Message11108 May 2012 Invoicing Service API GuidePPFault MessageThe PPFaultMessage returns ErrorData and the

Invoicing Service API Guide May 2012 109MarkInvoiceAsUnpaid API OperationPPFault Message11ErrorData FieldsResponseEnvelope FieldsField Descriptioncate

Invoicing Service API Guide May 2012 111Introduction to the Invoicing Service APIPayPal enables you to create and manage invoices. When you send an in

MarkInvoiceAsUnpaid API OperationMarkInvoiceAsUnpaid API Errors11110 May 2012 Invoicing Service API GuideMarkInvoiceAsUnpaid API ErrorscorrelationId x

Invoicing Service API Guide May 2012 11112MarkInvoiceAsRefunded API OperationUse the MarkInvoiceAsRefunded API operation to mark an invoice as refunde

MarkInvoiceAsRefunded API OperationMarkInvoiceAsRefundedResponse Message12112 May 2012 Invoicing Service API GuideOtherRefundDetailsType FieldsMarkInv

Invoicing Service API Guide May 2012 113MarkInvoiceAsRefunded API OperationMarkInvoiceAsRefundedResponse Message12MarkInvoiceAsRefundedResponse Fields

MarkInvoiceAsRefunded API OperationPPFault Message12114 May 2012 Invoicing Service API GuidePPFault MessageThe PPFaultMessage returns ErrorData and th

Invoicing Service API Guide May 2012 115MarkInvoiceAsRefunded API OperationPPFault Message12ErrorData FieldsResponseEnvelope FieldsField Descriptionca

MarkInvoiceAsRefunded API OperationMarkInvoiceAsRefunded API Errors12116 May 2012 Invoicing Service API GuideMarkInvoiceAsRefunded API Errorscorrelati

Invoicing Service API Guide May 2012 117 Revision HistoryThe revision history identifies changes to the PayPal Invoicing Service documentation at a hi

118 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 119IndexAack response field 32, 35, 38, 41, 50, 53, 62, 64, 71, 78, 83, 85, 91, 95, 99, 102, 106, 109, 112, 115ad

Introduction to the Invoicing Service API112 May 2012 Invoicing Service API Guide5. If the SendInvoice request was successful, PayPal sends an invoice

Index120 May 2012 Invoicing Service API GuideIinvoice request field 58invoice response field 72, 92invoiceDate request field 28, 46, 59, 90invoiceDate

Invoicing Service API Guide May 2012 121IndexresponseEnvelope PPFault field 34, 40, 52, 63, 77, 84, 94, 101, 108, 114responseEnvelope response field 3

Index122 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 13Introduction to the Invoicing Service APISending Invoices on Behalf of a Merchant1Sending Invoices on Behalf of

Introduction to the Invoicing Service APIIPN Variables for Invoicing API Operations114 May 2012 Invoicing Service API GuideIPN Variables for Invoicing

Invoicing Service API Guide May 2012 15Introduction to the Invoicing Service APIIPN Variables for Invoicing API Operations1receiver_email: jbui-us-bus

Introduction to the Invoicing Service APIIPN Variables for Invoicing API Operations116 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 172Invoicing Service API ExamplesYou can use the Invoicing Service API to create, send, update, cancel, or obtain

Invoicing Service API ExamplesHTTP Headers218 May 2012 Invoicing Service API GuideHTTP Headers for AuthenticationSpecifying JSON, NVP, or XML Data For

Invoicing Service API Guide May 2012 19Invoicing Service API ExamplesHTTP Headers2SOAP MessagesTo use Adaptive Payments with SOAP, include the HTTP he

Invoicing Service API GuideDocument Number: 10128.en_US-201205© 2011-2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal

Invoicing Service API ExamplesCreating an Invoice220 May 2012 Invoicing Service API GuideCreating an InvoiceThis example shows how to create an invoic

Invoicing Service API Guide May 2012 21Invoicing Service API ExamplesCreating and Sending an Invoice2Creating and Sending an InvoiceThis example shows

Invoicing Service API ExamplesObtaining Invoice Details222 May 2012 Invoicing Service API Guide&invoice.payerEmail=jbui-us-business2%40paypal.com

Invoicing Service API Guide May 2012 23Invoicing Service API ExamplesSearching for Invoices2curl -s --insecure -H "X-PAYPAL-SECURITY-USERID: You

Invoicing Service API ExamplesSearching for Invoices224 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 253CreateInvoice API OperationUse the CreateInvoice API operation to create a new invoice. The call includes merc

CreateInvoice API OperationCreateInvoiceRequest Message326 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 27CreateInvoice API OperationCreateInvoiceRequest Message3

CreateInvoice API OperationCreateInvoiceRequest Message328 May 2012 Invoicing Service API GuideRequestEnvelope FieldsCreateInvoiceRequest FieldsInvoic

Invoicing Service API Guide May 2012 29CreateInvoice API OperationCreateInvoiceRequest Message3dueDate xs:dateTime(Optional) Date on which the invoice

Invoicing Service API Guide May 2012 3ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateInvoice API OperationCreateInvoiceRequest Message330 May 2012 Invoicing Service API GuideBusinessInfoType FieldsBaseAddress FieldscustomAmountLa

Invoicing Service API Guide May 2012 31CreateInvoice API OperationCreateInvoiceRequest Message3InvoiceItemListType FieldsInvoiceItemType Fieldsline1 x

CreateInvoice API OperationCreateInvoiceResponse Message332 May 2012 Invoicing Service API GuideCreateInvoiceResponse MessageThe CreateInvoiceResponse

Invoicing Service API Guide May 2012 33CreateInvoice API OperationPPFault Message3CreateInvoiceResponse FieldsPPFault MessageThe PPFaultMessage return

CreateInvoice API OperationPPFault Message334 May 2012 Invoicing Service API GuideFaultMessage FieldsErrorData FieldsField Descriptionerror common:Err

Invoicing Service API Guide May 2012 35CreateInvoice API OperationPPFault Message3ResponseEnvelope Fieldsseverity common:ErrorSeverity The severity of

CreateInvoice API OperationCreateInvoice API Errors336 May 2012 Invoicing Service API GuideCreateInvoice API ErrorsCode Message Additional Information

Invoicing Service API Guide May 2012 374SendInvoice API OperationUse the SendInvoice API operation to send an invoice to a payer, and notify the payer

SendInvoice API OperationSendInvoiceResponse Message438 May 2012 Invoicing Service API GuideSendInvoiceRequest FieldsThe table below lists the fields

Invoicing Service API Guide May 2012 39SendInvoice API OperationSendInvoiceResponse Message4SendInvoiceResponse FieldscorrelationId xs:stringCorrelati

Contents4 May 2012 Invoicing Service API GuideBaseAddress Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SendInvoice API OperationPPFault Message440 May 2012 Invoicing Service API GuidePPFault MessageThe PPFaultMessage returns ErrorData and the ResponseEn

Invoicing Service API Guide May 2012 41SendInvoice API OperationPPFault Message4ErrorData FieldsResponseEnvelope FieldsField Descriptioncategory commo

SendInvoice API OperationSend Invoice API Errors442 May 2012 Invoicing Service API GuideSend Invoice API ErrorscorrelationId xs:stringCorrelation iden

Invoicing Service API Guide May 2012 435CreateAndSendInvoice API OperationUse the CreateAndSendInvoice API operation to create and send an invoice. Cr

CreateAndSendInvoice API OperationCreateAndSendInvoiceRequest Message544 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 45CreateAndSendInvoice API OperationCreateAndSendInvoiceRequest Message5

CreateAndSendInvoice API OperationCreateAndSendInvoiceRequest Message546 May 2012 Invoicing Service API GuideRequestEnvelope FieldsCreateAndSendInvoic

Invoicing Service API Guide May 2012 47CreateAndSendInvoice API OperationCreateAndSendInvoiceRequest Message5dueDate xs:dateTime(Optional) Date on whi

CreateAndSendInvoice API OperationCreateAndSendInvoiceRequest Message548 May 2012 Invoicing Service API GuideBusinessInfoType FieldsBaseAddress Fields

Invoicing Service API Guide May 2012 49CreateAndSendInvoice API OperationCreateAndSendInvoiceRequest Message5InvoiceItemListType FieldsInvoiceItemType

Invoicing Service API Guide May 2012 5ContentsFaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateAndSendInvoice API OperationCreateAndSendInvoiceResponse Message550 May 2012 Invoicing Service API GuideCreateAndSendInvoiceResponse MessageThe

Invoicing Service API Guide May 2012 51CreateAndSendInvoice API OperationPPFault Message5CreateAndSendInvoiceResponse FieldsPPFault MessageThe PPFault

CreateAndSendInvoice API OperationPPFault Message552 May 2012 Invoicing Service API GuideFaultMessage FieldsErrorData FieldsField Descriptionerror com

Invoicing Service API Guide May 2012 53CreateAndSendInvoice API OperationCreateAndSendInvoice API Errors5ResponseEnvelope FieldsCreateAndSendInvoice A

CreateAndSendInvoice API OperationCreateAndSendInvoice API Errors554 May 2012 Invoicing Service API Guide520005 Authentication failed. API credentials

Invoicing Service API Guide May 2012 556UpdateInvoice API OperationUse the UpdateInvoice API operation to update an invoice. UpdateInvoiceRequest Mess

UpdateInvoice API OperationUpdateInvoiceRequest Message656 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 57UpdateInvoice API OperationUpdateInvoiceRequest Message6

UpdateInvoice API OperationUpdateInvoiceRequest Message658 May 2012 Invoicing Service API GuideRequestEnvelope FieldsUpdateInvoiceRequest FieldsInvoic

Invoicing Service API Guide May 2012 59UpdateInvoice API OperationUpdateInvoiceRequest Message6invoiceDate xs:dateTime(Optional) Date on which the inv

Contents6 May 2012 Invoicing Service API GuideGetInvoiceDetails API Errors. . . . . . . . . . . . . . . . . . . . . . . . . .

UpdateInvoice API OperationUpdateInvoiceRequest Message660 May 2012 Invoicing Service API GuideBusinessInfoType FieldsInvoiceItemType FieldsReferrerCo

Invoicing Service API Guide May 2012 61UpdateInvoice API OperationUpdateInvoiceResponse Message6InvoiceItemType FieldsUpdateInvoiceResponse MessageThe

UpdateInvoice API OperationUpdateInvoiceResponse Message662 May 2012 Invoicing Service API GuideResponseEnvelope FieldsUpdateInvoiceResponse FieldsFie

Invoicing Service API Guide May 2012 63UpdateInvoice API OperationPPFault Message6PPFault MessageThe PPFaultMessage returns ErrorData and the Response

UpdateInvoice API OperationPPFault Message664 May 2012 Invoicing Service API GuideErrorData FieldsResponseEnvelope FieldsField Descriptioncategory com

Invoicing Service API Guide May 2012 65UpdateInvoice API OperationUpdateInvoice API Errors6UpdateInvoice API ErrorscorrelationId xs:stringCorrelation

UpdateInvoice API OperationUpdateInvoice API Errors666 May 2012 Invoicing Service API Guide570058 Invalid token.570059 Invoice number is too long.5700

Invoicing Service API Guide May 2012 677GetInvoiceDetails API OperationUse the GetInvoiceDetails API operation to get detailed information about an in

GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message768 May 2012 Invoicing Service API GuideGetInvoiceDetailsRequest FieldsGetInvoiceDetai

Invoicing Service API Guide May 2012 69GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message7

Invoicing Service API Guide May 2012 7ContentsResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message770 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 71GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message7ResponseEnvelope FieldsField Descriptionack co

GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message772 May 2012 Invoicing Service API GuideGetInvoiceDetailsResponse FieldsInvoiceType Fi

Invoicing Service API Guide May 2012 73GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message7itemList inv:InvoiceItemListTypeList of items

GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message774 May 2012 Invoicing Service API GuideInvoiceDetailsType FieldsshippingTaxRate xs:de

Invoicing Service API Guide May 2012 75GetInvoiceDetails API OperationGetInvoiceDetailsResponse Message7PaymentDetailsType FieldsPayPalPaymentDetailsT

GetInvoiceDetails API OperationPPFault Message776 May 2012 Invoicing Service API GuideOtherPaymentDetailsType FieldsPPFault MessageThe PPFaultMessage

Invoicing Service API Guide May 2012 77GetInvoiceDetails API OperationPPFault Message7FaultMessage FieldsErrorData FieldsField Descriptionerror common

GetInvoiceDetails API OperationGetInvoiceDetails API Errors778 May 2012 Invoicing Service API GuideResponseEnvelope FieldsGetInvoiceDetails API Errors

Invoicing Service API Guide May 2012 79GetInvoiceDetails API OperationGetInvoiceDetails API Errors7520005 Authentication failed. API credentials are i

Contents8 May 2012 Invoicing Service API Guide

GetInvoiceDetails API OperationGetInvoiceDetails API Errors780 May 2012 Invoicing Service API Guide

Invoicing Service API Guide May 2012 818CancelInvoice API OperationUse the CancelInvoice API operation to cancel an invoice. CancelInvoiceRequest Mess

CancelInvoice API OperationCancelInvoiceResponse Message882 May 2012 Invoicing Service API GuideCancelInvoiceRequest FieldsCancelInvoiceResponse Messa

Invoicing Service API Guide May 2012 83CancelInvoice API OperationCancelInvoiceResponse Message8ResponseEnvelope FieldsCancelInvoiceResponse FieldsFie

CancelInvoice API OperationPPFault Message884 May 2012 Invoicing Service API GuidePPFault MessageThe PPFaultMessage returns ErrorData and the Response

Invoicing Service API Guide May 2012 85CancelInvoice API OperationPPFault Message8ErrorData FieldsResponseEnvelope FieldsField Descriptioncategory com

CancelInvoice API OperationCancelInvoice API Errors886 May 2012 Invoicing Service API GuideCancelInvoice API ErrorscorrelationId xs:stringCorrelation

Invoicing Service API Guide May 2012 879SearchInvoices API OperationUse the SearchInvoice API operation to search an invoice. SearchInvoicesRequest Me

SearchInvoices API OperationSearchInvoicesRequest Message988 May 2012 Invoicing Service API GuideRequestEnvelope FieldsSearchInvoicesRequest FieldsFie

Invoicing Service API Guide May 2012 89SearchInvoices API OperationSearchInvoicesRequest Message9SearchParametersType Fieldspage xs:integer(Required)

Invoicing Service API Guide May 2012 9 PrefaceYou can use the Invoicing Service API to create, send, and manage invoices using PayPal.Documentation Fe

SearchInvoices API OperationSearchInvoicesResponse Message990 May 2012 Invoicing Service API GuideDateRangeType FieldsSearchInvoicesResponse MessageTh

Invoicing Service API Guide May 2012 91SearchInvoices API OperationSearchInvoicesResponse Message9ResponseEnvelope FieldsField Descriptionack common:A

SearchInvoices API OperationSearchInvoicesResponse Message992 May 2012 Invoicing Service API GuideSearchInvoicesResponse FieldsInvoiceSummaryListType

Invoicing Service API Guide May 2012 93SearchInvoices API OperationSearchInvoicesResponse Message9InvoiceSummaryType FieldsField DescriptioninvoiceID

SearchInvoices API OperationPPFault Message994 May 2012 Invoicing Service API GuidePPFault MessageThe PPFaultMessage returns ErrorData and the Respons

Invoicing Service API Guide May 2012 95SearchInvoices API OperationPPFault Message9ErrorData FieldsResponseEnvelope FieldsField Descriptioncategory co

SearchInvoices API OperationSearchInvoices API Errors996 May 2012 Invoicing Service API GuideSearchInvoices API ErrorscorrelationId xs:stringCorrelati

Invoicing Service API Guide May 2012 9710MarkInvoiceAsPaid API OperationUse the MarkInvoiceAsPaid API operation to mark an invoice as paid. MarkInvoic

MarkInvoiceAsPaid API OperationMarkInvoiceAsPaidRequest Message1098 May 2012 Invoicing Service API GuideMarkInvoiceAsPaidRequest FieldsOtherPaymentDet

Invoicing Service API Guide May 2012 99MarkInvoiceAsPaid API OperationMarkInvoiceAsPaidResponse Message10MarkInvoiceAsPaidResponse MessageThe MarkInvo