Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleIn this article
Table of Contents
Warning
titleWarning

Please do not remove Reseller entities completely from the system. It may cause distortions and overall mismatches in stored statistics. Instead, set their status to "deleted".

Section overview

Reseller in JeraSoft Billing , in the majority of cases, is a company that has a certain number of clients and governs their activities in the system. Like any company, it can have a range of managersusers, each responsible for a certain group of company clients. The Manager has limited functionality: doesn't have his own balance, therefore, he cannot perform any transactions; neither origination nor termination rate table cannot be assigned to him, etc. The Resellers section is designed to provide a user with a possibility to track and manage their company information and activity, build  The Resellers section is designed to cover two main purposes – partitioning and multi-level billing management. You can track and manage their company information and activity or build a hierarchy of company affiliates, or assign its managers. The . The section is presented in the form of a table with the following columns:

Screenshot: Resellers section

Image RemovedImage Added 

/Manager's /manager's/manager

Column name

Description

ID

Reseller's identification number

Name

Name of a reseller
Available Balance
Reseller's available balance (live balance + credit)
Users

Users associated with this company

Clients

The total amount of a respective reseller

's clients

The following functional buttons and icons are present in the section:

a following 's/manager/manager 's/manager
Button/IconDescription

Image Modified

Allows creating a new reseller

Image Removed

Allows creating a new manager
Image Removed

Image Added

Allows assigning an origination rate table to a respective reseller
Image Removed
Allows assigning a termination rate table to a respective reseller

Image Modified

Allows viewing a list of reseller's users
Image Modified
Allows viewing history of changes for a respective reseller in the Audit log section
Image Modified
Allows viewing reseller's balance operations in the Transactions section
Image Modified
Allows viewing a list of reseller's clients in the Clients 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 a blue downward arrow  icon, a drop-down menu with the following structure is displayed:

...

Screenshot: Adding a new company

Image RemovedImage Added

Currency

Indicate a tax profile that will be used for this reseller and reflected in invoices (refers to the Taxes Profiles section).

  • SureTax and Compliance are tax calculation services, which allow managing your compliance with tax law. These profiles are used for further calculation in invoices. To get more details, check out the US Taxation article.

Information blockFields Description
System InformationGeneral information about a company

Name

Specify the name of one of your companies (or affiliates). This field is mandatory. 

Status

Define the status of a reseller:

  • Active
  • Deleted 

Parent

  • Parent
Indicate a parent for a reseller or make it a root one. By default, the field value is set to root 

Gateways

Select a preferred currency for rates and invoices from the drop-down list of all available ones (see the Currencies section) 
  • Status

Define the status of a reseller:

  • Active
  • Deleted 
  • Client's Template
Select a template that will be used for all clients belonging to this reseller or manager by default (see the Clients Template section) 
  • Tax Profile
gateway(s) for this reseller 

Capacity Control


Capacity Control sums up bidirectional capacity for all the Clients under this Reseller.

ORIG Capacity

Indicate origination capacity for all clients, belonging to this reseller. Leave this field empty for unlimited capacity

TERM Capacity

Termination capacity for all clients, belonging to this reseller. Leave this field empty for unlimited capacity
Multi-level Billing









The Multi-Level Billing section allows for billing parameters management to cover actual reselling/agent schemes. If the configured reseller should be part of a multi-level billing scenario, you can set rates and needed taxes for them here.

Legal Entity

Select a Legal Entity associated with the company.

Currency

Select a preferred currency for rates and invoices from the drop-down list of all available ones (see the Currencies section). 

To keep correct accounting data, it is not allowed to switch the currency of the Client once the accounting transactions are created in the system.

Tip
titleTip

Once you create a Client and the system tracks any Transactions with them, you cannot change the currency in their settings anymore. However, if you have to change the currency for the Client and would like to have new Transactions in that currency, here’s what you can do:

  1. Archive the existing Client entity, all previous Transactions with them stay intact.
  2. Add the Client as new and assign the currency in which you would like to receive payments from them.

From this point on, the new Transactions of the Client will be in this new currency.


Credit limit

The additional field next to the Unlimited checkbox. User can indicate an amount of reseller's credit

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

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

  • Gateways
Select gateway(s) for this reseller 
  • SMTP Credentials
Select SMTP Credentials for this Reseller. Credentials are managed in the Data Sources section

Terminator Settings

Reseller's billing settings for outgoing calls
  • TERM Rates

Rates for outgoing events from customers under a current reseller. Enables resellers billing mode

Panel
borderColor#ccffcc
bgColor#ccffcc
borderWidth2px
borderStylesolid
Image Removed Tip

For more information about resellers billing mode, address this article

  • TERM Capacity
Termination capacity for all clients, belonging to this reseller. Leave this field empty for unlimited capacityOrigination Settings
Current Reseller's billing settings for incoming calls

Unlimited checkbox

Here you can set a specific payment mode for a client. Unlimited mode means that a client will have unlimited credit. Otherwise, the client's Balance + Credit value will be checked on RADIUS or SIP authorization. When this field is checked, the Credit limit field becomes unavailable.

  • Credit limit
The additional field next to the Unlimited checkbox. User can indicate an amount of reseller's creditORIG Rates

ORIG Rate Tables

Specify rates for outgoing events from customers under a current reseller. Enables resellers billing mode

TERM Rate Tables

Specify rates for incoming events from customers under a current reseller. Enables resellers billing modeORIG CapacityTax Profile

Indicate

origination capacity for all clients, belonging to this reseller. Leave this field empty for unlimited capacity

Invoicing Information

Current Reseller's invoicing settings

  • Date

Allows you to select how the system sets an invoicing date:

  • Real date – sets an invoicing date to actual invoicing date

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

 
  • Template
Select an invoice template that will be assigned to a reseller 
  • No Tpl
Allows to define a default format of invoice's name

a tax profile that will be used for this reseller and reflected in invoices (refers to the Taxes Profiles section).

  • SureTax, Avalara and Compliance are tax calculation services, which allow managing your compliance with tax law. These profiles are used for further calculation in invoices. To get more details, check out the US Taxation article.

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

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

Invoices Template

Select an invoice template that will be assigned to a reseller 
  • Last No
Define the last used invoice numberContact Information




Some additional information

Email

Company's email (it is required to specify an email to receive notifications). Use only Latin characters. This field is mandatory

Postal Address

Company's postal address 

Bank Account

Company's bank account info 

Tax ID

An ID of the tax-paying entity 

Reg ID

Company's registration ID 
  • Bank Account

Company's bank account info 

Company LogoHere you can add a file with a company's logo. To delete the company logo, open the edit form of a respective Reseller with a logo, then click the delete icon to remove the old logo.Mail TemplatesA detailed Mail TemplatesA detailed description of all Mail Templates and their configuration is presented at the end of the article

...

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

  • Changes in Resellers' settings will not be applied instantly. They will be automatically reloaded at the next run of the Cache Manager service.
  • Parent Reseller has access to all information of its Sub-Resellers, and also can assign any routing plan and rate table to its Sub-Resellers.

...

Reseller Removal

To add a manager, click the New Manager button. After specifying the required fields, click OK.

Screenshot: Adding a new manager

Image Removed

...

  • Name

...

  • Parent

...

  • Status

...

Select the current status of a manager:

  • Active
  • Deleted

...

  • Email

...

Manager's email. 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 the Reseller's/Manager's profile editing form.

Screenshot: Editing reseller's status

Image Removed

Please note that, in fact, a Reseller/Manager will not be deleted fully; it will be archived. To display them, use Advance Search (see above). To delete a profile completely, you need to click Full Delete in this editing window. 

Custom Fields

  • Custom Fields are used as custom variables that will be represented as readable text in invoice templates. A Custom Field allows adding information about a client.
  • Custom Package Fields are also used as custom variables that allow adding information about a package. 

To add a new field, follow these steps:

  1. Click the Add Custom Field button.
  2. Specify the Field Key and Title fields for a 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.

  3. Add respective notes to the VoIP Phone field in the Client's settings/Package settings > Custom Fields tab. 

  4. Create an invoice template and assign it to a target reseller. Then, the Clients Custom Fields and Package Custom Fields tables will appear in the Invoice Template settings. You simply need to add those tables to the invoice template. 

  5. Finally, you can generate an invoice.

Screenshot: Custom Fields

Image Removed

Rates Notifications

Rates Notification settings in the Resellers profile allow creating a default rate notification for the clients that belong to a target reseller. 

Screenshot: Rates Notifications

Image Removed

To configure these settings, open the Rate Notifications tab in the reseller profile. The structure of a tab is as follows:

...

  • Separate Rows

...

  • Delimited List

...

  • Ranges List

...

delete a Reseller from the system, you need to change the status from Active to Deleted in the Reseller's profile editing form.

Please note that a Reseller will not be deleted fully; it will be archived. To display them, use Advance Search (see above). To delete a profile completely, you need to click Full Delete in the editing window. 

Custom Fields

  • Custom Fields are used as custom variables that will be represented as readable text in invoice templates. A Custom Field allows adding information about a client.
  • Custom Package Fields are also used as custom variables that allow adding information about a package. 

To add a new field, follow these steps:

  1. Click the Add Custom Field button.
  2. Specify the Field Key and Title fields for a 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.

  3. Add respective notes to the VoIP Phone field in the Client's settings/Package settings > Custom Fields tab. 

  4. Create an invoice template and assign it to a target reseller. Then, the Clients Custom Fields and Package Custom Fields tables will appear in the Invoice Template settings. You simply need to add those tables to the invoice template. 

  5. Finally, you can generate an invoice.

Screenshot: Custom Fields

Image Added

Rates Notifications

Rates Notification settings in the Resellers profile allow creating a default rate notification for the clients that belong to a target reseller. 

Screenshot: Rates Notifications

Image Added

To configure these settings, open the Rate Notifications tab in the reseller profile. The structure of a tab is as follows:

FieldDescription
Output format
Fields DelimiterSet a delimiter for the fields if you've chosen .csv. For .xls format, this field is unavailable
With headers rowInclude a row with column names in a file
Export ColumnsSelect the columns to export
Code DeckSelect a code deck here to rewrite code names in an export file if needed
Codes from code deck checkboxInclude only codes, which are present in a specified Code Deck
Codes OutputSelect a way codes must be displayed
  • Separate Rows
Each code is placed into a single row
  • Delimited List
Codes are grouped by a code name in a row. For example, 5510, 5511, 5512
  • Ranges List
Codes are grouped by a code name into ranges plus delimiter. For example, 5510-5512, 5515
Date FormatSpecify the date format in your export file. Example of the field syntax: if you enter “%d-%m-%Y” here, your date will look like 25-02-2018
Header Text/Footer TextAllows to specify additional text into an exported file as a header and footer, respectively

Description of all columns that could be selected for a rate notification is provided below:

Info

Note that the first selected column will be the one used for sorting the rates list.


Column Name
Description
Code / Code NameCode or Code Name of a respective rate
Effective DateDate, on which a rate to be applied
RatePrice
Min VolumeThe minimum volume of chargeable events
IntervalChargeable interval
Grace VolumeFree of charge interval
Setup FeeInterval of a 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 DiffShows how current rate differs from a previous one after import
Prev Diff StatusShows how the current rate's status changed in comparison to a previous one (unchanged, increased, decreased)
Prev Diff (export) Shows how the current rate differs from a previous one after export
Prev Diff Status (export)

Rate's changes after the last export. Shows the status of how the current rate differs from a previous one.
The rate will have an unchanged status if the Effective date is lower than the Last Notification Date


Expand
titlePrev Diff Status usage example


Step 1: Notification type: All rates unique mode - First Notification: 07/07/2017
CodeRateEffective FromPrevious RatePrev DiffPrev Diff StatusPrev Diff Status (export)
11007/01/2017 00:00:00 +0000--newunchanged
21007/01/2017 00:00:00 +0000--newunchanged
31007/01/2017 00:00:00 +0000--newunchanged
Step 2: Added new rates with effective date 07/21/2017 - Second Notification: 07/14

...

Info

Note that the first selected column will be the one used for sorting the rates list.

unchanged
Column Name
Description
Code / Code NameCode or Code Name of a respective rate
Effective DateDate, on which a rate to be applied
RatePrice
Min VolumeThe minimum volume of chargeable events
IntervalChargeable interval
Grace VolumeFree of charge interval
Setup FeeInterval of a 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 DiffShows how current rate differs from a previous one after import
Prev Diff StatusShows how the current rate's status changed in comparison to a previous one (unchanged, increased, decreased)
Prev Diff (export) Shows how the current rate differs from a previous one after export
Prev Diff Status (export)

Rate's changes after the last export. Shows the status of how the current rate differs from a previous one.
The rate will have an unchanged status if the Effective date is lower than the Last Notification Date

unchanged
Expand
titlePrev Diff Status usage example
Step 1: Notification type: All rates unique mode - First Notification: 07/07
/2017
CodeRateEffective FromPrevious RatePrev DiffPrev Diff StatusPrev Diff Status (export)
1
10
1507/
01
21/2017 00:00:00 +0000
-
10
-
5
new
increasedincreased (5.0000)
2
10
1507/
01
21/2017 00:00:00 +0000
-
10
-
5
new
increasedincreased (5.0000)
3
10
1507/
01
21/2017 00:00:00 +0000
-
10
-
5
newunchanged
increasedincreased (5.0000)
Step
2
3:
Added new rates with effective date 07/21/2017 - Second
Rate with code 1 was edited and the increase was canceled- Third Notification: 07/
14
21/2017
CodeRateEffective FromPrevious RatePrev DiffPrev Diff StatusPrev Diff Status (export)
1
15
1007/21/2017 00:00:00 +0000100
5
unchanged
increasedincreased (5.0000)
unchanged
21507/21/2017 00:00:00 +0000105increasedincreased (5.0000)
31507/21/2017 00:00:00 +0000105increasedincreased (5.0000)
Step
3
4: Rate with code
1
2 was edited and
the increase was canceled- Third
added a new rate for code 3- Fourth Notification: 07/
21
28/2017
CodeRateEffective FromPrevious RatePrev DiffPrev Diff StatusPrev Diff Status (export)
1
1007/21/2017 00:00:00 +0000
10
0215
unchangedunchanged
07/21/2017 00:00:00 +000010
5increasedincreased (5.0000)31507/21/2017 00:00:00 +0000105increasedincreased (5.0000)Step 4: Rate with code 2 was edited and added a new rate for code 3 - Fourth Notification: 07/28/2017 CodeRateEffective FromPrevious RatePrev DiffPrev Diff StatusPrev Diff Status (export)11007/21/2017 00:00:00 +0000100unchangedunchanged22007/21/2017 00:00:00 +00001010increasedunchanged32007/31/2017 00:00:00 +0000155increasedincreased (5.0000)
NotesAdditional informationTagTags that are assigned to a respective ratePolicyIndicated policy of the rateStatusDefine a current rate status

Autocharge Settings

Autocharge Settings in the Resellers profile allow configuring the settings for Authorize.net or USAePay payment gateways. These settings will be true for all the clients under the respective Reseller.

Screenshot: Autocharge Settings

Image Removed

To configure these settings, open the Autocharge Settings tab in the reseller profile. The structure of a tab is as follows:

0unchangedunchanged
22007/21/2017 00:00:00 +00001010increasedunchanged
32007/31/2017 00:00:00 +0000155increasedincreased (5.0000)



NotesAdditional information
TagTags that are assigned to a respective rate
PolicyIndicated policy of the rate
StatusDefine a current rate status
FieldDescriptionAuthorize.NetLoginAPI loginTransaction KeyAPI transaction keyGateway CurrencyA currency declared by the Payment GatewaySystem CurrencyDefault JeraSoft Billing system currencyPayment AccountPayment Account nameUSAePayAPI KeyAPI keyAPI PINAPI PIN to the API key
System CurrencyDefault JeraSoft Billing system currencyPayment AccountPayment Account name

Configuring Mail Templates

Also, there are different mail templates you can configure in your company's profile:

...

Content by Label
showLabelsfalse
spaces+KB
showSpacefalse
sortmodified
excerpttrue
reversetrue
excerptTypesimple
cqllabel in ("companies","reseller") and space = "KB"
labels+companies,capacity