summaryrefslogtreecommitdiff
path: root/FS/FS/vend_bill.pm
blob: 5ea91fb581d9cbe3220ed35c514977eb05bee538 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
package FS::vend_bill;
use base qw(FS::Record);

use strict;
use FS::Record qw( dbh ); # qsearch qsearchs );
use FS::vend_pay;

=head1 NAME

FS::vend_bill - Object methods for vend_bill records

=head1 SYNOPSIS

  use FS::vend_bill;

  $record = new FS::vend_bill \%hash;
  $record = new FS::vend_bill { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::vend_bill object represents a vendor invoice or payable.  FS::vend_bill
inherits from FS::Record.  The following fields are currently supported:

=over 4

=item vendbillnum

primary key

=item vendnum

vendnum

=item _date

_date

=item charged

charged


=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<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'vend_bill'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=cut

sub insert {
  my $self = shift;

  my $oldAutoCommit = $FS::UID::AutoCommit;
  local $FS::UID::AutoCommit = 0;
  my $dbh = dbh;

  my $error = $self->SUPER::insert;
  if ( $error ) {
    $dbh->rollback if $oldAutoCommit;
    return "inserting vend_bill: $error";
  }

  #magically auto-inserting for the simple case
  my $vend_pay = new FS::vend_pay {
    'vendnum'    => $self->vendnum,
    'vendbillnum' => $self->vendbillnum,
    '_date'       => $self->get('payment_date') || $self->_date,
    'paid'        => $self->charged,
  };

  $error = $vend_pay->insert;
  if ( $error ) {
    $dbh->rollback if $oldAutoCommit;
    return "auto-inserting vend_pay: $error";
  }

  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
  '';

}

=item delete

Delete this record from the database.

=cut

sub delete {
  my $self = shift;

  my $oldAutoCommit = $FS::UID::AutoCommit;
  local $FS::UID::AutoCommit = 0;
  my $dbh = dbh;

  foreach my $vend_bill_pay ( $self->vend_bill_pay ) {
    my $error = $vend_bill_pay->delete;
    if ( $error ) {
      $dbh->rollback if $oldAutoCommit;
      return $error;
    }
  }

  my $error = $self->SUPER::delete;
  if ( $error ) {
    $dbh->rollback if $oldAutoCommit;
    return $error;
  }

  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
  '';

}

=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

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('vendbillnum')
    || $self->ut_foreign_key('vendnum', 'vend_main', 'vendnum')
    || $self->ut_numbern('_date')
    || $self->ut_money('charged')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item vend_main

=item vend_bill_pay

=item search

=cut

sub search {
  my ($class, $param) = @_;

  my @where = ();
  my $addl_from = '';

  #_date
  if ( $param->{_date} ) {
    my($beginning, $ending) = @{$param->{_date}};

    push @where, "vend_bill._date >= $beginning",
                 "vend_bill._date <  $ending";
  }

  #payment_date
  if ( $param->{payment_date} ) {
    my($beginning, $ending) = @{$param->{payment_date}};

    push @where, "vend_pay._date >= $beginning",
                 "vend_pay._date <  $ending";
  }

  if ( $param->{'classnum'} =~ /^(\d+)$/ ) {
    #also simplistic, but good for now
    $addl_from .= ' LEFT JOIN vend_main USING (vendnum) ';
    push @where, "vend_main.classnum = $1";
  }

  my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';

  #simplistic, but how we are for now
  $addl_from .= ' LEFT JOIN vend_bill_pay USING (vendbillnum) '.
                ' LEFT JOIN vend_pay      USING (vendpaynum)  ';

  my $count_query = "SELECT COUNT(*), SUM(charged) FROM vend_bill $addl_from $extra_sql";

  +{
    'table'         => 'vend_bill',
    'select'        => 'vend_bill.*, vend_pay._date as payment_date',
    'addl_from'     => $addl_from,
    'hashref'       => {},
    'extra_sql'     => $extra_sql,
    'order_by'      => 'ORDER BY _date',
    'count_query'   => $count_query,
    #'extra_headers' => \@extra_headers,
    #'extra_fields'  => \@extra_fields,
  };
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;