2 use base qw( FS::Agent_Mixin FS::Record );
5 use FS::Record qw( qsearch qsearchs );
13 FS::sales - Object methods for sales records
19 $record = new FS::sales \%hash;
20 $record = new FS::sales { 'column' => 'value' };
22 $error = $record->insert;
24 $error = $new_record->replace($old_record);
26 $error = $record->delete;
28 $error = $record->check;
32 An FS::sales object represents a sales person. FS::sales inherits from
33 FS::Record. The following fields are currently supported:
58 Creates a new sales person. To add the sales person to the database, see
61 Note that this stores the hash reference, not a distinct copy of the hash it
62 points to. You can ask the object for a copy with the I<hash> method.
66 # the new method can be inherited from FS::Record, if a table method is defined
68 sub table { 'sales'; }
72 Adds this record to the database. If there is an error, returns the error,
73 otherwise returns false.
77 # the insert method can be inherited from FS::Record
81 Delete this record from the database.
85 # the delete method can be inherited from FS::Record
87 =item replace OLD_RECORD
89 Replaces the OLD_RECORD with this one in the database. If there is an error,
90 returns the error, otherwise returns false.
94 # the replace method can be inherited from FS::Record
98 Checks all fields to make sure this is a valid sales person. If there is
99 an error, returns the error, otherwise returns false. Called by the insert
104 # the check method should currently be supplied - FS::Record contains some
105 # data checking routines
111 $self->ut_numbern('salesnum')
112 || $self->ut_text('salesperson')
113 || $self->ut_foreign_key('agentnum', 'agent', 'agentnum')
114 || $self->ut_foreign_keyn('sales_custnum', 'cust_main', 'custnum')
115 || $self->ut_enum('disabled', [ '', 'Y' ])
117 return $error if $error;
122 =item sales_cust_main
124 Returns the FS::cust_main object (see L<FS::cust_main>), if any, for this
129 sub sales_cust_main {
131 qsearchs( 'cust_main', { 'custnum' => $self->sales_custnum } );
135 my( $self, $sdate, $edate, %search ) = @_;
137 my $cmp_salesnum = delete $search{'cust_main_sales'}
138 ? ' COALESCE( cust_pkg.salesnum, cust_main.salesnum )'
139 : ' cust_pkg.salesnum ';
141 my $classnum_sql = '';
142 if ( exists( $search{'classnum'} ) ) {
143 my $classnum = $search{'classnum'};
144 $classnum_sql = " AND part_pkg.classnum ". ( $classnum ? " = $classnum "
148 qsearch({ 'table' => 'cust_bill_pkg',
149 'addl_from' => ' LEFT JOIN cust_bill USING ( invnum ) '.
150 ' LEFT JOIN cust_pkg USING ( pkgnum ) '.
151 ' LEFT JOIN part_pkg USING ( pkgpart ) '.
152 ' LEFT JOIN cust_main ON ( cust_pkg.custnum = cust_main.custnum )',
153 'extra_sql' => ( keys %{ $search{'hashref'} }
156 " cust_bill._date >= $sdate ".
157 " AND cust_bill._date < $edate ".
158 " AND $cmp_salesnum = ". $self->salesnum.
165 my( $self, $sdate, $edate, %search ) = @_;
167 $search{'hashref'}->{'commission_salesnum'} = $self->salesnum;
169 my $classnum_sql = '';
170 if ( exists($search{'commission_classnum'}) ) {
171 my $classnum = delete($search{'commission_classnum'});
172 $classnum_sql = " AND part_pkg.classnum ". ( $classnum ? " = $classnum"
175 $search{'addl_from'} .=
176 ' LEFT JOIN cust_pkg ON ( commission_pkgnum = cust_pkg.pkgnum ) '.
177 ' LEFT JOIN part_pkg USING ( pkgpart ) ';
180 qsearch({ 'table' => 'cust_credit',
181 'extra_sql' => " AND cust_credit._date >= $sdate ".
182 " AND cust_credit._date < $edate ".
194 L<FS::Record>, schema.html from the base documentation.