Page tree
Skip to end of metadata
Go to start of metadata

Create a new customer and order in Rev.io.

Input

  • Customer (Required Object)
    • AcctNum As String  – Optional – Custom account number.
    • AgentID As Integer– Optional - when specified, the customer created will be associated with this Agent. Cannot use with AgentNumber.
    • AgentNumber As String – Optional - when specified, the customer created will be associated with this Agent. Cannot use with AgentID.
    • BillProfileID As Integer – Optional - when specified, the customer created will be set to this Bill Profile.
    • SecurityPIN As String – Optional - when specified, the customer created will be set to use this 4-digit Security PIN for accessing the account.
    • Language As String – Optional - when specified, the customer created will be set to this Language (e.g. Spanish, English)
    • DOB As Date – Optional - when specified, the customer created will be set to this value as the Date of Birth.
    • DL As String – Optional - when specified, the customer created will be set to have this Drivers License #.
    • SSN As String – Optional - when specified, the customer created will be set to have this Social Security Number.
    • Source As String – Optional – can be used to specify the system that is entering this order. E.g. Kiosk1234, Public Website, IVR-A, etc.
    • BillMethod As Enum - Optional - Customers billing method "PRINT_ONLY", "EMAIL_ONLY", "BOTH", or "NONE". If not provided, the customer will use the bill profile's default bill method.
    • Email As String – Optional – can be used to specify customer's email address.
    • CustomerClass As Enum – Optional – can be used to specify the customer's class. Valid values are "Residential" and "Business".
    • IsParentAccount As Boolean – Optional – can be used to specify whether or not the account is created as a parent account. Cannot be passed in conjunction with ParentCustomerID.
    • ParentCustomerID As Integer – Optional – can be used to specify an existing Rev.io parent account for which this customer is to be created as a child. Cannot be passed in conjunction with IsParentAccount.
    • ContractStart As Date – Optional – can be used to set the starting date of the customer's contract.
    • ContractEnd As Date – Optional – can be used to set the ending date of the customer's contract.
    • Customer/Lifeline (Required for Lifeline Packages)
      • Status As Enum_Lifeline_Status(Optional). If not specified, will default to NEEDS_FORM if no form is given in this request, or NEEDS_REVIEW or APPROVED if form is given depending on client configuration. Possible values include:
        • NEEDS_REVIEW
        • APPROVED
        • REJECTED
        • NEEDS_FORM
      • Customer/Fields - List of customer-level custom fields.
        • Field - Individual Custom Field
        • FieldID As Integer – Custom Field ID. Not required if Label is specified.
        • Label As String – Custom Field Label. Not required if FieldID is specified, however must match actual label if specified with FieldID.
        • Value As String – Value of custom field.
      • LifelineTypeID As Integer – required when a Lifeline Package is specified on the Order. Use LifelineTypes_Query to find a valid ID.
      • SelfCertificationPDF As Byte() – optional PDF of the customer's signed Self-certification Form. The customer will be created with NEEDS_FORM by default, and if this field is populated, the Lifeline Status will be set to NEEDS_REVIEW or APPROVED, depending on Rev.io's default configuration.
      • TemporaryAddress As Boolean – required for Lifeline Customers, this field indicates the customer resides at a temporary address and will need to be verified periodically per the FCC's guidelines.
      • SeparateEconomicUnit As Boolean – required for Lifeline Customers, this field indicates the customer is a Separate Economic Unit as defined by the FCC's guidelines.
      • Tribal As Boolean – optional to mark customer as Tribal
      • CertificationDate As Date –indicates the customer's lifeline certification date or recertification date. Required only when lifeline status is "APPROVED".
      • OriginalCertificationDate As Date – Optional – indicates the customer's original lifeline certification date. If not specified, will be set to the value of the CertificationDate field.
      • ProofType ID As Integer – optional to pass the Rev.io ID for the type of proof document the customer submitted to verify Lifeline eligibility.
      • ProofIdentifyingInformation As String – optional to pass information of the proof type. For example, the last four digits of the account on the proof document supplied by the customer.
      • ProofNotes As String – optional to pass any text related to the proof document.
      • MultipleHouseholds As Boolean– optional to identify the physical address containing more than one household
      • HouseholdCount As Integer – optional number of persons in the customer's household. Must be 1 or greater.
      • AnnualIncome As Integer – optional enter annual income for customer
      • CGM_Reservation As String – optional pass the reservation CGM token from their intercompany duplicate database (IDD)
      • NLADEnrolled As Boolean – optional – Indicates that the customer was already enrolled in NLAD external from Rev.io. If "True", Rev.io will insert an enrollment record with the information given in this API call and mark the request as complete without actually sending the request to NLAD. If no active NLAD profile is setup for the customer's physical address state then this call will fail.
      • StatusNote As String – Optional - Customers can now track any time a lifeline status changes and log a record to the Customer's _History_ pane under the Lifeline_ tab on the Customer's profile when updated the V20 API.
      • TPIVStatus As Enum_TPIV_Status – Optional - Third Party Identity Verification (TPIV) Status, will be one of the values from Standard Values: Enum_TPIV_Status.
      • TaxExemptions - List of customer-level tax exemptions. Can be one or more of the values from StandardValues: CCHTaxExemption or SureTaxTaxExemptionEnum.  Not specifying this or providing an empty list will mean the customer is not tax exempt.
    • Customer/MailingAddress (Customer's billing address)
      • ID As Integer – Prohibited.
      • FirstName As String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
      • LastName As String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
      • MiddleName As String – Optional, Max Length 10 characters.
      • Suffix As String – Optional
      • CompanyName As String – Required if CustomerClass is "Business", otherwise prohibited.
      • Address1 As String – Required.
      • Address2 As String – Optional.
      • City As String – Required.
      • State As String – Required. 2 characters.
      • Zip As String – Required. 5 digits. Must be valid zip code.
      • Zip4 As String – Optional. Must be 4 digits if specified.
      • Country As String – 3 character Country ISO code. Defaults to USA if not specified.
    • Customer/PhysicalAddress (Customer's service location/tax address)
      • ID As Integer – Prohibited.
      • FirstName As String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
      • LastName As String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
      • MiddleName As String – Optional, Max Length 10 characters.
      • Suffix As String – Optional
      • CompanyName As String – Required if CustomerClass is "Business", otherwise prohibited.
      • Address1 As String – Required.
      • Address2 As String – Optional.
      • City As String – Required.
      • State As String – Required. 2 characters.
      • Zip As String – Required. 5 digits. Must be valid zip code.
      • Zip4 As String – Optional. Must be 4 digits if specified.
      • Country As String – 3 character Country ISO code. Defaults to USA if not specified.
    • Customer/Billing (Customer's billing specific information)
      • Balance As Decimal – Customer's current balance in Rev.io.
      • Due As Decimal – Amount due at the next statement.
      • Overdue As Decimal – Amount due on previous statements.
      • UnbilledUsage As Decimal – Total of unbilled customer usage.
      • EnableBalanceLimit As Boolean – Enable / Disable the customer's eligibility for suspends / restores based on balance limit
      • UsageBalanceLimit As Decimal – Customer's usage balance limit (used to trigger suspends and restores).
      • PaymentTerms As Int – Customer's payment terms in Rev.io.
      • PaymentTermsOverride As Boolean – Option on whether to override the default payment terms on the customer.
  • Order (if not specified - customer will be created in a PROSPECT status)
    • CarrierID As Integer – Optional. Cannot be used with CarrierCode. Settings > Providers.
    • CarrierCode As String – Optional. Cannot be used with CarrierID. Settings > Providers.
    • CarrierAccountID As Integer – Optional. Settings > Provider Accounts
    • PackageID As Integer – Required. Settings > Packages.
    • Description As String – Optional – Service description.
    • PBXMake As String – Optional – Make of PBX, if applicable.
    • PBXModel As String – Optional – Model of PBX, if applicable.
    • Order/ShippingAddress (Shipping Address. Conditionally required.)
      • ID As Integer – Prohibited.
      • FirstName As String – Required.
      • LastName As String – Required.
      • MiddleName As String – Optional, Max Length 10 characters.
      • Suffix As String – Optional
      • Address1 As String – Required.
      • Address2 As String – Optional.
      • City As String – Required.
      • State As String – Required. 2 characters.
      • Zip As String – Required. 5 digits. Must be valid zip code.
      • Zip4 As String – Optional. Must be 4 digits if specified.
      • Country As String – 3 character Country ISO code. Defaults to USA if not specified.
    • Order/WirelessPort (Required only when a Wireless MDN is being ported from another provider.)
      • MDN As String – Mobile Device Number (or phone number) being ported.
      • AccountNumber As String – Customer's account number with previous provider.
      • AuthorizedSigner As String – Customer's full name that has authorization to request this port.
      • PINPassword As String – Customer's password with previous provider.
      • Remark As String – General comment to be sent with the port request.
      • Address As Address – Address currently assigned to the device being ported
        • ID As Integer – Prohibited.
        • FirstName As String – Required.
        • LastName As String – Required.
        • MiddleName As String – Optional, Max Length 10 characters.
        • Suffix As String – Optional
        • Address1 As String – Required.
        • Address2 As String – Optional.
        • City As String – Required.
        • State As String – Required. 2 characters.
        • Zip As String – Required. 5 digits. Must be valid zip code.
        • Zip4 As String – Optional. Must be 4 digits if specified.
        • Country As String – 3 character Country ISO code. Defaults to USA if not specified.
      • ExternalProvider As Enum_Carrier_Code – New Provider for porting the MDN. This is required if the order is to be sent through Ready. Supplied Provider must be a wireless provider.
    • WirelessESN As String – Optional – ICCID (if provider only requires SIM card & not device), ESN (hex or decimal), or MEID (hex or decimal) of Inventory Item that is in either BATCHED1 (pre-activated) or AVAILABLE2 (not activated) status.
    • WirelessICCID As String – Optional – ICCID of Inventory Item that is to be used with associated device in WirelessESN field.  Must be in BATCHED1 (pre-activated) or AVAILABLE2 (not activated) status.  If in BATCHED1 (pre-activated) status, only the WirelessESN is used.
    • AdditionalProducts (used to specify additional products to be included as part of the order – e.g. shipping fees, connection charges, phones, etc)
      • Product (repeats)
        • ProductID As Integer – Required – Refers to an Rev.io Product ID (Settings > Products).
        • Rate As Decimal – Optional – If specified, the Product on the Order will use this rate. Otherwise, it will use the default rate from Settings > Products.
        • Quantity As Integer – Optional – If specified, the Product on the Order will use this quantity (must be greater than or equal to 1). Otherwise, a quantity of 1 is assumed.
        • Description As String – Optional – If specified, the Product on the Order will use this description. Otherwise, it will use the default description from Settings > Products.
    • LineTypeID As Integer – Optional – Settings > Service Types.
    • IsConversion As Boolean – Optional – If true, the order will be marked as a conversion order instead of the default new order. Defaults to False.
    • ProcessID As Integer – Optional – Settings > Processes.
    • ReconnectTN As String – Optional – When specified, the service will be created with the specified TN and the resulting order will be marked as a reconnect order.
  • SendOrders As Boolean – Optional – if set to True, will send any resultant orders to the provider immediately instead of waiting for flow-through to send.  Defaults to False.

Note 1:

If WirelessESN is specified, and the Inventory Item it references is in BATCHED status, the Inventory Item will be assigned to the Customer's account, and the MDN from this device on the batch will be assigned to the service.

Note 2:

If WirelessESN is specified and the Inventory Item it references is in AVAILABLE status, the Inventory Item will be assigned to the Customer's account, and the orders created will be set to Flow Through if possible to send to the respective providers/downstream systems.

  • You can poll Customers_Query to check the Customer's status and retrieve the MDN/MSID once completed, or you can poll Orders_Search or Orders_Query to check the status of the individual orders to know when it is completed, if needed.
  • Take into consideration, an activation order could result in an error and require an automatic resend by Rev.io or manual intervention by a provisioning rep, so there will be times when the order does not complete right away.

Output

  • Customer_ID As Integer
  • Orders – List of orders created by this request.
    • Order As Integer
  • Lines – List of services created by this request.
    • Line As Integer
  • Products – List of products added to the customer after creation
    • Product
      • ProductID As Integer – The Rev.io Product ID
      • ProductGroupID As Integer – The Rev.io product group ID if the product was added as part of a group. Otherwise the product group ID will be 0.
      • LeadProductFlag As Boolean – Indicates if the product is the lead product of a product group.
  • BillMethod As Enum - Customers billing method "PRINT_ONLY", "EMAIL_ONLY", "BOTH", or "NONE"
  • No labels