Retrieve an invoice item

GET

/object-query/invoice-items/:key

GET

/object-query/invoice-items/:key

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.object_queries.query_invoice_item_by_key(
    key="key",
    fields_array=[
        "id,createddate"
    ],
)

{
  "id": "8ad0875995cd65b60195cd7b76771f13",
  "createdById": "2c92c0f972a852360172bbe22ac551b6",
  "createdDate": "2025-03-25T06:26:15-07:00",
  "updatedById": "2c92c0f972a852360172bbe22ac551b6",
  "updatedDate": "2025-03-25T06:26:16-07:00",
  "invoiceId": "8ad0875995cd65b60195cd7b76621f03",
  "ratePlanChargeId": "f94fb52490e95cd65925cd7b737600c1",
  "accountingCode": "Subscription Revenue",
  "appliedToInvoiceItemId": "8ad0875995cd65b60195cd7b76771f12",
  "chargeAmount": -200,
  "chargeDate": "2025-03-25T06:26:15-07:00",
  "chargeName": "Percentage discount",
  "chargeNumber": "C-00000522",
  "description": "",
  "discountAmount": 0,
  "excludeItemBillingFromRevenueAccounting": false,
  "itemSoldToContactId": "2c92c0f87270a5970172747e28aa5e67",
  "processingType": "1",
  "quantity": 1,
  "reflectDiscountInNetAmount": false,
  "serviceEndDate": "2025-02-28",
  "serviceStartDate": "2025-02-01",
  "sKU": "SKU-001",
  "sourceItemType": "SubscriptionComponent",
  "subscriptionId": "f94fb52490e95cd65925cd7b737400bd",
  "subscriptionNumber": "A-S00000159",
  "taxAmount": 0,
  "taxExemptAmount": 0,
  "unitPrice": 20,
  "uOM": "",
  "balance": 0,
  "numberOfDeliveries": 0,
  "accountReceivableAccountingCodeId": "2c92c0f86cccaa59016cd5e108bf1206",
  "recognizedRevenueAccountingCodeId": "2c92c0f86cccaa59016cd5e125691213",
  "deferredRevenueAccountingCodeId": "2c92c0f86cccaa59016cd5e125691213",
  "accountId": "2c92c0f87270a5970172747e289a5e66",
  "billToContactId": "2c92c0f87270a5970172747e28aa5e67",
  "soldToContactId": "2c92c0f87270a5970172747e28aa5e67",
  "defaultPaymentMethodId": "2c92c0f872bc58ec0172c06fe2f07422",
  "ratePlanId": "f94fb52490e95cd65925cd7b73df00c6",
  "productRatePlanChargeId": "f94f16628be952195f3522404efb0010",
  "productRatePlanId": "f94fbebf61e952182765223a7a1d0000",
  "productId": "8ad08ea194da7ba00194df52a41f04c6",
  "subscriptionOwnerId": "2c92c0f87270a5970172747e289a5e66"
}

Retrieve the details of a specific Invoice Item object.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

keystringRequired

Object ID or Number.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org 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.

Query parameters

pageSizeintegerOptional1-99Defaults to 10

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.

cursorstringOptional

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[]list of stringsOptional

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[]list of enumsOptional

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

filter[]list of stringsOptional

A case-insensitive filter on the list.

fields[]list of stringsOptional

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

includeNullFieldsbooleanOptionalDefaults to false

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.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

idstringOptional

The unique identifier of the invoice item.

createdByIdstringOptional

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

createdDatedatetimeOptional

The date and time when the invoice item was created.

updatedByIdstringOptional

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

updatedDatedatetimeOptional

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

invoiceIdstringOptional

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

invoiceScheduleIdstringOptional

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 Billing Schedule feature enabled.

invoiceScheduleItemIdstringOptional

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

Note: This field is available only if you have the Billing Schedule feature enabled.

ratePlanChargeIdstringOptional

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

accountingCodestringOptional

The accounting code associated with the invoice item.

appliedToInvoiceItemIdstringOptional

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

chargeAmountdoubleOptional

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.

chargeDatedatetimeOptional

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

chargeNamestringOptional

The name of the charge.

chargeNumberstringOptional

Number of the charge.

commitmentChargeNumberstringOptional

commitmentChargeSegmentNumberstringOptional

descriptionstringOptional

The description of the invoice item.

discountAmountdoubleOptional

The amount of the discount.

excludeItemBillingFromRevenueAccountingbooleanOptional

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.

fulfillmentIdstringOptional

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

itemShipToContactIdstringOptional

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.

itemSoldToContactIdstringOptional

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.

itemSoldToContactSnapshotIdstringOptional

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.

processingTypeenumOptional

The kind of the charge for the invoice item.

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

Allowed values:

quantitydoubleOptional

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

reflectDiscountInNetAmountbooleanOptionalDefaults to false

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 Order to Revenue customer, when you set the reflectDiscountInNetAmount field to true, you must also set the excludeItemBillingFromRevenueAccounting field to true.
If you are a Billing - Revenue Integration 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.

revRecStartDatedateOptional

serviceEndDatedateOptional

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

serviceStartDatedateOptional

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.

sKUstringOptional

The SKU of the product associated with the invoice item.

sourceItemTypeenumOptional

The type of the source item.

Allowed values:

subscriptionIdstringOptional

ID of the subscription associated with the invoice item.

subscriptionNumberstringOptional

Number of the subscription associated with the invoice item.

taxAmountdoubleOptional

The amount of tax applied to the charge.

taxCodestringOptional

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

taxExemptAmountdoubleOptional

taxModeenumOptional

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

Allowed values:

unitPricedoubleOptional

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

uOMstringOptional

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

balancedoubleOptional

The balance of the invoice item.

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

numberOfDeliveriesdoubleOptional

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

accountReceivableAccountingCodeIdstringOptional

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

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

recognizedRevenueAccountingCodeIdstringOptional

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

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

deferredRevenueAccountingCodeIdstringOptional

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

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

contractAssetAccountingCodeIdstringOptional

ID of the accounting code for contract asset.

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

contractLiabilityAccountingCodeIdstringOptional

ID of the accounting code for contract liability.

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

contractRecognizedRevenueAccountingCodeIdstringOptional

ID of the accounting code for contract recognized revenue.

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

unbilledReceivablesAccountingCodeIdstringOptional

adjustmentRevenueAccountingCodeIdstringOptional

The accounting code for adjustment revenue.

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

adjustmentLiabilityAccountingCodeIdstringOptional

ID of the accounting code for adjustment liability.

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

journalEntryIdstringOptional

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

accountIdstringOptional

The ID of the account associated with the invoice item.

billToContactSnapshotIdstringOptional

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

shipToContactSnapshotIdstringOptional

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

soldToContactSnapshotIdstringOptional

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

parentAccountIdstringOptional

The parent account of the account associated with the invoice.

Note: This field is available only if you have Customer Hierarchy enabled for your tenant.

billToContactIdstringOptional

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

shipToContactIdstringOptional

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

soldToContactIdstringOptional

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

defaultPaymentMethodIdstringOptional

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

ratePlanIdstringOptional

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

amendmentIdstringOptional

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.

productRatePlanChargeIdstringOptional

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

productRatePlanIdstringOptional

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

productIdstringOptional

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

bookingReferencestringOptional

The booking reference of the invoice item.

itemTypestringOptional

The type of the invoice item.

purchaseOrderNumberstringOptional

The purchase order number associated with the invoice item.

revRecCodestringOptional

The revenue recognition code.

revRecTriggerConditionenumOptional

The date when revenue recognition is triggered.

Allowed values:

revenueRecognitionRuleNamestringOptional

The revenue recognition rule of the invoice item.

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

orderLineItemIdstringOptional

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

subscriptionOwnerIdstringOptional

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

invoiceobjectOptional

subscriptionobjectOptional

taxationItemslist of objectsOptional

ratePlanChargeobjectOptional

orderLineItemobjectOptional

subscriptionOwnerobjectOptional

Errors

4XX

Client Request Error

500

Internal Server Error