billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

servdef table — table for Service Definition data

servdef Field Definitions

Name

Description

Data Type BillMax Default
Name

Description

Data Type BillMax Default
basehours

The number of non-primetime base hours of usage allowed. The amount of time is tracked in datacall table. Time considered as primetime is configured using Virtual Company primestart and primeend parameters. A Metered Billing parameter.

int(11) 0
basehours_peak

The number of primetime base hours of usage allowed. The amount of time is tracked in datacall table. Time considered as primetime is configured using Virtual Company primestart and primeend parameters. A Metered Billing parameter.

int(11) 0
billinarrears

Not implemented.

tinyint(4) 0
cd01

Constraint for servdef.d01

char(100) BLANK
cd02

Constraint for servdef.d02

char(100) BLANK
cd03

Constraint for servdef.d03

char(100) BLANK
cd04

Constraint for servdef.d04

char(100) BLANK
cd05

Constraint for servdef.d05

char(100) BLANK
cd06

Constraint for servdef.d06

char(100) BLANK
cd07

Constraint for servdef.d07

char(100) BLANK
cd08

Constraint for servdef.d08

char(100) BLANK
cd09

Constraint for servdef.d09

char(100) BLANK
cd10

Constraint for servdef.d10

char(100) BLANK
charge_type

A mechanism for specifying a Sale's type. Sales reports may run using these values as a grouping mechanism.

char(30) none
company

int(11) 1
d01

The label for service.d01. This value is displayed on the Service page.

char(50) Login Name
d01conflict

Overrides the Resource settings for this Service Definition with respect to namespaces and the service.d01 field.

tinyint(4) 0
d02

The label for service.d02. This value is displayed on the Service page.

char(50) Password
d03

The label for service.d03. This value is displayed on the Service page.

char(50) BLANK
d04

The label for service.d04. This value is displayed on the Service page.

char(50) BLANK
d05

The label for service.d05. This value is displayed on the Service page.

char(50) BLANK
d06

The label for service.d06. This value is displayed on the Service page.

char(50) BLANK
d07

The label for service.d07. This value is displayed on the Service page.

char(50) BLANK
d08

The label for service.d08. This value is displayed on the Service page.

char(50) BLANK
d09

The label for service.d09. This value is displayed on the Service page.

char(50) BLANK
d10

The label for service.d10. This value is displayed on the Service page.

char(50) BLANK
def03

The default for service.d03. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def04

The default for service.d04. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def05

The default for service.d05. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def06

The default for service.d06. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def07

The default for service.d07. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def08

The default for service.d08. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def09

The default for service.d09. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
def10

The default for service.d10. This value is displayed on the Service page but may be modifies by the Customer Service Representative.

char(100) BLANK
deposit

The amount of a Deposit Charge to assess when creating a new Service. May be waived by Customer Service Representative.

int(11) 0
descr

The description of the Service Definition. This value is what is displayed in the Service dropdown on the User page.

char(100) No default. User input required.
duration

The regular Duration for a Service. This represents the amount of time for which a regular billing for a Service is assessed. The list of values comes from the durations list.

tinyint(4) 1
enddate

Denotes the date that the State of a Service Definition will be changed to No New Users State.

date 0000-00-00
free

Denotes whether or not the default for a Service created from the Service Definition should be free.

[Tip] Tip

If a Service is free, then neither the subscription price nor any usage will be billed. This differs from a zero-dollar charge Service where usage will be billed if applicable.

tinyint(4) 0
hourlyprice

The price per hour for non-primetime usage. A Metered Billing parameter.

int(11) 0
hourlyprice_peak

The price per hour for primetime usage. A Metered Billing parameter.

int(11) 0
icnt

The number of initial Durations to bill before billing a regular Duration. The list of values comes from the durations list.

int(11) 0
iduration

The initial Duration for a Service. The list of values comes from the durations list.

tinyint(4) 1
iprice

The default amount to bill for an initial Duration. If negative, a Store Credit will be granted to the Account rather than a Sale billed to the Account.

int(11) 0
misc01

A miscellaneous field to be used by the purchaser of BillMax.

int(11) 0
misc02

A miscellaneous field to be used by the purchaser of BillMax.

char(50) BLANK
misc03

A miscellaneous field to be used by the purchaser of BillMax.

date 0000-00-00
misc04

A miscellaneous field to be used by the purchaser of BillMax.

time 00:00:00
name

The name of the Service Definition. This shows up on an Account's Statement.

char(100) No default. User input required.
nosync

Defines whether Services created from this Service Definition are Synchronized or not.

tinyint(4) 0
number

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.

int(11) Autogenerated. Generally next available integer.
ou_notice

When a Service exceeds this number of regular hours, an email warning is sent to the Account email using /usr/local/billmax/local/usagewarn.email of the Email Template Files. May be overridden for a Service by a Customer Service Representative with "Accounting Write" Permissions. A Metered Billing parameter.

int(11) 0
ou_susp

Denotes the number of hours over regular hours a Service may use. When the number of hours is met or exceeded, the State of the Service is changed to Suspended State until the next usage billing period. May be overridden for a Service by a Customer Service Representative with "Accounting Write" Permissions. A Metered Billing parameter.

int(11) 0
ouprime_notice

When a Service exceeds this number of primetime hours, an email warning is sent to the Account email using /usr/local/billmax/local/usagewarn.email of the Email Template Files. May be overridden for a Service by a Customer Service Representative with "Accounting Write" Permissions. A Metered Billing parameter.

int(11) 0
ouprime_susp

Denotes the number of hours over primetime hours a Service may use. When the number of primetimehours is met or exceeded, the State of the Service is changed to Suspended State until the next usage billing period. May be overridden for a Service by a Customer Service Representative with "Accounting Write" Permissions. A Metered Billing parameter.

int(11) 0
prepaid

Denotes whether or not Services created from the Service are prepaid Services.

tinyint(4) 0
price

The default amount to bill for each non-initial Duration. If negative, a Store Credit will be granted to the Account rather than a Sale billed to the Account.

int(11) 0
printzerocharge

If a Service is not free, but has no cost (i.e. the cost is 0.00 for the subscription part), this setting denotes whether or not an entry is made in the payhist table for the zero subscription amount and subsequently printed on the Statement.

int(11) 0
pwautogen

Denotes whether or not to automatically generate a password to populate the service.d02.

tinyint(4) 0
refamt

The amount of Store Credit to grant an existing Account if the the existing Account holder referred the new Service created from the Service Definition.

int(11) 0
renewable

Denotes whether or not Services created from the Service Definition are automatically renewable or not. If not, then the enddate for the Service is automatically populated the Service is created.

tinyint(4) 1
resources

The Resource Set for a Service Definition. Used to denote to which namespace Services belong when created from the Service Definition. May also be used to indicate what types of services should be Provisioned.

int(11) 0
serviceclass

A mechanism for specifying a Sale's type. Sales reports may run using these values as a grouping mechanism. Also may be used to group Services for Provisioning pursposes.

char(50) Other
setup

The setup fee to assess when a Service is created. May be waived by Customer Service Representative.

int(11) 0
setup_taxable

Denotes whether or not to assess tax on the setup fee when a Service is created.

tinyint(4) 0
sortorder

User specified sort order of entries. Used for display purposes.

float(10,2) 1 + current sort order maximum.
startdate

The first date that a Service may be created from a particular Service Definition. If the current date is before the start date, the Service Definition will not show up in the Service dropdown on the User page.

date The date that the entry is created
state

The State of the Service Definition.

tinyint(4) 0
taxable

Denotes whether or not to assess tax on the subscription fees when billing for a Service.

tinyint(4) 0
taxexemption

The tax exemption amount. Either in dollars or as a percentage.

int(11) 0
taxexemption_type

Denotes the type of monthly taxexempt calculations.

  • 0 - The first X dollars for a service on a monthly basis are tax exempt. All Services under an Account that are created off of Service Definitions with X specified as the tax exempt amount are considered together. Therefore, if there are two Services for $25.00 per month, and the tax exempt amount specified on the Service Definition is $25.00, then only one $25.00 is tax exempt and tax will be assessed on the other $25.00.

  • 1 - Specify as a percentage (i.e. 10.00 for ten percent). The percentage of each Sale is deducted before tax is assessed.

int(11) 0
tierplan

Denotes the Tierplan/statistics to use when billing usage for the Service Definition.

int(11) 0
usageduration

Denotes the Duration between billings for either Usage Based Billing or Metered Billing.

int(11) 1
usageinvday

If used, the invday on which to bill Usage Based Billing or Metered Billing.

tinyint(4) BillMax derived
usageoptions

Specifies when to bill Usage Based Billing or Metered Billing

int(11) 1
useplaintextpass

Denotes whether or not to store the plain text password for a Service in the service.plaintextpass field in addition to storing the encrypted version in the service.d02 field.

  • 0 - Do not store the plain text password.

  • 1 - Store the plain text password.

tinyint(4) 0

SEE ALSO


Document Revision A for BillMax 2.2.0   -   Copyright © 1997-2006 The iSpark Group, Inc.

All rights reserved. No part of this documentation may be reproduced or transmitted in any fashion without written permission by The iSpark Group, Inc. This documentation is for the sole use of licensees of the BillMax billing software created by The iSpark Group, Inc. Making the documentation available to a non-licensee of BillMax without written permission of The iSpark Group, Inc. is a violation of the use of this documentation.

While precautions have been taken in the preparation of this documentation, The iSpark Group, Inc. assumes neither liability nor responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

All terms mentioned that are known to be trademarks have been appropriately capitalized. Use of the a trademark does not affect the validity of any trademark or service mark.

Links to third-party Web sites are provided for convenience. The iSpark Group, Inc. is not responsible for any content contained in the third-party Web sites.

Comments about this documentation may be sent to doc@billmax.com