billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

Constants — A list of BillMax constants available for programming

Synopsis

				#include "billmax.h"
			

General Constants

TRUE, FALSE

Constants returned by various library routines.

NULLDATE

"0000-00-00"

NULLTIME

"00:00:00"

FLAGS_NONE, FLAGS_NONOTE, FLAGS_NOHOOK, FLAGS_FORCE, FLAGS_NODATETIME

Constants used by various BillMax_entityPut routines.

AUTH_READ, AUTH_WRITE, AUTH_BILLING_READ, AUTH_BILLING_WRITE, AUTH_ADMIN

Permissions constants.

STATE_OPEN, STATE_CLOSED, STATE_SUSPENDED, STATE_WAIT_FOR_PAYMENT, STATE_COLLECTIONS

State constants.

REASON_NONE, REASON_OVERDUE, REASON_AUP, REASON_ADMIN, REASON_EXPIRED, REASON_OVERUSAGE, REASON_ACCOUNT, REASON_USER

The immutable constants of the reasons list

NODEFERRED, EXCLUDEUNEARNEDINCOME, EXCLUDEDEFERREDBYMONTH, EXCLUDEDEFERREDBYMONTHDAY, CASHSALES

Constants used for financial reports.

Account Constants

PAYTYPE_NONE, PAYTYPE_CASHCHECK, PAYTYPE_CREDIT, PAYTYPE_ECASH, PAYTYPE_EFT, PAYTYPE_CREDITONCE

See account.paytype.

CCTYPE_NONE, CCTYPE_VISA, CCTYPE_MASTERCARD, CCTYPE_AMEX, CCTYPE_DISCOVER

See account.cctype.

INVMETHOD_EMAIL, INVMETHOD_POSTAL, INVMETHOD_FAX, INVMETHOD_RESERVED1, INVMETHOD_RESERVED2, INVMETHOD_RESERVED3

See account.invmethod. INVMETHOD_RESERVED1, INVMETHOD_RESERVED2 and INVMETHOD_RESERVED3 are used to store the INVMETHOD_EMAIL, INVMETHOD_POSTAL and INVMETHOD_FAX settings respectively of Account before the State was changed to Closed State.

Calltrack Constants

STATE_VENDORWAIT, STATE_CUSTOMERWAIT

See calltrack.state.

Datacall Constants

PW_STATUS_START , PW_STATUS_STOP, PW_STATUS_ALIVE, PW_STATUS_MODEM_START, PW_STATUS_MODEM_STOP, PW_STATUS_CANCEL, PW_STATUS_ON, PW_STATUS_OFF

See datacall.status.

TYPE_STR, TYPE_INT, TYPE_RAWSTR, TYPE_UNSIGNED_INT

Used to process the radius parameter data using DATACALLMAP structure. See DATACALLMAP structure.

Date Constants

Constants used for formatting data into date strings

DATE_MYSQLSTYLE

"%Y-%m-%d"

TIME_MYSQLSTYLE

"%H:%M:%S"

DATE_WEBSTYLE

"%a, %d %b %Y %T %Z"

DATE_VALID, DATE_INVALID, DATE_ZERO, TIME_VALID, TIME_INVALID

Return values for BillMax_DateValid and BillMax_TimeValid routines.

Financial Constants

Used by financial routines

ABORT_AGING, ABORT_CHARGE, NOMOREDATA

Used by BillMax_InvoiceAging, BillMax_CreditAging and BillMax_RefundAging.

ACCOUNTINVDAY, SERVICECHARGED, SERVDEFUSAGEINVDAY, USAGEDURATIONUSAGEINVDAY

See servdef.usageinvday.

Credit Card Processing Constants

Used by credit card processing

CCSOFT_ICVERIFY, CCSOFT_PTC, CCSOFT_CYBERCASH, CCSOFT_PCCHARGE, CCSOFT_GENERIC

See globalconf.ccsoft.

Payhist Constants

Credit card types

TENDERTYPE_AMEX, TENDERTYPE_VISA, TENDERTYPE_MC, TENDERTYPE_DISC

See payhist.tender.

Payhist types

TYPE_CHARGE, TYPE_PAYMENT, TYPE_CREDIT, TYPE_REFUND, TYPE_APPLY, TYPE_SUMMARY, TYPE_VOID, TYPE_DEPCHARGE, TYPE_DEPREFUND, TYPE_BEGBAL, TYPE_MAXTYPE

See payhist.type.

Account financial activity flags

FINANCIAL_ACTIVITY_CLOSE, FINANCIAL_HARDCOPY

See account.finactivity.

Flags indicating source of Sale

FLAGS_AUTO, FLAGS_SETUP, FLAGS_USAGE

See payhist.flags.

Service Definition Constants

Availability constants

SERVDEF_AVAILABLE, SERVDEF_NONEWUSERS, SERVDEF_DISCONTINUED

See servdef.state.

Tax exemption constants

SERVDEF_TAX_EXEMPTION_AMOUNT, SERVDEF_TAX_EXEMPTION_PERCENT

See servdef.taxexemptiontype.

service.d01 conflict constants

D01CONFLICT_NEVEROK, D01CONFLICT_ALWAYSOK, D01CONFLICT_INUSER

See servdef.d01conflict.

Service Change Constants

Service Change status constants

SERVICECHANGE_SCHEDULED, SERVICECHANGE_COMPLETED, SERVICECHANGE_FAILED

See servicechange.status.

Tierplan Constants

Tierplan method constants

TIERPLAN_METHOD_PERCENTILE, TIERPLAN_METHOD_AVERAGE, TIERPLAN_METHOD_MAX, TIERPLAN_METHOD_MIN, TIERPLAN_METHOD_SUM

See tierplan.method.

Tierplan direction constants

TIERPLAN_DIRECTION_NONE, TIERPLAN_DIRECTION_IN, TIERPLAN_DIRECTION_OUT, TIERPLAN_DIRECTION_GREATEST, TIERPLAN_DIRECTION_INOUT

See tierplan.direction.

Tierplan style constants

TIERPLAN_STYLE_STEP, TIERPLAN_STYLE_LINEAR, TIERPLAN_STYLE_BULK, TIERPLAN_STYLE_MARGINAL

See tierplan.style.

Virtual Company Constants

SEND_BLANKSTMT, SEND_NONZEROBALANCE, SEND_ACTIVITYMONTHLY, SEND_MONTHLYMONEYOWED, SEND_MONTHLYMONEYOWEDOVERDUEMIN, SEND_ACTIVITYDAILY, SEND_ACTIVITYDAILYMONEYOWED

See config.sendnullstmt.

Get Environment(GEV) and related constants

In the following descriptions, variable refers to the value of the variable that may be checked against the types listed.

GEV Constants

GEV_CHECKBOX

Defaults to "0" if variable not in environment.

GEV_DATE

Looks for variables of "prefix_variable_year", "prefix_variable_month" and "prefix_variable_day". Concatenates them with dashes to create a date of the form yyyy-mm-dd.

GEV_DOUBLE

Interprets variable as a double. Decimal point must be appropriate for value of globalconf.locale.

GEV_FLOAT

Interprets variable as a float. Decimal point must be appropriate for value of globalconf.locale.

GEV_INT

Interprets variable as an integer.

GEV_MBITMASK

Converts a comma separated string representing bit locations into an integer.As an example:

"1,4,16" result in 21.

GEV_MONEY

Interprets variable as a money. Decimal point must be appropriate for value of globalconf.locale. Decimal places must either be appropriate for value of globalconf.locale or not specified.

GEV_OPFIELD

Represents an optional field. If not in the environment, a zero-length string is used.

GEV_STRING

Interprets variable as a string.

GEV_TIME

Looks for variables of "prefix_variable_hour", "prefix_variable_minute" and "prefix_variable_second". Concatenates them with colons to create a date of the form HH:MM:SS.

GEV_TIMESTAMP

Interprets variable as a timestamp(YYMMDDhhmmss).

Return values from BillMax_GetEnvVar

VALUE_MISSING, FAILS_CONSTRAINT

See BillMax_GetEnvVar.


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