On this page
No Headings
Additional business and descriptive details that can be associated with invoices, templates, and other resources.
objectreferencestring^[\S\s]*$The reference data. Includes a Purchase Order (PO) number.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
notestring^[\S\s]*$A note to the invoice recipient. Also appears on the invoice notification email.
terms_and_conditionsstring^[\S\s]*$The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
memostring^[\S\s]*$A private bookkeeping memo for the user.
attachmentsarrayAn array of PayPal IDs for the files that are attached to an invoice.
itemsobjectThe file reference. Can be a file in PayPal MediaServ, PayPal DMS, or another custom store.
idstring^.*$The ID of the referenced file.
reference_urlstringuriThe reference URL for the file.
content_typestring^.*$create_timeobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time when the file was created, in Internet date and time format.
sizestring^[0-9]+$The size of the file, in bytes.
tip_presetsarraySpecifies the predefined tip options configured by the invoicer. These preset values are shown to customers at checkout as suggested tipping amounts, in addition to the option to enter a custom tip.
itemsobjectDefines a tip option that can be presented to the customer as a percentage of the invoice total. Note: This preset represents a tip configuration where the percentage value is applied during checkout to calculate the tip amount.
percentstring^(([0-9]+)|(([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.The tip percentage ranges from 0.00001 to 100.00000 inclusive and supports up to five decimal places.
order_detailsstring^[\S\s]*$Order details information.
project_detailsstring^[\S\s]*$Project details information.
service_detailsstring^[\S\s]*$Service details information.
payment_termsstring^[\S\s]*$Payment terms information.
return_policystring^[\S\s]*$Return policy information.
cancellation_policystring^[\S\s]*$Cancellation policy information.
service_agreementstring^[\S\s]*$Service agreement information.