> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Field descriptions of InvoiceItem

> This reference provides the description of the fields of the InvoiceItem object.

This reference provides the description of the fields of the InvoiceItem object.

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing.

<table>
  <tr>
    <th>
      Name
    </th>

    <th>
      Required to create?
    </th>

    <th>
      Allowed operations
    </th>

    <th>
      Description
    </th>
  </tr>

  <tr>
    <td>
      AccountingCode
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The accounting code for the item's charge. Accounting codes group transactions that contain similar accounting attributes.

      **Type**: string

      **Character limit**: 100

      **Version notes**: --

      **Values**: inherited from `RatePlanCharge.AccountingCode`
    </td>
  </tr>

  <tr>
    <td>
      AppliedToChargeNumber
    </td>

    <td>
      optional
    </td>

    <td>
      This field is only used for subscription previews.
    </td>

    <td>
      The charge number that the discount charge is applied to. This field is only for the invoice items that are discount charges.

      **Note**:

      * You can preview a subscription when you: This field will be returned in the response if you specify the charge number in the rate plan charges in the request.

        * Create a new subscription with a subscribe() call
        * Create an Add Product amendment with an amend() call.
      * When you preview a subscription with an amend() call, this field will be returned in the response if the preview type is:

        * `InvoiceItem`
        * `InvoiceItemChargeMetrics`

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes:** WSDL 80.0+

      **Values**: inherited from `RatePlanCharge.ChargeNumber` for the charge associated with the invoice item that the discount charge is applied to
    </td>
  </tr>

  <tr>
    <td>
      AppliedToInvoiceItemId
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Associates a discount invoice item to a specific invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes:** WSDL 43.0+

      **Values**: inherited from `InvoiceItem.Id` for the invoice item that the discount charge is applied to
    </td>
  </tr>

  <tr>
    <td>
      ChargeAmount
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The amount being charged for the invoice item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.

      **Type**: decimal (currency)

      **Character limit**:

      **Version notes**: type is double for WSDL 18.0 and older

      **Values**: automatically calculated from multiple fields in multiple objects
    </td>
  </tr>

  <tr>
    <td>
      ChargeDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The date when the Invoice Item is created .

      **Type**: dateTime

      **Character limit**: 29

      **Version notes**: --

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      ChargeDescription
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      A description of the invoice item's charge.

      **Type**: string

      **Character limit**: 500

      **Version notes**: --

      **Values**: inherited from `RatePlanCharge.Description`
    </td>
  </tr>

  <tr>
    <td>
      ChargeId
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The original ID of the rate plan charge that is associated with this invoice item upon object creation.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: WSDL 59.0+

      **Values**: inherited from `RatePlanCharge.Id`
    </td>
  </tr>

  <tr>
    <td>
      ChargeName
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The name of the invoice item's charge.

      **Type**: string

      **Character limi** t: 50

      **Version notes**: --

      **Values:** inherited from `RatePlanCharge.Name`
    </td>
  </tr>

  <tr>
    <td>
      ChargeNumber
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The unique identifier of the invoice item's charge.

      **Type**: string

      **Character limit:** 50

      **Version notes**: --

      **Values:** inherited from `RatePlanCharge.ChargeNumber`
    </td>
  </tr>

  <tr>
    <td>
      CreatedById
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The user ID of the person who created the invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: WSDL 20.0+

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      CreatedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The date the invoice item was created.

      **Type**: dateTime

      **Character limit:** 29

      **Version notes**: WSDL 20.0+

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      ExcludeItemBillingFromRevenueAccounting
    </td>

    <td>
      optional
    </td>

    <td>
      Create Query Update
    </td>

    <td>
      Indicates whether the billing item is to be excluded from revenue accounting.

      ****Type:**** boolean

      ****Character limit:**** 100

      ****Version notes:**** WSDL 116.0+

      ****Values:**** automatically generated from one of the following: `True` , `False` (default)

      ****Note****: This field is only available if you have the Billing - Revenue Integration feature enabled.
    </td>
  </tr>

  <tr>
    <td>
      Id
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of this object. Upon creation, the ID of this object is `InvoiceItemId` .

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes:** --

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      InvoiceId
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of the invoice that's associated with this invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: inherited from `Invoice.Id`
    </td>
  </tr>

  <tr>
    <td>
      ItemSoldToContactId
    </td>

    <td>
      optional
    </td>

    <td>
      N/A
    </td>

    <td>
      The ID of the sold-to contact associated with the invoice item. This field is part of the Flexible Billing Attributes feature. For subscription-based invoices, sold-to information is inherited from the subscription or order line item and stored at the invoice-item level for tax calculation. Invoice items generated from subscriptions always link to the latest sold-to contact. This is a read-only field.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: Inherited from the sold-to contact specified on the subscription or order line item. If no sold-to contact is specified, the default sold-to contact of the subscription owner is used.

      > **Note**
      >
      > For subscription-based invoices, `Invoice.SoldToContactId` remains null because sold-to information is stored at the invoice-item level rather than the invoice header level.
    </td>
  </tr>

  <tr>
    <td>
      ProcessingType
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Identifies the kind of charge where 0 is a charge, 1 is a discount, 2 is a prepayment, and 3 is a tax.

      The returned value is text not decimal on data sources.

      **Type**: decimal

      **Character limit**:

      **Version notes**: --

      **Values:**

      * 0: charge
      * 1: discount
      * 2: prepayment
      * 3: tax
    </td>
  </tr>

  <tr>
    <td>
      ProductDescription
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      A description of the product associated with this invoice item.

      **Type**: string

      **Character limit**: 500

      **Version notes**: --

      **Values**: inherited from `Product.Description`

      **Note**: This value changes if Product.Description is updated. The values of UpdatedById and UpdatedDate for the InvoiceItem do not change when Product.Description is updated.
    </td>
  </tr>

  <tr>
    <td>
      ProductId
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of the product associated with this invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: inherited from `Product.Id`
    </td>
  </tr>

  <tr>
    <td>
      ProductName
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The name of the product associated with this invoice item.

      **Type**: string

      **Character limit**: 255

      **Version notes**: --

      **Values:** inherited from `Product.Name`

      **Note**: This value changes if Product.Name is updated. The values of UpdatedById and UpdatedDate for the InvoiceItem do not change when Product.Name is updated.
    </td>
  </tr>

  <tr>
    <td>
      ProductRatePlanChargeId
    </td>

    <td>
      optional
    </td>

    <td>
      N/A
    </td>

    <td>
      The ID of the rate plan charge that's associated with this invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: inherited from `ProductRatePlanCharge.Id`

      You cannot `query()` for this field. Only the s `ubscribe()` preview and the `amend()` preview calls will return the value of this field in the response.
    </td>
  </tr>

  <tr>
    <td>
      Quantity
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The number of units for this invoice item.

      **Type**: decimal

      **Character limit**:

      **Version notes**: type is double for WSDL 18.0 and older

      **Values**: inherited from `RatePlanCharge.Quantity`
    </td>
  </tr>

  <tr>
    <td>
      RatePlanChargeId
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of the rate plan charge that's associated with this invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: inherited from `RatePlanCharge.Id`
    </td>
  </tr>

  <tr>
    <td>
      RevRecCode
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Associates this invoice item with a specific revenue recognition code.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: inherited from `ProductRatePlanCharge.RevRecCode`
    </td>
  </tr>

  <tr>
    <td>
      RevRecStartDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The date when revenue recognition is triggered.

      **Type**:

      * date: Supported as of WSDL version 69+
      * dateTime: Supported through WSDL version 68

      **Character limit**: 29

      **Version notes**:

      **Values**: generated from `InvoiceItem.RevRecTriggerCondition`
    </td>
  </tr>

  <tr>
    <td>
      RevRecTriggerCondition
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Specifies when revenue recognition begins based on a triggering event.

      **Type**: string

      **Character limit**:

      **Version notes**:

      **Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition`
    </td>
  </tr>

  <tr>
    <td>
      ServiceEndDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The end date of the service period associated with this invoice item. Service ends one second before the date in this value.

      **Type**:

      * date: Supported as of WSDL version 69+
      * dateTime: Supported through WSDL version 68

      **Character limit**: 29

      **Version notes**:

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      ServiceStartDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The start date of the service period associated with this invoice item. If the associated charge is a one-time fee, then this date is the date of that charge.

      **Type**:

      * date: Supported as of WSDL version 69+
      * dateTime: Supported through WSDL version 68

      **Character limit:** 29

      **Version notes**:

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      SKU
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The unique SKU for the product associated with this invoice item.

      **Type**: string

      **Character limit**: 255

      **Version notes**:

      **Values**: inherited from `Product.SKU`
    </td>
  </tr>

  <tr>
    <td>
      SourceItemType
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The type of the source item.

      **Type**: string (enum)

      **Character limit**: 16

      **Version notes**: WSDL 118.0+

      **Values**: `SubscriptionComponent` , `Rounding` , `ProductRatePlanCharge` , `None` , `OrderLineItem`
    </td>
  </tr>

  <tr>
    <td>
      SubscriptionId
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of the subscription associated with the invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: inherited from `Subscription.Id`
    </td>
  </tr>

  <tr>
    <td>
      SubscriptionNumber
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The number or the name of the subscription associated with the invoice item.

      **Type**: string

      **Character limit**:

      **Version notes**: --

      **Values**:
    </td>
  </tr>

  <tr>
    <td>
      TaxAmount
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The amount of tax applied to the invoice item's charge.

      **Type**: decimal

      **Character limit**:

      **Version notes**: Requires Z-Tax or Avalara, WSDL 20.0+

      **Values**: calculated from multiple fields in the ProductRatePlanCharge object
    </td>
  </tr>

  <tr>
    <td>
      TaxCode
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Specifies the tax code for taxation rules.

      **Type**: string

      **Character limit**: 6

      **Version notes**: Requires Z-Tax or Avalara, WSDL 20.0+

      **Values**: inherited from `ProductRatePlanCharge.TaxCode`
    </td>
  </tr>

  <tr>
    <td>
      TaxExemptAmount
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The amount of the invoice item's charge that's tax exempt.

      **Type**: decimal (currency)

      **Character limit**:

      **Version notes**: Requires Z-Tax or Avalara, WSDL 20.0+

      **Values**: calculated from multiple fields in the ProductRatePlanCharge object
    </td>
  </tr>

  <tr>
    <td>
      TaxMode
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The tax mode of the invoice item.

      **Type**: string

      **Character limit**: 12

      **Version notes**: Requires Z-Tax or Avalara, WSDL 58.0+

      **Values**: `TaxExclusive` , `TaxInclusive`
    </td>
  </tr>

  <tr>
    <td>
      UnitPrice
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The per-unit price of the invoice item.

      **Type**: decimal (currency)

      **Character limit**:

      **Version notes**: type is double for WSDL 18.0 and older

      **Values**: calculated from multiple fields in ProductRatePlanCharge and ProductRatePlanChargeTier objets
    </td>
  </tr>

  <tr>
    <td>
      UOM
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Specifies the units to measure usage. Units of measure are configured in the web-based UI: **Z-Billing > Settings**

      **Type**: string

      **Character limit**:

      **Version notes**: --

      **Values**: inherited from `ProductRatePlanCharge.UOM`
    </td>
  </tr>

  <tr>
    <td>
      UpdatedById
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of the user who last updated the invoice item.

      **Type**: zns:ID

      **Character limit**: 32

      **Version notes**: --

      **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      UpdatedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The date when the invoice item was last updated.

      **Type**: dateTime

      **Character limit**: 29

      **Version notes**: --

      **Values**: automatically generated
    </td>
  </tr>
</table>