billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

payhist table — table for payhist data

payhist Field Definitions

Name

Description

Data Type
Name

Description

Data Type
account

The account to which a financial record belongs.

int(11)
authcode

The authorization code from an automated Electronic Funds Processing.

char(20)
bankacct

Used in tracking Payments. Equal to -payhist.ucash.

int(11)
batchid

Groups together transactions from Electronic Funds Processing.

char(15)
ccnumshort

Abbreviated version of a credit card number used for the transaction.

char(20)
cdeposit

The Deposit Charge or Deposit Refund amount.

int(11)
changetocnt

The number of times a service has been modified due to a Service Change when the Sale for Service is made.

int(11)
changetodate

The date that a Service Change was executed. The payhist.changetodates of Sales prior to the Service Change that have the appropriate value for payhist.changetocnt are populated.

date
charge_type

Value from chargetypes list. Used in reports.

char(30)
cleardate

The date that a Financial Transaction is totally Allocated.

date
customerof

The Virtual Company to which a financial record belongs.

int(11)
depno

Cross reference between a Deposit Charge and a Deposit Refund

int(11)
deposit

Used in tracking Deposit Charges and Deposit Refunds. Equal to -payhist.cdeposit.

int(11)
descr

A description of the Financial Transaction.

char(100)
duedate

The date that a Payment for a Sale or a Deposit Charge must be received. If the Payment is not received by this date, the Account is considered overdue.

date
empl

The Authorized BillMax User that entered the Financial Transaction.

mediumint(8)
enddate

The ending date for a Sale for a Service for a period of time.

date
entdate

The effective date for a payhist table record. Generally the date the record was created.

date
enttime

The effective time for a payhist table record. Generally the date the record was created.

time
epaydate

The first date an attempt will be made to collect funds via Electronic Funds Processing for a Sale or a Deposit Charge.

date
flags

Information about the record in the payhist table. This is a BIT mask. The following represents the BIT positions for the different information. A 1 value in the BIT position indicates the the information is TRUE. More than one bit may have a value of 1.

  • 1 - FLAGS_AUTO - The record was created by automated BillMax process and not through manual intervention.

  • 2 - FLAGS_SETUP - The Sale is a setup charge.

  • 3 - FLAGS_USAGE - The Sale is for usage.

tinyint(4)
generation

ID used to keep different editing sessions from colliding.

timestamp(14)
invcnt

Represents the number of times a Service has been billed since inception or the last Service Change

int(11)
invno

Allocation cross reference.

int(11)
invoiceval

Not Used.

char(20)
misc01

An integer miscellaneous field.

int(11)
misc02

A character miscellaneous field.

char(50)
misc03

A time miscellaneous field.

date
misc04

A date miscellaneous field.

time
noautoallocate

If non-zero, do NOT use automated BillMax processes to create Allocations for this record.

tinyint(4)
ntaxable

The non-taxable value of a Sale or Store Credit

int(11)
number

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

int(11)
payno

Allocation cross reference.

int(11)
ponumber

Purchase Order.

char(30)
ptax

Used to track purchases that are included in tax exemption calculations.

tinyint(4)
purchases

The total amount of a purchase. Equal to -(ntaxable + taxable + tax).

int(11)
quantity

The number of items purchased.

float(10,2)
receipt

The number of the receipt given for payment received.

char(50)
refund

Internal bookkeeping field.

int(11)
salesid

Not implemented.

int(11)
servdef

The associated Service Definition for a financial transaction.

int(11)
service

A description for the associated Service for a financial transaction.

int(11)
servicename

The service.d01 field at the creation time of a financial transaction.

char(100)
startdate

The starting date for a Sale for a Service for a period of time.

date
summary

  • 0 - No subsequent Summary record has been created. The financial transaction may be edited or deleted.

  • 1 - A subsequent Summary record has been created. The financial transaction may NOT be edited or deleted.

tinyint(4)
tax

The tax amount of the Sale.

int(11)
taxable

The taxable amount of the Sale.

int(11)
taxrate

The tax rate at the time of the Sale.

double(16,8)
taxregion

The tax region at the time of the Sale.

int(11)
tender

The type of tender (cash, check, VISA...) used for a Payment or Refund.

tinyint(4)
tendnum

The number (check number, transaction id, ... ) associated with the Payment or Refund.

char(50)
type

The type of financial transaction.

tinyint(4)
ucash

The amount of money used in a financial transaction.

int(11)
ucredit

The amount of Store Credit used in a financial transaction.

int(11)
voidtran

The number of the Void, if any, associated with the financial transaction.

int(11)

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