The template with invoice details to load with all captured fields.
template_infoobject<template_info>Optionaldetailobject<template_detail>Optionalcurrency_codestring<currency_code>Requiredattachmentsobject<file_reference>[]Optionalcreate_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
tip_presetsobject<tip_preset>[]Optionalpayment_termobject<payment_term>Optionalterm_typeenum<payment_term_type>Optionalconditional_rulesobject<payment_term_conditional_rules>Optionalearly_payment_discountobject<early_payment_discount>Optionaldiscount_end_datestring<date_no_time>Optionalpercentstring<percentage>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredauto_cancellationobject<auto_cancellation>Optionalcancel_by_datestring<date_no_time>Optionalmetadataobject<template_metadata>Optionalcreate_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
last_update_timestring<date_time>OptionalNote: The regular expression provides guidance but does not reject all invalid dates.
invoicerobject<invoicer_info>Optionalorthographyenum<orthography>Optionalnameobject<person_name>Optionalorthographyenum<orthography>Optionaladdressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionalemail_addressstring<restrictive_email_address>OptionalNote: 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.
phonesobject<phone_detail>[]Optionalcountry_codestringRequirednational_numberstringRequiredprimary_recipientsobject<recipient_info>[]Optionalbilling_infoobject<billing_info>Optionalorthographyenum<orthography>Optionalnameobject<person_name>Optionalorthographyenum<orthography>Optionaladdressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionalemail_addressstring<restrictive_email_address>OptionalNote: 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.
phonesobject<phone_detail>[]Optionalcountry_codestringRequirednational_numberstringRequiredlanguagestring<language>Optionalshipping_infoobject<contact_name_address>Optionalorthographyenum<orthography>Optionalnameobject<person_name>Optionalorthographyenum<orthography>Optionaladdressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionaladditional_recipientsarray<email_address>OptionalNote: Valid values are email addresses in the `additional_recipients` value associated with the invoice.
unit_amountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredtaxobject<tax>Optionalpercentstring<percentage>Requiredamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireditem_datestring<date_no_time>Optionaldiscountobject<discount>Optionalpercentstring<percentage>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredunit_of_measureenum<unit_of_measure>Optionalconfigurationobject<template_configuration>Optionalallow_tipbooleanOptionalNote: This feature is not available for users in `Hong Kong`, `Taiwan`, `India`, or `Japan`.
partial_paymentobject<partial_payment>Optionalminimum_amount_dueobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireddiscount_mode_preferenceenum<discount_mode_preference>Optionalthemeobject<configurable_theme>Optionalamountobject<amount_summary_detail>Optionalcurrency_codestring<currency_code>OptionalvaluestringOptionalbreakdownobject<amount_with_breakdown>Optionalitem_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireddiscountobject<aggregated_discount>Optionalinvoice_discountobject<discount>Optionalpercentstring<percentage>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireditem_discountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtax_totalobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredshippingobject<shipping_cost>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredtaxobject<tax>Optionalpercentstring<percentage>Requiredamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredcustomobject<custom_amount>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequireddue_amountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredsettingsobject<template_settings>Optionaltemplate_item_settingsobject<template_item_setting>[]Optionalfield_nameenum<template_item_field>Optionaldisplay_preferenceobject<template_display_preference>Optionaltemplate_subtotal_settingsobject<template_subtotal_setting>[]Optionalfield_nameenum<template_subtotal_field>Optionaldisplay_preferenceobject<template_display_preference>Optionaltemplate_details_settingsobject<template_details_setting>[]Optionalfield_nameenum<template_details_settings_field>Optionaldisplay_preferenceobject<template_setting_display_preference>Optionaltemplate_policy_and_agreement_settingsobject<template_policy_and_agreement_setting>[]Optionalfield_nameenum<template_policy_and_agreement_settings_field>Optionaldisplay_preferenceobject<template_setting_display_preference>Optionaltemplate_additional_settingsobject<template_additional_setting>[]Optionalfield_nameenum<template_additional_settings_field>Optionaldisplay_preferenceobject<template_setting_display_preference>Optionalunit_of_measureenum<unit_of_measure>Optionallinksobject<link_description>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptional