Skip to main content

Standalone invoices - Data dictionary

Zuora

Standalone invoices - Data dictionary

  1. Last updated
  2. Save as PDF

This article lists all the fields associated with creating a Standalone invoice in Zuora. Read more on Standalone Invoices here.

Note: Fields with an asterisk mark indicate mandatory fields. 

Name

Description 

Value
IsNewInvoice Marker Column TRUE,FALSE
Account Id* The ID of the account associated with the invoice.

Alphanumeric Id
Auto pay Whether invoices are automatically picked up for processing in the corresponding payment run. Boolean(TRUE|FALSE)

Invoice Comments

 Comments about the invoice. Alphanumeric
Invoice Number A unique customized invoice number Alphanumeric
Invoice Status

The status of invoice. By default, the invoice status is Draft.

Status values 

  • Draft,
  • Posted
Invoice Date* The date that appears on the invoice being created, in yyyy-mm-dd format. The value cannot fall in a closed accounting period. Date(YYYY-MM-dd)

IsNewCustomRates

 Marker Column TRUE,FALSE

customRates currency*

The currency code for either Reporting or Home currency.

3 letter currency code

customRates Custom Fx Rate*

 The date on which a particular currency rate is fixed or obtained on.

Decimal

IsNewInvoiceItem

 Marker Column TRUE,FALSE

Invoice Item Accounting Code

The accounting code associated with the invoice item.

 Alphanumeric

Invoice Item Adjustment Liability Accounting Code

 The accounting code for adjustment liability. Alphanumeric

Invoice Item Adjustment Revenue Accounting Code

 The accounting code for adjustment revenue. Alphanumeric

Invoice Item Amount*

 The amount of the invoice item. Decimal

Invoice Item Charge Date

 The date when the invoice item is charged Date(YYYY-MM-dd HH:MM:SS)

Invoice Item Charge Name

 The name of the charge associated with the invoice item.

Alphanumeric

Invoice Item Contract Asset Accounting Code

 The accounting code for contract asset. Alphanumeric

Invoice Item Contract Liability Accounting Code

 The accounting code for contract liability. Alphanumeric

Invoice Item Contract Recognition Revenue Accounting Code

 The accounting code for contract recognized revenue. Alphanumeric

Invoice Item Deferred Revenue Accounting Code

 The accounting code for the deferred revenue, such as Monthly Recurring Liability. Alphanumeric

Invoice Item Description

 The description of the invoice item. Alphanumeric

Invoice Item Type

The type of the invoice item.

 Alphanumeric

Invoice Item Product Rate Plan Charge Id

 The ID of the product rate plan charge that the invoice item is created from. Alphanumeric Id

Invoice Item Purchase Order Number

 The purchase order number associated with the invoice item. Alphanumeric

Invoice Item Quantity

The number of units for the invoice item.

Number

Invoice Item Recognized Revenue Accounting Code

The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

 Alphanumeric

Invoice Item Revenue Recognition Code

 The revenue recognition code. Alphanumeric

Invoice Item Revenue Recognition Trigger Condition

 The date when revenue recognition is triggered.

Trigger Condition Values 

  • ContractEffectiveDate,
  • ServiceActivationDate,
  • CustomerAcceptanceDate

Invoice Item Revenue Recognition Rule Name

 The name of the revenue recognition rule governing the revenue schedule.

Alphanumeric

Invoice Item Service End Date

 The service end date of the invoice item. Date(YYYY-MM-dd)

Invoice Item Service Start Date*

 The service start date of the invoice item. Date(YYYY-MM-dd)

Invoice Item SKU

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

Invoice Item Tax Mode

 The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

Tax Mode values 

  • TaxInclusive,
  • TaxExclusive

Invoice Item Unbilled Receivables Accounting Code

 The accounting code for unbilled receivables. Alphanumeric

Invoice Item Unit Price

 The per-unit price of the invoice item.  Decimal

Invoice Item UOM

 The unit of measure. Alphanumeric

Invoice Item Tax Code

 The tax code identifies which tax rules and tax rates to apply to the invoice item. Alphanumeric

IsNewInvoiceItemTaxItem

 Marker Column TRUE,FALSE

Invoice Item Tax Item Tax Code*

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

Invoice Item Exempt Amount

 The calculated tax amount excluded due to the exemption. Decimal

Invoice Item Jurisdiction

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

Invoice Item Location Code

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

Invoice Item Tax Name*

The name of taxation.

 Alphanumeric

Invoice Item Tax Amount*

 The amount of the taxation item in the invoice item. Decimal

Invoice Item Tax code Description

 The description of the tax code. Alphanumeric

Invoice Item Tax Date*

The date that the tax is applied to the invoice item

 Date(yyyy-MM-dd)

Invoice Item Tax Rate*

 The tax rate applied to the invoice item. Alphanumeric

Invoice Item Tax Rate Description

 The description of the tax rate. Alphanumeric

Invoice Item Tax Rate Type *

 The type of the tax rate applied to the invoice item.

Tax Rate Type values 

  • Percentage,
  • Flatfee

Invoice Item Tax Item Tax Mode*

 The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

Tax Mode values 

  • TaxInclusive,
  • TaxExclusive

IsNewInvoiceItemDiscountItem

 Marker Column TRUE,FALSE

Discount Item Accounting Code

 The accounting code associated with the discount item. Alphanumeric

Discount Item Accounts Receivable Accounting Code

 The accounting code for accounts receivable. Alphanumeric

Discount Item Adjustment Liability Accounting Code

 The accounting code for accounts receivable. Alphanumeric

Discount Item Adjustment Revenue Accounting Code

 The accounting code for accounts receivable. Alphanumeric

Discount Item Amount*

 The amount of the discount item. Decimal

Discount Item Charge Date

The date when the discount item is charged

 Date(YYYY-MM-dd HH:MM:SS)

Discount Item Charge Name

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

Discount Item Contract Asset Accounting Code

 The accounting code for contract asset.  Alphanumeric

Discount Item Contract Liability Accounting Code

 The accounting code for contract liability.  Alphanumeric

Discount Item Contract Recognition Revenue Accounting Code

 The accounting code for contract recognized revenue. Alphanumeric

Discount Item Deferred Revenue Accounting Code

 The accounting code for the deferred revenue, such as Monthly Recurring Liability. Alphanumeric

Discount Item Description

 The description of the discount item. Alphanumeric

Discount Item Type

The type of the discount item.

 Alphanumeric

Discount Item Product Rate Plan Charge Id

 The ID of the product rate plan charge that the invoice item is created from. Alphanumeric Id

Discount Item Purchase Order Number

The purchase order number associated with the discount item.

 Alphanumeric

Discount Item Recognized Revenue Accounting Code

 The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. Alphanumeric

Discount Item Revenue Recognition Code

 The revenue recognition code.

Alphanumeric

Discount Item Revenue Recognition Trigger Condition

 The date when revenue recognition is triggered.

Revenue Recognition Code Values 

  • ContractEffectiveDate,
  • ServiceActivationDate,
  • CustomerAcceptanceDate

Discount Item Revenue Recognition Rule Name

 The name of the revenue recognition rule governing the revenue schedule. Alphanumeric

Discount Item SKU

 The SKU of the invoice item. Alphanumeric

Discount Item Unbilled Receivables Accounting Code

 The accounting code for unbilled receivables. Alphanumeric

Discount Item Unit Price

 The per-unit price of the discount item.  Decimal

IsNewInvoiceItemDiscountItemTaxItem

 Marker Column TRUE,FALSE

Discount Item Tax Item Tax Code*

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

Discount Item Exempt Amount

 The calculated tax amount excluded due to the exemption. Decimal

Discount Item Jurisdiction

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

Discount Item Location Code

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

Discount Item Tax Name*

The name of taxation.

 Alphanumeric

Discount Item Tax Amount*

 The amount of the taxation item in the invoice item. Decimal

Discount Item Tax code Description

 The description of the tax code. Alphanumeric

Discount Item Tax Date*

The date that the tax is applied to the invoice item

 Date(yyyy-MM-dd)

Discount Item Tax Rate*

 The tax rate applied to the invoice item. Alphanumeric

Discount Item Tax Rate Description

 The description of the tax rate. Alphanumeric

Discount Item Tax Rate Type *

 The type of the tax rate applied to the invoice item.

Tax Rate Type values 

  • Percentage,
  • Flatfee

Discount Item Tax Item Tax Mode*

 The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

 

Tax Mode values 

  • TaxInclusive,
  • TaxExclusive