InvoiceItem
From API Documentation
This object is a line item of an invoice, detailing a specific charge.
Fields
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name | Required? | Type | Allowed Operations: ● Yes ○ No | Allowable Values | Description |
|---|---|---|---|---|---|
| AccountingCode | No | string | ○ Create
● Query | 255 characters maximum | This can be used to enter your accounting code for this charge. |
| ChargeAmount | Yes. System generated. | double (v1.0-18.0) / decimal (v19.0+) | ○ Create
● Query | A valid amount | The amount being charged for this invoice item. Does not include TaxAmount. |
| ChargeDate | Yes. System generated. | dateTime | ○ Create
● Query | A valid date and time | The date on which the charge is being made. |
| ChargeDescription | No | string | ○ Create
● Query | This is a read-only field | A description of the charge inherited from the product rate plan charge. |
| ChargeName | See description | string | ○ Create
● Query | 50 characters | This read-only field is the name of the charge, inherited from the rate plan charge. This can be null if the product charge has it null. |
| ChargeNumber | Yes | string | ○ Create
● Query | This is automatically generated | The number of the charge, inherited from the rate plan charge. This is set at the product catalog level; by default it is an auto-increment sequence. |
| CreatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | This field is not editable. 32 characters maximum. | Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who created the object. |
| CreatedDate | System generated, always exists | dateTime | ○ Create
● Query | This field is not editable. | Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was first created. |
| InvoiceId | Yes. System generated. | zns: ID | ○ Create
● Query | A valid ID for an invoice | The ID of the invoice that this item is associated with. |
| ProcessingType | No | decimal | ○ Create
● Query | 0, 1, 2, 3 | Use this field to identify charges that are discounts or charges. Specify one of the following values:
|
| ProductDescription | No | string | ○ Create
● Query | 255 characters maximum | A description of the product for this invoice line item. This is inherited from the product catalog or subscription. |
| ProductId | Yes | zns:ID | ○ Create
● Query | A valid ID for a product | The ID of the product for this invoice item. This is inherited from the product catalog or subscription. |
| ProductName | Yes | string | ○ Create
● Query | 255 characters maximum | The name of the product that the charge belongs to. This is inherited from the product. |
| Quantity | No | double (v1.0-18.0) / decimal (v19.0+) | ○ Create
● Query | This is a read-only field | The number of units (quantity) for this invoice item. This read-only field is inherited from the rate plan charge or usage data |
| RatePlanChargeId | Yes | zns: ID | ○ Create
● Query | A valid ID for a rate plan charge | The ID of the rate plan charge for this invoice item. This is inherited from the rate plan charge. |
| RevRecCode | No | string | ○ Create
● Query | A valid code. 70 characters maximum. | This is the revenue recognition code as taken from your accounting system, if you have enabled integration with that system using the Admin settings. |
| RevRecStartDate | No | dateTime | ○ Create
● Query | A valid date and time | This value is derived fromRevRecTriggerCondition. It is the revenue recognition start date as taken from your accounting system, if you have enabled integration with that system using the Admin settings. |
| RevRecTriggerCondition | No | string | ○ Create
● Query | Allowable values are defined in the Admin interface | The revenue recognition trigger condition as taken from your accounting system, if you have enabled integration with that system using the Admin settings. |
| ServiceEndDate | See description | dateTime | ○ Create
● Query | A valid date and time | The ending date for the period for which the item is being billed for. It is required only for recurring and usage charges, not for one-time charges. |
| ServiceStartDate | Yes | dateTime | ○ Create
● Query | A valid date and time | The starting date for the period for which the item is being billed for. For one-time charges, this is the date of the charge. |
| SKU | No | string | ○ Create
● Query | 255 characters maximum | Provides the SKU for the specific product for this invoice item. |
| SubscriptionId | Yes | zns:ID | ○ Create
● Query | A valid ID for a subscription | The ID of the subscription to which this invoice item applies. This is inherited from the subscription. |
| SubscriptionNumber | No | string | ○ Create
● Query | This is inherited from the associated subscription | This is inherited from the associated subscription for this invoice item's invoice. |
| TaxAmount | No. System generated, read only | Decimal | ○ Create
● Query | Valid currency amount | Available in version 20.0. The amount of taxes applied to the invoice item. Only available to Z-Tax customers. |
| TaxCode | No. System generated, read only | String | ○ Create
● Query | Valid tax code, 64 characters maximum | Available in version 20.0. The tax code that applies the invoice item. |
| TaxExemptAmount | No. System generated, read only | Decimal | ○ Create
● Query | Valid currency amount | Available in version 20.0. The amount of the line item that is tax exempt. Only available to Z-Tax customers. |
| UnitPrice | Yes | double (v1.0-18.0) / decimal (v19.0+) | ○ Create
● Query | A valid currency amount | The per-unit price for this invoice item. This is inherited from the subscription. |
| UOM | No | string, 255 characters maximum | ○ Create
● Query | Allowable values are defined in the Admin interface | The unit of measure being used for this invoice item. This is inherited from the subscription. |
| UpdatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | This field is not editable. 32 characters maximum. | Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object. |
| UpdatedDate | System generated, always exists | dateTime | ○ Create
● Query | This field is not editable. | Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was last updated. |
