summaryrefslogtreecommitdiff
path: root/FS/FS/vend_pay.pm
blob: 3216bdb99fac4b28c816420af7edd1e80546ec6c (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
package FS::vend_pay;

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

=head1 NAME

FS::vend_pay - Object methods for vend_pay records

=head1 SYNOPSIS

  use FS::vend_pay;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::vend_pay object represents a vendor payment.  FS::vend_pay inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item vendpaynum

primary key

=item vendnum

vendnum

=item _date

_date

=item paid

paid


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new payment.  To add the payment 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_pay'; }

=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_pay: $error";
  }

  if ( $self->get('vendbillnum') ) {

    my $vend_bill_pay = new FS::vend_bill_pay {
      'vendpaynum'  => $self->vendpaynum,
      'vendbillnum' => $self->get('vendbillnum'),
      'amount'      => $self->paid,
    };

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

  }

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

}

=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 payment.  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('vendpaynum')
    || $self->ut_foreign_key('vendnum', 'vend_main', 'vendnum')
    || $self->ut_numbern('_date')
    || $self->ut_money('paid')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

=head1 SEE ALSO

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

=cut

1;