Docs for all releases
Page History
Panel | ||
---|---|---|
| ||
|
Section overview
Reseller in JeraSoft VCS, in the majority of cases, is a company who has a certain amount of clients and governs their activities in the system. As any company, it can have a range of managers, each responsible for a certain group of company clients. Manager has a limited functionality: doesn't have his own balance, therefore, cannot perform any transactions; neither origination, nor termination rate table cannot be assigned to him, etc. Resellers section is designed to provide a user with a possibility to track and manage his company information and activity, build hierarchy of company affiliates, or assign its managers. Section is presented in a form of table with the following columns:
Screenshot: Resellers section
Column name | Description |
---|---|
ID | Reseller's/manager's identification number |
Name | Name of reseller/manager |
Available Balance | Reseller's available balance (live balance + credit) |
Clients | Total amount of a respective reseller's/manager's clients |
Cards | Total amount of a respective reseller's/manager's calling cards |
Call Shops | Total number of a respective reseller's/manager's call shops |
The following functional buttons and icons are present in the section:
Button/Icon | Description |
---|---|
Allows creating a new reseller | |
Allows creating a new manager | |
Allows assigning an origination rate table to a respective reseller | |
Allows assigning a termination rate table to a respective reseller | |
Allows viewing a list of a following reseller's/manager's users | |
Allows viewing a history of changes for a respective reseller/manager in Audit log section | |
Allows viewing reseller's balance operations in Transactions section | |
Allows viewing a list of reseller's/manager's clients in Clients section | |
Allows viewing a list of reseller's/manager's calling cards in Calling Cards section | |
Allows viewing a list of reseller's/manager's call shops for a current reseller/manager in Call Shops section |
Advanced Search
In the top right corner of the section above the table, an Advanced Search drop-down menu is located. By clicking on blue downwards arrow icon, a drop-down menu with the following structure is displayed:
Screenshot: Advanced Search drop-down menu
Field | Description | ||
---|---|---|---|
Mode | Select a mode for resellers display:
|
To apply the specified search criteria, press Search button; to cancel the applied parameters, press Reset button.
Adding New Reseller
To add a company, you need to:
- press New Company button;
- fill in all required fields in the appeared pop-up window (see below) and press OK button.
Screenshot: Adding new company
Information block | Fields Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
System Information | General information about a company | ||||||||||||
| Specify the name of one of your companies (or affiliates). This field is mandatory. | ||||||||||||
| Indicate a parent for a reseller or make it a root one. By default, field value is set to root | ||||||||||||
| Select a preferred currency for rates and invoices from the drop-down list of available ones (see Currencies section) | ||||||||||||
| Define a status of reseller:
| ||||||||||||
| Select a template that will be used for all clients belonging to this reseller or manager by default (see Clients Template section) | ||||||||||||
| Indicate a tax profile that will be used for this reseller and reflected in invoices (refers to Taxes Profiles section).
| ||||||||||||
| Select gateway(s) for this reseller | ||||||||||||
Terminator Settings | Reseller's billing settings for outcoming calls | ||||||||||||
| Rates for outgoing events from customers under current reseller. Enables resellers billing mode
| ||||||||||||
| Termination capacity for all clients, belonging to this reseller. Leave this field empty for unlimited capacity | ||||||||||||
Fraud Protection checkbox | Enables/disables administrator notification in case of multiple simultaneous calls made to the same number from the current Reseller.
Here you need to specify the following: | ||||||||||||
| Set minimum time in seconds between sent notifications (minimum interval must be ≥ 0 sec) | ||||||||||||
| 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 | ||||||||||||
Origination Settings | Current Reseller's billing settings for incoming calls | ||||||||||||
| Here you can set specific paid mode for a client. Postpaid mode means that client will have unlimited credit. Otherwise, client's Balance + Credit value will be checked on RADIUS or SIP authorization. When this field is checked, Credit field become unavailable. | ||||||||||||
| Additional field next to Postpaid checkbox. User can indicate an amount of reseller's credit | ||||||||||||
| Specify rates for incoming events from customers under current reseller. Enables resellers billing mode | ||||||||||||
| Indicate origination capacity for all clients, belonging to this reseller. Leave this field empty for unlimited capacity | ||||||||||||
Invoicing Information | Current Reseller's invoicing settings | ||||||||||||
| Allows you to select how system sets invoicing date:
| ||||||||||||
| Select an invoice template that will be assigned to reseller | ||||||||||||
| Allows to define default format of invoice's name | ||||||||||||
| Define last used invoice number | ||||||||||||
SureTax Settings | SureTax profile settings. SureTax is a 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: How to set SureTax profile? | ||||||||||||
| Specify a unique number that identify an individual in the SureTax service | ||||||||||||
| Defien a unique validation key of the SureTax service. | ||||||||||||
Contact Information | Some additional information | ||||||||||||
Company's email (it is required to specify email in order to receive notifications). Use only Latin characters. This field is mandatory | |||||||||||||
| Company's postal address | ||||||||||||
| An ID of tax paying entity | ||||||||||||
| Company's registration ID | ||||||||||||
| Company's bank account info | ||||||||||||
Company Logo | Here you can add a 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 the old logo. | ||||||||||||
Mail Templates | A detailed description of all Mail Templates and their configuration is presented at the end of the article |
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Attention
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Attention Email Rates Import Settings infromation block has been removed from Resellers settings in VCS 3.16.0 due to introduction of Data Source section. |
Adding New Manager
To add a manager, press New Manager button and after specifying required fields press OK.
Screenshot: Adding new manager.
Information block | Fields Description | ||
---|---|---|---|
System Information | General information about Manager | ||
| Here you can specify the name of a manager. This field is mandatory. | ||
| Select a parent for a manager | ||
| Select current status of a manager:
| ||
Contact Information | Some additional information | ||
Manager's email. Use only Latin characters. | |||
| 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/Manager's profile editing form.
Screenshot: Editing reseller's status
Please note, that in fact Reseller/Manager will not be deleted fully, it will be put to Archive. To display them, use Advance Search (see above). To delete a profile completely, you need to press Full Delete bottom in this very profile editing window.
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 adding information about package.
To add new field follow next steps:
- Click the Add Custom Field button.
Specify Field Key and Title fields for custom item: for example: voip_phone_sell as Key and VoIP Phone as common Title which will be visible for all clients. Please note that the Field Key must contain word characters only.
Add respective notes VoIP Phone field in Client's settings/Package settings > Custom Fields tab.
Create an invoice template and assign it to a target reseller. Then, Clients Custom Fields and Package Custom Fields tables will appear in the Invoice Template settings. You simpy need to add those tables in the invoice template.
Finally, you can generate an invoice.
Screenshot: Custom Fields
Rates Notifications
Rates Notification settings in Resellers profile allows to create default rate notification for clients that belong to a target reseller.
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Attention
|
Screenshot: Rates Notifications
To configure these settings, open Rate Notifications tab in reseller profile. The structure of the tab is as follows:
Field | Description | |
---|---|---|
Date Format | Specify date format in your export file. Example of field syntax: if you enter “%d-%m-%Y” here, your date will look like 25-02-2018 | |
Code Deck | Select a code deck here to rewrite code names in export file if needed | |
Codes Output | Select a way, codes must be displayed | |
| Each code is placed into single row | |
| Codes are grouped by code name in a row, for example, 5510, 5511, 5512 | |
| Codes are grouped by code name into ranges plus delimiter, for example, 5510-5512, 5515 | |
Data Format | Specify an output file format, .xls or .csv | |
Fields Delimiter | Set delimiter for fields if you've chosen .csv. For .xls format this field is unavailable | |
With headers row checkbox | Include into the file a row with column names | |
Codes from code deck checkbox | Include only codes which are present in a specified Code Deck | |
Header text / Footer text | Allows you to specify additional text into exported file as header and footer, respectively |
Description of all columns that could be selected for rate notification is provided below:
Column Name | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Code / Code Name | Code or Code Name of respective rate | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Effective Date | Date on which a rate to be applied | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rate | Price | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Min Volume | Minimum volume of chargeable events | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Interval | Chargeable interval | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Grace Volume | Free of charge interval | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Setup Fee | Interval of setup fee | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Profile | Time profile (all time, business time, non-business time, weekends) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
End Date | Date on which the rate ends | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Previous Rate | Rate used before the present time | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Prev Diff | Shows how current rate differs from a previous one after import | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Prev Diff Status | Shows how current rate's status changed in comparison to a previous one (unchanged, increased, decreased) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Prev Diff (export) | Shows how current rate differs from a previous one after export | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Prev Diff Status (export) | Rate's changes after the last export. Shows the status how differs current rate from previous. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Notes | Additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tag | Tags thar are assigned to respective rate | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Policy | Indicated policy of the rate | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status | Define a current rate status |
Configuring Mail Templates
Also, there are different mail templates you can configure in your company's profile:
Screenshot: Mail Templates
Template Name | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Mail Template: Invoice | Used when sending invoice to the customer | |||||||||||
Mail Template: Invoice Unpaid Reminder | Used when sending payment notification to a customer (sending notification on "Notify Days(Before)") | |||||||||||
Mail Template: Overdue Reminder | Used when sending payment notification to a customer (sending notification on "Notify Days(After)") | |||||||||||
Mail Template: Low Balance Notification | Used when sending low balance notification to a customer
| |||||||||||
Mail Template: Rates Notificator | Used when sending rate changes notification to a customer | |||||||||||
Mail Template: Factors Watcher | Used when sending notification to a customer once Preset by Factors Watcher has been added | |||||||||||
Mail Template: Reports Watcher | Used when sending reports by email |
The structure of all mail templates is identical and has the following structure:
Screenshot: Reseller/ Mail Template:Factors Watcher form
Field | Description | |
---|---|---|
From | Specify name and email of company | |
BCC | Specify who will receive a blind copy of an email | |
Subject | Indicate email subject that may contain company name, invoice number, etc. | |
Mail body | Content of the letter. On the screenshot above the following information is specified: | |
| Code or Code name that will be automatically filled in by the system | |
| Values specified in Factors Watcher settings (for example: calls_total >0). |
To configure any of these templates, simply click on its name. Below, you will find full list 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 Syntax | Description |
---|---|
${client['status']} | A client status:
|
${client['name']} | Сlient's name |
${client['balance']} | Сlient's live balance |
${client['balance_accountant']} | Сlient's fixed balance |
${client['credit']} | Сlient's available credit |
${client['c_company']} | Сlient's official company name |
${client['c_address']} | Post address of a client's company |
${client['c_email']} | Сlient's email |
${client['locale']} | Client's location |
${client['currencies_id']} | Сurrency ID, used by a client |
${client['tz']} | Time zone of a client |
${client['taxes_profiles_id']} | Taxes profile's ID, used by a client |
${client['tax_id']} | Customers tax ID of a client's company |
${client['reg_id']} | Registration ID of a client's company |
General Configuration Syntax Concerning Company/Reseller Data
Templates Configuration Syntax | Description |
---|---|
${company['status']} | Company's status:
|
${company['balance']} | Company's current balance |
${company['balance_accountant']} | Company's fixed balance |
${company['credit']} | Company's available credit |
${company['c_address']} | Company's post address |
${company['c_email']} | Email of a company |
${company['locale']} | Company's location |
${company['currencies_id']} | Company's currency ID |
${company['tz']} | Company's time zone |
${company['taxes_profiles_id']} | Company's taxes profiles |
${company['name']} | Name of a company |
${company['tax_id']} | Company's customers tax ID |
${company['reg_id']} | Company's registration ID |
Configuration Syntax for Mail Template: Invoice and Payment Reminder Notification
Templates Configuration Syntax | Description |
---|---|
${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']} | Сlient's currency |
Configuration Syntax for Mail Template: Low Balance Notification
Templates Configuration Syntax | Description |
---|---|
${client['balance_avail']} | Client's available balance: live balance + credit |
${client['currency']} | Сlient's currency |
${client['alert_threshold']} | Notification for a client regardig reaching a balance limit |
${client['alert_athreshold']} | Notification for an administrator regardig reaching a balance limit |
Configuration Syntax for Mail Template: Rates Notificator
Templates Configuration Syntax | Description |
---|---|
${msg['rt_name']} | Rate table name |
${msg['lastedit_dt']} | Date when rate table was last time edited |
${date} | Date when the notification was sent |
Configuration Syntax for Mail Template: Reports Watcher
Templates Configuration Syntax | Description |
---|---|
${report["title"]} | Title of report template |
${report["interval"]} | Actual report period of time |
${report["title-full"]} | Title of report template with indication of actual report period of time |
${report["webUrl"]} | URL to view report on the web portal |
${report["id"]} | ID of report template |
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Tip If you want the date of sending letter to be present, you can add the ${date} variablein any mail template. |
Knowledge Base Articles
Content by Label showLabels false spaces +KB showSpace false sort modified excerpt true reverse true excerptType simple cql label in ("companies","reseller") and space = "KB" labels +companies,capacity