billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

enter_servicechange.cgi — Create or Modify a Service Change record. Execute a Service Change

Synopsis

/usr/local/billmax/cgi-bin/enter_servicechange

DESCRIPTION

Creates or modifies a Service Change record in the servicechange table. It may also be used to execute a Service Change.

REQUIRED ENVIRONMENT VARIABLES

FORM_action - GEV_STRING
FORM_number - GEV_INT

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

FORM_status - GEV_INT

Stores the result of executing the Service Change.

FORM_statustext - GEV_STRING

Stores the textual result of executing the Service Change.

FORM_changeon - GEV_DATE

The effective date of the Service Change.

FORM_service - GEV_INT

The value of service.number of the Service undergoing the Service Change.

FORM_servdef - GEV_INT

The value of servdef.number of the new Service Definition.

FORM_oldservdef - GEV_INT

The value of servdef.number of the old Service Definition.

FORM_creditsetup - GEV_CHECKBOX

If non-zero, credit the old setup fee.

FORM_creditusage - GEV_CHECKBOX

If non-zero, credit usages fees.

FORM_refunddeposits - GEV_CHECKBOX

If non-zero, either refund the old Deposit Charge or Void the old Deposit Charge.

FORM_creditbyvoid - GEV_CHECKBOX

If non-zero, when the Service Change is executed, credit for future unused service will be made using Voids. Otherwise, issue Store Credit for future unused service.

FORM_chargesetup - GEV_CHECKBOX

If non-zero, indicates that any setup fees associated with the new Service Definition will be billed when the Service Change takes place.

FORM_chargedeposit - GEV_CHECKBOX

If non-zero, indicates that any Deposit Charge associated with the new Service Definition will be billed when the Service Change takes place.

FORM_chargeiterms - GEV_CHECKBOX

If non-zero, indicates that billing for the new Service Definition will begin with the initial price.

FORM_comment - GEV_STRING

A comment about the Service Change.

FORM_quantity - GEV_FLOAT

The quantity to use for the new billings.

FORM_free - GEV_CHECKBOX

If non-zero, the Service will be set to free when the Service Change takes place.

FORM_taxable - GEV_CHECKBOX

If non-zero, tax will be assessed on the recurring and initial fees billed after the Service Change.

FORM_setup_taxable - GEV_CHECKBOX

If non-zero, tax will be assessed on the setup fee billed when the Service Change takes place.

FORM_iprice - GEV_MONEY

The initial price to use for the new billings.

FORM_price - GEV_MONEY

The regular price to use for the new billings.

RETURN VALUE

System value EX_OK for success.

NOTES

NONE

SEE ALSO

NONE


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