Welcome to Zuora Product Documentation

Explore our rich library of product information

Line item details

This document details the fields and constraints for line items, including descriptions, product codes, quantities, and tax information.

A maximum of 1,000 line items is allowed, with each line item containing the following fields:

Level 3 field

Zuora field

Description

itemDetailLine[].description:

The description field on the InvoiceItem object

Description of the item.

itemDetailLine[].productCode:

The ProductCode custom field on the ProductRatePlanCharge object

Code identifying the product such as SKU or UPC.

The maximum length is 12 characters.

itemDetailLine[].quantity

The quantity field on the InvoiceItem object

Quantity of the product being purchased.

The maximum length is 4.

itemDetailLine[].unitOfMeasure

The unitOfMeasure field on the InvoiceItem object

Measurement unit for the item such as PCS or KG.

The maximum length is 3.

itemDetailLine[].taxAmount:

The total tax amount applied to the individual line item. It is calculated based on the item's price and tax rate, rounded to 2 decimal places.

itemDetailLine[].taxRate

The tax rate applied to the line item. It is expressed as a percentage such as 5.00 for 5% tax.

It is calculated using the following formula:

Invoice detail’s tax_amount/Invoice detail’s amount_without_tax

itemDetailLine[].totalAmount

Zuora combines the values from the amount_without_tax and tax_amount fields on the InvoiceItem object and considers it as totalAmount .

The total amount for the line item, including tax.

The maximum length is 12.

itemDetailLine[].discountAmount

The discount field on the InvoiceItem object

The discount applied to the line item, rounded to 2 decimal places.

This field is passed to the gateway when the credit card type is not American Express.

itemDetailLine[].commodityCode

The CommodityCode custom field on the ProductRatePlanCharge object

Commodity code of the item, if applicable.

The maximum length is 12 characters.

itemDetailLine[].unitPrice

The unitPrice field on the InvoiceItem object

The price per unit of the item, rounded to 2 decimal places.

itemDetailLine[itemNr].grossNetIndicator

Indicates whether the item's total amount includes tax (Gross) or excludes tax (Net).

Possible values:

  • "G" for Gross (tax included in the amount)

  • "N" for Net (tax not included in the amount)

It is determined using the following formula:

if(tax_amount==0){return "N"} else if(tax_amount!=0) {return "Y"}

itemDetailLine[itemNr].discountIndicator

Specifies if a discount is applied to the item.

Possible values:

  • "Y" for Yes (discount applied)

  • "N" for No (no discount applied)

It is determined using the following condition:

if(discount_amount==0){return "N"} else if(discount_amount!=0) {return "Y"}

itemDetailLine[itemNr].discountRate

The discount rate applied to the item, represented as a percentage.

Format: Decimal such as 10.00 for a 10% discount.

It is calculated using the following formula:

Invoice detail’s discount_amount/Invoice detail’s amount_without_tax

itemDetailLine[itemNr].taxCode

InvoiceDetailTaxCodeName

A code representing the type of tax applied to the item such as VAT, GST, or ST.