Invoice items are the line items contained in the invoices that you send to your customers. For more information about invoices, see Invoices.
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.
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 do not need to set this header.
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 (').
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/invoice-item/{id}
curl -i -X GET \
'https://rest.zuora.com/v1/object/invoice-item/{id}?fields=string' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'X-Zuora-WSDL-Version: 79' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string'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/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
The accounting code for the item's charge. Accounting codes group transactions that contain similar accounting attributes. Character limit: 100 Values: inherited from RatePlanCharge.AccountingCode
Associates a discount invoice item to a specific invoice item.
Character limit: 32
Values: inherited from InvoiceItem.Id for the invoice item that the discount charge is applied to
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. Character limit: Values: automatically calculated from multiple fields in multiple objects
The date when the Invoice Item is created . Character limit: 29 Values: automatically generated
The name of the invoice item's charge. Character limit: 50 **Values: **inherited from RatePlanCharge.Name
The user ID of the person who created the invoice item. Character limit: 32 Values: automatically generated
The date the invoice item was created. Character limit: 29 Values: automatically generated
Whether excluding item from revenue accounting. The flag to exclude non-revenue related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. Note: This field is only available if you have the RevPro Integration feature enabled. And you must set the X-Zuora-WSDL-Version request header to 116 or later. Otherwise, an error occurs. Character limit: 8 Values: Default value is false, inherited from order line item.
The ID of the invoice that's associated with this invoice item. Character limit: 32 Values: inherited from Invoice.Id
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. Character limit: **Values: **
- 0: charge
- 1: discount
- 2: prepayment
- 3: tax
A description of the product associated with this invoice item.
Character limit: 500
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.
The name of the product associated with this invoice item.
Character limit: 255
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.
The number of units for this invoice item. Values: inherited from RatePlanCharge.Quantity
The ID of the rate plan charge that's associated with this invoice item. Character limit: 32 Values: inherited from RatePlanCharge.Id
The date when revenue recognition is triggered. Character limit: 29 Values: generated from InvoiceItem.RevRecTriggerCondition
The unique SKU for the product associated with this invoice item. Character limit: 255 Values: inherited from Product.SKU
The end date of the service period associated with this invoice item. Service ends one second before the date in this value. Character limit: 29 Values: automatically generated
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. Character limit: 29 Values: automatically generated
The type of the source item. Note: To use this field, you must set the X-Zuora-WSDL-Version request header to 118 or later. Otherwise, an error occurs. Character limit: 16 Values: one of the following enum values:
SubscriptionComponent
Rounding
ProductRatePlanCharge
None
OrderLineItem
The ID of the subscription associated with the invoice item. Character limit: 32 Values: inherited from Subscription.Id
The amount of tax applied to the invoice item's charge. Character limit: Values: calculated from multiple fields in the ProductRatePlanCharge object
Specifies the tax code for taxation rules. Character limit: 6 Values: inherited from ProductRatePlanCharge.TaxCode
The calculated tax amount excluded due to the exemption. Character limit: Values: calculated from multiple fields in the ProductRatePlanCharge object
The tax mode of the invoice item. Character limit: 12 Values: TaxExclusive, TaxInclusive
Specifies the units to measure usage. Character limit: Values: inherited from ProductRatePlanCharge.UOM
The per-unit price of the invoice item. Character limit: Values: calculated from multiple fields in ProductRatePlanCharge and ProductRatePlanChargeTier objets
The ID of the user who last updated the invoice item. Character limit: 32 Values: automatically generated
The date when the invoice item was last updated. Character limit: 29 Values: automatically generated
ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Status of the invoice item's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Date when the invoice item was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Custom fields of the Invoice Item object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.
{ "ServiceEndDate": "2016-10-20", "Id": "2c93808457d787030157e03089c03c3b", "ChargeDate": "2016-10-20T05:44:19.000+02:00", "AccountingCode": "Accounts Receivable", "UnitPrice": 10, "SubscriptionId": "2c93808457d787030157e03088bf3c24", "ProcessingType": 0, "Quantity": 1, "ChargeAmount": 10, "ServiceStartDate": "2016-10-20", "CreatedById": "2c93808457d787030157e03071873a9a", "CreatedDate": "2016-10-20T05:44:19.000+02:00", "TaxAmount": 0, "ChargeName": "OneTime_Flat Fee Pricing1476935059154", "SKU": "API-SKU1476935058740", "SourceItemType": "SubscriptionComponent", "UpdatedDate": "2016-10-20T05:44:21.000+02:00", "UpdatedById": "2c93808457d787030157e03071873a9a", "TaxExemptAmount": 0, "excludeItemBillingFromRevenueAccounting": true, "InvoiceId": "2c93808457d787030157e03089bb3c39", "ProductDescription": "Create product via API", "RatePlanChargeId": "2c93808457d787030157e03088ec3c2d" }