summaryrefslogtreecommitdiff
path: root/FS/FS/tax_status.pm
blob: 5f7b50fdeb448a85f4aa005d4d2090129a112264 (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
package FS::tax_status;

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

our %initial_data;

=head1 NAME

FS::tax_status - Object methods for tax_status records

=head1 SYNOPSIS

  use FS::tax_status;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::tax_status object represents a customer tax status for use with
an external tax table.  FS::tax_status inherits from FS::Record.  The 
following fields are currently supported:

=over 4

=item taxstatusnum

primary key

=item data_vendor

Data vendor name (corresponds to the value of the C<taxproduct> config 
variable.)

=item taxstatus

The data vendor's name or code for the tax status.

=item description

Description for use in the Freeside UI.

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new tax status.  To add the record to the database, see L<"insert">.

=cut

sub table { 'tax_status'; }

=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 example.  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('taxstatusnum')
    || $self->ut_textn('data_vendor')
    || $self->ut_text('taxstatus')
    || $self->ut_text('description')
  ;
  return $error if $error;

  $self->SUPER::check;
}

sub _upgrade_data {
  my $self = shift;
  my $error;
  foreach my $data_vendor ( keys %initial_data ) {
    my $status_hash = $initial_data{$data_vendor};
    foreach my $taxstatus (sort keys %$status_hash) {
      my $description = $status_hash->{$taxstatus};
      my $tax_status;
      if ($tax_status = qsearchs('tax_status', {
            data_vendor => $data_vendor,
            taxstatus   => $taxstatus
        }))
      {
        if ($tax_status->description ne $description) {
          $tax_status->set(description => $description);
          $error = $tax_status->replace;
        }
        # else it's already correct
      } else {
        $tax_status = FS::tax_status->new({
            data_vendor => $data_vendor,
            taxstatus   => $taxstatus,
            description => $description
        });
        $error = $tax_status->insert;
      }
      die $error if $error;
    }
  }
}

%initial_data = (
  'avalara' => {
    'A' => 'Federal Government',
    'B' => 'State/Local Government',
    'C' => 'Tribal Government',
    'D' => 'Foreign Diplomat',
    'E' => 'Charitable Organization',
    'F' => 'Religious/Education',
    'G' => 'Resale',
    'H' => 'Agricultural Production',
    'I' => 'Industrial Production',
    'J' => 'Direct Pay Permit',
    'K' => 'Direct Mail',
    'L' => 'Other',
    'M' => 'Local Government',
    # P, Q, R: Canada, not yet supported
    # MED1/MED2: totally irrelevant to our users
  },
  suretax => {
    'R' => 'Residential',
    'B' => 'Business',
    'I' => 'Industrial',
    'L' => 'Lifeline',
  },
);

=back

=head1 SEE ALSO

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

=cut

1;