On this page
No Headings
An array of merchant-created templates with associated details that include the emails, addresses, and phone numbers from the user's PayPal profile.
objectaddressesarrayAn array of addresses in the user's PayPal profile.
itemsobjectThe portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1string^.*$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.
address_line_2string^.*$The second line of the address, for example, a suite or apartment number.
address_line_3string^.*$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.
admin_area_4string^.*$The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3string^.*$The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:
admin_area_2string^.*$A city, town, or village. Smaller than admin_area_level_1.
admin_area_1string^.*$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:
postal_codestring^.*$The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstring^([A-Z]{2}|C2)$The 2-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 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.
street_numberstring^.*$The street number.
street_namestring^.*$The street name. Just Drury in Drury Lane.
street_typestring^.*$The street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestring^.*$The delivery service. Post office box, bag number, or post office name.
building_namestring^.*$A 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_buildingstring^.*$The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
emailsobject^(?:[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.
An array of emails in the user's PayPal profile.
phonesarrayAn array of phone numbers in the user's PayPal profile.
itemsobjectThe phone details. Includes the phone number and type.
templatesarrayAn array of details for each template. If fields is none, returns only the template name, ID, and default status.
itemsobjectThe template with invoice details to load with all captured fields.
idstring^[\S\s]*$The ID of the template.
namestring^[\S\s]*$The template name.
Note: The template name must be unique.
descriptionstring^[\S\s]*$The detailed description of the template.
default_templatebooleanIndicates whether this template is the default template. A invoicer can have one default template.
template_infoobjectThe template details. Includes invoicer business information, invoice recipients, items, and configuration.
detailobjectThe template-related details. Includes notes, terms and conditions, memo, and attachments.
payment_termobjectThe payment term of the invoice. Payment can be due upon receipt, a specified date, or in a set number of days.
The 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"The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
conditional_rulesobjectThe conditional rules associated with the payment term of the invoice. Includes early payment discount, late payment surcharge, and auto cancellation details.
early_payment_discountobjectThe early payment discount for the invoice. If the payer pays before the discount end date, the specified discount is applied.
discount_end_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. 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 end date for the early payment discount, in Internet date and time format. For example, yyyy-MM-ddTz.
percentobject^((-?[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 early payment discount percentage value.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The early payment discount amount value.
currency_coderequiredstring^[\S\s]*$The 3-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.is_appliedbooleanIndicates whether the particular rule is applied or not.
auto_cancellationobjectThe auto cancellation details for the invoice. If the payer does not pay by the specified date, the invoice is automatically cancelled.
cancel_by_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. 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 by which the invoice is automatically cancelled if unpaid, in Internet date and time format. For example, yyyy-MM-ddTz.
is_appliedbooleanIndicates whether the particular rule is applied or not.
metadataobjectThe audit metadata. Captures all template actions on create and update.
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 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_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 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.
invoicerobjectThe invoicer business information that appears on the invoice.
The invoicer information. Includes business name, email, address, phone, fax, tax ID, additional notes, and logo URL.
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 of the invoice recipient. Includes name, address, email, phone, and language.
email_addressobject^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$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.
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.
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.
additional_infostring^[\S\s]*$Any additional information about the recipient.
languageobject^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$The language tag 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, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
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 contact information of the user. Includes name and address.
The recipient's shipping information. Includes the user's contact information, which includes name and address.
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.itemsobject^(?:[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 currency and amount for a financial transaction, such as a balance or payment due.
The 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_coderequiredstring^[\S\s]*$The 3-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 information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.
The 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.
percentrequiredobject^((-?[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 tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstring^[\S\s]*$The 3-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_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. 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 when the item or service was provided, in Internet date and time format. For example, yyyy-MM-ddTz.
discountobjectThe discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentobject^((-?[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 discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-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_measureobject"QUANTITY", "HOURS", "AMOUNT"The unit of measure for the invoiced item.
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 template configuration details. Includes tax information, tip, and partial payment.
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 expects from the payer.
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 currency and amount for a financial transaction, such as a balance or payment due.
The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
currency_coderequiredstring^[\S\s]*$The 3-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.
save_item_for_futurebooleantrueIndicates whether the item should be saved for future invoices.
show_additional_item_fieldsbooleanfalseIndicates 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.
discount_mode_preferencestring"ONE_TIME", "SAVE_FOR_FUTURE"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.
themeobjectThe theme configuration that defines the visual appearance of the invoice buyer experience and email. Pass an empty object to use the default theme.
The theme configuration for the template. Defines the visual appearance of the invoice buyer experience and email when invoice is created using the template in UI.
Note: Setting a theme on a template does not automatically carry over to invoices created using this template. To apply a theme to an invoice, set it directly on the invoice configuration.
primary_colorstring^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$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.
amountobjectThe invoice amount summary of item total, discount, tax total, and shipping.
currency_codestring^[\S\s]*$The 3-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. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.
item_totalobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items.
currency_coderequiredstring^[\S\s]*$The 3-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 an item- or invoice-level discount, 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.
percentobject^((-?[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 discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-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 currency and amount for a financial transaction, such as a balance or payment due.
The discount as a percent or amount at item level. The item discount amount is subtracted from each item amount.
currency_coderequiredstring^[\S\s]*$The 3-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 currency and amount for a financial transaction, such as a balance or payment due.
The aggregated amount of the item and shipping taxes.
currency_coderequiredstring^[\S\s]*$The 3-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 currency and amount for a financial transaction, such as a balance or payment due.
The shipping amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-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 information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.
The tax associated with the shipping.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredobject^((-?[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 tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstring^[\S\s]*$The 3-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 a custom amount.
labelrequiredstring^[\S\s]*$The label to the custom amount of the invoice.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The custom amount value. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-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 currency and amount for a financial transaction, such as a balance or payment due.
The amount due for the invoice.
currency_coderequiredstring^[\S\s]*$The 3-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.settingsobjectThe template settings. Sets a template as the default template or edit template.
The template settings. Describes which fields to show or hide when you create an invoice.
template_item_settingsarrayThe template item headers display preference.
itemsobjectThe template item setting. Sets a template as the default template or edit template.
field_nameobject"ITEMS_QUANTITY", "ITEMS_DESCRIPTION", "ITEMS_DATE", "ITEMS_DISCOUNT", "ITEMS_TAX"The field names for the invoice line items in the template.
The field name in template_data for which to map corresponding display preferences.
display_preferenceobjectThe template display preference.
hiddenbooleanfalseIndicates whether to show or hide this field.
template_subtotal_settingsarrayThe template subtotal headers display preference.
itemsobjectThe template subtotal setting. Includes the field name and display preference.
field_nameobject"DISCOUNT", "SHIPPING", "CUSTOM", "SHIPPING_TAX"The field names in the template for discount, shipping, and custom amounts.
The field name in template_data for which to map corresponding display preferences.
display_preferenceobjectThe template display preference.
hiddenbooleanfalseIndicates whether to show or hide this field.
template_details_settingsarrayThe template invoice details settings for order, project, and service details.
itemsobjectThe template invoice details setting. Includes the field name and display preference for order, project, and service details.
field_nameobject"ORDER_DETAILS", "PROJECT_DETAILS", "SERVICE_DETAILS"The field names for the invoice details in the template.
The field name for which to map corresponding display preferences.
display_preferenceobjectThe template setting display preference.
hiddenbooleanIndicates whether to show or hide this field.
template_policy_and_agreement_settingsarrayThe template policy and agreement settings for terms, cancellation, and return policies.
itemsobjectThe template policy and agreement setting. Includes the field name and display preference for policy and agreement related fields.
field_nameobject"CANCELLATION_POLICY", "PAYMENT_TERMS", "RETURN_POLICY", "SERVICE_AGREEMENT", "TERMS_AND_CONDITIONS"The field names for the policy and agreement details in the template.
The field name for which to map corresponding display preferences.
display_preferenceobjectThe template setting display preference.
hiddenbooleanIndicates whether to show or hide this field.
template_additional_settingsarrayThe template additional fields that define display preferences for references, attachments, and memos.
itemsobjectThe template additional setting. Includes the field name and display preference.
field_nameobject"ATTACHMENT", "MEMO", "REFERENCE"The field names in the invoice template for additional sections, such as reference, attachments, or memo.
Indicates which field or section of the invoice template this display preference applies to, as defined in template_additional_settings_field.json.
display_preferenceobjectThe template setting display preference.
hiddenbooleanIndicates whether to show or hide this field.
unit_of_measureobject"QUANTITY", "HOURS", "AMOUNT"The unit of measure for the invoiced item.
The unit of measure for the template. Value is quantity, hours, or amount.
standard_templatebooleanIndicates whether this template is a invoicer-created custom template. The system generates non-custom templates.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"The HTTP method required to make the related call.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"The HTTP method required to make the related call.