This documentation relates to an earlier version of JeraSoft VCS.
View User Guide 3.20 or visit our current documentation home page.
Skip to end of metadata
Go to start of metadata
On this page

Resellers List

This section covers Reseller/Manager features and functions that are available and allow you to specify the information about your company or affiliate.  
Main window of this section contains the full list of Resellers and here you can create a New Company/Reseller or Manager:


Screenshot: Resellers section main window

IconDescription
To assign an orig rate table for a respective Reseller
To assign a term rate table
To view users of a following Reseller

To view the history in the Audit log section
To view balance operations in the Transactions section
To show clients for a current Reseller in the Clients section
To display calling cards for the Reseller
To view call shops for a current Reseller

Adding New Company

To add a company, click the New Companybutton on the toolbar and a pop-up window with properties will appear. 


Screenshot: Adding new company


SectionFields Description
System InformationGeneral information
  • Name
Here you can specify the name of one of your companies (or affiliates). This field is mandatory.
  • Parent
Select a parent for this Reseller
  • Currency
Preferred currency for rates and invoices
  • Status
Current status of the Reseller
  • Client Template
Template that will be used for all clients belonging to this Reseller or Manager by default
  • Tax Profile

Select a tax profile, that will be used for this Reseller.

You can specify a tax profile which will be reflected in invoices (refers to Taxes Profiles section).

  • SureTax is a tax levied on top of another tax. It allows to manage your compliance with tax law. This profile is used for further calculation in invoices. To get more details, check out the article "US Taxation".

    For proper usage of SureTax, the Invoice Number should contain only Latin and numeric characters. Max length is 40 symbols. Dst and Src Numbers should be in format NPANXXNNNN (10 digits). 



  • VoIP Gateways
Select respective gateways that are allowed for this Reseller
Originator SettingsCurrent Reseller's billing settings for incoming calls
  • "Postpaid" 
    check box

Here you can set specific paid mode for a client.

If postpaid mode not selected, this client's Balance + Credit value will be checked on RADIUS or SIP authorization, in other case client will have unlimited credit.


  • Credit
Additional field in the row of Postpaid check box. Credit limit allowed for client.
  • ORIG Rates
Rates for incoming calls from customers under current Reseller. Requires resellers billing mode enable
  • Routing Plan
Default routing plan for customers of this Reseller, if no other is specified in Client's profile
  • ORIG Capacity
Origination capacity of this Reseller for all clients that belong to him. Leave this field empty for unlimited capacity
Terminator SettingsCurrent Reseller's billing settings for outcoming calls
  • TERM Rates
Rates for outgoing calls to providers under this Reseller (i.e the Reseller's rate by which the call is billing). Requires Resellers billing mode enable
  • TERM Capacity
Termination capacity of this Reseller for all clients that belong to him. Leave this field empty for unlimited capacity
Invoicing Information







Current Reseller's invoicing settings
  • Date

Allows you to select how system sets invoicing date:

  • Real date – sets invoicing date to actual invoicing date

  • Last day – sets invoicing date to date of last day of invoicing period


  • Template
Select an invoice template to use with this Reseller
  • No Tpl
Allows to define default format of invoice's name
  • Last No
Define last used invoice number here

"Fraud Protection" check box

Enables/disables administrator notification in case of multiple simultaneous calls made to the same number from the current Reseller.

Please note that all notifications can be found in System - Events Log section. If you want to receive its on exact email, go to System - Events Log - Configuration section, here specify an email and tick the "A" check box (stands for Alerts) of "RADIUS: Fraud Protection" service, then click the "Update" button for saving changes.

Here you need to specify the following:

  • Notification frequency
Set minimum time in seconds between sent notifications (minimum interval should be greater or equal to 0 sec)
  • Skip digits
Define amount of the last number digits which will be ignored when determining a destination number. For instance, with one digit for ignoring, the numbers 123456 and 123457 will be considered as the same number
Email Rates Import SettingsSettings used for automatic import of updated rates from emails  
  • Host
Specify an email server. Note that it should support IMAP and SSL
  • Port
Define a port, by default the 993 port is set
SureTax Settings

SureTax profile settings. SureTax is third-party tax calculation engine. This tax calculation is based on the location of the customer’s taxing jurisdiction. This profile is used for further calculation in invoices. 
To get more details, check out the article "US Taxation".

  • Client Number - unique number that identify an individual in the SureTax service.
  • Validation Key - unique validation key of the SureTax service.

Contact Information




Some additional information
  • E-mail
Company's e-mail (it is required to specify e-mail in order to receive notifications). Use only Latin characters.
 After update to the latest version, make sure that all e-mail addresses of your Resellers are specified in their settings.

  • Postal Address
Company's postal address
  • Tax ID
An ID of tax paying entity
  • Reg ID
Company's registration ID
  • Bank Account
Company's bank account info
Company LogoHere you can add the file with company's logo. To delete the company logo, open the edit form of a respective Reseller with logo, then click the delete icon to remove an old logo.

Please be aware, that changes of Resellers' settings will not be applied instantly. They will be automatically reloaded every 5 minutes.

Please note, that Parent Reseller has access to all information of his Sub-Resellers and also can assign any routing plan and rate table to his Sub-Resellers.

Adding New Manager

To add a manager, click the New Manager” button and complete by supplying required information.


Screenshot: Adding new manager.


SectionFields Description
System Information


General information about Manager
  • Name
Here you can specify the name of Manager. This field is mandatory.
  • Parent
Select a parent for this Manager
  • Status
Current status of Manager
Contact Information

Some additional information
  • E-mail

Manager's e-mail. Use only Latin characters.

  • Postal Address

Manager's postal address

Reseller Removal

To delete a Reseller/Manager from the system you need to change the status from Active to Deleted in Reseller's Properties window.


Screenshot: Edit Reseller status



Please note, that in fact Reseller/Manager will not be deleted fully, it will be put to Archive. To find it just choose Archive Mode in the right top under Resellers List. To delete a profile completely you need to click the "Full Delete" bottom. 
 

Screenshot: Resellers section/ search toolbar


Custom Fields

  • Custom Field is used as custom variables that will be represented as readable text in invoice templates. Custom Field allows to add an information about client.
  • Custom Package Field is also used as as custom variables that allows to add an information about package. 

To add new field follow next steps:

  1. Click the "Add Custom Field" button.
  2. Specify Field Key and Title for custom item: for example: "voip_phone_sell" as Key and "Sell of VoIP Phone" as common Title which will be visible for all clients. Please note, that the Field Key must contain word characters only.

  3. Add respective notes in the Client's settings/Package settings → Custom Fields tab. 

  4. Create an invoice template and assign it to the Reseller. Then, Clients Custom Fields and Package Custom Fields tables will appear in the Invoice Template settings. You need to add these tables in the invoice template. 

  5. Finally, you can generate an invoice.
     

Screenshot: Custom Field

Rates Notifications

Rates Notifications settings in Resellers section allows to create default rate notification for clients that belong to relative Reseller. 


Screenshot: Reseller/Rates Notifications


You may find a description of all columns that could be selected for rate notification below:

Field
Description
Code / Name Code or Code Name of respective rate
Effective FromDate on which a rate to be applied
RatePrice
Min TimeMinimal time interval of tarificated calls (sec)
IntervalTarification interval (sec)
Grace TimeInterval of free time
Setup FeeInterval of setup fee
ProfileTime profile (all time, business time, non-business time, weekends)
End DateDate on which the rate ends
Previous RateRate used before the present time
Prev DiffShow how differs current rate from previous
Prev Diff StatusShows the status how differs current rate from previous
Prev Diff Status (export)Shows the status how differs current export from previous
NotesAdditional information
TagChoose the column with label to be shown
PolicyChoose the column with policy of the rate
StatusChoose the state to be shown


Fill here next fields:

FieldDescription
Date FormatDate format in your export file. Syntax is following: for example, if you put “%d-%m-%Y” here, your date will look like 25-05-2011
Code DeckSelect a code deck here to rewrite code names in export file if needed
Codes OutputSpecify how codes should be displayed. There are few options
  • Separate rows
Each code is placed into single row
  • Delimited list
Codes are grouped by code name in a row, for example, 5510,5511,5512
  • Ranges list
Codes are grouped by code name into ranges plus delimiter, for example, 5510-5512, 5515
Data FormatSpecify output file format, XLS or CSV
Fields DelimiterSet delimiter for fields if you've chosen CSV
"With headers row" check boxInclude column names into the file
"Codes from code deck" check boxAllows to additionally filter the export, by selecting only codes which are present in specified Code Deck
Header text / Footer textAllows you to additionally put some text into exported file as header and footer respectively

Configuring Mail Templates

Also, there are different mail templates you can configure for your company:

Template NameDescription
Mail Template: InvoiceIs used when sending invoice to the customer
Mail Template: Invoice Unpaid ReminderIs used when sending payment notification to the customer (sending notification on "Notify Days(Before)")
Mail Template: Overdue Reminder Is used when sending payment notification to the customer (sending notification on "Notify Days(After)")
Mail Template: Low Balance Notification

Is used when sending low balance notification to the customer

You can add a rounding rule for client's balance while low balance notification.  For example, to round up to 2 decimal places you need to add the variable ${client['balance']} in the Mail template: Low balance notification of the Reseller settings and specify the number of rounding decimals in the "Totals precision" in the Currencies.


Mail Template: Rates NotificatorIs used when sending rate changes notification to the customer
Mail Template: Factors Watcher

Is used when sending notification to the customer once adding Preset by Factors Watcher

Mail Template: Reports WatcherIs used when sending reports by email


Screenshot: Reseller/ Mail Template:Factors Watcher form

FieldDescription
FromName of Company, e-mail of the Company
BCCHere specify who will receive a blind copy of an email
SubjectName of Company that is used for Factors Watcher notification
Direction {direction}Code or Code name, this field fills in automatically by the system
Reason {reason}Values specified in Factors Watcher settings (for example: calls_total >0).


To configure any of these templates, click on its name. Here presented templates configuration syntax used almost in all kinds of configured mails concerning Clients and Resellers data and configuration syntax which is used in foregoing list of mail templates. 

Configuration Syntax

General Configuration Syntax Concerning Client Data

Templates Configuration SyntaxDescription

${client['status']}

 A client status:

  • active
  • deleted
${client['name']}A client name

${client['balance']}

A client live balance
${client['balance_accountant']}A client fixed balance

${client['credit']}

A client available credit

${client['c_company']}

A client official company name

${client['c_address']}

The post address of a client's company

${client['c_email']}

The email of a client

${client['locale']}

A client location

${client['id_currencies']}

The currency ID used by a client

${client['tz']}

The time zone of a client

${client['id_taxes_profiles']}

The taxes profiles used by a client

${client['tax_id']}

Customers tax ID of a clients' company

${client['reg_id']}

The registration ID of a clients' company

 

General Configuration Syntax Concerning Company/Reseller Data

Templates Configuration SyntaxDescription
${company['status']}

A company/reseller status:

  • active
  • deleted

${company['balance']}

A company/reseller current balance

${company['balance_accountant']}A company/reseller fixed balance

${company['credit']}

A company/reseller available credit

${company['c_address']}

The post address of a company

${company['c_email']}

The email of a company

${company['locale']}

A company location

${company['id_currencies']}

A company currency ID

${company['tz']}

A company time zone

${company['id_taxes_profiles']}

A company/reseller taxes profiles

${company['name']}

Name of a company

${company['tax_id']}

Customers tax ID of a  company

${company['reg_id']}

The registration ID of a  company

 

Configuration Syntax for Mail Template: Invoice and Payment Reminder Notification

Templates Configuration SyntaxDescription

${invoice['c_dt']}

Invoice date

${invoice['type']}

Invoice type

${invoice['amount']}

Invoice total sum

${invoice['period_start']}

Invoice period start

${invoice['period_finish']}

Invoice period end

${invoice['due_date']}

Invoice due date

${invoice['no']}

Invoice number

${invoice['descr']}

Invoice comments

${invoice['tz']}

Invoice time zone

${invoice['state']}

Invoice state

${invoice['name']}

Invoiced client name

${client['currency']}

A client currency


Configuration Syntax for Mail Template: Low Balance Notification

Templates Configuration SyntaxDescription
${client['balance_avail']}A client live balance + credit
${company['balance_avail']}A company/reseller live balance + credit

${client['currency']}

A client currency

${client['alert_threshold']}

Notification for a client of reached balance limit

${client['alert_athreshold']}

Notification for an administrator of reached balance limit


Configuration Syntax for Mail Template: Rates Notificator

Templates Configuration SyntaxDescription

${msg['rt_name']}

Rate table name

${msg['lastedit_dt']}

Data when Rate table was last time edited

${date}Data when the notification was sent


Configuration Syntax for Mail Template: Reports Watcher

Templates Configuration SyntaxDescription

${report["title"]}

Head of report template

${report["interval"]}

Actual report period of time

${report["title-full"]} = ${report["title"]} + ${report["interval"]}
${report["webUrl"]}URL to view report in the web portal
${report["id"]}ID of report template

Knowledge Base Articles

  • No labels