HomeGuidesAPI ExplorerAnnouncements
Guides
AboutContactRev.io
Start typing to search…

Customers

📘

For information about Customers in Rev.io, please see Customer Relationship Management in the Rev.io Help Center.

Customers_Query

Looks up a customer in Rev.io.

Input

  • Choice of:
  • CustomerIDAs Integer – ID of customer to lookup.
  • TNAs String – TN of service on customer's account.
  • Inventory – Object describing an inventory item associated with a customer.
    • IdentifierAs String – Inventory identifier of inventory.
    • TypeAs String – Optional. Type of inventory item. Must be "Mobile_Device" or "SIM_Card". If not specified, will assume "Mobile_Device".

Output

  • Customer
  • IDAs Integer – Customer ID
  • AcctNumAs String – Custom account number
  • AgentIDAs Integer – Agent ID
  • AgentNumberAs Integer – Agent account number of associated agent id.
  • BIllProfileIDAs Integer – ID of customer's bill profile.
    • CustomerClassAs Enum – Customers class, either "Residential" or "Business"
    • BillMethodAs Enum – Customers billing method "PRINT_ONLY", "EMAIL_ONLY", "BOTH", or "NONE"
    • IsParentAccountAs Boolean – Indicates if the customer is a parent account.
    • ParentAccountIDAs Integer – Indicates if the customer is a child account of another Rev.io customer.
    • ContractStartAs Date – the starting date of the customer's contract.
    • ContractEndAs Date – the ending date of the customer's contract.
    • SecurityPINAs String – Customer's security pin.
    • LanguageAs String – Customer's preferred language.
    • PhysicalAddress – Customer's physical (service) address.
    • IDAs Integer – Internal address id of address.
    • FirstNameAs String – Customer's first name (if CustomerClass is "Residential").
    • LastNameAs String – Customer's last name (if CustomerClass is "Residential") and Customer's second last name Concatenated.
    • MiddleNameAs String – Customer's middle name (if CustomerClass is "Residential").
    • SuffixAs String – Customer's name suffix (if CustomerClass is "Residential").
    • CompanyNameAs String – Customer's name suffix (if CustomerClass is "Residential").
    • Address1As String – Customer's address, first line.
    • Address2As String – Customer's address, second line.
    • CityAs String – Customer's city
    • StateAs String – Customer's State
    • ZipAs String – Customer's zip code (first 5 digits only).
    • Zip4As String – Customer's +4 portion of zip code.
    • CountryAs String – 3 character Country ISO code.
    • MailingAddress – Customer's mailing (billing) address.
    • IDAs Integer – Internal address id of address.
    • FirstNameAs String – Customer's first name (if CustomerClass is "Residential").
    • LastNameAs String – Customer's last name (if CustomerClass is "Residential") and Customer's second last name Concatenated.
    • MiddleNameAs String – Customer's middle name (if CustomerClass is "Residential").
    • SuffixAs String – Customer's name suffix (if CustomerClass is "Residential").
    • CompanyNameAs String – Customer's company name (if CustomerClass is "Business").
    • Address1As String – Customer's address, first line.
    • Address2As String – Customer's address, second line.
    • CityAs String – Customer's city
    • StateAs String – Customer's State
    • ZipAs String – Customer's zip code (first 5 digits only).
    • Zip4As String – Customer's +4 portion of zip code.
    • CountryAs String – 3 character Country ISO code.
    • Customer/Billing (Customer's billing specific information)
    • BalanceAs Decimal – Customer's current balance in Rev.io.
    • DueAs Decimal – Amount due at the next statement.
    • OverdueAs Decimal – Amount due on the previous statement.
    • UnbilledUsageAs Decimal – Total of unbilled customer usage.
    • EnabledBalanceLimitAs Boolean – Enables / Disables the customer's eligibility to be suspended or restored based on balance
    • UsageBalanceLimitAs Decimal – Customer's usage balance limit (used to trigger suspends and restores).
    • PaymentTermsAs Int – Customer's payment terms in Rev.io.
    • PaymentTermsOverrideAs Boolean – Option on whether to override the default payment terms on the customer.
  • DOBAs Date – Customer's date of birth.
  • DLAs String – Customer's driver's license number.
  • SSNAs String – Customer's social security number.
  • EmailAs String – Customer's email address.
  • IsAutoDebit – The flag that specifies whether the customer has AutoDebit enabled.
  • AutoPaymentAccountID – The Payment Account used for AutoDebit.
  • AutoDebitDay – The day of the month when the AutoDebit takes place. If 0, then the AutoDebit takes place on the Due Date.
  • LifeLine – Customer's lifeline information if applicable.
    • LifelineTypeIDAs Integer – Lifeline Type ID of customer.
    • SelfCertificationPDFAs Byte – Not used in response.
    • TemporaryAddressAs Boolean – ndicates if the customer's physical address is temporary.
    • SeparateEconomicUnitAs Boolean – Indicates if customer is classified as a "Separate Economic Unit".
    • TribalAs Boolean – Indicates if customer is a Tribal lifeline customer.
    • ProofTypeIDAs Integer – Lifeline proof type
    • ProofIdentifyingInformationAs String – Lifeline proof identifying information.
    • ProofNotesAs String – Lifeline proof notes.
    • StatusAs Enum_Lifeline_Status – Current lifeline status. Could be any of the following:
      • NOT_SET – Lifeline status has not been set (should not be returned in practice, however it is the default value).
      • NEEDS_FORM – Customer needs lifeline form.
      • NEEDS_REVIEW – Customer's lifeline form needs to be reviewed.
      • APPROVED – Customer's lifeline form/information has been approved.
      • REJECTED – Customer's lifeline form/information has been rejected.
    • MultipleHouseholdsAs Boolean – There are multiple households at the customer's address.
    • ProofDocumentationPDFAs Byte – Not used in response.
    • HouseholdCountAs Integer – The number of people living in the customer's household.
    • AnnualIncomeAs Decimal – The customer's annual income in dollars.
    • CertificationDateAs Date – The customer's current certification date.
    • OriginalCertificationDateAs Date – The date the customer was first certified for lifeline.
    • TPIVStatusAs Enum_TPIV_Status – Current 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. If not returned / empty, the customer is not tax exempt.
  • Services – list of ServiceItems associated with the customer.

Customers_Update

Updates a customer in Rev.io.

Input

  • Customer
  • IDAs Integer – CustomerID
  • AcctNumAs String – Custom account number.
  • AgentIDAs Integer – AgentID
  • AgentNumberAs String – Agent account number of associated agent id. Ignored if AgentID is specified.
  • BillProfileIDAs Integer – ID of customer's bill profile.
  • SecurityPINAs String – Customer's security pin.
  • IsParentAccountAs Boolean – specifies whether or not the account is a parent account. Cannot be passed in conjunction with ParentAccountID. If the account hierarchy cannot be changed, standard error returned indicating the account must be migrated from Rev.io is returned. Standard accounts can be upgraded to parent, but not vice versa.
  • ParentAccountIDAs Integer – specifies an existing Rev.io parent account for which this customer is to be made a child. Cannot be passed in conjunction with IsParentAccount. If the account cannot be changed, standard error returned indicating the account must be migrated from Rev.io is returned.
  • ContractStartAs Date – specifies the starting date of the customer's contract.
  • ContractEndAs Date – specifies the ending date of the customer's contract.
  • LanguageAs String – Customer's preferred language.
  • PhysicalAddress – Customer's physical (service) address.
    • IDAs Integer – Ignored
    • FirstNameAs String – Customer's first name (if CustomerClass is "Residential").
    • LastNameAs String – Customer's last name (if CustomerClass is "Residential").
    • CompanyNameAs String – Customer's company name (if CustomerClass is "Business").
    • Address1As String – Customer's address, first line.
    • Address2As String – Customer's address, second line.
    • CityAs String – Customer's city
    • StateAs String – Customer's state.
    • ZipAs String – Customer's zip code (first 5 digits only).
    • Zip4As String – Customer's +4 portion of zip code.
    • CountryAs String – 3 character Country ISO code.
  • MailingAddress – Customer's mailing (billing) address.
    • IDAs Integer – Ignored
    • FirstNameAs String – Customer's first name (if CustomerClass is "Residential").
    • LastNameAs String – Customer's last name (if CustomerClass is "Residential").
    • CompanyNameAs String – Customer's company name (if CustomerClass is "Business").
    • Address1As String – Customer's address, first line.
    • Address2As String – Customer's address, second line.
    • CityAs String – Customer's city
    • StateAs String – Customer's state.
    • ZipAs String – Customer's zip code (first 5 digits only).
    • Zip4As String – Customer's +4 portion of zip code.
    • CountryAs String – 3 character Country ISO code.
    • Customer/Billing (Customer's billing specific information)
    • BalanceAs Decimal – Customer's current balance in Rev.io.
    • DueAs Decimal – Amount due at the next statement.
    • OverdueAs Decimal – Amount due on the previous statement.
    • UnbilledUsageAs Decimal – Total of unbilled customer usage.
    • EnabledBalanceLimitAs Boolean – Enables / Disables the customer's eligibility to be suspended or restored based on balance
    • UsageBalanceLimitAs Decimal – Customer's usage balance limit (used to trigger suspends and restores).
    • PaymentTermsAs Int – Customer's payment terms in Rev.io.
    • PaymentTermsOverrideAs Boolean – Option on whether to override the default payment terms on the customer.
  • DOBAs Date – Customer's date of birth.
  • DLAs String – Customer's driver's license number.
  • SSNAs String – Customer's social security number.
  • SourceAs String – Source of customer creation.
  • BillMethodAs Enum – Customers billing method "PRINT_ONLY", "EMAIL_ONLY", "BOTH", or "NONE".
  • EmailAs String – Customer's email address.
  • Lifeline – Customer's lifeline information if applicable.
    • LifelineTypeIDAs Integer – Lifeline Type ID of customer.
    • SelfCertificationPDFAs Byte – Self Certification PDF serialized into a byte array.
    • TemporaryAddressAs Boolean – Indicates if the customer's physical address is temporary.
    • SeparateEconomicUnitAs String – Indicates if customer is classified as a "Separate Economic Unit".
    • TribalAs Boolean – Indicates if customer is a Tribal lifeline customer.
    • ProofTypeIDAs Integer – Lifeline proof type
    • ProofIdentifyingInformationAs String – Lifeline proof identifying information.
    • ProofNotesAs String – Lifeline proof notes.
    • StatusAs Enum_Lifeline_Status – Current lifeline status. Could be any of the following:
      • NOT_SET – Lifeline status has not been set (should not be returned in practice, however it is the default value).
      • NEEDS_FORM – Customer needs lifeline form.
      • NEEDS_REVIEW – Customer's lifeline form needs to be reviewed.
      • APPROVED – Customer's lifeline form/information has been approved.
      • REJECTED – Customer's lifeline form/information has been rejected.
    • MultipleHouseholdsAs Boolean – There are multiple households at the customer's address.
    • ProofDocumentationPDFAs Byte – Proof Documentation PDF serialized into a byte array.
    • HouseholdCountAs Integer – The number of people living in the customer's household.
    • AnnualIncomeAs Decimal – The customer's annual income in dollars.
    • CertificationDateAs Date – The customer's current certification date.
    • OriginalCertificationDateAs Date – The date the customer was first certified for lifeline.
    • TPIVStatusAs Enum_TPIV_Status – Current Third Party Identity Verification (TPIV) Status, will be one of the values from Standard Values: Enum_TPIV_Status .
    • ProgramAs Enum_Lifeline_Program – Current regulatory designation of the account.
      • NON_LIFELINE – Indicates account is not Lifeline configured.
      • ETC_LIFELINE – Indicates account is Lifeline and you are acting as the Eligible Telecommunications Carrier recognized by the State in which service is provided.
      • NON_ETC_LIFELINE – Indicates account is Lifeline and the LEC will act as the Eligible Telecommunications Carrier.
  • Fields – List of customer-level custom fields.
    • Field – Individual Custom Field
    • FieldIDAs Integer – Custom Field ID. Not required if Label is specified.
    • LabelAs String – Custom Field Label. Not required if FieldID is specified, however must match actual label if specified with FieldID.
    • ValueAs String – New value of custom field.
    • TaxExemptions – List of customer-level tax exemptions, can be one or more of the values from StandardValues: CCHTaxExemption or SureTaxTaxExemptionEnum. Not specifying the field at all means that no changes are made, and providing an empty list means that all tax exemptions are removed.
    • IsAutoDebit – The flag that enables or disables AutoDebit.
    • AutoPaymentAccountID – The Payment Account used for AutoDebit. If IsAutoDebitAuthorized is set to 1 to enroll a new customer, then this field must be specified. The Payment Account supplied must be an account that associated to the customer listed in this request.
    • AutoDebitDay – The day of the month when the AutoDebit takes place. If 0, then the AutoDebit will take place on the Due Date.

Input - Change a non Lifeline customer to a Lifeline customer

  • Customer
    • IDAs Integer – Customer ID
    • DOBAs Date – Customer's date of birth.
    • SSNAs String – Customer's social security number.
    • Lifeline – Customer's lifeline information if applicable.
    • LifelineTypeIDAs Integer – Lifeline Type ID of customer.
    • ProgramAs Enum_Lifeline_Program – Current regulatory designation of the account.
      • ETC_LIFELINE – Indicates account is Lifeline and you are acting as the Eligible Telecommunications Carrier recognized by the State in which service is provided.
      • NON_ETC_LIFELINE – Indicates account is Lifeline and the LEC will act as the Eligible Telecommunications Carrier.
Prerequisites
  • User calling API needs to have the permission MANUALLY_CHANGE_LIFELINE_INFORMATION

Output

None if successful, otherwise normal error code and message.

📘

Note:

Only fields specified in request will be updated. If field is specified, but null, then it will be ignored. However, if a field is specified with a default value, such as 0 or an empty string, then it will replace information currently on a customer's account. For example, the following will be ignored:

<SecurityPIN />

However, the following will not be ignored and will empty out the SecurityPIN field on the customer's account:

<SecurityPIN></SecurityPIN>

Please take this into consideration when updating an account using this API function.

This behavior is also true for any sub-objects, for example, to update just the customer's first name, the following may be used:

<PhysicalAddress>
        <FirstName>Test</FirstName>
</PhysicalAddress>

Additionally note that the Customer ID cannot be changed, and must be specified for this API function.

Duplicate_Query

Search for existing customers and/or locations that match your criteria.

Optional Input

  • Person/Customer Query:
    • FirstNameAs String – First Name of a customer for which to search.
    • LastNameAs String – Last Name of customer. The Second Last Name can be included here as well. It is concatenated to the first with a single space.
    • MiddleNameAs String – MiddleName of a customer for which to search.
    • SuffixAs String – MiddleName of a customer for which to search.
    • SSNTaxIDAs String – Full SSN, EIN, Tribal ID, or other Tax ID.
    • SSNTaxIDLast4As String – Last 4 digits only of the customer's SSN, EIN, Tribal ID, or other Tax ID.
    • DateOfBirthAs Date – Customer's date of birth.
    • DriversLicenseNumberAs String – Full drivers license number – alpha-numeric only for best results.
  • Location/Address Query:
    • Street1As String – Full street address according to USPS standards.
    • Street2As String – Apartment/Unit/Building, etc – according to USPS standards.
    • CityAs String – City name – according to USPS standards.
    • StateAs String – 2-character USPS State Abbreviation.
    • ZIPAs String – 5-digit USPS Zip code.
    • Street1As String – Full street address according to USPS standards.
  • Options:
    • IgnoreClosedAs Boolean – True by default. When set to False, customers with a Status of CLOSED in Rev.io will be returned as well.
    • LifelineProgramsAs List(of String) – list of Lifeline Programs that we should match on. If left blank, Program will not be considered in the matching query. (i.e. "NON_LIFELINE", "ETC_LIFELINE")
    • MatchPatternsAs List(of String) – list of combinations of fields that would be considered matches. If you specify a match pattern but don't populate the field in the request object (e.g. SSNTaxId as a match pattern, but leave SSNTaxId as blank on your customer information in the request), it will be skipped in searching.
      • If not specified, the following match list is used:
        • SSNTaxId
        • DriversLicenseNumber
        • SSNTaxIdLast4,DateOfBirth
        • FirstName,LastName,SSNTaxIdLast4
        • Street1,Street2,City,State,Zip
        • Street1,Street2,City,State
        • Street1,Street2,Zip

Output

  • MatchTotalCountAs Integer – total number of matches found. Simplistically, if this is 0, there were not any existing customers found that match your search, and if it is > 0 then there is a duplicate.
  • MatchPersonCountAs Integer – the number of matches found that were based on the person/customer (e.g. name, DOB, SSN, etc)
  • MatchLocationCountAs Integer – the number of matches found that were based on the location address.
  • Options – returns the options you specified, or the default values for any left empty.
  • Matches – list of customers as described below:
    • MatchPatternAs String – E.g. SSNTaxId or FirstName,LastName,SSNTaxIdLast4
    • MatchTypeAs Enum_Match_Type – PERSON or LOCATION.
    • CustomerIDAs Integer – Customer's ID from Rev.io.
    • AcctNumAs String – Account Number from Rev.io (for companies with customized account numbering schemes – e.g. AA3332)
    • NameAs String – Customer's full name in Rev.io.
    • Street1As String – full street address as found in Rev.io.
    • Street2As String – apartment/unit/building, etc in Rev.io.
    • CityStateZipAs String – combined City, State, and Zip from Rev.io (e.g. Pensacola, FL 32502)
    • StatusAs Enum_Customer_Status – OPEN, PENDING, CLOSED, PROSPECT
    • Created_DateAs Date – Date & Time the Customer was created in Rev.io.

NewCustomers_Create

Create a new customer and order in Rev.io.

Input

  • Customer (Required Object)
  • AcctNumAs String – Optional – Custom account number
  • AgentIDAs Integer – Optional – when specified, the customer created will be associated with this Agent. Cannot use with AgentNumber.
  • AgentNumberAs Integer – Optional – when specified, the customer created will be associated with this Agent. Cannot use with AgentID.
  • BIllProfileIDAs Integer – Optional – when specified, the customer created will be set to this Bill Profile.
    • BillMethodAs Enum – Optional – Customers billing method "PRINT_ONLY", "EMAIL_ONLY", "BOTH", or "NONE"
    • SecurityPINAs String – Optional – when specified, the customer created will be set to use this 4-digit Security PIN for accessing the account.
    • LanguageAs String – Optional – when specified, the customer created will be set to this Language (e.g. Spanish, English)
  • DOBAs Date – Optional – when specified, the customer created will be set to this value as the Date of Birth.
  • DLAs String – Optional – when specified, the customer created will be set to have this Drivers License #.
  • SSNAs String – Optional – when specified, the customer created will be set to have this Social Security Number.
  • SourceAs String – Optional – can be used to specify the system that is entering this order. E.g. Kiosk1234, Public Website, IVR-A, etc.
  • BillMethodAs 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.
  • EmailAs String – Optional – can be used to specify customer's email address.
  • CustomerClassAs Enum – Optional – can be used to specify the customer's class. Valid values are "Residential" and "Business".
  • IsParentAccountAs Boolean – Optional – can be used to specify whether or not the account is created as a parent account. Cannot be passed in conjunction with ParentAccountID.
  • ParentCustomerIDAs 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.
  • ContractStartAs Date – Optional – can be used to set the starting date of the customer's contract.
  • ContactEndAs Date – Optional – can be used to set the ending date of the customer's contract.
  • Customer/Lifeline (Required for Lifeline Packages)
    • StatusAs 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
      • FieldIDAs Integer – Custom Field ID. Not required if Label is specified.
      • LabelAs String – Custom Field Label. Not required if FieldID is specified, however must match actual label if specified with FieldID.
      • ValueAs String – Value of custom field.
    • LifelineTypeIDAs Integer – required when a Lifeline Package is specified on the Order. Use LifelineTypes_Query to find a valid ID.
    • SelfCertificationPDFAs 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.
    • TemporaryAddressAs 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.
    • SeparateEconomicUnitAs Boolean – required for Lifeline Customers, this field indicates the customer is a Separate Economic Unit as defined by the FCC's guidelines.
    • TribalAs Boolean – optional to mark customer as Tribal
    • CertificationDateAs Date – indicates the customer's lifeline certification date or recertification date. Required only when lifeline status is "APPROVED".
    • OriginalCertificationDateAs Date – Optional – indicates the customer's original lifeline certification date. If not specified, will be set to the value of the CertificationDate field.
    • ProofTypeIDAs Integer – optional to pass the Rev.io ID for the type of proof document the customer submitted to verify Lifeline eligibility.
    • ProofIdentifyingInformationAs 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.
    • ProofNotesAs String – optional to pass any text related to the proof document.
    • MultipleHouseholdsAs Boolean – optional to identify the physical address containing more than one household
    • HouseholdCountAs Integer – optional number of persons in the customer's household. Must be 1 or greater.
    • AnnualIncomeAs Integer – optional enter annual income for customer
    • CGM_ReservationAs String – optional pass the reservation CGM token from their intercompany duplicate database (IDD)
    • NLADEnrolledAs 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.
    • StatusNoteAs 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.
    • TPIVStatusAs 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)
    • IDAs Integer – Prohibited
    • FirstNameAs String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
    • LastNameAs String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
    • MiddleNameAs String – Optional, Max Length 10 characters.
    • SuffixAs String – Optional
    • CompanyNameAs String – Required if CustomerClass is "Business", otherwise prohibited.
    • Address1As String – Required.
    • Address2As String – Optional.
    • CityAs String – Required.
    • StateAs String – Required. 2 characters.
    • ZipAs String – Required. 5 digits. Must be valid zip code.
    • Zip4As String – Optional. Must be 4 digits if specified.
    • CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.
    • Customer/PhysicalAddress (Customer's service location/tax address)
    • IDAs Integer – Prohibited
    • FirstNameAs String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
    • LastNameAs String – Required if CustomerClass is not specified or is "Residential", otherwise prohibited.
    • MiddleNameAs String – Optional, Max Length 10 characters.
    • SuffixAs String – Optional
    • CompanyNameAs String – Required if CustomerClass is "Business", otherwise prohibited.
    • Address1As String – Required.
    • Address2As String – Optional.
    • CityAs String – Required.
    • StateAs String – Required. 2 characters.
    • ZipAs String – Required. 5 digits. Must be valid zip code.
    • Zip4As String – Optional. Must be 4 digits if specified.
    • CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.
    • Customer/Billing (Customer's billing specific information)
    • BalanceAs Decimal – Customer's current balance in Rev.io.
    • DueAs Decimal – Amount due at the next statement.
    • OverdueAs Decimal – Amount due on the previous statement.
    • UnbilledUsageAs Decimal – Total of unbilled customer usage.
    • EnabledBalanceLimitAs Boolean – Enables / Disables the customer's eligibility to be suspended or restored based on balance limit
    • UsageBalanceLimitAs Decimal – Customer's usage balance limit (used to trigger suspends and restores).
    • PaymentTermsAs Int – Customer's payment terms in Rev.io.
    • PaymentTermsOverrideAs 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)
    • CarrierIDAs Integer – Optional. Cannot be used with CarrierCode. Settings > Providers.
    • CarrierCodeAs String – Optional. Cannot be used with CarrierID. Settings > Providers.
    • CarrierAccountIDAs Integer – Optional. Settings > Provider Accounts
    • PackageIDAs Integer – Required. Settings > Packages.
    • DescriptionAs String – Optional – Service description.
    • PBXMakeAs String – Optional – Model of PBX, if applicable.
    • PBXModelAs String – Option on whether to override the default payment terms on the customer.
    • Order/ShippingAddress (Shipping Address. Conditionally required.)
      • IDAs Integer – Prohibited
      • FirstNameAs String – Required
      • LastNameAs String – Required
      • MiddleNameAs String – Optional, Max Length 10 characters.
      • SuffixAs String – Optional
      • CompanyNameAs String – Required
      • Address1As String – Required.
      • Address2As String – Optional.
      • CityAs String – Required.
      • StateAs String – Required. 2 characters.
      • ZipAs String – Required. 5 digits. Must be valid zip code.
      • Zip4As String – Optional. Must be 4 digits if specified.
      • CountryAs 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.)
    • MDNAs String – Mobile Device Number (or phone number) being ported.
    • AccountNumberAs String – Customer's account number with previous provider.
    • AuthorizedSignerAs String – Customer's full name that has authorization to request this port.
    • PINPasswordAs String – Customer's password with previous provider.
    • RemarkAs String – General comment to be sent with the port request.
    • AddressAs Address – Address currently assigned to the device being ported
    • IDAs Integer – Prohibited
    • FirstNameAs String – Required
    • LastNameAs String – Required
    • MiddleNameAs String – Optional, Max Length 10 characters.
    • SuffixAs String – Optional
    • Address1As String – Required.
    • Address2As String – Optional.
    • CityAs String – Required.
    • StateAs String – Required. 2 characters.
    • ZipAs String – Required. 5 digits. Must be valid zip code.
    • Zip4As String – Optional. Must be 4 digits if specified.
    • CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.
    • ExternalProviderAs 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.
    • WirelessESNAs 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.
    • WirelessICCIDAs 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)
      • ProductIDAs Integer – Required – Refers to an Rev.io Product ID (Settings > Products).
      • RateAs Decimal – Optional – If specified, the Product on the Order will use this rate. Otherwise, it will use the default rate from Settings > Products.
      • QuantityAs 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.
      • DescriptionAs String – Optional – If specified, the Product on the Order will use this description. Otherwise, it will use the default description from Settings > Products.
    • LineTypeIDAs Integer – Optional – Settings > Service Types.
    • ProcessIDAs Integer – Optional – Settings > Processes.
    • ReconnectTNAs String – Optional – When specified, the service will be created with the specified TN and the resulting order will be marked as a reconnect order.
  • SendOrdersAs 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_IDAs Integer
  • Orders – List of orders created by this request.
  • OrderAs Integer
  • Lines – List of orders created by this request.
  • LineAs Integer
  • Products – List of products added to the customer after creation
  • Product
    • ProductIDAs Integer – The Rev.io Product ID
    • ProductGroupIDAs 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.
    • LeadProductFlagAs Boolean – Indicates if the product is the lead product of a product group.
  • BillMethodAs Enum – Customers billing method "PRINT_ONLY", "EMAIL_ONLY", "BOTH", or "NONE"

NewCustomers_Quote

Calculate the taxes and charges for a package and/or one or more products for a given zip code. Returns subtotals, totals, and a detailed list of charges/credits and taxes.

Note - an Address element can be specified to automatically retrieve the Zip+4 information if this value is not known.

Required Input

  • ZIPAs String – Required.(Optional if specified in Address). 5 digits. Must be valid zip code.
  • PackageIDAs Integer – maps to an Rev.io Package (Settings > Packages)

Optional/Conditional Input

  • AdditionalProducts – used to specify additional products to be included as part of the order – e.g. shipping fees, connection charges, phones, etc
    • Product – (repeats)
      • ProductIDAs Integer – Required – Refers to an Rev.io Product ID (Settings > Products).
      • RateAs Decimal – Optional – If specified, the Product on the Order will use this rate. Otherwise, it will use the default rate from Settings > Products.
      • QuantityAs 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.
      • DescriptionAs String – Optional – If specified, the Product on the Order will use this description. Otherwise, it will use the default description from Settings > Products.
  • Address
    • IDAs Integer – Prohibited.
    • FirstNameAs String – Optional.
    • LastNameAs String – Optional.
    • CompanyNameAs String – Optional.
    • Address1As String – Required.
    • Address2As String – Optional.
    • CityAs String – Required.
    • StateAs String – Required. 2 characters.
    • ZipAs String – Required. 5 digits. Must be valid zip code.
    • Zip4As String – Optional. Must be 4 digits if specified. If NOT specified - this value will attempt to be calculated automatically.
    • CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.

Output

  • Subtotal_OneTimeAs Decimal – Non-recurring charges + taxes.
  • Subtotal_OneTime_RevenueAs Decimal – Non-recurring charges without taxes.
  • Subtotal_OneTime_TaxesAs Decimal – Non-recurring taxes only.
  • Subtotal_MonthlyAs Decimal – Monthly recurring charges + taxes.
  • Subtotal_Monthly_RevenueAs Decimal – Monthly recurring charges without taxes.
  • Subtotal_Monthly_TaxesAs Decimal – Monthly recurring taxes only.
  • TotalAs Decimal – Total of all non-recurring and recurring charges and taxes.
  • Details_Taxes – list of recurring & non-recurring taxes
    • DescriptionAs String
    • AmountAs Decimal
    • CategoryAs String – OneTime or Monthly
  • Details_Taxes – list of recurring & non-recurring taxes
    • DescriptionAs String
    • AmountAs Decimal
    • CategoryAs String – OneTime or Monthly

Updated about 1 month ago