billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

enter_account.cgi — Create or Modify a Account

Synopsis

/usr/local/billmax/cgi-bin/enter_account.cgi [[0] | [1]]

DESCRIPTION

enter_account.cgi is designed to take information supplied by the form /usr/local/billmax/uatemplates/account.tmp to create or modify a record in the account table. The values are passed via environment variables. In addition to updating the account table, enter_account.cgi inserts Notes for certain actions and performs some financial related tasks.

REQUIRED ENVIRONMENT VARIABLES

FORM_srchnumber - GEV_INT

Used to detect when the value for account.number is being modified using the FORM_number. If the value for FORM_srchnumber does not equal the value for FORM_number, and the value for FORM_override is zero, then HTML is output asking for verification that the value for account.number be changed. If FORM_override is non-zero, the number is changed without asking for verification.

FORM_override - GEV_CHECKBOX

See discussion for FORM_srchnumber.

FORM_reopenclosed - GEV_INT
FORM_refdeposit - GEV_INT

If non-zero, a Deposit Refund will be issued for each Deposit Charge for the Account.

FORM_number - GEV_INT

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

FORM_state - GEV_INT

The State of the Account

FORM_startdate - GEV_DATE

The start date of the Account. Generally the only time this is different than the enter date of the Account is when migrating accounts from a different billing system to BillMax.

FORM_enddate - GEV_DATE

If populated, the date this Account's state will be changed to Suspended State.

FORM_adcode - GEV_INT

The advertising code captured when the Account was created. A valid value from the adcodes list.

FORM_cancelreason - GEV_INT

The reason stated by the Account holder for closing the account. A valid value from the cancelreasons list. The MARKETING report makes use of this value.

FORM_referredby - GEV_STRING

A placeholder to store a referral code or name. If the intent is to credit an existing Account for referring a new customer, consider using the referral account field in a Service

FORM_cfname - GEV_STRING

The first name of the billing contact.

FORM_cmname - GEV_STRING

The middle name of the billing contact for the Account.

FORM_clname - GEV_STRING

The last name of the billing contact for the Account

FORM_company - GEV_STRING

The company name of the Account.

FORM_cphone - GEV_STRING

The phone number of the billing contact for the Account.

FORM_fphone - GEV_STRING

The fax number to which the Statement is faxed. Generally the number of the billing contact.

FORM_email - GEV_STRING

The email of the billing contact for this Account. Populate this if it is not be an email that you provide the Account. Otherwise, BillMax will populate this field when you create a Service for this Account

FORM_taxable - GEV_INT

Denotes whether the Account is taxable or not. Even if all the products sold are currently non-taxable, it is important to capture this information in the event of a future taxable sale. Only mark an Account non-taxable if you have supporting documentation.

FORM_taxregion - GEV_INT

The tax region of the Account.

FORM_reseller - GEV_STRING

A field that may be used to capture the reseller number for an Account that is taxexempt.

FORM_paytype - GEV_INT

BillMax Payment Methods and their meanings

  • Cash/Check - The Account pays bills using either cash or checks.

  • Credit - The Account pays bills using a credit card.

  • Credit Once, Then Cash/Check - The Account initially pays their bill using a credit card. If the credit card charge is successful, then the payment method for the Account is changed to Cash/Check. In addition, the Account terms are changed to the Virtual Company terms for Cash/Check.

  • E-Cash - The Account pays bills using electronic checks through an electronic check processor.

  • EFT - A placeholder. May be used to denote Accounts that pay their bills using wire transfers or direct deposits.

FORM_invmethod - GEV_MBITMASK

The different methods by which an Account may receive a Statement. This is a BIT mask. If no BITs are set, no Statement is sent. The following represents the BIT positions for the different methods. A 0 value in the BIT position indicates the method is not used. A 1 value in the BIT position indicates the method is used. More than one method selected.

  • 1 - email sent

  • 2 - postal sent

  • 4 - fax sent

FORM_invterms - GEV_INT

Statement terms. A positive integer representing how many days the customer has from the time of Statement creation to when the Account is pastdue if payment hasn't been received.

FORM_addr1 - GEV_STRING

Address field

FORM_addr2 - GEV_STRING

Address field

FORM_addr3 - GEV_STRING

Address field

FORM_addr4 - GEV_STRING

Address field

FORM_city - GEV_STRING

The city of the billing contact.

FORM_statename - GEV_STRING

The state/province of the billing contact.

FORM_zip - GEV_STRING

The postal code of the billing contact.

FORM_country - GEV_STRING

The country of the Account.

FORM_ccnum - GEV_STRING

The Account's credit card number in the form ##**********####.

FORM_cctype - GEV_INT

The brand of credit card (VISA, AMEX ...). A valid value from the cctypes list.

FORM_ccexp_month - GEV_INT

The month of The expiration date of the Accounts credit card. May be used for credit card processing.

FORM_ccexp_year - GEV_INT

The four digit year of The expiration date of the Accounts credit card. May be used for credit card processing.

FORM_ccname - GEV_STRING

The name on the Accounts credit card. May be used for credit card processing.

FORM_bacct - GEV_STRING

The Account's bank account number. May be used for EFT, ECHECK or ACH processing.

FORM_brout - GEV_STRING

The Account's bank routing number. May be used for EFT, ECHECK or ACH processing.

FORM_invday - GEV_INT

This value is a day of month, 1 through 31, and is used for several purposes:

FORM_ccaddr - GEV_STRING

The address at which the Account's credit card is registered. May be used for credit card processing.

FORM_cczip - GEV_STRING

The address at which the Account's credit card is registered. May be used for credit card processing.

FORM_ccnexttry - GEV_DATE

Used when an Account pays via automated electronic payment processing. If set to a future date, processing will not be attempted until that date. May be set by either manually or through closeofday

FORM_epaydays - GEV_INT

Given the date an item is billed to an Account, this is the number of days after that date for the first attempt to automatically collect funds for the item via . As an example, assume the Account pays by credit card and the item was billed 1/1/2003. The following are examples of the effect of epaydays on the first time the credit card will be attempted for these funds.

  • 0 - The credit card will be attempted 1/1/03

  • 1 - The credit card will be attempted 1/2/03

  • 7 - The credit card will be attempted 1/8/03

  • 15 - The credit card will be attempted 1/16/03

FORM_ccdeclines - GEV_INT

The current number of consecutive time a Account's electronic payment processing has failed. This number is set back to 0 when electronic payment for processing for the Account is successful. This parameter works in conjunction with the cctries option in the config table. When the number of consecutive declines equals cctries electronic payment processing for this Account is suspended.

FORM_gracedate - GEV_DATE

The date through which BillMax will ignore the overdue status of an Account (not send them any overdue notices, not suspend them, etc.). Use when making payment arrangements with Accounts that are overdue.

FORM_misc01 - GEV_INT

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

FORM_misc02 - GEV_INT

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

FORM_misc03 - GEV_INT

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

FORM_misc04 - GEV_INT

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

FORM_misc05 - GEV_INT

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

FORM_misc06 - GEV_STRING

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

FORM_misc07 - GEV_STRING

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

FORM_misc08 - GEV_STRING

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

FORM_misc09 - GEV_STRING

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

FORM_misc10 - GEV_STRING

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

FORM_misc11 - GEV_DATE

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

FORM_misc12 - GEV_DATE

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

FORM_misc13 - GEV_DATE

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

FORM_misc14 - GEV_DATE

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

FORM_misc15 - GEV_DATE

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

FORM_misc16 - GEV_TIME

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

FORM_misc17 - GEV_TIME

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

FORM_misc18 - GEV_TIME

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

FORM_misc19 - GEV_TIME

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

FORM_misc20 - GEV_TIME

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

FORM_bname - GEV_STRING

The Account's bank account name. May be used for EFT, ECHECK or ACH processing.

FORM_bcity - GEV_STRING

Address field

FORM_bstate - GEV_STRING

The state or province in which the Account's bank is located. May be used for EFT, ECHECK or ACH processing.

FORM_customerof - GEV_INT

A valid value from config.number denoting the Virtual Company to which this Account belongs.

FORM_generation - GEV_TIMESTAMP

A timestamp denoting the last time the record was modified.

FORM_reason - GEV_INT

The reason that the Account was changed to a State other than the Open State. A valid value from the reasons list.

FORM_title - GEV_STRING

The salutation of the billing contact.

FORM_postalcost - GEV_MONEY

A monthly charge assessed to the Account if they receive Statements by postal mail.

FORM_faxcost - GEV_MONEY

A monthly charge assessed to the Account if they receive Statements by fax.

FORM_bmui - GEV_INT

Setting allows or denies subscriber access to BillMax data through the Customer Interface.

  • 0 - Access denied

  • 1 - Access granted

FORM_useradmin - GEV_INT

Specifies which User is granted access to Account information through the Customer Interface

FORM_immune - GEV_CHECKBOX

Specifies whether an Account is immune from Overdue Processing. This is normally used for special Accounts.

FORM_ccpin - GEV_STRING

An option PIN field associated with a Account's credit card. May be used for credit card processing.

FORM_ccpass - GEV_STRING

An optional password field associated with a Account's credit card. May be used for credit card processing.

FORM_chargemin - GEV_MONEY

The minimum allowable by automatic processing. Used to make sure that small customer balances are not collected. Collecting them may cost more in fees than they are worth.

FORM_chargemax - GEV_MONEY

The maximum funds collection allowable by automated Electronic Funds Processing. Used to make sure an excessive incorrectly billed amount is not collected.

FORM_creditdue - GEV_MONEY

The maximum allowable refund by automatic processing for this Account.

FORM_refundmax - GEV_MONEY

The maximum refund allowable by automated Electronic Funds Processing. Used to make sure a mistaken excessive refund is not distributed.

OPTIONS

0

Prints a Location line for interpretation by the browser that refreshes the Account page.

1

Prints a Location line for interpretation by the browser that redirects the the browser to the User page.

RETURN VALUE

0 for success.

NOTES

NONE

SEE ALSO

createcust, enter_user.cgi, enter_service.cgi, BillMax_AccountPut


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