accounting_code |
String |
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` |
[optional] |
applied_to_charge_number |
String |
The charge number that the discount charge is applied to. This field is only for the invoice items that are discount charges. This field is only returned in subscription previews. This field will be returned in the response if you specify the charge number in the rate plan charges in the request. Character limit: 32 Values: inherited from `RatePlanCharge.ChargeNumber` for the charge associated with the invoice item that the discount charge is applied to |
[optional] |
applied_to_invoice_item_id |
String |
Associates a discount invoice item to a specific invoice item. Character limit: 32 Values: inherited from the ID of the charge that a discount applies to |
[optional] |
charge_amount |
Float |
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 |
[optional] |
charge_date |
DateTime |
The date when the Invoice Item is created . Character limit: 29 Values: automatically generated |
[optional] |
charge_description |
String |
A description of the invoice item's charge. Character limit: 500 Values: inherited from `RatePlanCharge.Description` |
[optional] |
charge_id |
String |
The ID of the rate plan charge that is associated with this invoice item upon object creation. Character limit: 32 Values: inherited from `RatePlanCharge.Id` |
[optional] |
charge_name |
String |
The name of the invoice item's charge. Character limit: 50 **Values: **inherited from `RatePlanCharge.Name` |
[optional] |
charge_number |
String |
The unique identifier of the invoice item's charge. Character limit: 50 Values: inherited from `RatePlanCharge.ChargeNumber` |
[optional] |
charge_type |
String |
Specifies the type of charge. Character limit: 9 Values: one of the following: - `OneTime` - `Recurring` - `Usage` |
[optional] |
created_by_id |
String |
The user ID of the person who created the invoice item. Character limit: 32 Values: automatically generated |
[optional] |
created_date |
DateTime |
The date the invoice item was created. Character limit: 29 Values: automatically generated |
[optional] |
invoice_id |
String |
The ID of the invoice that's associated with this invoice item. Character limit: 32 Values: inherited from `Invoice.Id` |
[optional] |
processing_type |
Float |
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 |
[optional] |
product_description |
String |
A description of the product associated with this invoice item. Character limit: 500 Values: inherited from `Product.Description` |
[optional] |
product_id |
String |
The ID of the product associated with this invoice item. Character limit: 32 Values: inherited from `Product.Id` |
[optional] |
product_name |
String |
The name of the product associated with this invoice item. Character limit: 255 **Values: **inherited from `Product.Name` |
[optional] |
product_rate_plan_charge_id |
String |
The ID of the rate plan charge that's associated with this invoice item. Character limit: 32 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. |
[optional] |
quantity |
Float |
The number of units for this invoice item. Values: inherited from `RatePlanCharge.Quantity` |
[optional] |
rate_plan_charge_id |
String |
The ID of the rate plan charge that's associated with this invoice item. Character limit: 32 Values: inherited from `RatePlanCharge.Id` |
[optional] |
rev_rec_code |
String |
Associates this invoice item with a specific revenue recognition code. Character limit: 32 Values: inherited from `ProductRatePlanCharge.RevRecCode` |
[optional] |
rev_rec_start_date |
Date |
The date when revenue recognition is triggered. Character limit: 29 Values: generated from `InvoiceItem.RevRecTriggerCondition` |
[optional] |
rev_rec_trigger_condition |
String |
Specifies when revenue recognition begins based on a triggering event. Character limit: Values: inherited from `ProductRatePlanCharge`.`RevRecTriggerCondition` |
[optional] |
sku |
String |
The unique SKU for the product associated with this invoice item. Character limit: 255 Values: inherited from `Product.SKU` |
[optional] |
service_end_date |
Date |
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 |
[optional] |
service_start_date |
Date |
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 |
[optional] |
subscription_id |
String |
The ID of the subscription associated with the invoice item. Character limit: 32 Values: inherited from `Subscription.Id` |
[optional] |
subscription_number |
String |
The number of the subscription associated with the invoice item. Character limit: Values: |
[optional] |
tax_amount |
Float |
The amount of tax applied to the invoice item's charge. Character limit: Values: calculated from multiple fields in the ProductRatePlanCharge object |
[optional] |
tax_code |
String |
Specifies the tax code for taxation rules. Character limit: 6 Values: inherited from `ProductRatePlanCharge.TaxCode` |
[optional] |
tax_exempt_amount |
Float |
The amount of the invoice item's charge that's tax exempt. Character limit: Values: calculated from multiple fields in the ProductRatePlanCharge object |
[optional] |
tax_mode |
String |
The tax mode of the invoice item. Character limit: 12 Values: `TaxExclusive`, `TaxInclusive` |
[optional] |
uom |
String |
Specifies the units to measure usage. Units of measure are configured in the web-based UI: Z-Billing > Settings Character limit: Values: inherited from `ProductRatePlanCharge.UOM` |
[optional] |
unit_price |
Float |
The per-unit price of the invoice item. Character limit: Values: calculated from multiple fields in ProductRatePlanCharge and ProductRatePlanChargeTier objets |
[optional] |
updated_by_id |
String |
The ID of the user who last updated the invoice item. Character limit: 32 Values: automatically generated |
[optional] |
updated_date |
DateTime |
The date when the invoice item was last updated. Character limit: 29 Values: automatically generated |
[optional] |