multi_tax_filing_region_model.go

// 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"
)

// MultiTaxFilingRegionModel Regions
// Example: {"country":"US","hasNexus":true,"region":"AZ","regionTaxSummary":{"collectAmount":10,"nonTaxableAccrualAmount":100,"nonTaxableAmount":100,"remittanceAmount":10,"reportableNonTaxableAmount":50,"reportableSalesAmount":100,"reportableTaxAmount":5,"reportableTaxableAmount":5,"salesAccrualAmount":100,"salesAmount":200,"taxAccrualAmount":10,"taxAmount":10,"taxableAccrualAmount":0,"taxableAmount":0},"returns":[{"accrualType":0,"adjustments":[{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}],"description":"Sales Tax Return","filingCalendarId":513256,"filingFrequency":"Monthly","filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"returnTaxDetails":[{"nonTaxableAmount":100,"numberOfNights":1,"salesAmount":200,"taxAmount":10,"taxType":"S"}],"returnTaxSummary":{"collectAmount":10,"nonTaxableAccrualAmount":100,"nonTaxableAmount":100,"remittanceAmount":10,"reportableNonTaxableAmount":50,"reportableSalesAmount":100,"reportableTaxAmount":5,"reportableTaxableAmount":5,"salesAccrualAmount":100,"salesAmount":200,"taxAccrualAmount":10,"taxAmount":10,"taxableAccrualAmount":0,"taxableAmount":0},"status":"PendingApproval","totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}],"status":"PendingApproval"}
//
// swagger:model MultiTaxFilingRegionModel
type MultiTaxFilingRegionModel struct {

	// The two-character ISO-3166 code for the country.
	// Example: US
	Country string `json:"country,omitempty"`

	// Whether or not you have nexus in this region.
	// Example: true
	HasNexus bool `json:"hasNexus,omitempty"`

	// The two or three character region code for the region.
	// Example: AZ
	Region string `json:"region,omitempty"`

	// A detailed breakdown of the taxes in this filing
	RegionTaxDetails []*FilingsTaxDetailsModel `json:"regionTaxDetails"`

	// A summary of all taxes compbined for this period
	// Example: {"collectAmount":10,"nonTaxableAccrualAmount":100,"nonTaxableAmount":100,"remittanceAmount":10,"reportableNonTaxableAmount":50,"reportableSalesAmount":100,"reportableTaxAmount":5,"reportableTaxableAmount":5,"salesAccrualAmount":100,"salesAmount":200,"taxAccrualAmount":10,"taxAmount":10,"taxableAccrualAmount":0,"taxableAmount":0}
	RegionTaxSummary *FilingsTaxSummaryModel `json:"regionTaxSummary,omitempty"`

	// A list of tax returns in this region.
	// Example: [{"accrualType":0,"adjustments":[{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}],"description":"Sales Tax Return","filingCalendarId":513256,"filingFrequency":"Monthly","filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"returnTaxDetails":[{"nonTaxableAmount":100,"numberOfNights":1,"salesAmount":200,"taxAmount":10,"taxType":"S"}],"returnTaxSummary":{"collectAmount":10,"nonTaxableAccrualAmount":100,"nonTaxableAmount":100,"remittanceAmount":10,"reportableNonTaxableAmount":50,"reportableSalesAmount":100,"reportableTaxAmount":5,"reportableTaxableAmount":5,"salesAccrualAmount":100,"salesAmount":200,"taxAccrualAmount":10,"taxAmount":10,"taxableAccrualAmount":0,"taxableAmount":0},"status":"PendingApproval","totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}]
	Returns []*MultiTaxFilingReturnModel `json:"returns"`

	// The current status of the filing region.
	// Example: PendingApproval
	// Enum: [PendingApproval Dirty ApprovedToFile PendingFiling PendingFilingOnBehalf Filed FiledOnBehalf ReturnAccepted ReturnAcceptedOnBehalf PaymentRemitted Voided PendingReturn PendingReturnOnBehalf DoNotFile ReturnRejected ReturnRejectedOnBehalf ApprovedToFileOnBehalf]
	Status string `json:"status,omitempty"`

	// A list of tax returns in this region.
	SuggestReturns []*FilingsCheckupSuggestedFormModel `json:"suggestReturns"`
}

// Validate validates this multi tax filing region model
func (m *MultiTaxFilingRegionModel) Validate(formats strfmt.Registry) error {
	var res []error

	if err := m.validateRegionTaxDetails(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateRegionTaxSummary(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateReturns(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateStatus(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateSuggestReturns(formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *MultiTaxFilingRegionModel) validateRegionTaxDetails(formats strfmt.Registry) error {
	if swag.IsZero(m.RegionTaxDetails) { // not required
		return nil
	}

	for i := 0; i < len(m.RegionTaxDetails); i++ {
		if swag.IsZero(m.RegionTaxDetails[i]) { // not required
			continue
		}

		if m.RegionTaxDetails[i] != nil {
			if err := m.RegionTaxDetails[i].Validate(formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("regionTaxDetails" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("regionTaxDetails" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

func (m *MultiTaxFilingRegionModel) validateRegionTaxSummary(formats strfmt.Registry) error {
	if swag.IsZero(m.RegionTaxSummary) { // not required
		return nil
	}

	if m.RegionTaxSummary != nil {
		if err := m.RegionTaxSummary.Validate(formats); err != nil {
			if ve, ok := err.(*errors.Validation); ok {
				return ve.ValidateName("regionTaxSummary")
			} else if ce, ok := err.(*errors.CompositeError); ok {
				return ce.ValidateName("regionTaxSummary")
			}
			return err
		}
	}

	return nil
}

func (m *MultiTaxFilingRegionModel) validateReturns(formats strfmt.Registry) error {
	if swag.IsZero(m.Returns) { // not required
		return nil
	}

	for i := 0; i < len(m.Returns); i++ {
		if swag.IsZero(m.Returns[i]) { // not required
			continue
		}

		if m.Returns[i] != nil {
			if err := m.Returns[i].Validate(formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("returns" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("returns" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

var multiTaxFilingRegionModelTypeStatusPropEnum []interface{}

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["PendingApproval","Dirty","ApprovedToFile","PendingFiling","PendingFilingOnBehalf","Filed","FiledOnBehalf","ReturnAccepted","ReturnAcceptedOnBehalf","PaymentRemitted","Voided","PendingReturn","PendingReturnOnBehalf","DoNotFile","ReturnRejected","ReturnRejectedOnBehalf","ApprovedToFileOnBehalf"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		multiTaxFilingRegionModelTypeStatusPropEnum = append(multiTaxFilingRegionModelTypeStatusPropEnum, v)
	}
}

const (

	// MultiTaxFilingRegionModelStatusPendingApproval captures enum value "PendingApproval"
	MultiTaxFilingRegionModelStatusPendingApproval string = "PendingApproval"

	// MultiTaxFilingRegionModelStatusDirty captures enum value "Dirty"
	MultiTaxFilingRegionModelStatusDirty string = "Dirty"

	// MultiTaxFilingRegionModelStatusApprovedToFile captures enum value "ApprovedToFile"
	MultiTaxFilingRegionModelStatusApprovedToFile string = "ApprovedToFile"

	// MultiTaxFilingRegionModelStatusPendingFiling captures enum value "PendingFiling"
	MultiTaxFilingRegionModelStatusPendingFiling string = "PendingFiling"

	// MultiTaxFilingRegionModelStatusPendingFilingOnBehalf captures enum value "PendingFilingOnBehalf"
	MultiTaxFilingRegionModelStatusPendingFilingOnBehalf string = "PendingFilingOnBehalf"

	// MultiTaxFilingRegionModelStatusFiled captures enum value "Filed"
	MultiTaxFilingRegionModelStatusFiled string = "Filed"

	// MultiTaxFilingRegionModelStatusFiledOnBehalf captures enum value "FiledOnBehalf"
	MultiTaxFilingRegionModelStatusFiledOnBehalf string = "FiledOnBehalf"

	// MultiTaxFilingRegionModelStatusReturnAccepted captures enum value "ReturnAccepted"
	MultiTaxFilingRegionModelStatusReturnAccepted string = "ReturnAccepted"

	// MultiTaxFilingRegionModelStatusReturnAcceptedOnBehalf captures enum value "ReturnAcceptedOnBehalf"
	MultiTaxFilingRegionModelStatusReturnAcceptedOnBehalf string = "ReturnAcceptedOnBehalf"

	// MultiTaxFilingRegionModelStatusPaymentRemitted captures enum value "PaymentRemitted"
	MultiTaxFilingRegionModelStatusPaymentRemitted string = "PaymentRemitted"

	// MultiTaxFilingRegionModelStatusVoided captures enum value "Voided"
	MultiTaxFilingRegionModelStatusVoided string = "Voided"

	// MultiTaxFilingRegionModelStatusPendingReturn captures enum value "PendingReturn"
	MultiTaxFilingRegionModelStatusPendingReturn string = "PendingReturn"

	// MultiTaxFilingRegionModelStatusPendingReturnOnBehalf captures enum value "PendingReturnOnBehalf"
	MultiTaxFilingRegionModelStatusPendingReturnOnBehalf string = "PendingReturnOnBehalf"

	// MultiTaxFilingRegionModelStatusDoNotFile captures enum value "DoNotFile"
	MultiTaxFilingRegionModelStatusDoNotFile string = "DoNotFile"

	// MultiTaxFilingRegionModelStatusReturnRejected captures enum value "ReturnRejected"
	MultiTaxFilingRegionModelStatusReturnRejected string = "ReturnRejected"

	// MultiTaxFilingRegionModelStatusReturnRejectedOnBehalf captures enum value "ReturnRejectedOnBehalf"
	MultiTaxFilingRegionModelStatusReturnRejectedOnBehalf string = "ReturnRejectedOnBehalf"

	// MultiTaxFilingRegionModelStatusApprovedToFileOnBehalf captures enum value "ApprovedToFileOnBehalf"
	MultiTaxFilingRegionModelStatusApprovedToFileOnBehalf string = "ApprovedToFileOnBehalf"
)

// prop value enum
func (m *MultiTaxFilingRegionModel) validateStatusEnum(path, location string, value string) error {
	if err := validate.EnumCase(path, location, value, multiTaxFilingRegionModelTypeStatusPropEnum, true); err != nil {
		return err
	}
	return nil
}

func (m *MultiTaxFilingRegionModel) validateStatus(formats strfmt.Registry) error {
	if swag.IsZero(m.Status) { // not required
		return nil
	}

	// value enum
	if err := m.validateStatusEnum("status", "body", m.Status); err != nil {
		return err
	}

	return nil
}

func (m *MultiTaxFilingRegionModel) validateSuggestReturns(formats strfmt.Registry) error {
	if swag.IsZero(m.SuggestReturns) { // not required
		return nil
	}

	for i := 0; i < len(m.SuggestReturns); i++ {
		if swag.IsZero(m.SuggestReturns[i]) { // not required
			continue
		}

		if m.SuggestReturns[i] != nil {
			if err := m.SuggestReturns[i].Validate(formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("suggestReturns" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("suggestReturns" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

// ContextValidate validate this multi tax filing region model based on the context it is used
func (m *MultiTaxFilingRegionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
	var res []error

	if err := m.contextValidateRegionTaxDetails(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateRegionTaxSummary(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateReturns(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateSuggestReturns(ctx, formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *MultiTaxFilingRegionModel) contextValidateRegionTaxDetails(ctx context.Context, formats strfmt.Registry) error {

	for i := 0; i < len(m.RegionTaxDetails); i++ {

		if m.RegionTaxDetails[i] != nil {
			if err := m.RegionTaxDetails[i].ContextValidate(ctx, formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("regionTaxDetails" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("regionTaxDetails" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

func (m *MultiTaxFilingRegionModel) contextValidateRegionTaxSummary(ctx context.Context, formats strfmt.Registry) error {

	if m.RegionTaxSummary != nil {
		if err := m.RegionTaxSummary.ContextValidate(ctx, formats); err != nil {
			if ve, ok := err.(*errors.Validation); ok {
				return ve.ValidateName("regionTaxSummary")
			} else if ce, ok := err.(*errors.CompositeError); ok {
				return ce.ValidateName("regionTaxSummary")
			}
			return err
		}
	}

	return nil
}

func (m *MultiTaxFilingRegionModel) contextValidateReturns(ctx context.Context, formats strfmt.Registry) error {

	for i := 0; i < len(m.Returns); i++ {

		if m.Returns[i] != nil {
			if err := m.Returns[i].ContextValidate(ctx, formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("returns" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("returns" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

func (m *MultiTaxFilingRegionModel) contextValidateSuggestReturns(ctx context.Context, formats strfmt.Registry) error {

	for i := 0; i < len(m.SuggestReturns); i++ {

		if m.SuggestReturns[i] != nil {
			if err := m.SuggestReturns[i].ContextValidate(ctx, formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("suggestReturns" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("suggestReturns" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

// MarshalBinary interface implementation
func (m *MultiTaxFilingRegionModel) MarshalBinary() ([]byte, error) {
	if m == nil {
		return nil, nil
	}
	return swag.WriteJSON(m)
}

// UnmarshalBinary interface implementation
func (m *MultiTaxFilingRegionModel) UnmarshalBinary(b []byte) error {
	var res MultiTaxFilingRegionModel
	if err := swag.ReadJSON(b, &res); err != nil {
		return err
	}
	*m = res
	return nil
}