Charge Fields
| Property | Type | Description |
|---|---|---|
quantity | Decimal | The quantity of the subscription product or purchase being charged for |
unitPrice | Decimal | The price per unit of quantity |
amount | Decimal | The total amount of the charge, not including any discounts |
name | String | The name of the line item |
description | String | The description of the line item |
glCode | String | The general ledger code for this transaction |
effectiveTimestamp | Timestamp | The effective time of the transaction. |
proratedUnitPrice | Decimal | The price per unit of quantity if the charge is subject to proration. |
startServiceDate | Timestamp | The date the associated service starts. |
endServiceDate | Timestamp | The date the associated service ends. |
rangeQuantity | Integer | For non standard pricing, indicates the value used to calculate the price per unit |
isReversable | Boolean | Indicates whether the charge can be reversed. |
discount | Object. Definition below | Deprecated. Use discounts instead |
discounts | List of Objects. Definition below | A list of the discounts applied to the line item at the point of charge. |
subscriptionProduct | Object. Defined below | Contains an id and uri that references the subscription product this charge is associated with. This is null if the charge is not associated with a subscription product. |
purchase | Object. Defined below | Contains an id and uri that references the purchase this charge is associated with. This is null if the charge is not associated with the direct purchase of a purchasable product. |
chargeTiers | List of Objects. Defined below | If the charge was based on a subscription product or purchase using the Tiered pricing model, then this list breaks down the charge into its tiers |
netsuiteChargeItem | String | The Item in NetSuite this charge relates to. Based on the value in the underlying product's netsuiteItemId. For the NetSuite plugin. |
id | Integer | The Fusebill generated ID for this transaction |
Discount
| Property | Type | Description |
|---|---|---|
configuredDiscountAmount | Decimal | The dollar amount or percentage configured for the discount, depending on discountType |
amount | Decimal | The total amount discounted off the charge by this discount |
quantity | Decimal | The number of times this discount was applied to this charge. |
unearnedAmount | Decimal | The amount of this discount remaining to be earned |
remainingReversalAmount | Decimal | The amount of this discount that can still be reversed |
discountType | Enum: {Percentage, Amount, AmountPerUnit} | Indicates how configuredDiscountAmount is interpreted for calculating the discount |
description | String | The label for this discount on the invoice. Typically something like "30% off Product Name" |
Subscription Product
| Property | Type | Description |
|---|---|---|
items | List of Objects. See Tracking; Tracked Items Object for details | If the subscription product that generated this charge is tracking quantities, then this is the list of tracked items that contributed to the charge |
id | Integer | The Fusebill generated ID of the subscription product that generated this charge |
uri | String | The full string path to the subscription product which generated this charge |
Purchase
| Property | Type | Description |
|---|---|---|
items | List of Objects. See Tracking; Tracked Items Object for details | If the purchase that generated this charge is tracking quantities, then this is the list of tracked items that contributed to the charge |
id | Integer | The Fusebill generated ID of the purchase that generated this charge |
uri | String | The full string path to the purchase which generated this charge |
Charge Tier
| Property | Type | Description |
|---|---|---|
label | String | The label of the charge tier e.g. "0-3", ">3-6", ">6" |
quantity | Decimal | How much of the charge's quantity is portioned to this tier |
unitPrice | Decimal | The price per unit of quantity in this tier |
amount | Decimal | The amount charged for this tier. This is the quantity multiplied by the unitPrice |