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

// MultiTaxFilingModel Represents a listing of all tax calculation data for filings and for accruing to future filings.
// Example: {"companyId":62593,"filingRegions":[{"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"}],"id":326529,"month":10,"type":"Original","year":2016}
//
// swagger:model MultiTaxFilingModel
type MultiTaxFilingModel struct {

	// The unique ID number of the company for this filing.
	// Example: 62593
	CompanyID int32 `json:"companyId,omitempty"`

	// A listing of regional tax filings within this time period.
	// 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"}]
	FilingRegions []*MultiTaxFilingRegionModel `json:"filingRegions"`

	// The unique ID number of this filing.
	// Example: 326529
	ID int64 `json:"id,omitempty"`

	// The month of the filing period for this tax filing.
	// The filing period represents the year and month of the last day of taxes being reported on this filing.
	// For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
	// Example: 10
	Month int32 `json:"month,omitempty"`

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

	// A summary of all taxes combined 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}
	TaxSummary *FilingsTaxSummaryModel `json:"taxSummary,omitempty"`

	// Indicates whether this is an original or an amended filing.
	// Example: Original
	// Enum: [Original Amended Test]
	Type string `json:"type,omitempty"`

	// The year of the filing period for this tax filing.
	// The filing period represents the year and month of the last day of taxes being reported on this filing.
	// For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
	// Example: 2016
	Year int16 `json:"year,omitempty"`
}

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

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

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

	if err := m.validateTaxSummary(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 *MultiTaxFilingModel) validateFilingRegions(formats strfmt.Registry) error {
	if swag.IsZero(m.FilingRegions) { // not required
		return nil
	}

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

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

	}

	return nil
}

func (m *MultiTaxFilingModel) validateTaxDetails(formats strfmt.Registry) error {
	if swag.IsZero(m.TaxDetails) { // not required
		return nil
	}

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

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

	}

	return nil
}

func (m *MultiTaxFilingModel) validateTaxSummary(formats strfmt.Registry) error {
	if swag.IsZero(m.TaxSummary) { // not required
		return nil
	}

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

	return nil
}

var multiTaxFilingModelTypeTypePropEnum []interface{}

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["Original","Amended","Test"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		multiTaxFilingModelTypeTypePropEnum = append(multiTaxFilingModelTypeTypePropEnum, v)
	}
}

const (

	// MultiTaxFilingModelTypeOriginal captures enum value "Original"
	MultiTaxFilingModelTypeOriginal string = "Original"

	// MultiTaxFilingModelTypeAmended captures enum value "Amended"
	MultiTaxFilingModelTypeAmended string = "Amended"

	// MultiTaxFilingModelTypeTest captures enum value "Test"
	MultiTaxFilingModelTypeTest string = "Test"
)

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

func (m *MultiTaxFilingModel) 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 multi tax filing model based on the context it is used
func (m *MultiTaxFilingModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
	var res []error

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

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

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

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

func (m *MultiTaxFilingModel) contextValidateFilingRegions(ctx context.Context, formats strfmt.Registry) error {

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

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

	}

	return nil
}

func (m *MultiTaxFilingModel) contextValidateTaxDetails(ctx context.Context, formats strfmt.Registry) error {

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

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

	}

	return nil
}

func (m *MultiTaxFilingModel) contextValidateTaxSummary(ctx context.Context, formats strfmt.Registry) error {

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

	return nil
}

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

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