BILLmanager Documentation

Database structure

BILLmanager 5 stores its data in MySQL or MariaDB database. It supports all the versions provided by CentOS 7. External keys with different types of connectivity are used to ensure data integrity (removal of records that refer to the object during deletion, forbidding to delete records, if there are links that refer to them). Representation, procedures, and triggers are not used, because they can influence the replication.

BILLmanager tables can be divided into several basic groups:

  • Basic objects — basic BILLmanager objects to which other objects refer. 
  • Services and tariff plans — information about clients' services and their billing cycles. 
  • Finances and discounts — information about promotion actions, payments, and expenses. 
  • Mass mailing and notifications — information about mass mailing and notification templates.
  • Support — tickets and tasks.
  • internal information — BILLmanager service objects that you can use when writing plug-ins. 

In this article, we don't describe all tables and fields, as some of them are used only for internal needs. Tables and table fields described here refer to BILLmanager Corporate, that's why your database may not contain some tables or fields. The database structure can be modified and additional tables and fields can be added. Direct links to other tables can be replaced by tables which store "many-to-many" relationships.

Tables and fields containing values for all the localizations configured in the billing panel are duplicated with the _code_language prefix. Such fields are shown in italics in this article. The orderpriority field in the tables defines the sorting order of elements in BILLmanager interface. 

Basic objects


account

Information about accounts and client groups

  • id — client or client group id
  • name — client or client group name 
  • parent — parent account of a client or client group (by default 1). Link to the account table 
  • level — access level:
    • 29 — provider's parent account; 
    • 16 — registered client;
    • 15 — client group;
    • 8 — unregistered client
  • registration_date — client registration date
  • registration_ip — IP address that the client was registered from
  • note — comment to client account
  • attitude — characteristics of the client:
    • 0 — common,
    • 1 — good,
    • 2 — conflict
  • allowdeleteitem — clients included into the group can delete services regardless the policy settings
  • allowsuspenditem — clients included into the group can disable services regardless the policy settings
  • ignoreitemmax — clients included into the group can ignore the limit on the number of services available for and related to a specific tariff plan
  • ignoreabuserate — clients included into the group can ignore the actions that will be performed when the they reached the abuse score limit
  • employee — staff member who registered the client. Link to the user table
  • label — client label which can be used in filters
  • need_activation — email verification is required for this account
  • need_manual_vetting — manual verification is required for this account
  • country — client country. Link to the country table
  • state — client region. Link to the state table
  • abuse_rate — number of abuse scores

account_fraud_check

Phone verification information

  • account — client id. Link to the account table
  • verification_code — confirmation code
  • try_count_code — number of attempt to enter a code
  • try_count_phone — number of phone verification attempts
  • try_phone — unverified phone number
  • valid_phone — verified phone number
  • send_time — code sending time
  • expire_time — code expiration time

accountgroup_condition

Client group conditions 

  • id — condition id
  • type — condition type
  • accountgroup — id of the client group. Link to the account table
  • conditiongroup — group of conditions
  • comparison — comparison type for condition
  • param — name of the parameter that is used in comparison
  • value — value for comparison

account2project

Information about clients and providers

  • account — Client id. Link to the account table
  • project — Provider id. Link to the project table
  • affiliate — provider's affiliate program, in which a client participates. Link to the affiliate table
  • affiliatereferer — user who referred a client by the link. Link to the account table
  • affiliateprogram — affiliate program associated with the referred client. Link to the affiliate table
  • assigning_date — date when the client was referred to provider

account2group

Client groups

  • account — Client id. Link to the account table
  • accountgroup — Client group id. Link to the account table
  • assigning_date — date when client was included into the group

user

Users, staff members, departments

  • id — user or department id
  • name — user or department name
  • account — client or provider account who is the owner of user or staff member. Link to the account table
  • password — password hash
  • level — access level:
    • 29 — staff member,
    • 28 — department,
    • 16 — client's user
  • enabled — user or staff member state
  • language — interface language
  • realname — full name of the user or staff member, department description
  • position — job title
  • support_department — indicates that client can write tickets to this department in the Support center
  • working_plan — department business hours. Link to the working_plan table
  • email — user or staff member email
  • emailverified — verified/non-verified email address
  • phone — user or staff member phone number
  • avatar_file — avatar file name of the user or staff member
  • support_require — support incidents will be deducted from client's account for support or assistance
  • timezone — timezone where user or staff member is located
  • head — link to head of department. Link to the user table

user2project

Information about departments and providers that clients can see in the Support center

  • user — department id. Link to the user table
  • project — provider id. Link to the project table

user2usergroup

Company departments 

  • user — employee code. Link to the table user table
  • usergroup — department code. Link to the table user table

project

List of providers

  • id — provider id
  • name — provider name
  • account —parent account id. The system field. Link to the account table
  • requery_phone — phone verification is required for service order
  • smallimg — logo file name
  • subaccountgentype — account id generation type:
    • 0 — Consecutive numbers
    • 1 — Luhn algorithm numbers
  • notifyemail — email address that sends notifications
  • site — provider's web-site URL
  • billurl — billing URL for provider identification
  • ga_counter — tracking ID for Google Analytics
  • ga_type — export data type for Google Analytics:
    • expense — upload expenses,
    • item — upload services
  • support_require — per incident support
  • support_over_limit — allows staff members to deduct support incidents when a client exceeds the limit of available incidents
  • taxexclusive — apply taxes that are not included in price
  • taxcustompay — apply taxes for advanced payments
  • country_default — provider's default country. Link to the country table

project2currency

Currencies set by the service provider 

  • project — provider id. Link to the project table
  • currency — currency id. Link to the currency table
  • projectdefault — default value

project2profile

Companies tied to service providers

  • project — provider id. Link to the project table
  • profile — company id. Link to the profile table
  • payment_description — purpose of advanced payment template

taxrule

Tax rules

  • id — rule id
  • project — provider id . Link to the project table
  • country — id of the country for which the rule is applied. Link to the country table
  • state — id of the region for which the rule is applied. Link to the state table
  • taxrate — tax rate
  • specialitemtype — tax rate will be applied only to certain product types
  • company — tax rate will be applied for the specified company. Link to the profile table

taxrule2itemtype

Product types that the tax rate is applied to

  • taxrule — tax rule. Link to the taxrule table
  • itemtype — product type. Link to the itemtype table

subaccount

Personal accounts

  • id — personal account
  • account — id of personal account owner. Link to the account table
  • currency — currency id. Link to the currency table
  • project — id of service provider. Link to the project table
  • creditlimit — credit limit set for the account
  • allowpostpaid — allows a client to purchase services on credit
  • enoughmoneyto — client will enough funds on his account until the specified date
  • active — current status of personal account
  • balance — account balance

profile

Payers and companies 

  • id — payer or company id
  • name — payer or company name
  • person — contact person
  • account — client or provider account. Link to the account table
  • profiletype — legal status:
    1 — private person,
    2 — legal entity,
    3 — sole proprietor
  • invoicetype — invoice generation type for payers:
    0 — after payment,
    1 — automatically after advance payment is made,
    2 — based on paid and unpaid expenses (separately),
    3 — based on paid and unpaid expenses (jointly)
  • invoicedesc — description of invoice position (invoice generated based on advance payment)
  • doctmpl_payment — payment template for printing. Link to the doctmpl table
  • doctmpl_invoice — invoice template for printing. Link to the doctmpl table
  • doctmpl_envelope — envelope template for printing. Link to the doctmpl table
  • doctmpl_reconciliation — reconciliation report template for printing. Link to the doctmpl table
  • sendcost — cost of invoice sending. This information is displayed to clients
  • sendcostcurrency — currency of invoice sending cost. Link to the currency table
  • numtmpl_payment — template for generating payments numbers
  • numtmpl_invoice — template for creating invoices
  • nextnum_payment — the next serial number of payment
  • nextnum_invoice — the next serial number of invoice
  • email — payer's or company's email
  • www — website
  • fax — fax number
  • phone — phone number
  • country_legal — legal address, country. Link to the country table
  • postcode_legal — legal address, index
  • state_legal — legal address, region
  • city_legal — legal address, city
  • address_legal — legal address, address
  • country_physical — actual address, country. Link to the country table
  • postcode_physical — actual address, index
  • state_physical — actual address, region
  • city_physical — actual address, city
  • address_physical — actual address, address
  • locale — documents localization. Link to the locale table
  • regdate — registration date
  • vatnum — tax number
  • id1c — code in accounting system
  • payment_description — advance payment description
  • maildocs — how to send documents to customers
  • maildocs — how to receive documents:
    • 0 — do not receive,
    • 1 — by mail,
    • 2 — email,
    • 3 — via electronic document management system
  • note — comment to the payer profile
  • need_activation — email confirmation is required
  • need_manual_vetting — manual confirmation of payer data is required
  • manual_vetting_message — unsuccessful verification notice
  • postcompany — company on behalf of which invoices are generated. The invoices are based on unpaid expenses. Link to the profile table
  • postcurrency — currency which is used for invoices. The invoices are based on unpaid expenses. Link to the  currency  table

profileparam

Additional parameters of companies and payers

  • id — parameter id
  • profile — payer or company id. Link to the profile table
  • intname — parameter internal name
  • value — parameter value

profile2company

Payers tied to companies

  • profile — payer id. Link to the profile table
  • company — company id. Link to the table profile table

companycontract

Drafts of contracts and service agreements

  • id — id of contract draft
  • name — name
  • profile — Company which uses such contract draft. Link to the profile table
  • doctmpl — printing template of contract draft. Link to the doctmpl table
  • suffix — contracts number suffix
  • firstappendix — serial number of the first appendix
  • accountgroup — client group for which contract drafts will be created. Link to the account table
  • start_date — the start date of contract
  • end_date — the end date of contract
  • contracttype —contract type:
    • 0 — service agreement,
    • 1 — offer,
    • 2 — affiliate agreement
  • accepttype — when customers accept terms of the contract:
    • 0 — during registration,
    • 1 — during registration and payment,
    • 2 — during payment

companycontract2itemtype

Contract drafts died to product types

  • companycontract — contract draft id. Link to the account table
  • itemtype — product type id. Link to the account table

companycontractappendix

appendixes to the contract drafts

  • id — code of appendix to a contract
  • name — name
  • companycontract — contract draft code. Link to the table companycontract
  • project — code of provider, which uses such appendix. Link to the table project
  • itemtype — code of product type, to which this appendix relates. It is used to add tariff plan prices. Link to the table itemtype
  • doctmpl — code of template of appendix to a contract
  • nocheck — checkbox for checking that customer has the services of indicated product type

contract

contrast for clients

  • id — contract id
  • number — contract number
  • signdate — date when the contract was signed
  • senddate — date when the contract was sent to client
  • profile — payer, who signed the contract. Link to the profile table
  • companycontract — contract draft code. Link to the companycontract table
  • status — current contract status:
    • 1 — draft,
    • 2 — requested,
    • 3 — sent,
    • 4 — signed,
    • 5 — terminated

contractparam

contract parameters

  • id - parameter id
  • contract — id of payer's contract. Link to the contract table
  • intname — internal parameter name
  • value — contract value

contractappendix

Contract appendixes

  • id — id of contract appendix
  • contract — contract id. Link to the contract table
  • companycontractappendix — id of appendix to contract draft. Link to the companycontractappendix table
  • number — number of the contract appendix
  • cdate — creation date

currency

List of currencies 

  • id — country id
  • name — currency name
  • iso — ISO currency code
  • code — digital currency code
  • active — indicates is the currency is activated or not

currencyrate

Currency rates

  • id — id of currency rate
  • currency_base — source currency. Link to the currency table
  • currency_relate — target currency. Link to the currency table
  • rate — conversion rate
  • amount — amount of basic currency units. Conversion rate is indicated for this amount
  • ratedate — rate date

currencyrate_account

Personal currency rates

  • id — code of currency rate record
  • account — conversion rate for a client. Link to the account table 
  • currency_base — base currency. Link to the currency table  
  • currency_relate — target currency. Link to the currency table  
  • rate — conversion rate
  • amount — amount of basic currency. Conversion rate is indicated for this amount
  • ratedate — rate date

enumeration

List of enumerations

  • id — enumeration id
  • name — enumeration name
  • intname — internal enumeration name

enumerationitem

Enumeration values

  • id — enumeration item id
  • enumeration — enumeration id. Link to the enumeration table
  • name — enumeration item name
  • intname — internal enumeration item name

ipmgr

Integration with IPmanager

  • id — id of connection to IPmanager
  • name — name
  • url — IPmanager URL
  • login — user login
  • password — user password
  • adminlogin — IPmanager administrator login
  • adminpassword — IPmanager admin password
  • hiddentypes — types of IP addresses that the system won't check

nameserver

Integration with name servers

  • Tid — connection id
  • module — module type
  • name — name
  • url — panel URL
  • login — user login
  • password — user password
  • project — id of the provider who uses name servers. Link to the project table
  • freedomain — name servers will be used for free domain names
  • dnsprovider — name servers will be used for provider's name servers
  • dnsprivate — name servers will be used for private name servers
  • dnsprovidercount — domain limit for provider's name servers
  • dnsprivatecount — domain limit for private name servers

processingmodule

Service processing modules

  • id — id of processing module
  • orderpriority — selection order for processing module during service activation
  • name — name of the processing module
  • module — type of the processing module
  • ipmgr — id of connection to IPmanager. Link to the ipmgr table
  • laststatdate — date of the last successful statistics collection
  • config — internal processing module configuration received from the control panel
  • datacenter — data center id. Link to the data-center table
  • department — id of department responsible for this processing module. Link to the user table
  • licserver — license server id. Link to the processingmodule table
  • active — indicates if this processing module is activated or not

processingparam

Parameters of processing modules

  • id — id of processing modules parameter
  • intname — internal parameter name
  • value — parameter value
  • processingmodule — processing module id. Link to the processingmodule table

processingcryptedparam

Encrypted parameters of processing modules

  • id — id of processing module parameter
  • intname — internal parameter name
  • value — parameter value
  • processingmodule — processing module id. Link to the processingmodule table

processingnode

Additional nodes of processing modules

  • id — additional node id
  • name — name of processing module node
  • processingmodule — processing module id. Link to the processingmodule table
  • panelid — id of processing module node according to the control panel's data
  • ip — IP address of processing module node

processingmodule2pricelist

Tariff plans associated with processing modules

  • processingmodule — processing module id. Link to the processingmodule table
  • pricelist — tariff id. Link to the pricelist table

measure

Units of measure

  • id — measure unit id
  • name — measure unit name
  • intname — internal name of the unit of measure
  • embedded — indicates that this is a system unit of measure
  • lessmeasure — link to the less measure unit of the same type. Link to the lessmeasure table
  • relation — relation of the smaller unit of measure to a larger one

tld

List of top-level domains

  • id — tld id
  • name — domain name in punycode
  • whois_host — server whois address
  • idn_type — symbols that can be used in subdomains
  • min_lenght — minimal domain name length in symbols
  • max_lenght — maximum domain name length in punycode
  • whois_find_string — Whois string to check domain availability
  • embedded — indicates if it is embedded into BILLmanager or not

locale

Localizations

  • id — localization id
  • name — localization name
  • langcode — id of the language corresponding to localization
  • processed — indicates that the localization is processed
  • active — indicates that the localization is activated
  • embedded — indicates if it is embedded into BILLmanager or not

country

List of countries

  • id — country id in the BILLmanager database
  • name — country name
  • iso2 — ISO2 code
  • phonecode — phone code
  • phoneformat — phone number format for this country
  • active — indicates if the country is activated or not

country_profile_param

Payer parameters based on a certain country

  • id — parameter id
  • orderpriority — how parameters are sorted on the payer edit from
  • intname — parameter internal unique name
  • inputtype — input field for parameter
  • name — field name that will be displayed in the interface
  • hint — field hint that will be displayed in the interface
  • country — country associated with this parameter. It will be displayed on the payer edit form. Link to the country table
  • embedded — indicates if it is present in BILLmanager
  • required — indicates that it is the obligatory parameter
  • validator — parameter field validator
  • check_range — validator parameters
  • page — name of the page where this parameter will be displayed
  • inputrows — number of input fields for text parameters
  • zoom — indicates that the input field can be zoomed
  • readonly_client — indicates that the parameter is read-only
  • requiredonpay — indicates that this is the obligatory parameter during the payment process

country_profile_param_type

Payer parameters based on payer type

  • id — record id
  • country_profile_param — parameter id. Link to the country_profile_param table
  • profiletype — type of the payer to which the parameter will be applied

countrydoctype

Documents that are used in a country

  • id — record id
  • intname — internal name of the document type
  • country — country that can use a selected document type. Link to the country table

state

List of regions

  • id — record id
  • name — region name
  • country — region country. Link to the country table

doctmpl

Document templates

  • id — record id
  • name — document template name
  • account — id of the template owner. Link to the account table
  • doctype — document type
  • content — contents of the document template
  • locale — localization associated with the document

docflow_box

Mailboxes of the electronic document management system that documents will be sent to 

  • id — record id
  • profile — owner of the mailbox in the electronic document management system. Link to the profile table
  • docflow_connection — connection id to the electronic document management system. Link to the  docflow_connection table
  • organization_id — organization id in the electronic document management system.
  • box_id — mailbox id in the electronic document management system.
  • name — mailbox name
  • active — indicates that the mailbox is used
  • roaming — indicates the the mailbox is connected to roaming service with the electronic management system, which differs from the system that the providers uses
  • branch — indicates that the mailbox is registered for a certain branch of the company

docflow_connection

 Electronic document management system

  • id — record id
  • profile — company that is connected to the electronic document management system. Link to the profile  table
  • username — username
  • password — user password
  • module — module that allows to connect to the electronic document management system
  • xmlparams — connection parameters in XML
  • autoassign — allows to automatically find payers associated with a certain company in the electronic document management system

docflow_counteragent

Contract parties in the electronic document management system 

  • id — record id
  • profile — company that is connected to the electronic document management system. Link to the profile  table
  • username — username
  • password — user password
  • module — module that allows to connect to the electronic document management system
  • xmlparams — connection parameters in XML
  • autoassign — allows to automatically find payers associated with a certain company in the electronic document management system

docflow_department

Departments of contract party

  • id — record id
  • name — name of the contract party in the electronic document management system
  • profile — payer associated with the contract party department. Link to the profile table
  • docflow_connection — connection id to the electronic document management system. Link to the  docflow_connection  table
  • department_id — department id in the electronic document management system
  • organization_id — organization id in the electronic document management system
  • active — current status

Services and tariff plans


itemtype

List of tariff plans and their addons

  • id — product type id
  • orderpriority — display order in the order form
  • name — product type name
  • intname — internal product type name
  • embedded — indicates that is embedded into BILLmanager
  • parent — parent product type, if it is included into another product type. Link to the itemtype table
  • itemname — template of service name, expenses, order item
  • show_addon_image — enables to display images in the service order form
  • orderimage — name of the product type image file
  • orderview — indicates how to display services in the order form:
    • 0 — list,
    • 1 — blocks
  • trial — activates trial period
  • day — activates daily order period
  • monthly — activates monthly order period
  • quarterly — activates 3-month order period
  • semiannual — activates half-a-year order period
  • annually — activates yearly order period
  • biennial — activates 2-year order period
  • triennial — activates 3-year order period
  • quadrennial — activates 4-year order period
  • quinquennial — activates 5-year order period
  • lifetime — activates lifetime order period
  • transfer — allows transfers
  • trialtype — trial version policy:
    • 0 — one trial version per product type,
    • 1 — one trial version in every tariff group,
    • 2 — one trial version per tariff plan,
    • 3 — per every service
  • suspendperiod — period for automatic termination of suspended services
  • splitexpense — divide expenses by months
  • nostopholidays — do not stop services during weekend
  • closetype — service renewal policy:
    • 0 — clients can delete services,
    • 1 — clients cannot delete services,
    • 2 — clients can delete services after phone confirmation
  • closesubtype - additional policy for service deletion:
    • 0 — immediately,
    • 1 — after the service expires
  • statparam — parameter name statistics-based billing type
  • open_duration_limit — service activation time limit which is used in reports

itemtype2project

Service order/payment requires phone verification 

  • itemtype — product type id. Link to the itemtype table
  • project — provider id. Link to the project table
  • requery_phone — indicates that the verified phone number should be specified in the billing system

itemtypeparam

Product type parameters

  • id — record id
  • orderpriority — display order in the order form
  • intname — internal parameter name
  • embedded — indicates if it is embedded into BILLmanager
  • itemtype — product type id associated with parameter. Link to the itemtype table

  • ordervisible — display in the order form
  • openvisible — display and save during automatic processing or in manual tasks
  • editwritelevel — parameter record permissions after service order
  • editreadlevel — parameter view permissions after service order
  • inputtype — input field type for parameter
  • inputrows — number of input strings for parameter's input fields
  • validator — field validator name
  • check_range — validator parameters
  • name — product type parameter name, which is displayed in interface
  • hint — hint to the parameter input field
  • required — mandatory parameter
  • zoom — indicates that the input field can be expanded
  • crypted — save parameters in encrypted form

itemtypeparamvalue

Parameter values set by the list of values 

  • id — record id
  • orderpriority — display order in the order/renewal form
  • name — parameter name that is displayed in the interface
  • intname — internal value parameter name. It is saved in database
  • itemtypeparam — product type parameter id. Link to the itemtypeparam table
  • info — additional information about the value. It is displayed as underlined
  • disablepricelists — do not add parameter value to new tariff plans
  • tags — additional data (e.g. it can be used for comparison of recipes and operating systems)

autosuspend

List of services that will be suspended soon

  • id — record id
  • item — id of the service that will be suspended. Link to the item table
  • suspenddate — service suspension time and date

billorder

Client orders

  • id — order id
  • subaccount — id of the personal account associated with the order. Link to the subaccount table
  • name — order name
  • cdate — order creation date
  • status — current order status:
    • 1 — open,
    • 2 — pending,
    • 3 — paid
  • amount — order amount in the account currency
  • postpaid — post-paid service

billorderitem

List of ordered items

  • id — position id
  • billorder — order id. Link to the billorder table
  • item — id of service associated with the order position. Link to the item table
  • operation — type of operation paid by position
  • operationparams — parameters of operation paid by position
  • amount — position cost in account's currency
  • taxamount — tax amount which is counted in personal account currency
  • taxrate — tax rate by order position
  • paymethodamount — unit price in payment method currency. It is specified when generating an invoice for order
  • paymethodtaxamount — tax amount. It is specified when generating an invoice for order
  • name — order position name
  • customname — indicates that an order position name should be specified manually

colo_hardware

List of hardware for colocation

  • id — record id
  • item — colocation service id. Link to the item table
  • hardware — equipment name
  • receivingdate — date when service provider received equipment
  • returndate — return date of equipment to client
  • note — additional information about equipment
  • unit — hardware location in a rack
  • status — current status:
    • 1 — located,
    • 2 — returned
  • receiveemployee — staff member who accepted equipment
  • receiveuser — person who delivered equipment
  • returnemployee — staff member who returned equipment
  • returnuser — person who received equipment

colo_port

Server equipment ports

  • id — record id
  • name — port name
  • item — colocation service id. Link to the item table
  • linked_port — id of the associated port. Link to the colo_port table
  • note — additional information to the port
  • vlan — name of the VLAN connected to the port

datacenter

List of data-centers

  • id — data-center id
  • orderpriority — order priority
  • name — data-center name

fixedprices

Fixed prices

  • id — record id
  • pricelist — id of the tariff plan or addon associated with the fixed price. Link to the pricelist table
  • fixdate — date of the fixed price
  • parent — parent record of the fixed price. Link to the fixedprices table

fixedpricesprice

Comparison of fixed and common prices

  • id — record id
  • fixedprices — fixed price id. Link to the fixedprices table
  • price — price id. Link to the price table
  • currency — currency id. Link to the currency table
  • pricelist — tariff or addon id. Link to the pricelist table
  • enumerationitem — id of the enumeration associated with the fixed price. Link to the enumerationitem table

ip

List of IP addresses

  • id — record id
  • ipmgr — id of IPmanager the IP address was allocated from. Link to the ipmgr table
  • name — IP address
  • domain — PTR record
  • item — id of the service addon this IP is assigned to. Link to the item table
  • pricelist — id of the tariff plan associated with this IP. Link to the pricelist table
  • status — current status:
    • 0 — IP address is not assigned to a service,
    • 1 — in progress,
    • 2 — active
  • createdate — IP add date
  • mask — IP network mask
  • gateway — default gateway

item

List of services and their addons

  • id — service id
  • pricelist — tariff or addon id. Link to the pricelist table
  • lastpricelist — id of the old tariff plan during tariff change. Link to the pricelist table
  • account — id of the client who ordered the service. Link to the account table
  • period — current order period
  • parent — id of the parent service for addon. Link to the item table
  • intvalue — additional value for integer addon
  • enumerationitem — addon value specified by enumeration. Link to the enumerationitem table
  • enumerationitem_addonenumerationitem — addon limit specified by enumeration. Link to the enumerationitem table
  • processingmodule — service processing module id. Link to the processingmodule table
  • status — current status of the service:
    • 1 — ordered,
    • 2 — active,
    • 3 — suspended,
    • 4 — deleted,
    • 5 — in progress
  • addonlimit — addon limit specified by integer
  • createdate — service creation date
  • expiredate — service expiration date
  • opendate — service activation date
  • suspenddate — service suspension date
  • updatedate — last modification date
  • statdate — last statistics date
  • price — record id of personal prices. Link to the price table
  • addonbool — personal limit specified for Boolean addon
  • boolvalue — Boolean addon value
  • autoprolong — auto-renewal period
  • autosuspend — indicates that the service can be suspended due to non payment
  • employeesuspend — indicates that the service can be suspended by provider staff
  • abusesuspend — service can be suspended due to abuses
  • name — service name
  • note — comment
  • changerefund — amount above the price of the old tariff plan in case of tariff downgrade
  • remoteid — service id in BILLmanager reselling services from this BILLmanager
  • cost — service renewal price
  • reservedsum — amount reserved for service renewal
  • costperiod — period for which service renewal price is calculated
  • costdate — service price calculation date
  • serverloaded — id of the processing modules that were used to activate the service
  • processingnode — processing module node where the service is created. Link to the processingnode table
  • clonedfrom — service id from which the current service was received when moving it between clients. Link to the item table
  • delete_code — code for service deletion with phone verification
  • try_count_code — number of attempts to enter the service deletion confirmation code
  • try_count_phone — number of attempts to receive the service deletion confirmation code
  • code_send_time — service deletion code sent time
  • code_expire_time — service deletion code expiration time
  • fixedprices — fixed price id. Link to the fixedprices table
  • autoassign — indicates that the service can be activated for a client automatically
  • specialstatus — service status for hourly billing:
    • 0 — normal status,
    • 1 — change in progress,
    • 2 — hourly billing cannot be activate for a service
  • hourlycompensationdate — last date when the client was refunded for over debit (provided that the hourly billing is enabled)
  • scheduledclose — indicates that the service must be deleted rather than suspended

certificate

Additional parameters of SSL-certificates 

  • item — certificate id. Link to the item table
  • csr — certificate signing request
  • crt — certificate text
  • crt_type — certificate type:
    • empty value — text,
    • zip — base64 encrypted archive

itemparam

Service parameters

  • id — record id
  • item — id of the parameter service. Link to the item table
  • intname — parameter internal name
  • value — parameter value

itemcryptedparam

Encrypted parameters

  • id — record id
  • item — service id. Link to the item table
  • intname — parameter internal name
  • value — parameter encrypted value

itemevent

List of service events. It is used in case of service reselling

  • id — record id
  • item — service id associated with the event. Link to the item table
  • eventtype — event type:
    • 1 — creation,
    • 2 — susension,
    • 3 — activation,
    • 4 — deletion,
    • 5 — allocation of a new IP address,
    • 6 — deletion of IP address,
    • 7 — certificate issue,
    • 8 — change of addons,
    • 9 — change of parameters,
    • 10 — renewal,
    • 11 — activation,
    • 12 — suspension
  • param — XML-document describing an event

itemspecialstatus

Service status change in case of hourly billing

  • id — record id
  • item — service id which status was changed. Link to the item table
  • changedate — date and time when the service status was changed
  • specialstatus — new status

itemstat

Resource usage statistics

  • item — service id. Link to the item
  • statdate — statistics date
  • measure — unit of measure used for statistics collection . Link to the measure table
  • param — resource internal name
  • value — resource value

price

List of service prices, tariff plans, etc. 

  • id — record id
  • trial — trial service cost. It is used for addons
  • lifetime — lifetime service cost
  • day — daily cost
  • monthly — monthly cost
  • quarterly — 3 month cost
  • semiannual — 6 month cost
  • annually — yearly cost
  • biennial — 2 year cost
  • triennial — 3 year cost
  • quadrennial — 4 year cost
  • quinquennial — 5 year cost
  • setup — setup fee
  • transfer — transfer cost
  • stat — cost based on statistics. It is used for addons
  • currency — currency id. Link to the currency table
  • prolong — record id renewal cost. Link to the price table

pricelist

List of tariff plans and addons 

  • id — tariff plan id or additions
  • orderpriority — defines how tariff plans or addons are sorted
  • name — tariff or addon name
  • project — provider id who offers this tariff plan. Link to the project table
  • itemtype — id of the tariff or addon product type. Link to the itemtype table
  • description — tariff description displayed on the order form, or addon description displayed in a hint
  • billtype — addon billing type:
    • 1 — do not bill,
    • 2 — based on order,
    • 3 — based on resource statistics,
    • 4 — client can choose,
    • 5 — based on values of other resources,
    • 10 — addon was added manually (this information is not displayed in the interface)
  • billhourly — hourly billing
  • billdaily — daily billing
  • changepolicy — tariff change policy:
    • 0 — service expiration date will change,
    • 1 — extra charge/refund,
    • 2 — tariff cannot be changed,
    • 3 — extra charge for upgrade, no refund after downgrade,
    • 4 — a client must pay the full price of a new tariff plan. Renewal from the current date
  • billprorata — calendar billing
  • prorataday — pro-rata day for daily billing
  • active — tariff is available for order
  • intname — tariff internal name in the control panel
  • opennotify — service activation template id. Link to the notifytemplate table
  • show_addon_image — addon icon name on the tariff order form
  • orderimage — tariff icon name on the order form
  • license — service agreement template id. Link to the doctmpl table
  • trial — trial period length in days
  • pricelist_group — tariff group id. Link to the pricelist table
  • access — id of the group that can order the tariff plan. Link to the account table
  • addontype — tariff addon type:
    • 1 — boolean addon,
    • 2 — integer addon,
    • 3 — addon specified by enumeration
  • measure — unit of measure. Link to the measure table
  • parent — id of the main tariff for addon. Link to the pricelist table
  • addonlimit — amount of addon that the tariff includes
  • addonstep — addon order step
  • addonmax — maximum amount available for order
  • addonmaxtrial — maximum amount available for order during a trial period
  • addonmin — minimum amount available for order
  • enumeration — addon enumeration. Link to the enumeration table
  • enumerationitem — addon default value specified by enumeration. Link to the enumerationitem table
  • addonbool — boolean addon that the tariff plan includes
  • minperiodtype — minimum order period:
    • 1 — month,
    • 2 — day
  • minperiodlen — minimum order period length
  • addonstattype — resource overage calculation type (the billing type - based on statistic):
    • 1 — calendar month,
    • 2 — day
  • addonstatcomparison — how to bill clients for resource overage if several parameters are used:
    • 1 — sum values,
    • 2 — count the maximum value
  • addonstatcalculation — price type selected in the addon configuration form:
    • 0 — per every item,
    • 1 — per item per month (the price will be divide by the number of days in the month)
  • requery_phone — phone verification is required for service order
  • suspendperiod — period in days that will pass before unpaid services will be deleted automatically
  • suspendpenaltytype — late renewal fee:
    • 0 — no fee,
    • 1 — fixed amount,
    • 2 — percent,
    • 3 — service renewal from the suspension date
  • suspendpenaltypercent — penalty percentage for late renewal
  • isgroup — tariff group
  • manualname — defines that the addon name should be specified manually
  • compound — addon with the billing type "Client can choose". It groups other addons. Link to the pricelist table
  • note — comment field
  • itemmax — maximum number of services associated with the tariff plan or tariff group available for order
  • trial_itemmax — maximum number of trail services of a certain tariff plan or tariff group ordered by all clients at the same time
  • allownosuitable — indicates that the tariff plan will be available for order even if there are no available processing modules
  • restrictclientchange — addon change policy after order:
    • 'on' — can be changed
    • 'off' — cannot be changed,
    • 'uponly' — only upgrade,
    • 'downonly' — only downgrade
  • orderpolicy — addon charge policy:
    • 0 — payment for the remaining period
    • 1 — full price
  • returnpolicy — refund policy if a client cancel the service before it expires:
    • 0 — refund
    • 1 — no refund
  • manualprocessing — indicates that addons should be processed manually
  • nostopholidays — do not suspend services on weekend
  • scaletype — value scale type for integers:
    • 0 — the maximum value but not larger than the order includes
    • 1 — calculate price per every scale step
    • 2 — order pre-defined addon packages
    • 3 — select a value from a list of pre-defined values
  • label — list of tariff labels
  • allowpostpaid — allows for post-paid services
  • processing_feature — the system will check that a processing module supports this feature. It is used for tariff plans with the "Client can choose" billing type.
  • chargestoped — charge a client for a suspended service in case of hourly billing
  • autocalcday — the system will calculate a service price per day provided that the 'day' order period is available to clients
  • forcecontractprint — tariff plan will be displayed in a service agreement even if a client doesn't have services associated with that tariff
  • roundtype — rounding procedure for addon value (the value is calculated based on values of other resources)
  • quickorder — tariff plan is available for quick order
  • addonstatchargestoped — an add-on is associated with the tariff plan "Bill on suspended services"

pricelist2enumerationitem

Addons and corresponding enumerations

  • id — record id
  • orderpriority — display order on a service order form
  • pricelist — addon id. Link to the pricelist table
  • enumerationitem — enumeration item id. Link to the enumerationitem table
  • disabled — indicates that this option is not available

pricelist2enumerationitemprice

Prices and corresponding addons with enumerations

  • pricelist2enumerationitem — record id. Link to the pricelist2enumerationitem table
  • currency — currency id. Link to the currency table
  • price — record id with prices. Link to the price table

pricelist2itemtypeparam

Tariff plans with corresponding product types

  • pricelist — tariff id. Link to the pricelist table
  • itemtypeparam — product type parameter id. Link to the itemtypeparam table

pricelist2itemtypeparamvalue

Tariff plans and corresponding product type parameters 

  • pricelist — tariff plan id. Link to the pricelist table
  • itemtypeparamvalue — product type parameter id. Link to the itemtypeparamvalue table

processingmodule2itemtypeparamvalue

Service processing modules and associated product type parameters

  • processingmodule — processing module id. Link to the processingmodule table
  • itemtypeparamvalue — service type parameter id. Link to the itemtypeparamvalue table

pricelistcalc

Rules for calculating addon values based on values of other addons 

  • id — record id
  • pricelist — id of the addon which value is calculated based on values of other resources. Link to the pricelist table
  • reference — addon id. Link to the pricelist table
  • only_additional — indicates that values should be calculated only based on additional resources that the client orders
  • relation — multiplier
  • value — currently not used

pricelistchange

Access to tariff plans in case of tariff upgrade/downgrade

  • pricelist — id of the tariff plan the access will be granted to. Link to the pricelist table
  • topricelist — id of the tariff plan that the current tariff can be upgraded/downgraded to. Link to the pricelist table

pricelistchangerule

Tariff change rules

  • id — record id
  • pricelist — old tariff id. Link to the pricelist table
  • topricelist — new tariff id. Link to the pricelist table
  • fromdate — start date of the service that the rule will be applied to
  • todate — end date of the service that the rule will be applied to
  • discount — amount of a discount that will be applied to a new tariff plan
  • period — period associated with the rule

pricelistparam

Additional parameters of tariff plans

  • id — record id
  • intname — parameter internal name
  • pricelist — tariff id. Link to the pricelist table
  • value — parameter value

pricelistprice

Tariff plans and associated addons and prices

  • pricelist — tariff or addon id. Link to the pricelist table
  • currency — currency id. Link to the currency table
  • price — record id with prices. Link to the price table

pricelistscale

Price scale for integer addons

  • id —record id
  • pricelist — addon id. Link to the pricelist table
  • value — scale value

pricelistscaleprice

Value scale and prices

  • pricelistscale — record id of the value scale. Link to the pricelistscale table
  • currency — currency id. Link to the currency table
  • price — record id with prices. Link to the price table

suspendpenalty

Late renewal fees

  • id — record id
  • pricelist — tariff id. Link to the pricelist table
  • currency — currency id. Link to the currency table
  • amount — fee amount

runningoperation

List of running operations

  • id — record id
  • item — service id associated with the current operation Link to the item table
  • intname — operation type
  • params — operation parameters
  • elid — id of the object associated with the running operation (service id, IP address id, etc.)
  • cdate — operation creation time
  • laststartdate — operation last start time
  • trycount — number of attempts to start the operation
  • manual — indicates the the service must be started manually rather than automatically
  • comment — comment
  • errorxml — XML description of the error which occurred while running the operation
  • exparams — additional parameters of the running operation
  • callbackurl — URL that the system must call when the current operation is finished

service_profile

Service profile (domain contacts)

  • id — record id
  • profiletype — profile legal status
  • name — profile name
  • account — id of the profile owner. Link to the account table

service_profile2item

Service profiles and associated services

  • id — record id
  • service_profile — service profile id
  • item — service id
  • type — linking type

service_profile2processingmodule

Service profiles and processing modules

  • id — record id
  • service_profile — service profile id. Link to the service_profile table
  • processingmodule — service processing module id. Link to the processingmodule table
  • type — linking type
  • externalid — service profile external id
  • externalpassword — external password associated with the service profile and linking type

service_profileparam

Service profile parameters

  • id — record id
  • service_profile — service profile id. Link to the service_profile table
  • intname — parameter internal name
  • value — parameter value
  • warning_message — error message which occurred when the processing module handled the parameter

domain_profiledoc

Documents confirming domain contats

  • id — record id
  • service_profile — domain contact id. Link to the service_profile table
  • filename — name of the document file
  • name — file name that will be displayed in the interface
  • size — file size
  • doctype — document type

domain_profiledoc_send

Document sending status 

  • id — record id
  • service_profile — domain contact id. Link to the service_profile table
  • domain_profiledoc — domain contact document id
  • processingmodule — processing module id. Link to the processingmodule table
  • item — service id
  • verify — verification status

Finance and discounts


paymethod

List of payment methods

  • id — payment method id
  • currency — payment method currency id. Link to the currency table
  • doctmpl — invoice print template id. Link to the doctmpl table
  • orderpriority — defines how the payment method is sorted on the order page
  • name — payment method name
  • active — indicates that the payment method is available to clients
  • minamount — minimum payment amount for this payment method
  • maxamount — maximum payment amount for this payment method
  • autoclearperiod — period in days that will pass before unpaid invoices will be deleted automatically
  • profiletype — types of payers who can use this payment method
  • commissionamount — amount of fee that will be charged from the client if he uses this payment method
  • commissionpercent — fee in percent
  • module — payment processing module
  • xmlparams — XML document of additional parameters of the payment method
  • recurring — indicates that automatic payments can be set up
  • numtmpl_payment — payment number template
  • nextnum_payment — payment next order number
  • payimage — name of the payment method icon file
  • allowrefund — enable refunds
  • language — this payment method will be available to the users with the selected languages
  • payment_description — advanced payment default purpose
  • note — comment field

paymethod2company

Payment methods and associated companies 

  • paymethod — payment method id. Link to the paymethod table
  • company — company id. Link to the profile table

paymethod2group

Payment methods and client groups

  • paymethod — payment method id. Link to the paymethod table
  • accountgroup — client group id. Link to the account table
  • access_policy — access policy:
    • 'off' — clients of the specified group cannot use this payment method
    • 'on' — clients of the specified group can use this payment method

paymethod2project

Payment methods and providers

  • paymethod — payment method id. Link to the paymethod table
  • project — provider id. Link to the project table

paymethodparam

Payment method parameters

  • id — parameter id
  • intname — parameter internal name
  • paymethod — payment method id. Link to the paymethod table
  • orderpriority — parameters sort order
  • inputtype — type of the parameter input field
  • name — parameter name
  • hint — hint
  • required — indicates that it is the obligatory parameter
  • validator — input field validator
  • check_range — validator parameters
  • inputrows — number of input fields for the text parameter
  • zoom — indicates that the input fields can be zoomed

discount

Discounts

  • id — discount id
  • promotion — promo action id. Link to the promotion table
  • itemtype — product type id the discount is applied to. Link to the itemtype table
  • pricelist — tariff id the discount is applied to . Link to the pricelist table
  • account — client id. Link to the account table
  • item — service id the discount is applied to. Link to the item table
  • project — provider id. Link to the project table
  • period — order period
  • percentage — percentage of a discount
  • type — discount type:
    • 0 — percentage,
    • 1 — special price
  • fromdate — start date of a discount
  • todate — end date of a discount
  • validity — discount validity period:
    • 0 —the whole period,
    • 1 — several first months
  • validitylength — discount validity period in months
  • priority — discount priority
  • note — comment field

discountprice

Special prices and order cost

  • discount — discount id. Link to the discount table
  • currency — currency id. Link to the currency table
  • price — record id with prices Link to the price table

expense

List of expenses

  • id — record id
  • subaccount — account id where expense was generated. Link to the subaccount table
  • item — service id. Link to the item table
  • discount — id of the discount that was given when expense was generated. Link to the discount table
  • period — order period associated with this expense
  • amount — expense amount
  • discountamount — discount amount
  • notpayd — unpaid expense
  • cdate — date when the service associated with this expense was provided
  • name — expense name
  • realdate — expense date
  • operation — operation associated with this expense
  • operationparams — parameters of the operation associated with this expense
  • taxrate — tax deducted from the expense
  • taxamount — tax amount that was calculated when generating expense

expense2billorderitem

Expenses and associated invoice items 

  • expense — expense id. Link to the expense table
  • billorderitem — invoice item id. Link to the billorderitem table
  • amount — amount

expense2payment

Expenses and associated payments

  • expense — expense id. Link to the expense table
  • payment — payment id. Link to the payment table
  • invoice — id of the invoice generated for the payment. Link to the invoice table
  • amount — expense that was covered by the payment.

expensechange

Expense history 

  • id — record id
  • reference — changed expense id. Link to the expense table
  • changedate — change date
  • username — user who changed the expense
  • request_ip — IP address from which the client changed the expense
  • request_action — function that changed the expense
  • amount — old expense
  • amount_new — new expense

invoice

Invoices 

  • id — record id
  • company — company that generated the invoice. Link to the profile table
  • customer — payer this invoice is generated for Link to the profile table
  • currency — invoice currency. Link to the currency table
  • docflow_connection — connection to the electronic document management system. Link to the docflow_connection table
  • number — invoice number
  • cdate — invoice date
  • sdate — send date
  • amount — invoice amount
  • realamount — amount of expenses that the invoice includes
  • invoice_status — current status:
    • 0 — preliminary (clients cannot see it),
    • 1 — created (read-only for clients),
    • 2 — requested,
    • 3 — sent,
    • 4 — signed,
    • 100 — waiting for sending through the electronic document management system,
    • 110 — signed in the electronic document management system,
    • 120 — canceled in the electronic document management system,
  • externalid — invoice id the electronic document management system,

invoiceitem

Invoice item

  • id — record id
  • invoice — invoice id. Link to the invoice table
  • item — service id associated with the invoice item. Link to the item table
  • amount — amount
  • taxamount — tax amount
  • taxrate — tax rate
  • name — description of provided services
  • realamount — amount included into the invoice item

invoiceitem2expense

Invoice items tied to expenses 

  • invoiceitem — invoice item id. Link to the invoiceitem table
  • expense — expense id. Link to the expense table
  • amount — amount of expenses that the invoice includes (in invoice currency)
  • expense_amount — amount of expenses the the invoice item includes

invoiceitem2payment

Invoice items tied to payments 

  • invoiceitem — invoice item id. Link to the invoiceitem table
  • payment — payment id. Link to the payment table
  • amount — part of the payment that the invoice item includes

payment

List of payments

  • id — payment id
  • subaccount — id of the account associated with the payment . Link to the subaccount table
  • paymethod — payment method id. Link to the paymethod table
  • recipient — id of the company that receives the funds. Link to the profile table
  • sender — payer id. Link to the profile table
  • expense_commission — associated expense with the payment commission. Link to the expense table
  • currency — payment curremcy id. Link to the currency
  • billorder — order id. Link to the billorder table
  • recurring — automatic payment settings id. Link to the recurring table
  • invoice — invoice id. Link to the invoice table
  • subaccountamount — payment amount in the account currency
  • status — current payment status:
    • 1 — new,
    • 2 — pending,
    • 3 — reserved payment,
    • 4 — paid,
    • 5 — waiting for refund,
    • 6 — refunded,
    • 7 — fraudulent,
    • 8 — new payment with quick credit of funds,
    • 100 — deletion id progress
  • number — payment number
  • paymethodamount — payment amount in the payment gateway currency
  • usedamount — used amount
  • commissionamount — payment commission in the account currency
  • paydate — payment date
  • createdate — creation date
  • taxrate — tax amount
  • taxamount — tax amount for this payment
  • externalid — payment id in the payment gateway
  • info — payment information from the payment gateway
  • xmlparams — XML-document with additional payment parameters
  • documentnumber — number of the document confirming the payment
  • randomnumber - unique number of the instant payment
  • documentdate — date of the document confirming the payment
  • description — purpose of advanced payment
  • note — comment field
  • refund — refunds are allowed
  • restrictrefund — refunds are not allowed
  • autogenerated — indicates that the invoice was generated automatically
  • chargecommission — commission should be charged

payment2payment

Information about refunds 

  • payment_base — payment id. Link to the payment table
  • payment_refund — id of the payment that was used for refund. Link to the payment table
  • amount — refund amount.

promocode

Promotions codes

  • id — promotion code id
  • code — promotion code
  • promotion — promotion associated with this promotion code. Link to the promotion table
  • uselimit — the maximum number of times a promotion can be used.
  • account_uselimit — the maximum number of times a promotion can be used by a certain user.
  • fromdate — promotion start date
  • todate — promotion expiration date
  • expiretype — promotion code can be applied on:
    • 0 — service order period,
    • 1— specified period
  • periodtype — period:
    • 1 — day,
    • 2 — month
  • periodlength — period length

promocode2item

Usage of promotion codes

  • promocode — promotion code id. Link to the promocode table
  • item — service id. Link to the item table
  • fromdate — promotion code start date
  • todate — promotion code expiration date

promotion

List of promotions

  • id — promotion id
  • project — provider id associated with this promotion. Link to the project table
  • name — promotion name
  • fromdate — promotion start date
  • todate — promotion expiration date
  • archive — archive the promotion

promotionactivate

List of activations based on the  "Service purchase" type

  • id — record id
  • promotion — promotion id. Link to the promotion table
  • account — client id who meets the condition requirements. Link to the account table
  • fromitem — service id. Link to the item table
  • item — service id for which the promotion was used. Link to the item table
  • activated — active
  • discountused — indicates that the promotion was activated

promotioncondition

List of promotion conditions 

  • id — condition id
  • promotion — promotion id. Link to the promotion table
  • itemtype — product type id. Link to the itemtype table
  • pricelist — tariff id. Link to the pricelist table
  • currency — currency id. Link to the currency table
  • affiliate — id of the affiliate program associated with the condition. Link to the affiliate table
  • account_group — id of the client group associated with the condition Link to the account table
  • ctype — condition type
  • comparison — comparison type:
    • 'eq' — equals,
    • 'ne' — not equal,
    • 'gt' — larger than,
    • 'ge' — larger than or equals to,
    • 'lt' — smaller than,
    • 'le' — smaller than or equals to,
  • amount — number for comparison in the condition
  • summa — amount for comparison in the condition
  • period — service order period
  • cgroup — group of conditions
  • periodtype — period type
  • periodlength — period length

recalculation

Recalculations

  • id — record id
  • currency — recalculation currency. Link to the currency table
  • recalcdate — recalculation date
  • username — the user who made recalculation
  • request_ip — IP address from which recalculation was made.
  • note — comment to recalculation
  • discountamount — amount of a discount given during recalculation

recalculationitem

List of recalculated services 

  • id — record id
  • item — service id. Link to the item
  • recalculation — record id of recalculation. Link to the recalculation table
  • oldsum — amount of expenses before recalculation
  • newsum — amount of expenses after recalculation
  • fromdate — recalculation period start date
  • todate — recalculation period end date

recurring

Auto-payment settings

  • id — record id
  • paymethod — payment method id. Link to the paymethod table
  • subaccount — account id from which payment will be made. Link to the subaccount table
  • profile — payer id who will make a payment. Link to the profile table
  • maxamount — auto-payment amount
  • status — auto-payment settings status:
    • 0 — configuration in progress,
    • 1 — auto-payment is enabled,
    • 2 — auto-payment is disabled,
  • token — unique key which is used for auto-payment,
  • data1 — data field
  • data2 — data field
  • rtype — auto-payment configuration type:
    • 1 — for a service,
    • 2 — for several services,
    • 7 — for all services,
    • 8 — within the maximum amount
  • createday — auto-payment settings date
  • nextdate — next date of the auto-payment

recurring2item

Services with auto-payment 

  • recurring — auto-payment configuration id. Link to the recurring table
  • item — service id. Link to the item table

refundrule

Refund rules

  • id — record id
  • name — rule name
  • account — provider account id. Link to the account table
  • fixedsum — amount of fixed fee
  • percent — commission percent
  • expensename — description of expenses if commission was deducted
  • calcorder — commission calculation order

Marketing


advertisement

Advertisement on the Dashboard

  • id — record id
  • name — banner ad id
  • selectclients — client selection criteria Link to the selectclients table
  • project — provider id whose clients will see the advertisement. Link to the project table
  • language — interface language for the advertisement
  • weight — banner ad weight which is used to define banner ad frequency
  • active — active
  • url — URL to the banner ad

affiliate

List of affiliate programs 

  • id — affiliate program id
  • project — provider id associated with this affiliate program. Link to the project table
  • account_group — id of the client groups who can participate in this affiliate program. Link to the account table
  • account_group_restrict — id of the client groups who cannot participate in this affiliate program. Link to the account table
  • name — affiliate program name
  • integration — usage type. Not used
  • billurl - URL BILLmanager. Not used
  • url — referral URL template
  • promocode — affiliate promotion code id
  • reward — referral reward

affiliateclick

Affiliate click-throughs

  • sesid — unique key
  • account — affiliate id. Link to the account table
  • referal — referral id. Link to the account table
  • project — provider id associated with this affiliate program. Link to the project table
  • site — site page from which the client was referred
  • ip — IP address from which the client was referred
  • cdate — date and time when a client clicked the link

affiliateitemtype

Affiliate reward rules

  • id — record id
  • affiliate — affiliate program id. Link to the affiliate table
  • itemtype — product type id. Link to the itemtype table
  • pricelist — tariff id. Link to the pricelist table
  • reward — percent of the affiliate reward

affiliatereward

Affiliate rewards

  • id — record id
  • affiliate — affiliate program id. Link to the affiliate table
  • account — id of the client who receives the reward. Link to the account table
  • referal — referral id. Link to the account table
  • currency — currency id. Link to the currency table
  • payment — payment id. Link to the payment table
  • itemtype — product type id for which the reward was made. Link to the itemtype table
  • pricelist — tariff id for which the reward was made. Link to the pricelist table
  • amount — reward amount
  • cdate — date
  • reward — percent of the affiliate reward

buymore

List of services that customers also buy with their main service 

  • id — record id
  • project — provider id associated with the complement service. Link to the project table
  • orderpriority — sort order
  • name — position name
  • language — language for which the complement service is displayed
  • image — image file name
  • description — service description
  • link — service order link
  • active — active

buymore_condition

Conditions for displaying services that customers can also buy 

  • id — record id
  • buymore — service id. Link to the buymore table
  • itemtype — item type id the condition is applied to. Link to the itemtype table
  • pricelist — tariff id the condition is applied to. Link to the pricelist table
  • type — condition type:
    • pricelist — the Cart contains the service,
    • nopricelist — the Cart doesn't contain the service
  • conditiongroup — condition group

buymore_stat

Statistics that shows how many customers followed the link to buy complement services

  • id — record id
  • buymore — service id. Link to the buymore table
  • account — id of the client who followed the link or viewed the information about a complement service. Link to the account table
  • item — ordered service id. Link to the item table
  • date — date when the client followed the link or viewed the information
  • action — record type:
    • 0 — service is displayed
    • 1 — a client followed the link

notification

List of notifications 

  • id — record id
  • user — id of the user who received the notification. Link to the user table
  • project — provider id. Link to the project table
  • cdate — creation date
  • subject — notification theme
  • message — notification message
  • readed — indicates that a client has read the notification

notificationbar

List of short notifications

  • id — record id
  • user — id of the user who received the notification. Link to the user table
  • name — notification type
  • status — notification status:
    • 1 — error notification,
    • 2 — warning,
    • 3 — information
  • isnew — indicates that a client has reviewed the notification

notificationbarparam

Shot notification parameters

  • id — record id
  • notificationbar — notification id. Link to the notificationbar table
  • intname — parameter internal name
  • value — parameter value

notificationlist

Mailing lists

  • id — record id
  • selectclients — client selection id who will receive notifications. Link to the selectclients table
  • notifytemplate — notification template id. Link to the notifytemplate table
  • notify_module — notification delivery method
  • language — user language
  • email_from — sender email
  • test_email — email for test mailing
  • subject — mailing subject
  • message — mailing text
  • repeat_period — period to repeat the mailing
  • active — active
  • archive — mailing list was added into archive
  • user_count — number of users the mailing lists were sent to

user2notificationlist

Mailig lists sent to clients 

  • senddate — send date
  • user — user id. Link to the user table
  • notificationlist — mailing list id. Link to the notificationlist table
  • is_sent — indicates that the mailing list has been sent
  • is_queued — indicates that the mailing list was added into the queue

notifytask

List of mailing tasks 

  • id — record id
  • filename — name of the file with notification text and parameters
  • modulename — notification send module
  • createdate — creation date
  • priority — send priority
  • error_count — number of failed attempts to send notifications
  • err_info — failure information

notifyattfiles

Notification attachments

  • id — record id
  • filename — file name
  • sendname — file name which is displayed in the notification

notifytask2notifyattfiles

Notification files 

  • notifytask — notification send task id. Link to the notifytask table
  • notifyattfiles — record id with file description. Link to the notifyattfiles table

notifytemplate

Notification templates

  • id — record id
  • project — provider id who uses the template. Link to the project table
  • name — template name
  • notice — notification type
  • allowcopy — copy to the Notifications section

notifycontent

Notification template contents 

  • id — record id
  • notifytemplate — notification template id. Link to the notifytemplate table
  • content — notification template contents 
  • modulename — notification module
  • subject — notification subject

selectclients

Selection of clients 

  • id — record id
  • project — provider id whose clients will be selected. Link to the project table
  • name — selection name
  • archive — added into archive

selectclientsrule

Selection rule

  • id — record id
  • selectclients — selection id. Link to the selectclients table
  • itemtype — product type id. Link to the itemtype table
  • pricelist — tariff id that the condition is applied to. Link to the pricelist table
  • processingmodule — processing module is associated with the condition. Link to the processingmodule table
  • processingnode — processing module node id associated with the condition. Link to the processingnode table
  • datacenter — data-center id associated with the condition. Link to the datacenter table
  • currency — currency id. Link to the currency table
  • affiliate — affiliate program id associated with the condition. Link to the affiliate table
  • accountgroup — client group id associated with the condition. Link to the account table
  • type — condition type
  • period — period
  • status — service type which is used in the condition
  • fromday — start date of the period which is used in the condition
  • todayend date of the period which is used in the condition
  • rowdata — any data associated with the condition
  • comparison — comparison type
  • summa — amount which is used in the condition
  • amount — number which is used in the condition
  • periodtype — period type
  • rulegroup — condition group

subscription

Notification subscription

  • id — record id
  • user — user id who is subscribed to notifications. Link to the user table
  • notice — notification group type that the user is subscribed to
  • modulename — notification module
  • enabled — subscription is active

unsubscription

Unique identifiers to receive or subscribe to notifications

  • id — record id
  • user — identification owner id. Link to the user table
  • notice — notification group type that the use is subscribed to
  • modulename — notification module
  • cmdhash — unique identifier

Support center


answer_template

Pre-defined replies

  • id — record id
  • user — template owner id. Link to the user
  • project — provider id that uses this pre-defined reply. Link to the project table
  • user_department — department id that can use this pre-defined reply. Link to the user table
  • orderpriority — sort order
  • name — pre-defined reply name/summary
  • message — text of the pre-defined reply
  • shared_for_all — pre-defined reply is available/not available to other users
  • template_type — pre-defined reply type. not used
  • autoinsert — insert the pre-defined reply into the ticket automatically. Not used
  • regular — use this pre-defined reply in all answers in the ticket. Not used

fraud_gateway

Phone verification gateways

  • id — record id
  • name — gateway name
  • xmlparams — XML-document with gateway parameters
  • modulename — notification send module with verification data
  • gate_modulename — notification send gateway module with verification data
  • identifier — identifier
  • phone_filter — regular expression of phone number filter
  • priority — priority during the phone verification procedure
  • verify_type — verified data transfer way: call(0), sms (1) or both (2)
  • retry_timeout — data verification re-send period
  • code_lifetime — verification data lifetime
  • active — active

gateway

Notification gateways

  • id — gateway id
  • identifier — identifier
  • gateway_type — gateway type
  • gateway_module — gateway module
  • project — provider who uses this module. Link to the project table
  • user — department id that will received incoming emails. Link to the user table
  • xmlparams — XML-document with gateway parameters
  • notify_module — notification send module
  • active — active
  • abuse — send incoming emails to the abuse section

gateway_blacklist

List of blacklist senders

  • id — record id
  • name — contact data that do not receive notifications

gateway_message

List of emails received through gateways

  • id — record id
  • gateway — id of the gateway that received the email. Link to the gateway table
  • name — email subject
  • sender — sender contact details
  • message — email text
  • date_post — date received
  • verification_codeBILLmanager registration verification id
  • reason_code — code of the reason why the email was forwarded to the list of incoming emails:
    • 1 — email is received from an unregistered user,
    • 2 — cannot identify the email sender,
    • 3 — error processing incoming email,
    • 4 — abuse notification
  • error_message — error notification text
  • email_message_id — incoming email identifier
  • email_cc — list of mail recipients in the email copy

gateway_message_attach

Attachments to incoming emails

  • id — attachment id
  • gateway_message — incoming email id. Link to the gateway_message table
  • base_name — attachment file name that will be displayed
  • name — attachment file name

infoboard

Announcements

  • id — announcement id
  • name — announcement name
  • orderpriority — sort order
  • subject — announcement subject
  • message — announcement text
  • start_datetime — announcement start time
  • end_datetime — announcement end time
  • timezone — time zone corresponding to start and end time
  • blocking — blocking announcement

infoboard_condition

Announcement conditions

  • id — condition id
  • infoboard — announcement id. Link to the infoboard table
  • processingmodule — processing module id associated with the announcement. Link to the processingmodule table
  • datacenter — data-center id associated with the announcement. Link to the datacenter table
  • project — provider id associated with this announcement. Link to the project table
  • type — condition type
  • processingnode — processing module node id used in the condition
  • account_list — client ids that will be used in the condition
  • item_list — service ids that will be used in the condition

supportaccount

Technical support account for adding and deducting lifetime support incidents

  • project — provider id who provided support services. Link to the project table
  • account — technical account owner id. Link to the account table
  • currency — currency id which records the amount of balance top-ups. Link to the currency table
  • incident_used — number of used incidents
  • incident_limit — number of added incidents
  • not_used_amount — amount of funds that were added but not counted when adding incidents
  • expense_charged — first charge

supportincident

List of support incidents (with limited usage period) available to a client

  • id — record id
  • project — provider id who provided support services. Link to the project table
  • account — id of the client who has support incidents. Link to the account table
  • incident_used — number of used incidents
  • incident_limit — available incidents for a selected period
  • from_date — period start date
  • to_date — period end date

task

List of tasks 

  • id — record id
  • department — id of the department the task is assigned to. Link to the user table
  • performer — id of the staff member the task is assigned to. Link to the user table
  • item — service id the task is created for. Link to the item
  • account — client id the task is created for. Link to the account
  • profile — payer id the task is created for. Link to the profile
  • runningoperation — current operation the task is created for. Link to the runningoperation
  • opendate — task creation date
  • closedate — task close date
  • status — current status:
    • 0 — open,
    • 1 — in progress,
    • 2 — closed,
    • 3 — deleted
  • type — task type
  • specification — task description
  • params — task parameters

task_attach

Task attachements

  • id — record id
  • task — task id. Link to the task table
  • base_name — file name that will be displayed
  • name — file name

taskmessage

Task messages

  • id — record id
  • task — task id. Link to the task table
  • user — id of the user who added the message. Link to the user table
  • message — message text
  • createdate — message add date

working_plan

Department business hours

  • id — record id
  • name — timetable name

working_hours

Staff member business hours 

  • id — record id
  • day_of_week — days of the week
  • working_plan — timetable id. Link to the working_plan table
  • active — working day
  • allday — round-the-clock work
  • day_begin — working day start time
  • day_end — working day end time
  • type — record type:
    • 0 — working day,
    • 1 — weekend,
    • 2 — exclusion
  • affected_date — weekend or exclusion from the timetable
  • note — comment

ticket

Support tickets

  • id — ticket id
  • account_client — client id associated with the ticket. Link to the account table
  • responsible — department id. Link to the user table
  • item — service id associated with the ticket. Link to the item table
  • user_block — user id who blocked the ticket. Link to the user table
  • gateway — id of the gateway that received the ticket. Link to the gateway table
  • project — provider id associated with the ticket. Link to the project table
  • user_lastresponsible — id of the staff member who send a reply for the last time. Link to the user table
  • name — subject
  • date_start — ticket creation date and time
  • priority — priority:
    • 0 — standard,
    • 1 — medium,
    • 2 — high,
  • time_block — ticket blocking time
  • status — current status
  • client_read — client has reviewed the ticket
  • date_last — date of the last post in the ticket
  • highpriority — ticket has higher priority
  • incident_count — number of incidents deducted from this ticket
  • summary — ticket summary

ticket2user

Tickets assigned to departments and staff members 

  • id — record id
  • user — id of the department or staff member the ticket is assigned to. Link to the user table
  • ticket — ticket id. Link to the ticket
  • assign_date — date when the ticket was assigned
  • reply_until — reply time
  • postponed_until — the ticket was delayed until this time
  • autosavetext — message that was saved for the ticket
  • autosavenote — comment that was saved for the ticket
  • highpriority — ticket has higher priority
  • from_abuse_process — indicates that the ticket was assigned because a client didn't respond to the abuse notification

ticket_favorite

List of favorite tickets

  • ticket — ticket id. Link to the ticket table
  • user — id of the user who added the ticket into favorites. Link to the user
  • date_add — date when the ticket was marked as favorite

ticket_history

Ticket history

  • id — record id
  • ticket — ticket id. Link to the ticket
  • user — id of the user who performed the operation. Link to the user table
  • type — record type:
    • 1 — ticket subject was changed,
    • 2 — department was changed,
    • 3 — ticket service was changed,
    • 4 — priority was changed,
    • 5 — status was changed,
    • 6 — ticket was copied to a department or staff member
    • 7 — priority was increased,
    • 8 — ticket was split,
    • 9 — ticket was closed,
    • 10 — support incident was deducted/returned,
    • 11 — ticket reply was delayed,
    • 12 — ticket priority was decreased,
    • 13 — client was charged for this ticket,
    • 14 — ticket reply was delayed,
    • 100 — any message
  • date_post — date and time when the history was recorded
  • old_value — previous value of the ticket parameter
  • new_value — new value of the ticket parameter
  • visible_by_client — indicates that client can see the information in the ticket

ticket_message

Ticket messages

  • id — message id
  • ticket — ticket id. Link to the ticket
  • user — id of the user who posted the message. Link to the user table
  • user_delete — id of the user who deleted the message. Link to the user table
  • message — text
  • date_post — message date
  • date_delete — date when the message was deleted
  • access_key — unique key to access the ticket reply rating
  • email_message_id — email id
  • email_cc — list of mail recipients in the copy of this email

ticket_message_attach

List of ticket attachemenets

  • id — record id
  • ticket_message — message id. Link to the ticket_message table
  • base_name — file name that will be displayed
  • name — file name

ticket_note

List of comments that staff members added in a ticket 

  • id — record id
  • ticket — ticket id. Link to the ticket table
  • user — staff member id who added the comment. Link to the user table
  • note — comment
  • date_post — comment date

ticket_schedule

Ticket response time

  • id — record id
  • project — provider id. Link to the project table
  • currency — currency id. Link to the currency table
  • account_client — id of the client for which the ticket response time is set . Link to the account table
  • account_group — id of the client group for which the ticket response time is set Link to the account table
  • user_department — id of the department for which the ticket response time is set Link to the user table
  • pricelist — tariff id associated with the ticket response time. Link to the pricelist table
  • pricelist_addon — addon id associated with the ticket response time. Link to the pricelist table
  • enumerationitem — id of the addon enumeration which is used in the ticket response time conditions. Link to the enumerationitem table
  • name — response time name
  • type — condition type
  • comparison — comparison type
  • period_type — period:
    • 1 — month,
    • 2 — day,
    • 3 — year
  • amount — amount which is used to apply the ticket response time
  • value — value which is used to apply the ticket response time
  • schedule — ticket response time
  • priority — priority that will be set for the ticket that meets the requirements
  • attitude — client characteristics which is used to apply the ticket response time
  • highpriority — ticket that meets the requirement will have higher priority

abuse_task

List of abuses

  • id — abuse id
  • ticket — abuse ticket id. Link to the ticket table
  • gateway_message — id of the incoming message associated with the abuse. Link to the gateway_message table
  • user — user who registered the abuse. Link to the user table
  • user_responsible — department that the ticket will be forwarded to if the client doesn't perform a required action. Link to the user table
  • deadline — period when the issue can be resolved
  • score — number of abuse scores
  • score_note — comment
  • action — select an action that should be performed if the client didn't respond:
    • 0 — do not perform any actions,
    • 1 — move the ticket into the active tickets list,
    • 2 — suspend all services,
    • 3 — suspend the selected service
  • last_warning_time — time when the client was notified about the abuse for the last time
  • status — abuse status:
    • 0 — not resolved (active),
    • 1 — resolved

Internal records


history_*

The following tables contain history of services or other objects in BILLmanager. They have a number of common fields + fields of the source table in two variants: without suffix and with the suffix _new. The first one contains the source value of a field, the second one contains its new value. 

  • reference — link to the record in the source field
  • username — the user who made changes
  • request_ip — IP address that changes were made from
  • request_action — function
  • fromdate — date when previous changes were made
  • changedate — data change date
  • changedfields — list of the fields which data were changed
  • xxx — field with old data
  • xxx_new — field with new data
  • (...)
  • zzz — field with old data
  • zzz_new — field with new data

analytics_google

Google analytics

  • item — service id. Link to the item table
  • cost — service price
  • date — calculation date

analytics_google_expense

  • expense — expense id. Link to the expense table
  • cost — expense amount
  • date — calculation date

analytics_google_registration

  • account — client id. Link to the account table
  • date — registration date