invoice

The ID of the referenced file.

The reference URL for the file.

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The size of the file, in bytes.

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.

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

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.

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The email address of the account that created the resource.

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The email address of the account that last edited the resource.

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The actor who canceled the resource.

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). 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, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The email address of the account that last sent the resource.

The frequency at which the invoice is sent:

• Multiple recipient. Sent to multiple recipients.
• Batch. Sent in a batch.
• Regular single. Sent one time to a single recipient.

The URL for the invoice payer view hosted on paypal.com.

The URL for the invoice merchant view hosted on paypal.com.

The prefix, or title, to the party's name.

When the party is a person, the party's given, or first, name.

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

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

The suffix for the party's name.

When the party is a person, the party's full name.

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

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.

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

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.

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.

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.

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

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

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

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.

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

The extension number.

The phone type.

Required. The business name of the party.

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

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.

Any additional information about the recipient.

The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Required. The business name of the party.

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

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

The value, which might be:

• An integer for currencies like `JPY` that are not typically fractional.
• A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

The name of the tax applied on the invoice items.

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

The tax note used to track the tax related data.

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Indicates 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 in `India`, `Brazil`, or `Israel`.

The primary color chosen by the merchant for branding the invoice buyer experience and email. Accepts a hex color code in #RGB or #RRGGBB format.

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.

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.

The field name for the invoice item.

The field names for additional sections in the invoice.

The field names for the policy and agreement details in the invoice.

The field names for the invoice details.

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

The value, which might be:

• An integer for currencies like `JPY` that are not typically fractional.
• A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

The payment type. Can be PayPal or an external payment. Includes cash or a check.

The ID for a PayPal payment transaction. Required for the `PAYPAL` payment type.

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.

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

The payment mode or method through which the invoicer can accept the payments.

A note associated with an external cash or check payment.