Sign in
Object Queries

Retrieve an invoice item

Retrieve the details of a specific Invoice Item object.

get/object-query/invoice-items/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

The unique identifier of the invoice item.

createdByIdstring

The unique identifier of the user who created the invoice item.

createdDatestring date-time

The date and time when the invoice item was created.

updatedByIdstring

The unique identifier of the user who last updated the invoice item.

updatedDatestring date-time

The date and time when the invoice item was last updated.

invoiceIdstring

The unique identifier of the invoice to which this invoice item belongs.

invoiceScheduleIdstring

The ID of the invoice schedule associated with the rate plan charge on the subscription.

Note: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule" target="_blank">Billing Schedule</a> feature enabled.

invoiceScheduleItemIdstring

The ID of the invoice schedule item that generates this invoice item.

Note: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule" target="_blank">Billing Schedule</a> feature enabled.

ratePlanChargeIdstring

The ID of the rate plan charge associated with the invoice item.

accountingCodestring

The accounting code associated with the invoice item.

appliedToInvoiceItemIdstring

The unique ID of the invoice item that the discount charge is applied to.

chargeAmountnumber double

The amount of the charge.

Note: This amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive. This is the discount amount actually applied when the invoice item is a discount charge.

chargeDatestring date-time

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

chargeNamestring

The name of the charge.

chargeNumberstring

Number of the charge.

commitmentChargeNumberstring
commitmentChargeSegmentNumberstring
descriptionstring

The description of the invoice item.

discountAmountnumber

The amount of the discount.

excludeItemBillingFromRevenueAccountingboolean

The flag to exclude the invoice item from revenue accounting.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

fulfillmentIdstring

The reference ID of the fulfillment associated with the invoice item.

itemShipToContactIdstring

The ID of the ship-to contact associated with the invoice item.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

itemSoldToContactIdstring

The ID of the sold-to contact associated with the invoice item.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

itemSoldToContactSnapshotIdstring

The ID of the sold-to contact snapshot associated with the invoice item.

Note: If you have the Flexible Billing Attributes feature disabled, the value of this field is null.

processingType'0' | '1' | '2' | '3'

The kind of the charge for the invoice item.

  • 0: charge
  • 1: discount
  • 2: prepayment
  • 3: tax
quantitynumber

The quantity of this item, in the configured unit of measure for the charge.

reflectDiscountInNetAmountboolean

When you apply percentage discounts to either of the following charges, you need to set the reflectDiscountInNetAmount field on your discount charge to true, to enable calculating and displaying the net amount of the following charges in Zuora Revenue.

  • delivery pricing charge
  • prepayment charge
  • drawdown charge

Note the following:

  • If you are an <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> customer, when you set the reflectDiscountInNetAmount field to true, you must also set the excludeItemBillingFromRevenueAccounting field to true.
  • If you are a <a href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration" target="_blank">Billing - Revenue Integration</a> customer, you must set the reflectDiscountInNetAmount field to false, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges.
  • If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the reflectDiscountInNetAmount field to true.
revRecStartDatestring date
serviceEndDatestring date

The end date of the service period for this item, i.e., the last day of the service period, as yyyy-mm-dd.

serviceStartDatestring date

The start date of the service period for this item, as yyyy-mm-dd. For a one-time fee item, the date of the charge.

sKUstring

The SKU of the product associated with the invoice item.

sourceItemType'SubscriptionComponent' | 'Rounding' | 'ProductRatePlanCharge' | 'None' | 'OrderLineItem'

The type of the source item.

subscriptionIdstring

ID of the subscription associated with the invoice item.

subscriptionNumberstring

Number of the subscription associated with the invoice item.

taxAmountnumber double

The amount of tax applied to the charge.

taxCodestring

The tax code of the invoice item. Note Only when taxation feature is enabled, this field can be presented.

taxExemptAmountnumber
taxMode'TaxExclusive' | 'TaxInclusive'

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

unitPricenumber double

The per-unit price of the invoice item.

Note: For discount charges, this represents the discount percentage (for percentage-based discounts) or the discount amount (for fixed-amount discounts).

uOMstring

The unit of measure (UOM) that is configured in Settings > Billing for the product rate plan charge.

balancenumber

The balance of the invoice item.

Note: This field is only available if you have the Invoice Settlement feature enabled.

numberOfDeliveriesnumber

The number of deliveries dedicated to the Delivery Pricing charges. Note: This field is available only if you have the Delivery Pricing feature enabled.

accountReceivableAccountingCodeIdstring

ID of the account receivable accounting code associated with the invoice item.

Note: This field is only available if you have Zuora Finance enabled.

recognizedRevenueAccountingCodeIdstring

ID of the recognized revenue accounting code associated with the invoice item.

Note: This field is only available if you have Zuora Finance enabled.

deferredRevenueAccountingCodeIdstring

ID of the deferred revenue accounting code associated with the invoice item.

Note: This field is only available if you have Zuora Finance enabled.

contractAssetAccountingCodeIdstring

ID of the accounting code for contract asset.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

contractLiabilityAccountingCodeIdstring

ID of the accounting code for contract liability.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

contractRecognizedRevenueAccountingCodeIdstring

ID of the accounting code for contract recognized revenue.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

unbilledReceivablesAccountingCodeIdstring
adjustmentRevenueAccountingCodeIdstring

The accounting code for adjustment revenue.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

adjustmentLiabilityAccountingCodeIdstring

ID of the accounting code for adjustment liability.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

journalEntryIdstring

The ID of the journal entry that corresponds to this invoice item.

accountIdstring

The ID of the account associated with the invoice item.

billToContactSnapshotIdstring

The ID of the bill-to contact snapshot associated with the invoice.

shipToContactSnapshotIdstring

The ID of the ship-to contact snapshot associated with the invoice.

soldToContactSnapshotIdstring

The ID of the sold-to contact snapshot associated with the invoice.

parentAccountIdstring

The parent account of the account associated with the invoice.

Note: This field is available only if you have <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy" target="_blank">Customer Hierarchy</a> enabled for your tenant.

billToContactIdstring

The ID of the bill-to contact associated with the invoice.

shipToContactIdstring

The ID of the ship-to contact associated with the invoice.

soldToContactIdstring

The ID of the sold-to contact associated with the invoice.

defaultPaymentMethodIdstring

The ID of the default payment method on the associated account.

ratePlanIdstring

The ID of the rate plan that the invoice is created from.

amendmentIdstring

The ID of the amendment associated with the subscription.

Note: This field is available only if you do not have Orders enabled for your tenant.

productRatePlanChargeIdstring

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

productRatePlanIdstring

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

productIdstring

The ID of the product that the invoice item is created from.

bookingReferencestring

The booking reference of the invoice item.

itemTypestring

The type of the invoice item.

purchaseOrderNumberstring

The purchase order number associated with the invoice item.

revRecCodestring

The revenue recognition code.

revRecTriggerCondition'ContractEffectiveDate' | 'ServiceActivationDate' | 'CustomerAcceptanceDate'

The date when revenue recognition is triggered.

revenueRecognitionRuleNamestring

The revenue recognition rule of the invoice item.

Note: This field is only available if you have Zuora Finance enabled.

orderLineItemIdstring

The reference ID of the oder line item associated with the invoice item.

subscriptionOwnerIdstring

The ID of the subscription owner associated with the invoice item.

Changes