Fully update invoice

View as Markdown

API Spec (JSON)

API Spec (YAML)

Compact mode

Compact mode

Copy / Export

Fully updates an invoice, by ID. In the JSON request body, include a complete `invoice` object. This call does not support partial updates.

Notes:
API caller can change/modify recipient only 2 times in 72 hours.

.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite

Path Parameters

Query Parameters

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

detailobject<invoice_detail>Required

The details of the invoice. Includes invoice number, date, payment terms, and audit metadata.

invoice_detail properties

17 properties

referencestring<currency_code>Optional

The reference data. Includes a Purchase Order (PO) number.

Match^[\S\s]*$Length1 <= length <= 120

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

notestring<currency_code>Optional

A note to the invoice recipient. Also appears on the invoice notification email.

Match^[\S\s]*$Length1 <= length <= 4000

terms_and_conditionsstring<currency_code>Optional

The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.

Match^[\S\s]*$Length1 <= length <= 4000

memostring<currency_code>Optional

A private bookkeeping memo for the user.

Match^[\S\s]*$Length1 <= length <= 500

attachmentsobject<file_reference>[]Optional

An array of PayPal IDs for the files that are attached to an invoice.

Items0 <= length <= 32767

tip_presetsobject<tip_preset>[]Optional

Specifies 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.

Items1 <= length <= 3

order_detailsstring<currency_code>Optional

Order details information.

Match^[\S\s]*$Length1 <= length <= 2500

project_detailsstring<currency_code>Optional

Project details information.

Match^[\S\s]*$Length1 <= length <= 2500

service_detailsstring<currency_code>Optional

Service details information.

Match^[\S\s]*$Length1 <= length <= 2500

payment_termsstring<currency_code>Optional

Payment terms information.

Match^[\S\s]*$Length1 <= length <= 2500

return_policystring<currency_code>Optional

Return policy information.

Match^[\S\s]*$Length1 <= length <= 2500

cancellation_policystring<currency_code>Optional

Cancellation policy information.

Match^[\S\s]*$Length1 <= length <= 2500

service_agreementstring<currency_code>Optional

Service agreement information.

Match^[\S\s]*$Length1 <= length <= 2500

invoice_numberstring<currency_code>Optional

The invoice number. If omitted, an auto-incremented number from the last number is used.

Match^[\S\s]*$Length0 <= length <= 25

invoice_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

payment_termobject<invoice_payment_term>Optional

The payment term of the invoice. Payment can be due upon receipt, a specified date, or in a set number of days.

invoice_payment_term properties

3 properties

term_typeenum<payment_term_type>Optional

The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.

Allowed values

"DUE_ON_RECEIPT"
"DUE_ON_DATE_SPECIFIED"
"NET_10"
"NET_15"
"NET_30"
"NET_45"
"NET_60"
"NET_90"
"NO_DUE_DATE"

conditional_rulesobject<payment_term_conditional_rules>Optional

The conditional rules associated with the payment term of the invoice. Includes early payment discount, late payment surcharge, and auto cancellation details.

payment_term_conditional_rules properties

2 properties

early_payment_discountobject<early_payment_discount>Optional

The early payment discount for the invoice. If the payer pays before the discount end date, the specified discount is applied.

auto_cancellationobject<auto_cancellation>Optional

The auto cancellation details for the invoice. If the payer does not pay by the specified date, the invoice is automatically cancelled.

due_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

invoicerobject<invoicer_info>Optional

The invoicer business information that appears on the invoice.

invoicer_info properties

10 properties

business_namestringOptional

Required. The business name of the party.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

Match^.*$Length0 <= length <= 300

address_line_2stringOptional

The second line of the address, for example, a suite or apartment number.

Match^.*$Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Match^.*$Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Match^.*$Length0 <= length <= 100

admin_area_3stringOptional

The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, *bairro*, or neighborhood.
India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

Match^.*$Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Match^.*$Length0 <= length <= 120

admin_area_1stringOptional

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A *kanton*.

Match^.*$Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

address_detailsobject<Address Details>Optional

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is 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`.

email_addressstring<restrictive_email_address>Optional

The internationalized email address with more restrictive rules. This version restricts the local-part to a dot-atom as defined in https://www.ietf.org/rfc/rfc5322.txt. It does not allow for a quoted-string or an obs-local-part.

Allows alphanumeric and RFC-allowed special characters, !#$%&'*+-/=?^_`{|}~
Ensures that the local part does not start with dot (.), have consecutive dots, or end with dot. Ensures that the domain part does not have consecutive dots.
Ensures that the local part does not exceed 64 characters.

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.

Match^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$Length3 <= length <= 254

phonesobject<phone_detail>[]Optional

An array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice.

Items0 <= length <= 32767

websitestringOptional

The invoicer's website.

FormaturiLength0 <= length <= 2048

tax_idstring<currency_code>Optional

The invoicer's tax ID.

Match^[\S\s]*$Length0 <= length <= 100

additional_notesstring<currency_code>Optional

Any additional information. Includes business hours.

Match^[\S\s]*$Length0 <= length <= 400

logo_urlstringOptional

The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.

FormaturiLength0 <= length <= 2000

primary_recipientsobject<recipient_info>[]Optional

The billing and shipping information. Includes name, email, address, phone and language.

Items0 <= length <= 100

additional_recipientsarray<email_address>Optional

An 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.

Items0 <= length <= 100

itemsobject<item>[]Optional

An array of invoice line item information.

Items0 <= length <= 100

item properties

8 properties

namestring<currency_code>Required

The item name for the invoice line item.

Match^[\S\s]*$Length0 <= length <= 200

descriptionstring<currency_code>Optional

The item description for the invoice line item.

Match^[\S\s]*$Length0 <= length <= 1000

quantitystringRequired

The quantity of the item that the invoicer provides to the payer. Value is from `-1000000` to `1000000`. Supports up to five decimal places.

Match^\d+(.\d{1,5})?$Length0 <= length <= 14

unit_amountobject<money>Required

The currency and amount for a financial transaction, such as a balance or payment due.

taxobject<tax>Optional

The tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.

item_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

discountobject<discount>Optional

The discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.

unit_of_measureenum<unit_of_measure>Optional

The unit of measure for the invoiced item.

Allowed values

"QUANTITY"
"HOURS"
"AMOUNT"

configurationobject<configuration>Optional

The invoice configuration details. Includes partial payment, tip, and tax calculated after discount.

configuration properties

11 properties

tax_calculated_after_discountbooleanOptional

Indicates 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.

Defaulttrue

tax_inclusivebooleanOptional

Indicates whether the unit price includes tax.

Defaultfalse

allow_tipbooleanOptional

Indicates 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 in `Hong Kong`, `Taiwan`, `India`, or `Japan`.

Defaultfalse

partial_paymentobject<partial_payment>Optional

The partial payment details. Includes the minimum amount that the invoicer expects from the payer.

has_conditional_rulebooleanOptional

Indicates 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.

Defaultfalse

save_item_for_futurebooleanOptional

Indicates whether the item should be saved for future invoices.

Defaulttrue

show_additional_item_fieldsbooleanOptional

Indicates whether items tray should be shown for invoices or not. If `true`, additional fields containing items tray will be shown. If `false`, the items tray will be hidden.

Defaultfalse

discount_mode_preferenceenum<discount_mode_preference>Optional

Represents the user's preferred mode for creating discounts. Determines whether "One-time discount" or "Save for future invoices" is preselected when creating a new discount.

Allowed values

"ONE_TIME"
"SAVE_FOR_FUTURE"

themeobject<configurable_theme>Optional

The theme configuration that defines the visual appearance of the invoice buyer experience and email. Pass an empty object to use the default theme.

template_idstring<currency_code>Optional

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.

Default"PayPal system template"Match^[\S\s]*$Length0 <= length <= 30

payment_method_overridesobject<override_payment_method_detail>[]Optional

The payment method override configurations for the invoice. Defines which payment methods are enabled and any rules that control payment behavior. When provided during invoice creation or update, this array replaces any existing payment method override configuration for the invoice.

Note: Payment method availability depends on the merchant's country, the buyer's country, and the invoice amount. Override configurations only take effect if the specified payment method is available for the invoice.

Items1 <= length <= 15

override_payment_method_detail properties

3 properties

payment_method_typeenum<override_payment_method_type>Optional

The payment method types that can be configured in the payment method overrides object for invoice payments.

Note: To use PAY_BY_BANK, you must first complete the onboarding process. Visit the onboarding page to get started. Once onboarding is complete, you can configure PAY_BY_BANK as a payment method.

Allowed values

"PAY_BY_BANK"
"ACH"

enabledbooleanOptional

Indicates whether the specified payment method is enabled for the invoice. When set to `true`, the payment method is available for the buyer to use. When set to `false`, the payment method is disabled.

rulesobject<override_payment_method_rule>[]Optional

The list of payment method override rules applied to the invoice via payment method overrides object. Each rule defines a specific restriction or behavior for the payment method, such as making it the exclusive payment option when the invoice total exceeds a system-defined threshold.

Items1 <= length <= 10

amountobject<amount_summary_detail>Optional

The invoice amount summary of item total, discount, tax total, and shipping.

settingsobject<invoice_settings>Optional

The settings for the invoice.

paymentsobject<payments>Optional

An array of payments registered against the invoice.

effective_invoice_totalobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

effective_due_amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

refundsobject<refunds>Optional

The invoicing refund details. Includes the refund type, date, amount, and method.

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

curl -X PUT "https://example.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "id": "INV2-C82X-JNN9-Y6S5-CNXW",    "status": "DRAFT",    "detail": {      "invoice_number": "#123",      "reference": "deal-refernce-update",      "invoice_date": "2018-11-12",      "currency_code": "USD",      "note": "Thank you for your business.",      "term": "No refunds after 30 days.",      "memo": "This is a long contract",      "payment_term": {        "term_type": "NET_10",        "due_date": "2018-11-22"      },      "order_details": "Updated order #12345 details from Jan 15, 2023.",      "project_details": "Updated website redesign project for XYZ Corp - added mobile optimization.",      "service_details": "Additional consulting services Jan-Apr 2023.",      "cancellation_policy": "Updated: Services may be cancelled with 30-day notice.",      "payment_terms": "Updated: Payment due within 15 days of invoice date.",      "return_policy": "Updated: All sales are final. No returns accepted after 15 days.",      "service_agreement": "Updated: Services provided as per revised agreement dated Feb 1, 2023.",      "tip_presets": [        {          "percent": "15"        },        {          "percent": "20"        },        {          "percent": "25"        }      ]    },    "invoicer": {      "name": {        "given_name": "David",        "surname": "Larusso"      },      "address": {        "address_line_1": "1234 First Street",        "address_line_2": "337673 Hillside Court",        "admin_area_2": "Anytown",        "admin_area_1": "CA",        "postal_code": "98765",        "country_code": "US"      },      "email_address": "merchant@example.com",      "phones": [        {          "country_code": "001",          "national_number": "4085551234",          "phone_type": "MOBILE"        }      ],      "website": "www.test.com",      "tax_id": "ABcNkWSfb5ICTt73nD3QON1fnnpgNKBy-Jb5SeuGj185MNNw6g",      "logo_url": "https://example.com/logo.PNG",      "additional_notes": "2-4"    },    "primary_recipients": [      {        "billing_info": {          "name": {            "given_name": "Stephanie",            "surname": "Meyers"          },          "address": {            "address_line_1": "1234 Main Street",            "admin_area_2": "Anytown",            "admin_area_1": "CA",            "postal_code": "98765",            "country_code": "US"          },          "email_address": "bill-me@example.com",          "phones": [            {              "country_code": "001",              "national_number": "4884551234",              "phone_type": "HOME"            }          ],          "additional_info_value": "add-info"        },        "shipping_info": {          "name": {            "given_name": "Stephanie",            "surname": "Meyers"          },          "address": {            "address_line_1": "1234 Main Street",            "admin_area_2": "Anytown",            "admin_area_1": "CA",            "postal_code": "98765",            "country_code": "US"          }        }      }    ],    "items": [      {        "name": "Yoga Mat",        "description": "Elastic mat to practice yoga.",        "quantity": "1",        "unit_amount": {          "currency_code": "USD",          "value": "50.00"        },        "tax": {          "name": "Sales Tax",          "percent": "7.25",          "tax_note": "Reduced tax rate",          "amount": {            "currency_code": "USD",            "value": "3.27"          }        },        "discount": {          "percent": "5",          "amount": {            "currency_code": "USD",            "value": "2.5"          }        },        "unit_of_measure": "QUANTITY"      },      {        "name": "Yoga t-shirt",        "quantity": "1",        "unit_amount": {          "currency_code": "USD",          "value": "10.00"        },        "tax": {          "name": "Sales Tax",          "percent": "7.25",          "amount": {            "currency_code": "USD",            "value": "0.34"          }        },        "discount": {          "amount": {            "currency_code": "USD",            "value": "5.00"          }        },        "unit_of_measure": "QUANTITY"      }    ],    "configuration": {      "partial_payment": {        "allow_partial_payment": true,        "minimum_amount_due": {          "currency_code": "USD",          "value": "20.00"        }      },      "allow_tip": true,      "tax_calculated_after_discount": true,      "tax_inclusive": false,      "show_additional_item_fields": true,      "template_id": "TEMP-19V05281TU309413B"    },    "amount": {      "currency_code": "USD",      "value": "74.21",      "breakdown": {        "item_total": {          "currency_code": "USD",          "value": "60.00"        },        "custom": {          "label": "Packing Charges",          "amount": {            "currency_code": "USD",            "value": "10.00"          }        },        "shipping": {          "amount": {            "currency_code": "USD",            "value": "10.00"          },          "tax": {            "name": "Sales Tax",            "percent": "7.25",            "amount": {              "currency_code": "USD",              "value": "0.73"            }          }        },        "discount": {          "item_discount": {            "currency_code": "USD",            "value": "-7.50"          },          "invoice_discount": {            "percent": "5",            "amount": {              "currency_code": "USD",              "value": "-2.63"            }          }        },        "tax_total": {          "currency_code": "USD",          "value": "4.34"        }      }    },    "settings": {      "invoice_item_settings": [        {          "field_name": "ITEM_DESCRIPTION",          "display_preference": {            "hidden": false          }        },        {          "field_name": "ITEM_DATE",          "display_preference": {            "hidden": true          }        },        {          "field_name": "ITEM_TAX",          "display_preference": {            "hidden": false          }        },        {          "field_name": "ITEM_DISCOUNT",          "display_preference": {            "hidden": true          }        }      ],      "invoice_additional_settings": [        {          "field_name": "ATTACHMENT",          "display_preference": {            "hidden": false          }        },        {          "field_name": "MEMO",          "display_preference": {            "hidden": false          }        },        {          "field_name": "REFERENCE",          "display_preference": {            "hidden": true          }        }      ],      "invoice_policy_and_agreement_settings": [        {          "field_name": "TERMS_AND_CONDITIONS",          "display_preference": {            "hidden": false          }        },        {          "field_name": "PAYMENT_TERMS",          "display_preference": {            "hidden": false          }        },        {          "field_name": "CANCELLATION_POLICY",          "display_preference": {            "hidden": false          }        }      ],      "invoice_details_settings": [        {          "field_name": "SERVICE_DETAILS",          "display_preference": {            "hidden": false          }        }      ]    }  }'

{  "id": "INV2-C82X-JNN9-Y6S5-CNXW",  "status": "DRAFT",  "detail": {    "invoice_number": "#123",    "reference": "deal-refernce-update",    "invoice_date": "2018-11-12",    "currency_code": "USD",    "note": "Thank you for your business.",    "term": "No refunds after 30 days.",    "memo": "This is a long contract",    "payment_term": {      "term_type": "NET_10",      "due_date": "2018-11-22"    },    "order_details": "Updated order #12345 details from Jan 15, 2023.",    "project_details": "Updated website redesign project for XYZ Corp - added mobile optimization.",    "service_details": "Additional consulting services Jan-Apr 2023.",    "cancellation_policy": "Updated: Services may be cancelled with 30-day notice.",    "payment_terms": "Updated: Payment due within 15 days of invoice date.",    "return_policy": "Updated: All sales are final. No returns accepted after 15 days.",    "service_agreement": "Updated: Services provided as per revised agreement dated Feb 1, 2023.",    "tip_presets": [      {        "percent": "15"      },      {        "percent": "20"      },      {        "percent": "25"      }    ],    "metadata": {      "create_time": "2018-11-12T08:00:20Z",      "recipient_view_url": "https://www.api-m.paypal.com/invoice/p#Z56S5LLAQ52LCPZ5",      "invoicer_view_url": "https://www.api-m.paypal.com/invoice/details/INV2-Z56S-5LLA-Q52L-CPZ5"    }  },  "invoicer": {    "name": {      "given_name": "David",      "surname": "Larusso"    },    "address": {      "address_line_1": "1234 First Street",      "address_line_2": "337673 Hillside Court",      "admin_area_2": "Anytown",      "admin_area_1": "CA",      "postal_code": "98765",      "country_code": "US"    },    "email_address": "merchant@example.com",    "phones": [      {        "country_code": "001",        "national_number": "4085551234",        "phone_type": "MOBILE"      }    ],    "website": "https://example.com",    "tax_id": "ABcNkWSfb5ICTt73nD3QON1fnnpgNKBy-Jb5SeuGj185MNNw6g",    "logo_url": "https://example.com/logo.PNG",    "additional_notes": "2-4"  },  "primary_recipients": [    {      "billing_info": {        "name": {          "given_name": "Stephanie",          "surname": "Meyers"        },        "address": {          "address_line_1": "1234 Main Street",          "admin_area_2": "Anytown",          "admin_area_1": "CA",          "postal_code": "98765",          "country_code": "US"        },        "email_address": "bill-me@example.com",        "phones": [          {            "country_code": "001",            "national_number": "4884551234",            "phone_type": "HOME"          }        ],        "additional_info_value": "add-info"      },      "shipping_info": {        "name": {          "given_name": "Stephanie",          "surname": "Meyers"        },        "address": {          "address_line_1": "1234 Main Street",          "admin_area_2": "Anytown",          "admin_area_1": "CA",          "postal_code": "98765",          "country_code": "US"        }      }    }  ],  "items": [    {      "name": "Yoga Mat",      "description": "Elastic mat to practice yoga.",      "quantity": "1",      "unit_amount": {        "currency_code": "USD",        "value": "50.00"      },      "tax": {        "name": "Sales Tax",        "percent": "7.25",        "amount": {          "currency_code": "USD",          "value": "3.27"        }      },      "discount": {        "percent": "5",        "amount": {          "currency_code": "USD",          "value": "2.5"        }      },      "unit_of_measure": "QUANTITY"    },    {      "name": "Yoga t-shirt",      "quantity": "1",      "unit_amount": {        "currency_code": "USD",        "value": "10.00"      },      "tax": {        "name": "Sales Tax",        "percent": "7.25",        "amount": {          "currency_code": "USD",          "value": "0.34"        }      },      "discount": {        "amount": {          "currency_code": "USD",          "value": "5.00"        }      },      "unit_of_measure": "QUANTITY"    }  ],  "configuration": {    "partial_payment": {      "allow_partial_payment": true,      "minimum_amount_due": {        "currency_code": "USD",        "value": "20.00"      }    },    "allow_tip": true,    "allow_only_pay_by_bank": true,    "tax_calculated_after_discount": true,    "show_additional_item_fields": true,    "tax_inclusive": false,    "template_id": "TEMP-19V05281TU309413B"  },  "amount": {    "currency_code": "USD",    "value": "74.21",    "breakdown": {      "item_total": {        "currency_code": "USD",        "value": "60.00"      },      "custom": {        "label": "Packing Charges",        "amount": {          "currency_code": "USD",          "value": "10.00"        }      },      "shipping": {        "amount": {          "currency_code": "USD",          "value": "10.00"        },        "tax": {          "name": "Sales Tax",          "percent": "7.25",          "amount": {            "currency_code": "USD",            "value": "0.73"          }        }      },      "discount": {        "item_discount": {          "currency_code": "USD",          "value": "-7.50"        },        "invoice_discount": {          "percent": "5",          "amount": {            "currency_code": "USD",            "value": "-2.63"          }        }      },      "tax_total": {        "currency_code": "USD",        "value": "4.34"      }    }  },  "due_amount": {    "currency_code": "USD",    "value": "74.21"  },  "settings": {    "invoice_item_settings": [      {        "field_name": "ITEM_DESCRIPTION",        "display_preference": {          "hidden": false        }      },      {        "field_name": "ITEM_DATE",        "display_preference": {          "hidden": true        }      },      {        "field_name": "ITEM_TAX",        "display_preference": {          "hidden": false        }      },      {        "field_name": "ITEM_DISCOUNT",        "display_preference": {          "hidden": false        }      }    ]  },  "links": [    {      "href": "https://api-m.paypal.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5",      "rel": "self",      "method": "GET"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/send",      "rel": "send",      "method": "POST"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/update",      "rel": "replace",      "method": "PUT"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5",      "rel": "delete",      "method": "DELETE"    }  ]}

On this page

On this page

Authorization Path Parameters invoice_id Query Parameters send_to_recipient send_to_invoicer Header Parameters Authorization Request Body detail reference currency_code note terms_and_conditions memo attachments tip_presets order_details project_details service_details payment_terms return_policy cancellation_policy service_agreement invoice_number invoice_date payment_term invoicer business_name orthography name address email_address phones website tax_id additional_notes logo_url primary_recipients billing_info shipping_info additional_recipients items name description quantity unit_amount tax item_date discount unit_of_measure configuration tax_calculated_after_discount tax_inclusive allow_tip partial_payment has_conditional_rule save_item_for_future show_additional_item_fields discount_mode_preference theme template_id payment_method_overrides amount currency_code value breakdown settings invoice_item_settings invoice_additional_settings invoice_policy_and_agreement_settings invoice_details_settings payments effective_invoice_total currency_code value effective_due_amount currency_code value refunds Response Body