On this page
No Headings
The invoice details which includes all information of the invoice like items, billing information.
objectidstring^[\s\S]*$The ID of the invoice.
parent_idstring^[\s\S]*$The parent ID to an invoice that defines the group invoice to which the invoice is related.
statusstring"DRAFT", "SENT", "SCHEDULED", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING", "AUTO_CANCELLED", "PAID_EXTERNAL", "REFUNDED_EXTERNAL", "SHARED"^[\s\S]*$The status of the invoice.
detailrequiredobjectThe details of the invoice. Includes the invoice number, date, payment terms, and audit metadata.
referencestring^[\S\s]*$The reference data. Includes a Purchase Order (PO) number.
currency_coderequiredstringThe three-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 other custom store.
idstringThe ID of the referenced file.
reference_urlstringuriThe reference URL for the file.
create_timestringppaas_date_time_v3^[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 when the file was created, in Internet date and time format.
sizestring^[0-9]+$The size of the file, in bytes.
invoice_numberstringThe invoice number. Default is the number that is auto-incremented number from the last number.
invoice_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The invoice date as specificed by the sender, in Internet date and time format. Only UTC is supported in response. For example, yyyy-MM-ddTz.
payment_termobjectThe payment due date for the invoice. Value is either but not both term_type or due_date.
term_typestring"DUE_ON_RECEIPT", "DUE_ON_DATE_SPECIFIED", "NET_10", "NET_15", "NET_30", "NET_45", "NET_60", "NET_90", "NO_DUE_DATE"^[\S\s]*$The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
due_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the invoice payment is due, in Internet date and time format. For example, yyyy-MM-ddTz.
metadataobjectThe audit metadata. Captures all invoicing actions on create, send, update, and cancel.
create_timestringppaas_date_time_v3^[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 when the resource was created, in Internet date and time format.
created_bystring^[\S\s]*$The email address of the account that created the resource.
last_update_timestringppaas_date_time_v3^[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 when the resource was last edited, in Internet date and time format.
last_updated_bystring^[\S\s]*$The email address of the account that last edited the resource.
cancel_timestringppaas_date_time_v3^[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 when the resource was canceled, in Internet date and time format.
cancelled_bystringThe actor who canceled the resource.
first_sent_timestringppaas_date_time_v3^[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 when the resource was first sent, in Internet date and time format.
last_sent_timestringppaas_date_time_v3^[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 when the resource was last sent, in Internet date and time format.
last_sent_bystringThe email address of the account that last sent the resource.
created_by_flowstring"MULTIPLE_RECIPIENTS_GROUP", "BATCH", "REGULAR_SINGLE"^[\s\S]*$The flow variation that created this invoice.
recipient_view_urlstringuriThe URL for the invoice payer view hosted on paypal.com.
invoicer_view_urlstringuriThe URL for the invoice merchant view hosted on paypal.com.
invoicerobjectThe invoicer information. Includes the business name, email, address, phone, fax, tax ID, additional notes, and logo URL.
email_addressstring^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$The invoicer email address, which must be listed in the user's PayPal profile. If you omit this value, notifications are sent from and to the primary email address but do not appear on the invoice.
phonesarrayAn array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice.
itemsobjectThe phone details. Includes the phone number and type.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
websitestringuriThe invoicer's website.
tax_idstringThe invoicer's tax ID.
additional_notesstringAny additional information. Includes business hours.
logo_urlstringuriThe full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
primary_recipientsarrayThe billing and shipping information. Includes name, email, address, phone and language.
itemsobjectThe billing and shipping information. Includes name, email, address, phone, and language.
billing_infoobjectThe billing information for the invoice recipient. Includes name, address, email, phone, and language.
email_addressstring^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$The invoice recipient email address. If you omit this value, the invoice is payable and a notification email is not sent.
phonesarrayThe invoice recipient's phone numbers. Extension number is not supported.
itemsobjectThe phone details. Includes the phone number and type.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
additional_infostringAny additional information about the recipient.
languagestringppaas_common_language_v3^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$The language in which to show the invoice recipient's email message. Used only when the recipient does not have a PayPal account. If you omit the language and the recipient does not have a PayPal account, the email message is sent in the language of the merchant's PayPal account.
shipping_infoobjectThe recipient's shipping information. Includes the user's contact information, which includes name and address.
business_namestringRequired. The business name of the party.
nameobjectThe first and Last name of the recipient.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
addressobjectThe address of the recipient.
address_line_1stringThe first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
address_line_2stringThe second line of the address. For example, suite or apartment number.
address_line_3stringThe third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4stringThe neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3stringA sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
admin_area_2stringA city, town, or village. Smaller than admin_area_level_1.
admin_area_1stringThe highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobjectThe non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
street_numberstringThe street number.
street_namestringThe street name. Just Drury in Drury Lane.
street_typestringThe street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestringThe delivery service. Post office box, bag number, or post office name.
building_namestringA named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstringThe first-order entity below a named building or location that represents the sub-premises. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
additional_recipientsarrayAn array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.
Note: Valid values are email addresses in the additional_recipients value associated with the invoice.itemsstringppaas_common_email_address_v2^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
itemsarrayAn array of invoice line item information.
itemsobjectAn array of invoice line item information. The maximum items for an invoice is 100.
idstring^[\S\s]*$The ID of the invoice line item.
namerequiredstring^[\S\s]*$The item name for the invoice line item.
descriptionstring^[\S\s]*$The item description for the invoice line item.
quantityrequiredstring\d+(.\d{1,5})?$The quantity of the item that the invoicer provides to the payer. Value is from -1000000 to 1000000. Supports up to five decimal places.
unit_amountrequiredobjectThe unit price of the item. This does not include tax and discount. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax associated with the item. The tax amount is added to the item total. Value is from 0 to 100. Supports up to five decimal places.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
item_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the item or service was provided, in Internet date and time format. For example, yyyy-MM-ddTz.
discountobjectDiscount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.unit_of_measurestring"QUANTITY", "HOURS", "AMOUNT"^[\S\s]*$The unit of measure for the invoiced item. For AMOUNT the unit_amount and quantity are not shown on the invoice.
Note: If your specify different unit_of_measure values for the same invoice, the invoice uses the first value.configurationobjectThe invoice configuration details. Includes partial payment, tip, and tax calculated after discount.
tax_calculated_after_discountbooleantrueIndicates whether the tax is calculated before or after a discount. If false, the tax is calculated before a discount. If true, the tax is calculated after a discount.
tax_inclusivebooleanfalseIndicates whether the unit price includes tax.
allow_tipbooleanfalseIndicates whether the invoice enables the customer to enter a tip amount during payment. If true, the invoice shows a tip amount field so that the customer can enter a tip amount. If false, the invoice does not show a tip amount field.
Note: This feature is not available for users inHong Kong,Taiwan,India, orJapan.
partial_paymentobjectThe partial payment details. Includes the minimum amount that the invoicer wants the payer to pay.
allow_partial_paymentbooleanfalseIndicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
Note: This feature is not available for users inIndia,Brazil, orIsrael.
minimum_amount_dueobjectThe minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.has_conditional_rulebooleanfalseIndicates whether conditional pricing rules are applied to the invoice. If true, pricing rules (such as discounts or surcharges based on specific conditions) are applied. If false, no conditional pricing rules are applied.
template_idstring"PayPal system template"The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.
Note: This is an optional field. If you wish to customize the invoice layout using a specific template, provide a valid template ID here. You can either use an existing template ID or create a new template via the create template API and then use the newly created template's ID.
amountobjectThe invoice amount summary of item total, discount, tax total and shipping..
currency_codestringThe three-character ISO-4217 currency code that identifies the currency.
valuestring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.breakdownobjectThe breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, custom amount, shipping and discounts, if any.
item_totalobjectThe subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.discountobjectThe discount can be at the item or invoice level, or both. Can be applied as a percent or amount. If you provide both amount and percent, amount takes precedent.
invoice_discountobjectThe discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.item_discountobjectThe discount as a percent or amount at item level. The item discount amount is subtracted from each item amount.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_totalobjectThe aggregated amount of the item and shipping taxes.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shippingobjectThe shipping fee for all items. Includes tax on shipping.
amountobjectThe shipping amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax associated with the shipping.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
customobjectThe custom amount to apply to an invoice. If you include a label, you must include the custom amount.
labelrequiredstring^[\S\s]*$The label to the custom amount of the invoice.
amountobjectThe custom amount value. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.due_amountobjectThe due amount, which is the balance amount outstanding after payments.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.gratuityobjectThe amount paid by the payer as gratuity to the invoicer.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.paymentsobjectList of payments registered against the invoice..
paid_amountobjectThe aggregated payment amounts against this invoice.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.transactionsarrayAn array of payment details for the invoice. The payment details of the invoice like payment type, method, date, discount and transaction type.
itemsobjectThe payment details of the invoice. Includes payment type, method, date, discount, and transaction type.
typestring"PAYPAL", "EXTERNAL"^[\S\s]*$The payment type in an invoicing flow which can be PayPal or an external cash or check payment.
payment_idstring^[\S\s]*$The ID for a PayPal payment transaction. Required for the PAYPAL payment type.
payment_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the invoice was paid, in Internet date and time format. For example, yyyy-MM-dd z.
payment_date_timestringppaas_date_time_v3^[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-time when the invoice was paid. For example, yyyy-MM-dd T HH: mm: ss z. The time zone will be UTC.
methodrequiredstring"BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"^[\S\s]*$The payment mode or method through which the invoicer can accept the payment.
notestring^[\S\s]*$A note associated with an external cash or check payment.
amountobjectThe payment amount to record against the invoice. If you omit this parameter, the total invoice amount is marked as paid. This amount cannot exceed the amount due.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_infoobjectThe recipient's shipping information. Includes the user's contact information, which includes name and address.
business_namestringRequired. The business name of the party.
nameobjectThe first and Last name of the recipient.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
addressobjectThe address of the recipient.
address_line_1stringThe first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
address_line_2stringThe second line of the address. For example, suite or apartment number.
address_line_3stringThe third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4stringThe neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3stringA sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
admin_area_2stringA city, town, or village. Smaller than admin_area_level_1.
admin_area_1stringThe highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobjectThe non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
street_numberstringThe street number.
street_namestringThe street name. Just Drury in Drury Lane.
street_typestringThe street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestringThe delivery service. Post office box, bag number, or post office name.
building_namestringA named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstringThe first-order entity below a named building or location that represents the sub-premises. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
refundsobjectList of refunds against this invoice. The invoicing refund details includes refund type, date, amount, and method.
refund_amountobjectThe aggregated refund amounts.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.transactionsarrayAn array of refund details for the invoice. Includes the refund type, date, amount, and method.
itemsobjectThe refund details of the invoice. Includes the refund type, date, amount, and method.
typestring"PAYPAL", "EXTERNAL"^[\S\s]*$The PayPal refund type. Indicates whether the refund was paid through PayPal or externally in the invoicing flow. The record refund method supports the EXTERNAL refund type. The PAYPAL refund type is supported for backward compatibility.
refund_idstring^[\S\s]*$The ID for a PayPal payment transaction. Required for the PAYPAL payment type.
refund_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the invoice was refunded, in Internet date format. For example, 2014-02-27.
amountobjectThe amount to record as refunded. If you omit the amount, the total invoice paid amount is recorded as refunded.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.methodrequiredstring"BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"^[\S\s]*$The payment mode or method through which the invoicer can accept the payments.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.