Container for Standalone Invoices

IsNewInvoice

TRUE or FALSE

Required when creating new Invoice,Enter the value as 'True' if applicable; otherwise the value as FALSE the cell can be left blank

Indicator Column marking the start of a new object

Invoice

Account Id*

STRING

Required when Creating new Invoice

The ID of the account associated with the invoice.You must specify either accountNUMBER or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

Invoice

Account NUMBER*

STRING

Required when Creating new Invoice

The NUMBER of the account associated with the invoice. You must specify either accountNUMBER or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

Invoice

Invoice Date*

DATE

Required when Creating new Invoice

The date that appears on the invoice being created, in yyyy-mm-dd format. The value cannot fall in a closed accounting period.

Invoice

Auto pay

BOOLEAN

Optional

Default: false Whether invoices are automatically picked up for processing in the corresponding payment run.

Invoice

Bill To Contact Id

STRING

Optional and Conditional

Invoice

Currency

STRING

Optional

Invoice

Due Date

DATE

Optional

The date by which the payment for this invoice is due, in yyyy-mm-dd format.

Invoice

Integration Id NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice

Integration Status NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

Status of the invoice's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice

Invoice Comments

STRING

Optional

Comments about the invoice.

Invoice

Invoice NUMBER

STRING

Optional

A customized invoice NUMBER with the following format requirements: Max length: 32 characters Acceptable characters: a-z,A-Z,0-9,-,_, Purely numerical prefixes or prefixes ending with a NUMBER are supported for standalone invoices. For example, you can use 202310000300, 2003, INV202310000300, or 2023-09-100009785 as invoice NUMBERs. The value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out things to note and troubleshooting steps.

Invoice

Invoice Status

STRING

Optional

Default: "Draft" The status of invoice. By default, the invoice status is Draft. When creating an invoice, if you set this field to Posted, the invoice is created and posted directly. Enum: "Draft" "Posted"

Invoice

Payment Term

STRING

Optional

Invoice

Sequence Set

STRING

Optional

Invoice

Sold To Contact Id

STRING

Optional

Invoice

Sold To Same As Bill To

BOOLEAN

Optional

Invoice

Sync Date NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

Date when the invoice was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice

Template Id

STRING

Optional

Invoice

Transferred To Accounting

STRING

Optional

Enum: "Processing" "Error" "Ignore" "Yes" "No"

Invoice >object (Contact)

Bill To Contact Address1

STRING<= 255 characters

Optional

First address line, 255 characters or less.

Invoice

Bill To Contact Address2

STRING<= 255 characters

Optional

Second address line, 255 characters or less.

Invoice

Bill To Contact City

STRING<= 40 characters

Optional

City, 40 characters or less.

Invoice

Bill To Contact Country

STRING

Optional

Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.

Invoice

Bill To Contact County

STRING<= 32 characters

Optional

County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.

Invoice

Bill To Contact Fax

STRING<= 40 characters

Optional

Fax phone NUMBER, 40 characters or less.

Invoice

Bill To Contact FirstName

STRING<= 100 characters

Required when creating a new contact under invoice owner

First name, 100 characters or less.

Invoice

Bill To Contact Home Phone

STRING<= 40 characters

Optional

Home phone NUMBER, 40 characters or less.

Invoice

Bill To Contact LastName

STRING<= 100 characters

Required when creating a new contact under invoice owner

Last name, 100 characters or less.

Invoice

Bill To Contact MobilePhone

STRING<= 40 characters

Optional

Mobile phone NUMBER, 40 characters or less.

Invoice

Bill To Contact NickName

STRING

Optional

Nickname for this contact

Invoice

Bill To Contact OtherPhone

STRING<= 40 characters

Optional

Other phone NUMBER, 40 characters or less.

Invoice

Bill To Contact OtherPhoneType

STRING

Optional

Possible values are: Work, Mobile, Home, Other.

Invoice

Bill To Contact PersonalEmail

STRING<email> <= 80 characters

Optional

Personal email address.

Invoice

Bill To Contact PostalCode

STRING<= 20 characters

Optional

Zip code, 20 characters or less.

Invoice

Bill To Contact State

STRING

Optional

State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.

Invoice

Bill To Contact TaxRegion

STRING

Optional

If using Zuora Tax, a region STRING as optionally defined in your tax rules. Not required.

Invoice

Bill To Contact WorkEmail

STRING<= 80 characters

Optional

Work email address, 80 characters or less

Invoice

Bill To Contact WorkPhone

STRING<= 40 characters

Optional

Work phone NUMBER, 40 characters or less

Array of objects (customRates)

IsNewCustomRates

TRUE or FALSE

Required when adding home currency or reporting currency rates , enter the value as 'True" if applicable;otherwise the value is FALSE, the cell can be left blank

Invoice > Custom Rates

Custom Rates Currency*

STRING

Required when adding home currency or Reporting currency to Invoice

Invoice > Custom Rates

Custom Rates Custom Fx Rate*

NUMBER <decimal>

Required when adding home currency or Reporting currency to Invoice

Invoice> Custom Rates

Custom Rates Rate Date

STRING <date>

Optional

Array of objects (PostInvoiceItemType)

IsNewInvoiceItem

TRUE or FALSE

Required when adding Invoice Items to an Invoice,enter the value as "true" if applicable; otherwise the value is FALSE, the cell can be left blank

Invoice>Invoice Item

Invoice Item Amount*

NUMBER

Required when adding Invoice Items to an Invoice

The amount of the invoice item. For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax.

Invoice>Invoice Item

Invoice Item Service Start Date*

STRING<date>

Required when adding Invoice Items to an Invoice

The service start date of the invoice item.

Invoice>Invoice Item

Invoice Item Accounting Code

STRING

Optional

The accounting code associated with the invoice item.

Invoice>Invoice Item

Invoice Item Adjustment Liability Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Adjustment Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Charge Date

STRING<date-time>

Optional

The date when the invoice item is charged, in yyyy-mm-dd hh:mm:ss format

Invoice>Invoice Item

Invoice Item Charge Name

STRING

Optional

The name of the charge associated with the invoice item. This field is required if the productRatePlanChargeId field is not specified in the request

Invoice>Invoice Item

Invoice Item Contract Asset Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Contract Liability Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Contract Recognized Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Deferred Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Description

STRING

Optional

The description of the invoice item.

Invoice>Invoice Item

Invoice Item Exclude Item Billing From Revenue Accounting

BOOLEAN

Optional

Invoice>Invoice Item

Invoice Item Integration Id NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice>Invoice Item

Invoice Item Integration Status NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

Date when the invoice was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice>Invoice Item

Invoice Item Item Type

STRING

Optional

The type of the invoice item

Invoice>Invoice Item

Invoice Item Product Rate Plan Charge Id

STRING

Optional

The ID of the product rate plan charge that the invoice item is created from. If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body: chargeName sku uom taxCode taxMode accountingCode deferredRevenueAccountingCode recognizedRevenueAccountingCode

Invoice>Invoice Item

Invoice Item Purchase Order NUMBER

STRING

Optional

The purchase order NUMBER associated with the invoice item

Invoice>Invoice Item

Invoice Item Quantity

NUMBER

Optional

Default: 1 The NUMBER of units for the invoice item

Invoice>Invoice Item

Invoice Item Recognized Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Reference Of The Discount Item

Optional

Invoice>Invoice Item

Invoice Item Revenue Recognition Code

STRING

Optional

The revenue recognition code

Invoice>Invoice Item

Invoice Item Revenue Recognition Rule Name

STRING

Optional

Invoice>Invoice Item

Invoice Item Revenue Recognition Trigger Condition

STRING

Optional

The date when revenue recognition is triggered. Enum: "ContractEffectiveDate" "ServiceActivationDate" "CustomerAcceptanceDate"

Invoice>Invoice Item

Invoice Item SKU

STRING

Optional

The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product

Invoice>Invoice Item

Invoice Item Service End Date

STRING<date>

Optional

The service end date of the invoice item

Invoice>Invoice Item

Invoice Item Sync Date NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

Date when the invoice item was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice>Invoice Item

Invoice Item Tax Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Tax Mode

STRING

Optional

Invoice>Invoice Item

Invoice Item UOM

STRING

Optional

The unit of measure

Invoice>Invoice Item

Invoice Item Unbilled Receivables Accounting Code

STRING

Optional

Invoice>Invoice Item

Invoice Item Unit Price

NUMBER

Optional

The per-unit price of the invoice item. To pass Level 3 data to the gateway, this field is required and must be greater than zero

Array of objects (PostDiscountItemType)

IsNewInvoiceItemDiscountItem

TRUE or FALSE

Required when adding discount to Invoice Items to an Invoice,enter the value as "True" if applicable; otherwise the value is FALSE, the cell can be left blank

Indicator Column marking the start of a new object.Container for discount items. The maximum NUMBER of discount items is 10.

Invoice>Invoice Item> Discount Item

Discount Item Amount*

NUMBER

Required when adding discount to Invoice Items

The amount of the discount item. Should be a negative NUMBER. For example, -10. Always a fixed amount no matter whether the discount charge associated with the discount item uses the fixed-amount model or percentage model. For tax-exclusive discount items, this amount indicates the discount item amount excluding tax. For tax-inclusive discount items, this amount indicates the discount item amount including tax.

Invoice>Invoice Item> Discount Item

Discount Item Accounting Code

STRING

Optional

The accounting code associated with the discount item

Invoice>Invoice Item> Discount Item

Discount Item Accounts Receivable Accounting Code

STRING

Optional

The accounting code for accounts receivable

Invoice>Invoice Item> Discount Item

Discount Item Adjustment Liability Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Adjustment Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Booking Reference

STRING

Optional

The booking reference of the discount item.

Invoice>Invoice Item> Discount Item

Discount Item Charge Date

STRING<date-time>

Optional

The date when the discount item is charged, in yyyy-mm-dd hh:mm:ss format

Invoice>Invoice Item> Discount Item

Discount Item Charge Name

STRING

Optional

The name of the charge associated with the discount item. This field is required if the productRatePlanChargeId field is not specified in the request body.

Invoice>Invoice Item> Discount Item

Discount Item Contract Asset Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Contract Liability Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Contract Recognition Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Deferred Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Description

STRING

Optional

The description of the discount item

Invoice>Invoice Item> Discount Item

Discount Item Integration Id NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice>Invoice Item> Discount Item

Discount Item Integration Status NS

STRING <= 255 characters

Optional

Status of the invoice item's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice>Invoice Item> Discount Item

Discount Item Item Type

STRING

Optional

The type of the discount item.

Invoice>Invoice Item> Discount Item

Discount Item Product Rate Plan Charge Id

STRING

Optional

The ID of the product rate plan charge that the discount item is created from. If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body: chargeName sku If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding discount charge that uses discount specific accounting codes, rule and segment to manage revenue, regardless of the values specified in the request body: accountingCode deferredRevenueAccountingCode recognizedRevenueAccountingCode If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT use discount specific accounting codes, rule and segment to manage revenue, regardless of the values specified in the request body: accountingCode deferredRevenueAccountingCode recognizedRevenueAccountingCode

Discount Item

Discount Item Purchase Order NUMBER

STRING

Optional

The purchase order NUMBER associated with the discount item.

Invoice>Invoice Item> Discount Item

Discount Item Recognized Revenue Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Revenue Recognition Code

STRING

Optional

The revenue recognition code.

Invoice>Invoice Item> Discount Item

Discount Item Revenue Recognition Rule Name

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Revenue Recognition Trigger Condition

STRING

Optional

The date when revenue recognition is triggered. Enum: "ContractEffectiveDate" "ServiceActivationDate" "CustomerAcceptanceDate"

Invoice>Invoice Item> Discount Item

Discount Item SKU

STRING

Optional

The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.

Invoice>Invoice Item> Discount Item

Discount Item Sync Date NS

STRING <= 255 characters

Optional, Applicable with Netsuite Integration

Date when the discount was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Invoice>Invoice Item> Discount Item

Discount Item Unbilled Receivables Accounting Code

STRING

Optional

Invoice>Invoice Item> Discount Item

Discount Item Unit Price

NUMBER

Optional

The per-unit price of the discount item. If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF

Array of objects (PostTaxationItemType)

IsNewInvoiceItemDiscountItemTaxItem

True or false

Required when adding discount to invoice items for an Invoice, enter the value as "true" if applicable;otherwise the value is FALSE, the cell can be left blank

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Name*

STRING

Required if adding tax items to discount item

The name of taxation.

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Amount*

STRING <NUMBER>

Required when adding tax item to InvoiceItem

The amount of the taxation item in the invoice item

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Code*

STRING

Required if adding tax items to discount item

The tax code identifies which tax rules and tax rates to apply to a specific invoice item.

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Date*

STRING <date>

Required if adding tax items to discount item

The date that the tax is applied to the invoice item, in yyyy-mm-dd format

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Mode*

STRING

Required if adding tax items to discount item

The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. Enum: "TaxInclusive" "TaxExclusive"

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Rate*

STRING <NUMBER>

Required if adding tax items to discount item

The tax rate applied to the invoice item

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Rate Type*

STRING

Required if adding tax items to discount item

The type of the tax rate applied to the invoice item. Enum: "Percentage" "FlatFee"

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Exempt Amount

STRING <NUMBER>

Optional

The calculated tax amount excluded due to the exemption.

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Jurisdiction

STRING

Optional

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Location Code

STRING

Optional

The identifier for the location based on the value of the taxCode field

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Code Description

STRING

Optional

The description of the tax code

Invoice>Invoice Item> Discount Item>Tax Item

Discount Item Tax Item Tax Rate Description

STRING

Optional

The description of the tax rate.

Array of objects (PostTaxationItemType)

IsNewInvoiceItemTaxItem

TRUE or FALSE

Required when adding Taxation to an Invoice,enter the value as "true" if applicable; otherwise the value is FALSE, the cell can be left blank

Invoice>Invoice Item>Tax Item

Tax Item Name*

STRING

Required if adding tax items to invoice item

The name of taxation.

Invoice>Invoice Item>Tax Item

Tax Item Tax Amount*

STRING <NUMBER>

Required if adding tax items to invoice item

The amount of the taxation item in the invoice item

Invoice>Invoice Item>Tax Item

Tax Item Tax Code*

STRING

Required if adding tax items to invoice item

The tax code identifies which tax rules and tax rates to apply to a specific invoice item

Invoice>Invoice Item>Tax Item

Tax Item Tax Date*

STRING <date>

Required if adding tax items to invoice item

The date that the tax is applied to the invoice item, in yyyy-mm-dd format.

Invoice>Invoice Item>Tax Item

Tax Item Tax Mode*

STRING

Required if adding tax items to invoice item

The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. Enum: "TaxInclusive" "TaxExclusive"

Invoice>Invoice Item>Tax Item

Tax Item Tax Rate*

STRING <NUMBER>

Required if adding tax items to invoice item

The tax rate applied to the invoice item

Invoice>Invoice Item>Tax Item

Tax Item Tax Rate Type*

STRING

Required if adding tax items to invoice item

The type of the tax rate applied to the invoice item. Enum: "Percentage" "FlatFee"

Invoice>Invoice Item>Tax Item

Tax Item Exempt Amount

STRING <NUMBER>

Optional

The calculated tax amount excluded due to the exemption

Invoice>Invoice Item>Tax Item

Tax Item Jurisdiction

STRING

Optional

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

Invoice>Invoice Item>Tax Item

Tax Item Location Code

STRING

Optional

The identifier for the location based on the value of the taxCode field.

Invoice>Invoice Item>Tax Item

Tax Item Tax Code Description

STRING

Optional

The description of the tax code.

Invoice>Invoice Item>Tax Item

Tax Item Tax Rate Description

STRING

Optional

The description of the tax rate.

Invoice

Sold To Contact Address1

STRING <= 255 characters

Optional

Invoice

Sold To Contact Address2

STRING

Optional

Second address line, 255 characters or less

Invoice

Sold To Contact City

STRING <= 40 characters

Optional

City, 40 characters or less

Invoice

Sold To Contact Country

STRING

Optional

Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided

Invoice

Sold To Contact County

STRING <= 32 characters

Optional

County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax

Invoice

Sold To Contact Fax

STRING <= 40 characters

Optional

Fax phone NUMBER, 40 characters or less.

Invoice

Sold To Contact FirstName

STRING <= 100 characters

Required when creating a new contact under invoice owner

First name, 100 characters or less

Invoice

Sold To Contact Home Phone

STRING <= 40 characters

Optional

Home phone NUMBER, 40 characters or less.

Invoice

Sold To Contact LastName

STRING <= 100 characters

Required when creating a new contact under invoice owner

Last name, 100 characters or less.

Invoice

Sold To Contact MobilePhone

STRING <= 40 characters

Optional

Mobile phone NUMBER, 40 characters or less.

Invoice

Sold To Contact NickName

STRING

Optional

Nickname for this contact

Invoice

Sold To Contact OtherPhone

STRING <= 40 characters

Optional

Other phone NUMBER, 40 characters or less.

Invoice

Sold To Contact OtherPhoneType

STRING

Optional

Possible values are: Work, Mobile, Home, Other

Invoice

Sold To Contact PersonalEmail

STRING <email> <= 80 characters

Optional

Personal email address

Invoice

Sold To Contact PostalCode

STRING<= 20 characters

Optional

Zip code, 20 characters or less

Invoice

Sold To Contact State

STRING

Optional

State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.

Invoice

Sold To Contact TaxRegion

STRING

Optional

If using Zuora Tax, a region STRING as optionally defined in your tax rules. Not required.

Invoice

Sold To Contact WorkEmail

STRING <= 80 characters

Optional

Work email address, 80 characters or less

Invoice

Sold To Contact WorkPhone

STRING <= 40 characters

Optional

Work phone NUMBER, 40 characters or less