/
tax_override_model.go
232 lines (184 loc) · 6.69 KB
/
tax_override_model.go
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
// Code generated by go-swagger; DO NOT EDIT.
package models
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"context"
"encoding/json"
"strconv"
"github.com/go-openapi/errors"
"github.com/go-openapi/strfmt"
"github.com/go-openapi/swag"
"github.com/go-openapi/validate"
)
// TaxOverrideModel Represents a tax override for a transaction
// Example: {"reason":"Precalculated Tax","taxAmount":6.25,"taxDate":"2021-12-25","type":"TaxAmount"}
//
// swagger:model TaxOverrideModel
type TaxOverrideModel struct {
// This provides the reason for a tax override for audit purposes. It is required for types 2-4.
//
// Typical reasons include:
// "Return"
// "Layaway"
// Example: Precalculated Tax
Reason string `json:"reason,omitempty"`
// Indicates a total override of the calculated tax on the document. AvaTax will distribute
// the override across all the lines.
//
// Tax will be distributed on a best effort basis. It may not always be possible to override all taxes. Please consult
// your account manager for information about overrides.
// Example: 6.25
TaxAmount float64 `json:"taxAmount,omitempty"`
// Indicates a total override of the calculated tax on the line with TaxType.
// AvaTax will distribute the override across all the line details for that TaxType.
//
// TaxAmountByTaxType can be used only at the Line level.
TaxAmountByTaxTypes []*TransactionLineTaxAmountByTaxTypeModel `json:"taxAmountByTaxTypes"`
// The override tax date to use
//
// This is used when the tax has been previously calculated
// as in the case of a layaway, return or other reason indicated by the Reason element.
// If the date is not overridden, then it should be set to the same as the DocDate.
// Example: 2021-12-25T00:00:00+00:00
// Format: date
TaxDate strfmt.Date `json:"taxDate,omitempty"`
// Identifies the type of tax override
// Example: None
// Enum: [None TaxAmount Exemption TaxDate AccruedTaxAmount DeriveTaxable OutOfHarbor TaxAmountByTaxType]
Type string `json:"type,omitempty"`
}
// Validate validates this tax override model
func (m *TaxOverrideModel) Validate(formats strfmt.Registry) error {
var res []error
if err := m.validateTaxAmountByTaxTypes(formats); err != nil {
res = append(res, err)
}
if err := m.validateTaxDate(formats); err != nil {
res = append(res, err)
}
if err := m.validateType(formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *TaxOverrideModel) validateTaxAmountByTaxTypes(formats strfmt.Registry) error {
if swag.IsZero(m.TaxAmountByTaxTypes) { // not required
return nil
}
for i := 0; i < len(m.TaxAmountByTaxTypes); i++ {
if swag.IsZero(m.TaxAmountByTaxTypes[i]) { // not required
continue
}
if m.TaxAmountByTaxTypes[i] != nil {
if err := m.TaxAmountByTaxTypes[i].Validate(formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("taxAmountByTaxTypes" + "." + strconv.Itoa(i))
} else if ce, ok := err.(*errors.CompositeError); ok {
return ce.ValidateName("taxAmountByTaxTypes" + "." + strconv.Itoa(i))
}
return err
}
}
}
return nil
}
func (m *TaxOverrideModel) validateTaxDate(formats strfmt.Registry) error {
if swag.IsZero(m.TaxDate) { // not required
return nil
}
if err := validate.FormatOf("taxDate", "body", "date", m.TaxDate.String(), formats); err != nil {
return err
}
return nil
}
var taxOverrideModelTypeTypePropEnum []interface{}
func init() {
var res []string
if err := json.Unmarshal([]byte(`["None","TaxAmount","Exemption","TaxDate","AccruedTaxAmount","DeriveTaxable","OutOfHarbor","TaxAmountByTaxType"]`), &res); err != nil {
panic(err)
}
for _, v := range res {
taxOverrideModelTypeTypePropEnum = append(taxOverrideModelTypeTypePropEnum, v)
}
}
const (
// TaxOverrideModelTypeNone captures enum value "None"
TaxOverrideModelTypeNone string = "None"
// TaxOverrideModelTypeTaxAmount captures enum value "TaxAmount"
TaxOverrideModelTypeTaxAmount string = "TaxAmount"
// TaxOverrideModelTypeExemption captures enum value "Exemption"
TaxOverrideModelTypeExemption string = "Exemption"
// TaxOverrideModelTypeTaxDate captures enum value "TaxDate"
TaxOverrideModelTypeTaxDate string = "TaxDate"
// TaxOverrideModelTypeAccruedTaxAmount captures enum value "AccruedTaxAmount"
TaxOverrideModelTypeAccruedTaxAmount string = "AccruedTaxAmount"
// TaxOverrideModelTypeDeriveTaxable captures enum value "DeriveTaxable"
TaxOverrideModelTypeDeriveTaxable string = "DeriveTaxable"
// TaxOverrideModelTypeOutOfHarbor captures enum value "OutOfHarbor"
TaxOverrideModelTypeOutOfHarbor string = "OutOfHarbor"
// TaxOverrideModelTypeTaxAmountByTaxType captures enum value "TaxAmountByTaxType"
TaxOverrideModelTypeTaxAmountByTaxType string = "TaxAmountByTaxType"
)
// prop value enum
func (m *TaxOverrideModel) validateTypeEnum(path, location string, value string) error {
if err := validate.EnumCase(path, location, value, taxOverrideModelTypeTypePropEnum, true); err != nil {
return err
}
return nil
}
func (m *TaxOverrideModel) validateType(formats strfmt.Registry) error {
if swag.IsZero(m.Type) { // not required
return nil
}
// value enum
if err := m.validateTypeEnum("type", "body", m.Type); err != nil {
return err
}
return nil
}
// ContextValidate validate this tax override model based on the context it is used
func (m *TaxOverrideModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
var res []error
if err := m.contextValidateTaxAmountByTaxTypes(ctx, formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *TaxOverrideModel) contextValidateTaxAmountByTaxTypes(ctx context.Context, formats strfmt.Registry) error {
for i := 0; i < len(m.TaxAmountByTaxTypes); i++ {
if m.TaxAmountByTaxTypes[i] != nil {
if err := m.TaxAmountByTaxTypes[i].ContextValidate(ctx, formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("taxAmountByTaxTypes" + "." + strconv.Itoa(i))
} else if ce, ok := err.(*errors.CompositeError); ok {
return ce.ValidateName("taxAmountByTaxTypes" + "." + strconv.Itoa(i))
}
return err
}
}
}
return nil
}
// MarshalBinary interface implementation
func (m *TaxOverrideModel) MarshalBinary() ([]byte, error) {
if m == nil {
return nil, nil
}
return swag.WriteJSON(m)
}
// UnmarshalBinary interface implementation
func (m *TaxOverrideModel) UnmarshalBinary(b []byte) error {
var res TaxOverrideModel
if err := swag.ReadJSON(b, &res); err != nil {
return err
}
*m = res
return nil
}