OrderItem
Version: 1.33
Parameters
Extends: BaseOrderItem
| Element | Type | Required? | Description |
|---|---|---|---|
|
product |
product |
Yes |
The product that makes up this orderitem. |
|
priceList |
priceList |
|
The pricelist, if applicable. |
|
selectedAgreement |
Agreement |
The agreement, if applicable. |
|
|
serviceResources |
serviceResources |
The service resource, if applicable. |
|
|
inventoryItem |
ServiceDeviceInventoryItem |
The inventory item, if applicable. |
|
|
parentService |
Service |
The parent service, if applicable. |
|
|
operationAttributes |
operationAttributes |
Any attributes to use for actions or operations. |
|
|
agreementConfiguration |
agreementConfiguration |
Details of the agreement, if one exists. |
|
|
scheduledCharges |
scheduledCharges |
Any scheduled charges associated with this item. |
|
|
customFieldValues |
customFieldValues |
Any custom field values associated with this item. |
|
|
discountConfigurations |
discountConfigurations |
Discount information, if applicable. |
|
|
scheduledOneTimePriceCharges |
scheduledOneTimePriceCharges |
Any one time charges, if applicable. |
|
|
addresses |
Service address, if applicable. |
| Attribute | Required? | Datatype | Description |
|---|---|---|---|
|
awaitingApproval |
boolean |
Is this item awaiting an approval? |
|
|
requestedEffectiveDate |
dateTime |
Effective date, if future date is desired. |
|
|
overrideTrialDays |
intreger |
Number of days to enable the trial, if this product is a trial product. |
|
|
firstPeriodEndDate |
dateTime |
The end date for the first service period. Used to align service periods. |
|
|
fundPrepaidBalance |
boolean |
Whether to add funds to prepaid balance. This amount can be positive or negative. |
|
|
consumePrepaidBalance |
boolean |
Whether to consume funds from a prepaid balance. This amount can be positive or negative. |
Querying OrderItem
For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.
| Key | Type |
|
eid |
Long |
|
parentOrderItemEid |
Long |
|
orderEid |
Long |
|
serviceEid |
Long |
|
orderNum |
String |
|
serviceIdentifier |
String |
|
discountIdentifier |
String |
|
productEid |
Long |
|
status |
OrderItemStatus |
|
productTypeCode |
ProductTypeCode |
|
billingAccountEid |
Long |
REST Endpoints
|
getOrderItems |
GET |
https://my.tractbilling.com/t/s/r/1.33/orderItems |
|
cancelOrderItemScheduledCharges |
POST |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid}/cancelScheduledCharges |
|
approve |
POST |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid}/approve |
|
getOrderItem |
GET |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid} |
|
changeOrderItemOneTimePriceCharges |
POST |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid}/changeScheduledOneTimePriceCharges |
|
changeOrderItemServicePriceCharges |
POST |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid}/changeScheduledCharges |
|
deny |
POST |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid}/deny |
|
addAdjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/orderItems/{eid}/addAdjustment |