Customer Products

CustomerProducts_Query

Use to retrieve a listing of Customer Products on a customer's account or service in Rev.io.

Input Fields

Field	Type	Notes	Required?
ID	List/Integer	One or more Rev.io Customer Product IDs. Multiple Customer Product IDs can be used in one request to save round-trips.	Optional
CustomerID	List/Integer	One or more Rev.io Customer IDs. Multiple Customer IDs can be used in one request to save round-trips.	Optional
LineID	List/Integer	One or more Rev.io Service IDs. Multiple Service IDs can be used in one request to save round-trips.	Optional

Output Fields

Field	Type	Notes
Customer_Product_ID	Integer	Rev.io-generated unique identify for each Customer Product (same as ID in request)
Line_ID	Integer	Rev.io-generated ID for the Service these Customer Products are on.
Customer_ID	Integer	If you use Customer Account Numbers, this will not reflect that, but instead is the Rev.io-generated ID.
Product_ID	Integer	Every Customer Product must have a Product_ID that ties it back to the Product Catalog in Rev.io.
Description	String	Description from this item on the customer's account.
Group_On_Bill	Boolean	If True, doesn't get itemized on the customer's bill, but instead, rolls up to a service item of the Package description on the bill.
Tax_Included	Boolean	If True, taxes will be backed out of the Rate * Quantity when charged to the customer. E.g. instead of $10.00 + tax, the customer would be charged $10.00 (including $x.xx in taxes).
Quantity	Integer	Multiply Rate * Quantity to get total price for this item
Rate	Decimal	Rate you are charging the customer for this service (can be negative if this is a credit)
Cost	Decimal	Used to store your cost for providing this service
Code1	String	Product Code 1
Code2	String	Product Code 2
Billed_Through_Date	Date	Internal use mostly - date recurring billing has been processed through
Canceled_Date	Date	Typically same as disconnect date once disconnected - only time it is different is when disconnect proration is disabled on the customer's Bill Profile.
Activated_Date	Date	Effective date service started
Disconnect_Date	Date	Effective date this item was disconnected.
Status	String	One of the following values: PENDING ACTIVE DENIED DISCONNECTED
Carrier	String	Description of the Provider assigned. If this is a service you are buying from a wholesale provider, that is what goes here typically (e.g. AT&T, Verizon, Sprint, Broadvox, etc). This can also be internal systems - e.g. Metaswitch, Asterisk, LD Switch, Acme Packet, etc. When orders are created in Rev.io, they will be split up by provider so it is an important part of your workflow to have this set appropriately.
Carrier_ID	Integer	ID of above
Package	String	Description of the Package assigned if applicable. Packages are configured under Settings > Packages.
Package_ID	Integer	ID of above

CustomerProducts_Update

Input

ID As Integer – (Required) The ID of the customer product to be updated
Description As String – (Optional) The Description of the Customer Product
Code1 As String – (Optional) The Product_Code1 value (often used for provisioning)
Code2 As String – (Optional) The Product_Code2 value (often used for provisioning)
ActivatedDate As Date – (Optional) The effective activation date of the customer product to be updated. (will be effective on customer's next bill cycle)
DisconnectDate As Date – (Optional) The effective disconnect date of the customer product to be updated. (will be effective on customer's next bill cycle)
Rate As Decimal – (Optional) The rate of the customer product to be updated. (will be effective on customer's next bill cycle)
Quantity As Integer – (Optional) The quantity of the customer product to be updated. (will be effective on customer's next bill cycle)
DoNotProrateFlag As Boolean – (Optional) Overrides whether or not the customer product will prorate (from the Product-level)
Will default to product-level pro-rate flag if not specified

Output

None