package FS::cust_bill_pkg_tax_location; use strict; use base qw( FS::Record ); use FS::Record qw( qsearch qsearchs ); use FS::cust_bill_pkg; use FS::cust_pkg; use FS::cust_location; use FS::cust_bill_pay_pkg; use FS::cust_credit_bill_pkg; use FS::cust_main_county; =head1 NAME FS::cust_bill_pkg_tax_location - Object methods for cust_bill_pkg_tax_location records =head1 SYNOPSIS use FS::cust_bill_pkg_tax_location; $record = new FS::cust_bill_pkg_tax_location \%hash; $record = new FS::cust_bill_pkg_tax_location { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check; =head1 DESCRIPTION An FS::cust_bill_pkg_tax_location object represents an record of taxation based on package location. FS::cust_bill_pkg_tax_location inherits from FS::Record. The following fields are currently supported: =over 4 =item billpkgtaxlocationnum billpkgtaxlocationnum =item billpkgnum billpkgnum =item taxnum taxnum =item taxtype taxtype =item pkgnum pkgnum =item locationnum locationnum =item amount amount =back =head1 METHODS =over 4 =item new HASHREF Creates a new record. To add the record to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. =cut sub table { 'cust_bill_pkg_tax_location'; } =item insert Adds this record to the database. If there is an error, returns the error, otherwise returns false. =item delete Delete this record from the database. =item replace OLD_RECORD Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. =item check Checks all fields to make sure this is a valid record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. =cut # the check method should currently be supplied - FS::Record contains some # data checking routines sub check { my $self = shift; my $error = $self->ut_numbern('billpkgtaxlocationnum') || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' ) || $self->ut_number('taxnum') #cust_bill_pkg/tax_rate key, based on taxtype || $self->ut_enum('taxtype', [ qw( FS::cust_main_county FS::tax_rate ) ] ) || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum' ) || $self->ut_foreign_key('locationnum', 'cust_location', 'locationnum' ) || $self->ut_money('amount') ; return $error if $error; $self->SUPER::check; } =item cust_bill_pkg Returns the associated cust_bill_pkg object =cut sub cust_bill_pkg { my $self = shift; qsearchs( 'cust_bill_pkg', { 'billpkgnum' => $self->billpkgnum } ); } =item cust_location Returns the associated cust_location object =cut sub cust_location { my $self = shift; qsearchs( 'cust_location', { 'locationnum' => $self->locationnum } ); } =item desc Returns a description for this tax line item constituent. Currently this is the desc of the associated line item followed by the state/county/city for the location in parentheses. =cut sub desc { my $self = shift; my $cust_location = $self->cust_location; my $location = join('/', grep { $_ } # leave in? map { $cust_location->$_ } qw( state county city ) # country? ); my $cust_bill_pkg_desc = $self->billpkgnum ? $self->cust_bill_pkg->desc : $self->cust_bill_pkg_desc; "$cust_bill_pkg_desc ($location)"; } =item owed Returns the amount owed (still outstanding) on this tax line item which is the amount of this record minus all payment applications and credit applications. =cut sub owed { my $self = shift; my $balance = $self->amount; $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg('setup') ); $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg('setup') ); $balance = sprintf( '%.2f', $balance ); $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp $balance; } sub cust_bill_pay_pkg { my $self = shift; qsearch( 'cust_bill_pay_pkg', { map { $_ => $self->$_ } qw( billpkgtaxlocationnum billpkgnum ) } ); } sub cust_credit_bill_pkg { my $self = shift; qsearch( 'cust_credit_bill_pkg', { map { $_ => $self->$_ } qw( billpkgtaxlocationnum billpkgnum ) } ); } sub cust_main_county { my $self = shift; my $result; if ( $self->taxtype eq 'FS::cust_main_county' ) { $result = qsearchs( 'cust_main_county', { 'taxnum' => $self->taxnum } ); } } =back =head1 BUGS The presense of FS::cust_main_county::delete makes the cust_main_county method unreliable =head1 SEE ALSO L, schema.html from the base documentation. =cut 1;