models

package
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2022 License: MIT Imports: 7 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

View Source 
const (

	// AccountModelAccountStatusIDInactive captures enum value "Inactive"
	AccountModelAccountStatusIDInactive string = "Inactive"

	// AccountModelAccountStatusIDActive captures enum value "Active"
	AccountModelAccountStatusIDActive string = "Active"

	// AccountModelAccountStatusIDTest captures enum value "Test"
	AccountModelAccountStatusIDTest string = "Test"

	// AccountModelAccountStatusIDNew captures enum value "New"
	AccountModelAccountStatusIDNew string = "New"
)
View Source 
const (

	// AccountModelAccountTypeIDRegular captures enum value "Regular"
	AccountModelAccountTypeIDRegular string = "Regular"

	// AccountModelAccountTypeIDFirm captures enum value "Firm"
	AccountModelAccountTypeIDFirm string = "Firm"

	// AccountModelAccountTypeIDFirmClient captures enum value "FirmClient"
	AccountModelAccountTypeIDFirmClient string = "FirmClient"
)
View Source 
const (

	// AddTransactionLineModelDocumentTypeSalesOrder captures enum value "SalesOrder"
	AddTransactionLineModelDocumentTypeSalesOrder string = "SalesOrder"

	// AddTransactionLineModelDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	AddTransactionLineModelDocumentTypeSalesInvoice string = "SalesInvoice"

	// AddTransactionLineModelDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	AddTransactionLineModelDocumentTypePurchaseOrder string = "PurchaseOrder"

	// AddTransactionLineModelDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	AddTransactionLineModelDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// AddTransactionLineModelDocumentTypeReturnOrder captures enum value "ReturnOrder"
	AddTransactionLineModelDocumentTypeReturnOrder string = "ReturnOrder"

	// AddTransactionLineModelDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	AddTransactionLineModelDocumentTypeReturnInvoice string = "ReturnInvoice"

	// AddTransactionLineModelDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	AddTransactionLineModelDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// AddTransactionLineModelDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	AddTransactionLineModelDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// AddTransactionLineModelDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	AddTransactionLineModelDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// AddTransactionLineModelDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	AddTransactionLineModelDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// AddTransactionLineModelDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	AddTransactionLineModelDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// AddTransactionLineModelDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	AddTransactionLineModelDocumentTypeCustomsOrder string = "CustomsOrder"

	// AddTransactionLineModelDocumentTypeAny captures enum value "Any"
	AddTransactionLineModelDocumentTypeAny string = "Any"
)
View Source 
const (

	// AddressResolutionModelResolutionQualityNotCoded captures enum value "NotCoded"
	AddressResolutionModelResolutionQualityNotCoded string = "NotCoded"

	// AddressResolutionModelResolutionQualityExternal captures enum value "External"
	AddressResolutionModelResolutionQualityExternal string = "External"

	// AddressResolutionModelResolutionQualityCountryCentroid captures enum value "CountryCentroid"
	AddressResolutionModelResolutionQualityCountryCentroid string = "CountryCentroid"

	// AddressResolutionModelResolutionQualityRegionCentroid captures enum value "RegionCentroid"
	AddressResolutionModelResolutionQualityRegionCentroid string = "RegionCentroid"

	// AddressResolutionModelResolutionQualityPartialCentroid captures enum value "PartialCentroid"
	AddressResolutionModelResolutionQualityPartialCentroid string = "PartialCentroid"

	// AddressResolutionModelResolutionQualityPostalCentroidGood captures enum value "PostalCentroidGood"
	AddressResolutionModelResolutionQualityPostalCentroidGood string = "PostalCentroidGood"

	// AddressResolutionModelResolutionQualityPostalCentroidBetter captures enum value "PostalCentroidBetter"
	AddressResolutionModelResolutionQualityPostalCentroidBetter string = "PostalCentroidBetter"

	// AddressResolutionModelResolutionQualityPostalCentroidBest captures enum value "PostalCentroidBest"
	AddressResolutionModelResolutionQualityPostalCentroidBest string = "PostalCentroidBest"

	// AddressResolutionModelResolutionQualityIntersection captures enum value "Intersection"
	AddressResolutionModelResolutionQualityIntersection string = "Intersection"

	// AddressResolutionModelResolutionQualityInterpolated captures enum value "Interpolated"
	AddressResolutionModelResolutionQualityInterpolated string = "Interpolated"

	// AddressResolutionModelResolutionQualityRooftop captures enum value "Rooftop"
	AddressResolutionModelResolutionQualityRooftop string = "Rooftop"

	// AddressResolutionModelResolutionQualityConstant captures enum value "Constant"
	AddressResolutionModelResolutionQualityConstant string = "Constant"
)
View Source 
const (

	// AddressValidationInfoTextCaseUpper captures enum value "Upper"
	AddressValidationInfoTextCaseUpper string = "Upper"

	// AddressValidationInfoTextCaseMixed captures enum value "Mixed"
	AddressValidationInfoTextCaseMixed string = "Mixed"
)
View Source 
const (

	// AdjustMultiDocumentModelAdjustmentReasonNotAdjusted captures enum value "NotAdjusted"
	AdjustMultiDocumentModelAdjustmentReasonNotAdjusted string = "NotAdjusted"

	// AdjustMultiDocumentModelAdjustmentReasonSourcingIssue captures enum value "SourcingIssue"
	AdjustMultiDocumentModelAdjustmentReasonSourcingIssue string = "SourcingIssue"

	// AdjustMultiDocumentModelAdjustmentReasonReconciledWithGeneralLedger captures enum value "ReconciledWithGeneralLedger"
	AdjustMultiDocumentModelAdjustmentReasonReconciledWithGeneralLedger string = "ReconciledWithGeneralLedger"

	// AdjustMultiDocumentModelAdjustmentReasonExemptCertApplied captures enum value "ExemptCertApplied"
	AdjustMultiDocumentModelAdjustmentReasonExemptCertApplied string = "ExemptCertApplied"

	// AdjustMultiDocumentModelAdjustmentReasonPriceAdjusted captures enum value "PriceAdjusted"
	AdjustMultiDocumentModelAdjustmentReasonPriceAdjusted string = "PriceAdjusted"

	// AdjustMultiDocumentModelAdjustmentReasonProductReturned captures enum value "ProductReturned"
	AdjustMultiDocumentModelAdjustmentReasonProductReturned string = "ProductReturned"

	// AdjustMultiDocumentModelAdjustmentReasonProductExchanged captures enum value "ProductExchanged"
	AdjustMultiDocumentModelAdjustmentReasonProductExchanged string = "ProductExchanged"

	// AdjustMultiDocumentModelAdjustmentReasonBadDebt captures enum value "BadDebt"
	AdjustMultiDocumentModelAdjustmentReasonBadDebt string = "BadDebt"

	// AdjustMultiDocumentModelAdjustmentReasonOther captures enum value "Other"
	AdjustMultiDocumentModelAdjustmentReasonOther string = "Other"

	// AdjustMultiDocumentModelAdjustmentReasonOffline captures enum value "Offline"
	AdjustMultiDocumentModelAdjustmentReasonOffline string = "Offline"
)
View Source 
const (

	// AdjustTransactionModelAdjustmentReasonNotAdjusted captures enum value "NotAdjusted"
	AdjustTransactionModelAdjustmentReasonNotAdjusted string = "NotAdjusted"

	// AdjustTransactionModelAdjustmentReasonSourcingIssue captures enum value "SourcingIssue"
	AdjustTransactionModelAdjustmentReasonSourcingIssue string = "SourcingIssue"

	// AdjustTransactionModelAdjustmentReasonReconciledWithGeneralLedger captures enum value "ReconciledWithGeneralLedger"
	AdjustTransactionModelAdjustmentReasonReconciledWithGeneralLedger string = "ReconciledWithGeneralLedger"

	// AdjustTransactionModelAdjustmentReasonExemptCertApplied captures enum value "ExemptCertApplied"
	AdjustTransactionModelAdjustmentReasonExemptCertApplied string = "ExemptCertApplied"

	// AdjustTransactionModelAdjustmentReasonPriceAdjusted captures enum value "PriceAdjusted"
	AdjustTransactionModelAdjustmentReasonPriceAdjusted string = "PriceAdjusted"

	// AdjustTransactionModelAdjustmentReasonProductReturned captures enum value "ProductReturned"
	AdjustTransactionModelAdjustmentReasonProductReturned string = "ProductReturned"

	// AdjustTransactionModelAdjustmentReasonProductExchanged captures enum value "ProductExchanged"
	AdjustTransactionModelAdjustmentReasonProductExchanged string = "ProductExchanged"

	// AdjustTransactionModelAdjustmentReasonBadDebt captures enum value "BadDebt"
	AdjustTransactionModelAdjustmentReasonBadDebt string = "BadDebt"

	// AdjustTransactionModelAdjustmentReasonOther captures enum value "Other"
	AdjustTransactionModelAdjustmentReasonOther string = "Other"

	// AdjustTransactionModelAdjustmentReasonOffline captures enum value "Offline"
	AdjustTransactionModelAdjustmentReasonOffline string = "Offline"
)
View Source 
const (

	// AuditMultiDocumentModelAPICallStatusOriginalAPICallAvailable captures enum value "OriginalApiCallAvailable"
	AuditMultiDocumentModelAPICallStatusOriginalAPICallAvailable string = "OriginalApiCallAvailable"

	// AuditMultiDocumentModelAPICallStatusReconstructedAPICallAvailable captures enum value "ReconstructedApiCallAvailable"
	AuditMultiDocumentModelAPICallStatusReconstructedAPICallAvailable string = "ReconstructedApiCallAvailable"

	// AuditMultiDocumentModelAPICallStatusAny captures enum value "Any"
	AuditMultiDocumentModelAPICallStatusAny string = "Any"
)
View Source 
const (

	// AuditMultiDocumentModelTypeSalesOrder captures enum value "SalesOrder"
	AuditMultiDocumentModelTypeSalesOrder string = "SalesOrder"

	// AuditMultiDocumentModelTypeSalesInvoice captures enum value "SalesInvoice"
	AuditMultiDocumentModelTypeSalesInvoice string = "SalesInvoice"

	// AuditMultiDocumentModelTypePurchaseOrder captures enum value "PurchaseOrder"
	AuditMultiDocumentModelTypePurchaseOrder string = "PurchaseOrder"

	// AuditMultiDocumentModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	AuditMultiDocumentModelTypePurchaseInvoice string = "PurchaseInvoice"

	// AuditMultiDocumentModelTypeReturnOrder captures enum value "ReturnOrder"
	AuditMultiDocumentModelTypeReturnOrder string = "ReturnOrder"

	// AuditMultiDocumentModelTypeReturnInvoice captures enum value "ReturnInvoice"
	AuditMultiDocumentModelTypeReturnInvoice string = "ReturnInvoice"

	// AuditMultiDocumentModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	AuditMultiDocumentModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// AuditMultiDocumentModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	AuditMultiDocumentModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// AuditMultiDocumentModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	AuditMultiDocumentModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// AuditMultiDocumentModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	AuditMultiDocumentModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// AuditMultiDocumentModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	AuditMultiDocumentModelTypeCustomsInvoice string = "CustomsInvoice"

	// AuditMultiDocumentModelTypeCustomsOrder captures enum value "CustomsOrder"
	AuditMultiDocumentModelTypeCustomsOrder string = "CustomsOrder"

	// AuditMultiDocumentModelTypeAny captures enum value "Any"
	AuditMultiDocumentModelTypeAny string = "Any"
)
View Source 
const (

	// AuditTransactionModelAPICallStatusOriginalAPICallAvailable captures enum value "OriginalApiCallAvailable"
	AuditTransactionModelAPICallStatusOriginalAPICallAvailable string = "OriginalApiCallAvailable"

	// AuditTransactionModelAPICallStatusReconstructedAPICallAvailable captures enum value "ReconstructedApiCallAvailable"
	AuditTransactionModelAPICallStatusReconstructedAPICallAvailable string = "ReconstructedApiCallAvailable"

	// AuditTransactionModelAPICallStatusAny captures enum value "Any"
	AuditTransactionModelAPICallStatusAny string = "Any"
)
View Source 
const (

	// AvaFileFormModelDueDateTypeIDByDay captures enum value "ByDay"
	AvaFileFormModelDueDateTypeIDByDay string = "ByDay"

	// AvaFileFormModelDueDateTypeIDByLastDay captures enum value "ByLastDay"
	AvaFileFormModelDueDateTypeIDByLastDay string = "ByLastDay"

	// AvaFileFormModelDueDateTypeIDBySecondLastDay captures enum value "BySecondLastDay"
	AvaFileFormModelDueDateTypeIDBySecondLastDay string = "BySecondLastDay"
)
View Source 
const (

	// AvaFileFormModelEfileDueDateTypeIDByDay captures enum value "ByDay"
	AvaFileFormModelEfileDueDateTypeIDByDay string = "ByDay"

	// AvaFileFormModelEfileDueDateTypeIDByLastDay captures enum value "ByLastDay"
	AvaFileFormModelEfileDueDateTypeIDByLastDay string = "ByLastDay"

	// AvaFileFormModelEfileDueDateTypeIDBySecondLastDay captures enum value "BySecondLastDay"
	AvaFileFormModelEfileDueDateTypeIDBySecondLastDay string = "BySecondLastDay"
)
View Source 
const (

	// AvaFileFormModelFilingOptionTypeIDPaper captures enum value "Paper"
	AvaFileFormModelFilingOptionTypeIDPaper string = "Paper"

	// AvaFileFormModelFilingOptionTypeIDOptionalEfile captures enum value "OptionalEfile"
	AvaFileFormModelFilingOptionTypeIDOptionalEfile string = "OptionalEfile"

	// AvaFileFormModelFilingOptionTypeIDMandatoryEfile captures enum value "MandatoryEfile"
	AvaFileFormModelFilingOptionTypeIDMandatoryEfile string = "MandatoryEfile"
)
View Source 
const (

	// AvaFileFormModelFormTypeIDSalesAndUse captures enum value "SalesAndUse"
	AvaFileFormModelFormTypeIDSalesAndUse string = "SalesAndUse"

	// AvaFileFormModelFormTypeIDSales captures enum value "Sales"
	AvaFileFormModelFormTypeIDSales string = "Sales"

	// AvaFileFormModelFormTypeIDSellersUse captures enum value "SellersUse"
	AvaFileFormModelFormTypeIDSellersUse string = "SellersUse"

	// AvaFileFormModelFormTypeIDLodging captures enum value "Lodging"
	AvaFileFormModelFormTypeIDLodging string = "Lodging"

	// AvaFileFormModelFormTypeIDSalesAndLodging captures enum value "SalesAndLodging"
	AvaFileFormModelFormTypeIDSalesAndLodging string = "SalesAndLodging"

	// AvaFileFormModelFormTypeIDConsumerUse captures enum value "ConsumerUse"
	AvaFileFormModelFormTypeIDConsumerUse string = "ConsumerUse"

	// AvaFileFormModelFormTypeIDResortAndRental captures enum value "ResortAndRental"
	AvaFileFormModelFormTypeIDResortAndRental string = "ResortAndRental"

	// AvaFileFormModelFormTypeIDTouristAndRental captures enum value "TouristAndRental"
	AvaFileFormModelFormTypeIDTouristAndRental string = "TouristAndRental"

	// AvaFileFormModelFormTypeIDPrepayment captures enum value "Prepayment"
	AvaFileFormModelFormTypeIDPrepayment string = "Prepayment"

	// AvaFileFormModelFormTypeIDPrepaymentAllowed captures enum value "PrepaymentAllowed"
	AvaFileFormModelFormTypeIDPrepaymentAllowed string = "PrepaymentAllowed"
)
View Source 
const (

	// AvaFileFormModelOutletTypeIDNone captures enum value "None"
	AvaFileFormModelOutletTypeIDNone string = "None"

	// AvaFileFormModelOutletTypeIDSchedule captures enum value "Schedule"
	AvaFileFormModelOutletTypeIDSchedule string = "Schedule"

	// AvaFileFormModelOutletTypeIDDuplicate captures enum value "Duplicate"
	AvaFileFormModelOutletTypeIDDuplicate string = "Duplicate"

	// AvaFileFormModelOutletTypeIDConsolidated captures enum value "Consolidated"
	AvaFileFormModelOutletTypeIDConsolidated string = "Consolidated"
)
View Source 
const (

	// AvaFileFormModelRoundingTypeIDNone captures enum value "None"
	AvaFileFormModelRoundingTypeIDNone string = "None"

	// AvaFileFormModelRoundingTypeIDNearest captures enum value "Nearest"
	AvaFileFormModelRoundingTypeIDNearest string = "Nearest"

	// AvaFileFormModelRoundingTypeIDUp captures enum value "Up"
	AvaFileFormModelRoundingTypeIDUp string = "Up"

	// AvaFileFormModelRoundingTypeIDDown captures enum value "Down"
	AvaFileFormModelRoundingTypeIDDown string = "Down"
)
View Source 
const (

	// BatchAdjustTransactionModelAdjustmentReasonNotAdjusted captures enum value "NotAdjusted"
	BatchAdjustTransactionModelAdjustmentReasonNotAdjusted string = "NotAdjusted"

	// BatchAdjustTransactionModelAdjustmentReasonSourcingIssue captures enum value "SourcingIssue"
	BatchAdjustTransactionModelAdjustmentReasonSourcingIssue string = "SourcingIssue"

	// BatchAdjustTransactionModelAdjustmentReasonReconciledWithGeneralLedger captures enum value "ReconciledWithGeneralLedger"
	BatchAdjustTransactionModelAdjustmentReasonReconciledWithGeneralLedger string = "ReconciledWithGeneralLedger"

	// BatchAdjustTransactionModelAdjustmentReasonExemptCertApplied captures enum value "ExemptCertApplied"
	BatchAdjustTransactionModelAdjustmentReasonExemptCertApplied string = "ExemptCertApplied"

	// BatchAdjustTransactionModelAdjustmentReasonPriceAdjusted captures enum value "PriceAdjusted"
	BatchAdjustTransactionModelAdjustmentReasonPriceAdjusted string = "PriceAdjusted"

	// BatchAdjustTransactionModelAdjustmentReasonProductReturned captures enum value "ProductReturned"
	BatchAdjustTransactionModelAdjustmentReasonProductReturned string = "ProductReturned"

	// BatchAdjustTransactionModelAdjustmentReasonProductExchanged captures enum value "ProductExchanged"
	BatchAdjustTransactionModelAdjustmentReasonProductExchanged string = "ProductExchanged"

	// BatchAdjustTransactionModelAdjustmentReasonBadDebt captures enum value "BadDebt"
	BatchAdjustTransactionModelAdjustmentReasonBadDebt string = "BadDebt"

	// BatchAdjustTransactionModelAdjustmentReasonOther captures enum value "Other"
	BatchAdjustTransactionModelAdjustmentReasonOther string = "Other"

	// BatchAdjustTransactionModelAdjustmentReasonOffline captures enum value "Offline"
	BatchAdjustTransactionModelAdjustmentReasonOffline string = "Offline"
)
View Source 
const (

	// BatchAdjustTransactionModelDocumentTypeSalesOrder captures enum value "SalesOrder"
	BatchAdjustTransactionModelDocumentTypeSalesOrder string = "SalesOrder"

	// BatchAdjustTransactionModelDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	BatchAdjustTransactionModelDocumentTypeSalesInvoice string = "SalesInvoice"

	// BatchAdjustTransactionModelDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	BatchAdjustTransactionModelDocumentTypePurchaseOrder string = "PurchaseOrder"

	// BatchAdjustTransactionModelDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	BatchAdjustTransactionModelDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// BatchAdjustTransactionModelDocumentTypeReturnOrder captures enum value "ReturnOrder"
	BatchAdjustTransactionModelDocumentTypeReturnOrder string = "ReturnOrder"

	// BatchAdjustTransactionModelDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	BatchAdjustTransactionModelDocumentTypeReturnInvoice string = "ReturnInvoice"

	// BatchAdjustTransactionModelDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	BatchAdjustTransactionModelDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// BatchAdjustTransactionModelDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	BatchAdjustTransactionModelDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// BatchAdjustTransactionModelDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	BatchAdjustTransactionModelDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// BatchAdjustTransactionModelDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	BatchAdjustTransactionModelDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// BatchAdjustTransactionModelDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	BatchAdjustTransactionModelDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// BatchAdjustTransactionModelDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	BatchAdjustTransactionModelDocumentTypeCustomsOrder string = "CustomsOrder"

	// BatchAdjustTransactionModelDocumentTypeAny captures enum value "Any"
	BatchAdjustTransactionModelDocumentTypeAny string = "Any"
)
View Source 
const (

	// BatchModelStatusWaiting captures enum value "Waiting"
	BatchModelStatusWaiting string = "Waiting"

	// BatchModelStatusSystemErrors captures enum value "SystemErrors"
	BatchModelStatusSystemErrors string = "SystemErrors"

	// BatchModelStatusCancelled captures enum value "Cancelled"
	BatchModelStatusCancelled string = "Cancelled"

	// BatchModelStatusCompleted captures enum value "Completed"
	BatchModelStatusCompleted string = "Completed"

	// BatchModelStatusCreating captures enum value "Creating"
	BatchModelStatusCreating string = "Creating"

	// BatchModelStatusDeleted captures enum value "Deleted"
	BatchModelStatusDeleted string = "Deleted"

	// BatchModelStatusErrors captures enum value "Errors"
	BatchModelStatusErrors string = "Errors"

	// BatchModelStatusPaused captures enum value "Paused"
	BatchModelStatusPaused string = "Paused"

	// BatchModelStatusProcessing captures enum value "Processing"
	BatchModelStatusProcessing string = "Processing"

	// BatchModelStatusCancelling captures enum value "Cancelling"
	BatchModelStatusCancelling string = "Cancelling"
)
View Source 
const (

	// BatchModelTypeAvaCertUpdate captures enum value "AvaCertUpdate"
	BatchModelTypeAvaCertUpdate string = "AvaCertUpdate"

	// BatchModelTypeAvaCertUpdateAll captures enum value "AvaCertUpdateAll"
	BatchModelTypeAvaCertUpdateAll string = "AvaCertUpdateAll"

	// BatchModelTypeBatchMaintenance captures enum value "BatchMaintenance"
	BatchModelTypeBatchMaintenance string = "BatchMaintenance"

	// BatchModelTypeCompanyLocationImport captures enum value "CompanyLocationImport"
	BatchModelTypeCompanyLocationImport string = "CompanyLocationImport"

	// BatchModelTypeDocumentImport captures enum value "DocumentImport"
	BatchModelTypeDocumentImport string = "DocumentImport"

	// BatchModelTypeExemptCertImport captures enum value "ExemptCertImport"
	BatchModelTypeExemptCertImport string = "ExemptCertImport"

	// BatchModelTypeItemImport captures enum value "ItemImport"
	BatchModelTypeItemImport string = "ItemImport"

	// BatchModelTypeSalesAuditExport captures enum value "SalesAuditExport"
	BatchModelTypeSalesAuditExport string = "SalesAuditExport"

	// BatchModelTypeSstpTestDeckImport captures enum value "SstpTestDeckImport"
	BatchModelTypeSstpTestDeckImport string = "SstpTestDeckImport"

	// BatchModelTypeTaxRuleImport captures enum value "TaxRuleImport"
	BatchModelTypeTaxRuleImport string = "TaxRuleImport"

	// BatchModelTypeTransactionImport captures enum value "TransactionImport"
	BatchModelTypeTransactionImport string = "TransactionImport"

	// BatchModelTypeUPCBulkImport captures enum value "UPCBulkImport"
	BatchModelTypeUPCBulkImport string = "UPCBulkImport"

	// BatchModelTypeUPCValidationImport captures enum value "UPCValidationImport"
	BatchModelTypeUPCValidationImport string = "UPCValidationImport"

	// BatchModelTypeCustomerSupplierImport captures enum value "CustomerSupplierImport"
	BatchModelTypeCustomerSupplierImport string = "CustomerSupplierImport"
)
View Source 
const (

	// BatchVoidTransactionModelCodeUnspecified captures enum value "Unspecified"
	BatchVoidTransactionModelCodeUnspecified string = "Unspecified"

	// BatchVoidTransactionModelCodePostFailed captures enum value "PostFailed"
	BatchVoidTransactionModelCodePostFailed string = "PostFailed"

	// BatchVoidTransactionModelCodeDocDeleted captures enum value "DocDeleted"
	BatchVoidTransactionModelCodeDocDeleted string = "DocDeleted"

	// BatchVoidTransactionModelCodeDocVoided captures enum value "DocVoided"
	BatchVoidTransactionModelCodeDocVoided string = "DocVoided"

	// BatchVoidTransactionModelCodeAdjustmentCancelled captures enum value "AdjustmentCancelled"
	BatchVoidTransactionModelCodeAdjustmentCancelled string = "AdjustmentCancelled"
)
View Source 
const (

	// BatchVoidTransactionModelDocumentTypeSalesOrder captures enum value "SalesOrder"
	BatchVoidTransactionModelDocumentTypeSalesOrder string = "SalesOrder"

	// BatchVoidTransactionModelDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	BatchVoidTransactionModelDocumentTypeSalesInvoice string = "SalesInvoice"

	// BatchVoidTransactionModelDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	BatchVoidTransactionModelDocumentTypePurchaseOrder string = "PurchaseOrder"

	// BatchVoidTransactionModelDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	BatchVoidTransactionModelDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// BatchVoidTransactionModelDocumentTypeReturnOrder captures enum value "ReturnOrder"
	BatchVoidTransactionModelDocumentTypeReturnOrder string = "ReturnOrder"

	// BatchVoidTransactionModelDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	BatchVoidTransactionModelDocumentTypeReturnInvoice string = "ReturnInvoice"

	// BatchVoidTransactionModelDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	BatchVoidTransactionModelDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// BatchVoidTransactionModelDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	BatchVoidTransactionModelDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// BatchVoidTransactionModelDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	BatchVoidTransactionModelDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// BatchVoidTransactionModelDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	BatchVoidTransactionModelDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// BatchVoidTransactionModelDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	BatchVoidTransactionModelDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// BatchVoidTransactionModelDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	BatchVoidTransactionModelDocumentTypeCustomsOrder string = "CustomsOrder"

	// BatchVoidTransactionModelDocumentTypeAny captures enum value "Any"
	BatchVoidTransactionModelDocumentTypeAny string = "Any"
)
View Source 
const (

	// CertExpressInvitationModelDeliveryMethodEmail captures enum value "Email"
	CertExpressInvitationModelDeliveryMethodEmail string = "Email"

	// CertExpressInvitationModelDeliveryMethodFax captures enum value "Fax"
	CertExpressInvitationModelDeliveryMethodFax string = "Fax"

	// CertExpressInvitationModelDeliveryMethodDownload captures enum value "Download"
	CertExpressInvitationModelDeliveryMethodDownload string = "Download"
)
View Source 
const (

	// CertExpressInvitationStatusModelStatusInProgress captures enum value "InProgress"
	CertExpressInvitationStatusModelStatusInProgress string = "InProgress"

	// CertExpressInvitationStatusModelStatusReady captures enum value "Ready"
	CertExpressInvitationStatusModelStatusReady string = "Ready"
)
View Source 
const (

	// ClassificationParameterUsageMapModelVisibilityRequired captures enum value "Required"
	ClassificationParameterUsageMapModelVisibilityRequired string = "Required"

	// ClassificationParameterUsageMapModelVisibilityRecommended captures enum value "Recommended"
	ClassificationParameterUsageMapModelVisibilityRecommended string = "Recommended"

	// ClassificationParameterUsageMapModelVisibilityOptional captures enum value "Optional"
	ClassificationParameterUsageMapModelVisibilityOptional string = "Optional"

	// ClassificationParameterUsageMapModelVisibilityConditional captures enum value "Conditional"
	ClassificationParameterUsageMapModelVisibilityConditional string = "Conditional"
)
View Source 
const (

	// CommitMultiDocumentModelTypeSalesOrder captures enum value "SalesOrder"
	CommitMultiDocumentModelTypeSalesOrder string = "SalesOrder"

	// CommitMultiDocumentModelTypeSalesInvoice captures enum value "SalesInvoice"
	CommitMultiDocumentModelTypeSalesInvoice string = "SalesInvoice"

	// CommitMultiDocumentModelTypePurchaseOrder captures enum value "PurchaseOrder"
	CommitMultiDocumentModelTypePurchaseOrder string = "PurchaseOrder"

	// CommitMultiDocumentModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	CommitMultiDocumentModelTypePurchaseInvoice string = "PurchaseInvoice"

	// CommitMultiDocumentModelTypeReturnOrder captures enum value "ReturnOrder"
	CommitMultiDocumentModelTypeReturnOrder string = "ReturnOrder"

	// CommitMultiDocumentModelTypeReturnInvoice captures enum value "ReturnInvoice"
	CommitMultiDocumentModelTypeReturnInvoice string = "ReturnInvoice"

	// CommitMultiDocumentModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	CommitMultiDocumentModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// CommitMultiDocumentModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	CommitMultiDocumentModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// CommitMultiDocumentModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	CommitMultiDocumentModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// CommitMultiDocumentModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	CommitMultiDocumentModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// CommitMultiDocumentModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	CommitMultiDocumentModelTypeCustomsInvoice string = "CustomsInvoice"

	// CommitMultiDocumentModelTypeCustomsOrder captures enum value "CustomsOrder"
	CommitMultiDocumentModelTypeCustomsOrder string = "CustomsOrder"

	// CommitMultiDocumentModelTypeAny captures enum value "Any"
	CommitMultiDocumentModelTypeAny string = "Any"
)
View Source 
const (

	// CompanyModelRoundingLevelIDLine captures enum value "Line"
	CompanyModelRoundingLevelIDLine string = "Line"

	// CompanyModelRoundingLevelIDDocument captures enum value "Document"
	CompanyModelRoundingLevelIDDocument string = "Document"
)
View Source 
const (

	// CompanyModelTaxDependencyLevelIDDocument captures enum value "Document"
	CompanyModelTaxDependencyLevelIDDocument string = "Document"

	// CompanyModelTaxDependencyLevelIDState captures enum value "State"
	CompanyModelTaxDependencyLevelIDState string = "State"

	// CompanyModelTaxDependencyLevelIDTaxRegion captures enum value "TaxRegion"
	CompanyModelTaxDependencyLevelIDTaxRegion string = "TaxRegion"

	// CompanyModelTaxDependencyLevelIDAddress captures enum value "Address"
	CompanyModelTaxDependencyLevelIDAddress string = "Address"
)
View Source 
const (

	// CompanyUserDefinedFieldModelDataTypeString captures enum value "String"
	CompanyUserDefinedFieldModelDataTypeString string = "String"

	// CompanyUserDefinedFieldModelDataTypeNumber captures enum value "Number"
	CompanyUserDefinedFieldModelDataTypeNumber string = "Number"

	// CompanyUserDefinedFieldModelDataTypeDate captures enum value "Date"
	CompanyUserDefinedFieldModelDataTypeDate string = "Date"

	// CompanyUserDefinedFieldModelDataTypeBoolean captures enum value "Boolean"
	CompanyUserDefinedFieldModelDataTypeBoolean string = "Boolean"
)
View Source 
const (

	// CompanyUserDefinedFieldModelUserDefinedFieldTypeDocument captures enum value "Document"
	CompanyUserDefinedFieldModelUserDefinedFieldTypeDocument string = "Document"

	// CompanyUserDefinedFieldModelUserDefinedFieldTypeLine captures enum value "Line"
	CompanyUserDefinedFieldModelUserDefinedFieldTypeLine string = "Line"
)
View Source 
const (

	// CreateCertExpressInvitationModelDeliveryMethodEmail captures enum value "Email"
	CreateCertExpressInvitationModelDeliveryMethodEmail string = "Email"

	// CreateCertExpressInvitationModelDeliveryMethodFax captures enum value "Fax"
	CreateCertExpressInvitationModelDeliveryMethodFax string = "Fax"

	// CreateCertExpressInvitationModelDeliveryMethodDownload captures enum value "Download"
	CreateCertExpressInvitationModelDeliveryMethodDownload string = "Download"
)
View Source 
const (

	// CreateMultiDocumentModelDebugLevelNormal captures enum value "Normal"
	CreateMultiDocumentModelDebugLevelNormal string = "Normal"

	// CreateMultiDocumentModelDebugLevelDiagnostic captures enum value "Diagnostic"
	CreateMultiDocumentModelDebugLevelDiagnostic string = "Diagnostic"
)
View Source 
const (

	// CreateMultiDocumentModelDeliveryTermsDAP captures enum value "DAP"
	CreateMultiDocumentModelDeliveryTermsDAP string = "DAP"

	// CreateMultiDocumentModelDeliveryTermsDDP captures enum value "DDP"
	CreateMultiDocumentModelDeliveryTermsDDP string = "DDP"
)
View Source 
const (

	// CreateMultiDocumentModelServiceModeAutomatic captures enum value "Automatic"
	CreateMultiDocumentModelServiceModeAutomatic string = "Automatic"

	// CreateMultiDocumentModelServiceModeLocal captures enum value "Local"
	CreateMultiDocumentModelServiceModeLocal string = "Local"

	// CreateMultiDocumentModelServiceModeRemote captures enum value "Remote"
	CreateMultiDocumentModelServiceModeRemote string = "Remote"
)
View Source 
const (

	// CreateMultiDocumentModelTypeSalesOrder captures enum value "SalesOrder"
	CreateMultiDocumentModelTypeSalesOrder string = "SalesOrder"

	// CreateMultiDocumentModelTypeSalesInvoice captures enum value "SalesInvoice"
	CreateMultiDocumentModelTypeSalesInvoice string = "SalesInvoice"

	// CreateMultiDocumentModelTypePurchaseOrder captures enum value "PurchaseOrder"
	CreateMultiDocumentModelTypePurchaseOrder string = "PurchaseOrder"

	// CreateMultiDocumentModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	CreateMultiDocumentModelTypePurchaseInvoice string = "PurchaseInvoice"

	// CreateMultiDocumentModelTypeReturnOrder captures enum value "ReturnOrder"
	CreateMultiDocumentModelTypeReturnOrder string = "ReturnOrder"

	// CreateMultiDocumentModelTypeReturnInvoice captures enum value "ReturnInvoice"
	CreateMultiDocumentModelTypeReturnInvoice string = "ReturnInvoice"

	// CreateMultiDocumentModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	CreateMultiDocumentModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// CreateMultiDocumentModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	CreateMultiDocumentModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// CreateMultiDocumentModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	CreateMultiDocumentModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// CreateMultiDocumentModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	CreateMultiDocumentModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// CreateMultiDocumentModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	CreateMultiDocumentModelTypeCustomsInvoice string = "CustomsInvoice"

	// CreateMultiDocumentModelTypeCustomsOrder captures enum value "CustomsOrder"
	CreateMultiDocumentModelTypeCustomsOrder string = "CustomsOrder"

	// CreateMultiDocumentModelTypeAny captures enum value "Any"
	CreateMultiDocumentModelTypeAny string = "Any"
)
View Source 
const (

	// CreateOrAdjustTransactionModelAdjustmentReasonNotAdjusted captures enum value "NotAdjusted"
	CreateOrAdjustTransactionModelAdjustmentReasonNotAdjusted string = "NotAdjusted"

	// CreateOrAdjustTransactionModelAdjustmentReasonSourcingIssue captures enum value "SourcingIssue"
	CreateOrAdjustTransactionModelAdjustmentReasonSourcingIssue string = "SourcingIssue"

	// CreateOrAdjustTransactionModelAdjustmentReasonReconciledWithGeneralLedger captures enum value "ReconciledWithGeneralLedger"
	CreateOrAdjustTransactionModelAdjustmentReasonReconciledWithGeneralLedger string = "ReconciledWithGeneralLedger"

	// CreateOrAdjustTransactionModelAdjustmentReasonExemptCertApplied captures enum value "ExemptCertApplied"
	CreateOrAdjustTransactionModelAdjustmentReasonExemptCertApplied string = "ExemptCertApplied"

	// CreateOrAdjustTransactionModelAdjustmentReasonPriceAdjusted captures enum value "PriceAdjusted"
	CreateOrAdjustTransactionModelAdjustmentReasonPriceAdjusted string = "PriceAdjusted"

	// CreateOrAdjustTransactionModelAdjustmentReasonProductReturned captures enum value "ProductReturned"
	CreateOrAdjustTransactionModelAdjustmentReasonProductReturned string = "ProductReturned"

	// CreateOrAdjustTransactionModelAdjustmentReasonProductExchanged captures enum value "ProductExchanged"
	CreateOrAdjustTransactionModelAdjustmentReasonProductExchanged string = "ProductExchanged"

	// CreateOrAdjustTransactionModelAdjustmentReasonBadDebt captures enum value "BadDebt"
	CreateOrAdjustTransactionModelAdjustmentReasonBadDebt string = "BadDebt"

	// CreateOrAdjustTransactionModelAdjustmentReasonOther captures enum value "Other"
	CreateOrAdjustTransactionModelAdjustmentReasonOther string = "Other"

	// CreateOrAdjustTransactionModelAdjustmentReasonOffline captures enum value "Offline"
	CreateOrAdjustTransactionModelAdjustmentReasonOffline string = "Offline"
)
View Source 
const (

	// CreateTransactionBatchResponseModelStatusWaiting captures enum value "Waiting"
	CreateTransactionBatchResponseModelStatusWaiting string = "Waiting"

	// CreateTransactionBatchResponseModelStatusSystemErrors captures enum value "SystemErrors"
	CreateTransactionBatchResponseModelStatusSystemErrors string = "SystemErrors"

	// CreateTransactionBatchResponseModelStatusCancelled captures enum value "Cancelled"
	CreateTransactionBatchResponseModelStatusCancelled string = "Cancelled"

	// CreateTransactionBatchResponseModelStatusCompleted captures enum value "Completed"
	CreateTransactionBatchResponseModelStatusCompleted string = "Completed"

	// CreateTransactionBatchResponseModelStatusCreating captures enum value "Creating"
	CreateTransactionBatchResponseModelStatusCreating string = "Creating"

	// CreateTransactionBatchResponseModelStatusDeleted captures enum value "Deleted"
	CreateTransactionBatchResponseModelStatusDeleted string = "Deleted"

	// CreateTransactionBatchResponseModelStatusErrors captures enum value "Errors"
	CreateTransactionBatchResponseModelStatusErrors string = "Errors"

	// CreateTransactionBatchResponseModelStatusPaused captures enum value "Paused"
	CreateTransactionBatchResponseModelStatusPaused string = "Paused"

	// CreateTransactionBatchResponseModelStatusProcessing captures enum value "Processing"
	CreateTransactionBatchResponseModelStatusProcessing string = "Processing"

	// CreateTransactionBatchResponseModelStatusCancelling captures enum value "Cancelling"
	CreateTransactionBatchResponseModelStatusCancelling string = "Cancelling"
)
View Source 
const (

	// CreateTransactionModelDebugLevelNormal captures enum value "Normal"
	CreateTransactionModelDebugLevelNormal string = "Normal"

	// CreateTransactionModelDebugLevelDiagnostic captures enum value "Diagnostic"
	CreateTransactionModelDebugLevelDiagnostic string = "Diagnostic"
)
View Source 
const (

	// CreateTransactionModelDeliveryTermsDAP captures enum value "DAP"
	CreateTransactionModelDeliveryTermsDAP string = "DAP"

	// CreateTransactionModelDeliveryTermsDDP captures enum value "DDP"
	CreateTransactionModelDeliveryTermsDDP string = "DDP"
)
View Source 
const (

	// CreateTransactionModelServiceModeAutomatic captures enum value "Automatic"
	CreateTransactionModelServiceModeAutomatic string = "Automatic"

	// CreateTransactionModelServiceModeLocal captures enum value "Local"
	CreateTransactionModelServiceModeLocal string = "Local"

	// CreateTransactionModelServiceModeRemote captures enum value "Remote"
	CreateTransactionModelServiceModeRemote string = "Remote"
)
View Source 
const (

	// CreateTransactionModelTypeSalesOrder captures enum value "SalesOrder"
	CreateTransactionModelTypeSalesOrder string = "SalesOrder"

	// CreateTransactionModelTypeSalesInvoice captures enum value "SalesInvoice"
	CreateTransactionModelTypeSalesInvoice string = "SalesInvoice"

	// CreateTransactionModelTypePurchaseOrder captures enum value "PurchaseOrder"
	CreateTransactionModelTypePurchaseOrder string = "PurchaseOrder"

	// CreateTransactionModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	CreateTransactionModelTypePurchaseInvoice string = "PurchaseInvoice"

	// CreateTransactionModelTypeReturnOrder captures enum value "ReturnOrder"
	CreateTransactionModelTypeReturnOrder string = "ReturnOrder"

	// CreateTransactionModelTypeReturnInvoice captures enum value "ReturnInvoice"
	CreateTransactionModelTypeReturnInvoice string = "ReturnInvoice"

	// CreateTransactionModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	CreateTransactionModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// CreateTransactionModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	CreateTransactionModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// CreateTransactionModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	CreateTransactionModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// CreateTransactionModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	CreateTransactionModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// CreateTransactionModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	CreateTransactionModelTypeCustomsInvoice string = "CustomsInvoice"

	// CreateTransactionModelTypeCustomsOrder captures enum value "CustomsOrder"
	CreateTransactionModelTypeCustomsOrder string = "CustomsOrder"

	// CreateTransactionModelTypeAny captures enum value "Any"
	CreateTransactionModelTypeAny string = "Any"
)
View Source 
const (

	// CycleAddOptionModelFilingFrequencyIDMonthly captures enum value "Monthly"
	CycleAddOptionModelFilingFrequencyIDMonthly string = "Monthly"

	// CycleAddOptionModelFilingFrequencyIDQuarterly captures enum value "Quarterly"
	CycleAddOptionModelFilingFrequencyIDQuarterly string = "Quarterly"

	// CycleAddOptionModelFilingFrequencyIDSemiAnnually captures enum value "SemiAnnually"
	CycleAddOptionModelFilingFrequencyIDSemiAnnually string = "SemiAnnually"

	// CycleAddOptionModelFilingFrequencyIDAnnually captures enum value "Annually"
	CycleAddOptionModelFilingFrequencyIDAnnually string = "Annually"

	// CycleAddOptionModelFilingFrequencyIDBimonthly captures enum value "Bimonthly"
	CycleAddOptionModelFilingFrequencyIDBimonthly string = "Bimonthly"

	// CycleAddOptionModelFilingFrequencyIDOccasional captures enum value "Occasional"
	CycleAddOptionModelFilingFrequencyIDOccasional string = "Occasional"

	// CycleAddOptionModelFilingFrequencyIDInverseQuarterly captures enum value "InverseQuarterly"
	CycleAddOptionModelFilingFrequencyIDInverseQuarterly string = "InverseQuarterly"

	// CycleAddOptionModelFilingFrequencyIDWeekly captures enum value "Weekly"
	CycleAddOptionModelFilingFrequencyIDWeekly string = "Weekly"
)
View Source 
const (

	// DeclareNexusByAddressModelTextCaseUpper captures enum value "Upper"
	DeclareNexusByAddressModelTextCaseUpper string = "Upper"

	// DeclareNexusByAddressModelTextCaseMixed captures enum value "Mixed"
	DeclareNexusByAddressModelTextCaseMixed string = "Mixed"
)
View Source 
const (

	// DeleteErrorTransactionResponseModelDocumentTypeSalesOrder captures enum value "SalesOrder"
	DeleteErrorTransactionResponseModelDocumentTypeSalesOrder string = "SalesOrder"

	// DeleteErrorTransactionResponseModelDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	DeleteErrorTransactionResponseModelDocumentTypeSalesInvoice string = "SalesInvoice"

	// DeleteErrorTransactionResponseModelDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	DeleteErrorTransactionResponseModelDocumentTypePurchaseOrder string = "PurchaseOrder"

	// DeleteErrorTransactionResponseModelDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	DeleteErrorTransactionResponseModelDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// DeleteErrorTransactionResponseModelDocumentTypeReturnOrder captures enum value "ReturnOrder"
	DeleteErrorTransactionResponseModelDocumentTypeReturnOrder string = "ReturnOrder"

	// DeleteErrorTransactionResponseModelDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	DeleteErrorTransactionResponseModelDocumentTypeReturnInvoice string = "ReturnInvoice"

	// DeleteErrorTransactionResponseModelDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	DeleteErrorTransactionResponseModelDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// DeleteErrorTransactionResponseModelDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	DeleteErrorTransactionResponseModelDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// DeleteErrorTransactionResponseModelDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	DeleteErrorTransactionResponseModelDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// DeleteErrorTransactionResponseModelDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	DeleteErrorTransactionResponseModelDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// DeleteErrorTransactionResponseModelDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	DeleteErrorTransactionResponseModelDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// DeleteErrorTransactionResponseModelDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	DeleteErrorTransactionResponseModelDocumentTypeCustomsOrder string = "CustomsOrder"

	// DeleteErrorTransactionResponseModelDocumentTypeAny captures enum value "Any"
	DeleteErrorTransactionResponseModelDocumentTypeAny string = "Any"
)
View Source 
const (

	// DeleteErrorTransactionResponseModelResultSuccess captures enum value "Success"
	DeleteErrorTransactionResponseModelResultSuccess string = "Success"

	// DeleteErrorTransactionResponseModelResultFailure captures enum value "Failure"
	DeleteErrorTransactionResponseModelResultFailure string = "Failure"
)
View Source 
const (

	// DenormalizedJurisModelJurisTypeCountry captures enum value "Country"
	DenormalizedJurisModelJurisTypeCountry string = "Country"

	// DenormalizedJurisModelJurisTypeState captures enum value "State"
	DenormalizedJurisModelJurisTypeState string = "State"

	// DenormalizedJurisModelJurisTypeCounty captures enum value "County"
	DenormalizedJurisModelJurisTypeCounty string = "County"

	// DenormalizedJurisModelJurisTypeCity captures enum value "City"
	DenormalizedJurisModelJurisTypeCity string = "City"

	// DenormalizedJurisModelJurisTypeSpecial captures enum value "Special"
	DenormalizedJurisModelJurisTypeSpecial string = "Special"
)
View Source 
const (

	// EcmsModelExemptCertReviewStatusIDPending captures enum value "Pending"
	EcmsModelExemptCertReviewStatusIDPending string = "Pending"

	// EcmsModelExemptCertReviewStatusIDAccepted captures enum value "Accepted"
	EcmsModelExemptCertReviewStatusIDAccepted string = "Accepted"

	// EcmsModelExemptCertReviewStatusIDRejected captures enum value "Rejected"
	EcmsModelExemptCertReviewStatusIDRejected string = "Rejected"
)
View Source 
const (

	// EcmsModelExemptCertStatusIDInactive captures enum value "Inactive"
	EcmsModelExemptCertStatusIDInactive string = "Inactive"

	// EcmsModelExemptCertStatusIDActive captures enum value "Active"
	EcmsModelExemptCertStatusIDActive string = "Active"

	// EcmsModelExemptCertStatusIDExpired captures enum value "Expired"
	EcmsModelExemptCertStatusIDExpired string = "Expired"

	// EcmsModelExemptCertStatusIDRevoked captures enum value "Revoked"
	EcmsModelExemptCertStatusIDRevoked string = "Revoked"
)
View Source 
const (

	// EcmsModelExemptCertTypeIDBlanket captures enum value "Blanket"
	EcmsModelExemptCertTypeIDBlanket string = "Blanket"

	// EcmsModelExemptCertTypeIDSingleUse captures enum value "SingleUse"
	EcmsModelExemptCertTypeIDSingleUse string = "SingleUse"
)
View Source 
const (

	// ErrorDetailCodeServerConfiguration captures enum value "ServerConfiguration"
	ErrorDetailCodeServerConfiguration string = "ServerConfiguration"

	// ErrorDetailCodeAccountInvalidException captures enum value "AccountInvalidException"
	ErrorDetailCodeAccountInvalidException string = "AccountInvalidException"

	// ErrorDetailCodeCompanyInvalidException captures enum value "CompanyInvalidException"
	ErrorDetailCodeCompanyInvalidException string = "CompanyInvalidException"

	// ErrorDetailCodeEntityNotFoundError captures enum value "EntityNotFoundError"
	ErrorDetailCodeEntityNotFoundError string = "EntityNotFoundError"

	// ErrorDetailCodeValueRequiredError captures enum value "ValueRequiredError"
	ErrorDetailCodeValueRequiredError string = "ValueRequiredError"

	// ErrorDetailCodeRangeError captures enum value "RangeError"
	ErrorDetailCodeRangeError string = "RangeError"

	// ErrorDetailCodeRangeCompareError captures enum value "RangeCompareError"
	ErrorDetailCodeRangeCompareError string = "RangeCompareError"

	// ErrorDetailCodeRangeSetError captures enum value "RangeSetError"
	ErrorDetailCodeRangeSetError string = "RangeSetError"

	// ErrorDetailCodeTaxpayerNumberRequired captures enum value "TaxpayerNumberRequired"
	ErrorDetailCodeTaxpayerNumberRequired string = "TaxpayerNumberRequired"

	// ErrorDetailCodeEntityLimitExceeded captures enum value "EntityLimitExceeded"
	ErrorDetailCodeEntityLimitExceeded string = "EntityLimitExceeded"

	// ErrorDetailCodeCommonPassword captures enum value "CommonPassword"
	ErrorDetailCodeCommonPassword string = "CommonPassword"

	// ErrorDetailCodeWeakPassword captures enum value "WeakPassword"
	ErrorDetailCodeWeakPassword string = "WeakPassword"

	// ErrorDetailCodeStringLengthError captures enum value "StringLengthError"
	ErrorDetailCodeStringLengthError string = "StringLengthError"

	// ErrorDetailCodeMaxStringLengthError captures enum value "MaxStringLengthError"
	ErrorDetailCodeMaxStringLengthError string = "MaxStringLengthError"

	// ErrorDetailCodeEmailValidationError captures enum value "EmailValidationError"
	ErrorDetailCodeEmailValidationError string = "EmailValidationError"

	// ErrorDetailCodeEmailMissingError captures enum value "EmailMissingError"
	ErrorDetailCodeEmailMissingError string = "EmailMissingError"

	// ErrorDetailCodeInvalidQueryField captures enum value "InvalidQueryField"
	ErrorDetailCodeInvalidQueryField string = "InvalidQueryField"

	// ErrorDetailCodeInvalidQueryValue captures enum value "InvalidQueryValue"
	ErrorDetailCodeInvalidQueryValue string = "InvalidQueryValue"

	// ErrorDetailCodeSyntaxError captures enum value "SyntaxError"
	ErrorDetailCodeSyntaxError string = "SyntaxError"

	// ErrorDetailCodeTooManyParametersError captures enum value "TooManyParametersError"
	ErrorDetailCodeTooManyParametersError string = "TooManyParametersError"

	// ErrorDetailCodeUnterminatedValueError captures enum value "UnterminatedValueError"
	ErrorDetailCodeUnterminatedValueError string = "UnterminatedValueError"

	// ErrorDetailCodeDeleteUserSelfError captures enum value "DeleteUserSelfError"
	ErrorDetailCodeDeleteUserSelfError string = "DeleteUserSelfError"

	// ErrorDetailCodeOldPasswordInvalid captures enum value "OldPasswordInvalid"
	ErrorDetailCodeOldPasswordInvalid string = "OldPasswordInvalid"

	// ErrorDetailCodeCannotChangePassword captures enum value "CannotChangePassword"
	ErrorDetailCodeCannotChangePassword string = "CannotChangePassword"

	// ErrorDetailCodeReadOnly captures enum value "ReadOnly"
	ErrorDetailCodeReadOnly string = "ReadOnly"

	// ErrorDetailCodeDateFormatError captures enum value "DateFormatError"
	ErrorDetailCodeDateFormatError string = "DateFormatError"

	// ErrorDetailCodeNoDefaultCompany captures enum value "NoDefaultCompany"
	ErrorDetailCodeNoDefaultCompany string = "NoDefaultCompany"

	// ErrorDetailCodeAccountTypeNotSupported captures enum value "AccountTypeNotSupported"
	ErrorDetailCodeAccountTypeNotSupported string = "AccountTypeNotSupported"

	// ErrorDetailCodeInvalidAuthenticationType captures enum value "InvalidAuthenticationType"
	ErrorDetailCodeInvalidAuthenticationType string = "InvalidAuthenticationType"

	// ErrorDetailCodeAuthenticationException captures enum value "AuthenticationException"
	ErrorDetailCodeAuthenticationException string = "AuthenticationException"

	// ErrorDetailCodeAuthorizationException captures enum value "AuthorizationException"
	ErrorDetailCodeAuthorizationException string = "AuthorizationException"

	// ErrorDetailCodeValidationException captures enum value "ValidationException"
	ErrorDetailCodeValidationException string = "ValidationException"

	// ErrorDetailCodeInactiveUserError captures enum value "InactiveUserError"
	ErrorDetailCodeInactiveUserError string = "InactiveUserError"

	// ErrorDetailCodeAuthenticationIncomplete captures enum value "AuthenticationIncomplete"
	ErrorDetailCodeAuthenticationIncomplete string = "AuthenticationIncomplete"

	// ErrorDetailCodeBasicAuthIncorrect captures enum value "BasicAuthIncorrect"
	ErrorDetailCodeBasicAuthIncorrect string = "BasicAuthIncorrect"

	// ErrorDetailCodeIdentityServerError captures enum value "IdentityServerError"
	ErrorDetailCodeIdentityServerError string = "IdentityServerError"

	// ErrorDetailCodeBearerTokenInvalid captures enum value "BearerTokenInvalid"
	ErrorDetailCodeBearerTokenInvalid string = "BearerTokenInvalid"

	// ErrorDetailCodeModelRequiredException captures enum value "ModelRequiredException"
	ErrorDetailCodeModelRequiredException string = "ModelRequiredException"

	// ErrorDetailCodeAccountExpiredException captures enum value "AccountExpiredException"
	ErrorDetailCodeAccountExpiredException string = "AccountExpiredException"

	// ErrorDetailCodeBearerTokenNotSupported captures enum value "BearerTokenNotSupported"
	ErrorDetailCodeBearerTokenNotSupported string = "BearerTokenNotSupported"

	// ErrorDetailCodeInvalidSecurityRole captures enum value "InvalidSecurityRole"
	ErrorDetailCodeInvalidSecurityRole string = "InvalidSecurityRole"

	// ErrorDetailCodeInvalidRegistrarAction captures enum value "InvalidRegistrarAction"
	ErrorDetailCodeInvalidRegistrarAction string = "InvalidRegistrarAction"

	// ErrorDetailCodeRemoteServerError captures enum value "RemoteServerError"
	ErrorDetailCodeRemoteServerError string = "RemoteServerError"

	// ErrorDetailCodeNoFilterCriteriaException captures enum value "NoFilterCriteriaException"
	ErrorDetailCodeNoFilterCriteriaException string = "NoFilterCriteriaException"

	// ErrorDetailCodeOpenClauseException captures enum value "OpenClauseException"
	ErrorDetailCodeOpenClauseException string = "OpenClauseException"

	// ErrorDetailCodeJSONFormatError captures enum value "JsonFormatError"
	ErrorDetailCodeJSONFormatError string = "JsonFormatError"

	// ErrorDetailCodeInvalidDecimalValue captures enum value "InvalidDecimalValue"
	ErrorDetailCodeInvalidDecimalValue string = "InvalidDecimalValue"

	// ErrorDetailCodePermissionRequired captures enum value "PermissionRequired"
	ErrorDetailCodePermissionRequired string = "PermissionRequired"

	// ErrorDetailCodeUnhandledException captures enum value "UnhandledException"
	ErrorDetailCodeUnhandledException string = "UnhandledException"

	// ErrorDetailCodeInactiveAccount captures enum value "InactiveAccount"
	ErrorDetailCodeInactiveAccount string = "InactiveAccount"

	// ErrorDetailCodeLinkageNotAllowed captures enum value "LinkageNotAllowed"
	ErrorDetailCodeLinkageNotAllowed string = "LinkageNotAllowed"

	// ErrorDetailCodeLinkageStatusUpdateNotSupported captures enum value "LinkageStatusUpdateNotSupported"
	ErrorDetailCodeLinkageStatusUpdateNotSupported string = "LinkageStatusUpdateNotSupported"

	// ErrorDetailCodeReportingCompanyMustHaveContactsError captures enum value "ReportingCompanyMustHaveContactsError"
	ErrorDetailCodeReportingCompanyMustHaveContactsError string = "ReportingCompanyMustHaveContactsError"

	// ErrorDetailCodeCompanyProfileNotSet captures enum value "CompanyProfileNotSet"
	ErrorDetailCodeCompanyProfileNotSet string = "CompanyProfileNotSet"

	// ErrorDetailCodeCannotAssignUserToCompany captures enum value "CannotAssignUserToCompany"
	ErrorDetailCodeCannotAssignUserToCompany string = "CannotAssignUserToCompany"

	// ErrorDetailCodeMustAssignUserToCompany captures enum value "MustAssignUserToCompany"
	ErrorDetailCodeMustAssignUserToCompany string = "MustAssignUserToCompany"

	// ErrorDetailCodeInvalidTaxTypeMapping captures enum value "InvalidTaxTypeMapping"
	ErrorDetailCodeInvalidTaxTypeMapping string = "InvalidTaxTypeMapping"

	// ErrorDetailCodeModelStateInvalid captures enum value "ModelStateInvalid"
	ErrorDetailCodeModelStateInvalid string = "ModelStateInvalid"

	// ErrorDetailCodeDateRangeError captures enum value "DateRangeError"
	ErrorDetailCodeDateRangeError string = "DateRangeError"

	// ErrorDetailCodeInvalidDateRangeError captures enum value "InvalidDateRangeError"
	ErrorDetailCodeInvalidDateRangeError string = "InvalidDateRangeError"

	// ErrorDetailCodeRuleMustHaveTaxCode captures enum value "RuleMustHaveTaxCode"
	ErrorDetailCodeRuleMustHaveTaxCode string = "RuleMustHaveTaxCode"

	// ErrorDetailCodeRuleTypeRestricted captures enum value "RuleTypeRestricted"
	ErrorDetailCodeRuleTypeRestricted string = "RuleTypeRestricted"

	// ErrorDetailCodeAllJurisRuleLimits captures enum value "AllJurisRuleLimits"
	ErrorDetailCodeAllJurisRuleLimits string = "AllJurisRuleLimits"

	// ErrorDetailCodeInvalidCompanyLocationSetting captures enum value "InvalidCompanyLocationSetting"
	ErrorDetailCodeInvalidCompanyLocationSetting string = "InvalidCompanyLocationSetting"

	// ErrorDetailCodeInvalidAdjustmentType captures enum value "InvalidAdjustmentType"
	ErrorDetailCodeInvalidAdjustmentType string = "InvalidAdjustmentType"

	// ErrorDetailCodeDeleteInformation captures enum value "DeleteInformation"
	ErrorDetailCodeDeleteInformation string = "DeleteInformation"

	// ErrorDetailCodeDisableAuthenticationForSamlBasedAccounts captures enum value "DisableAuthenticationForSamlBasedAccounts"
	ErrorDetailCodeDisableAuthenticationForSamlBasedAccounts string = "DisableAuthenticationForSamlBasedAccounts"

	// ErrorDetailCodeDisableResetPasswordForSamlBasedAccounts captures enum value "DisableResetPasswordForSamlBasedAccounts"
	ErrorDetailCodeDisableResetPasswordForSamlBasedAccounts string = "DisableResetPasswordForSamlBasedAccounts"

	// ErrorDetailCodeOutOfRange captures enum value "OutOfRange"
	ErrorDetailCodeOutOfRange string = "OutOfRange"

	// ErrorDetailCodeUnspecifiedTimeZone captures enum value "UnspecifiedTimeZone"
	ErrorDetailCodeUnspecifiedTimeZone string = "UnspecifiedTimeZone"

	// ErrorDetailCodeCannotCreateDeletedObjects captures enum value "CannotCreateDeletedObjects"
	ErrorDetailCodeCannotCreateDeletedObjects string = "CannotCreateDeletedObjects"

	// ErrorDetailCodeCannotModifyDeletedObjects captures enum value "CannotModifyDeletedObjects"
	ErrorDetailCodeCannotModifyDeletedObjects string = "CannotModifyDeletedObjects"

	// ErrorDetailCodeReturnNameNotFound captures enum value "ReturnNameNotFound"
	ErrorDetailCodeReturnNameNotFound string = "ReturnNameNotFound"

	// ErrorDetailCodeInvalidAddressTypeAndCategory captures enum value "InvalidAddressTypeAndCategory"
	ErrorDetailCodeInvalidAddressTypeAndCategory string = "InvalidAddressTypeAndCategory"

	// ErrorDetailCodeDefaultCompanyLocation captures enum value "DefaultCompanyLocation"
	ErrorDetailCodeDefaultCompanyLocation string = "DefaultCompanyLocation"

	// ErrorDetailCodeInvalidCountry captures enum value "InvalidCountry"
	ErrorDetailCodeInvalidCountry string = "InvalidCountry"

	// ErrorDetailCodeInvalidCountryRegion captures enum value "InvalidCountryRegion"
	ErrorDetailCodeInvalidCountryRegion string = "InvalidCountryRegion"

	// ErrorDetailCodeBrazilValidationError captures enum value "BrazilValidationError"
	ErrorDetailCodeBrazilValidationError string = "BrazilValidationError"

	// ErrorDetailCodeBrazilExemptValidationError captures enum value "BrazilExemptValidationError"
	ErrorDetailCodeBrazilExemptValidationError string = "BrazilExemptValidationError"

	// ErrorDetailCodeBrazilPisCofinsError captures enum value "BrazilPisCofinsError"
	ErrorDetailCodeBrazilPisCofinsError string = "BrazilPisCofinsError"

	// ErrorDetailCodeJurisdictionNotFoundError captures enum value "JurisdictionNotFoundError"
	ErrorDetailCodeJurisdictionNotFoundError string = "JurisdictionNotFoundError"

	// ErrorDetailCodeMedicalExciseError captures enum value "MedicalExciseError"
	ErrorDetailCodeMedicalExciseError string = "MedicalExciseError"

	// ErrorDetailCodeRateDependsTaxabilityError captures enum value "RateDependsTaxabilityError"
	ErrorDetailCodeRateDependsTaxabilityError string = "RateDependsTaxabilityError"

	// ErrorDetailCodeInvalidRateTypeCode captures enum value "InvalidRateTypeCode"
	ErrorDetailCodeInvalidRateTypeCode string = "InvalidRateTypeCode"

	// ErrorDetailCodeRateTypeNotSupported captures enum value "RateTypeNotSupported"
	ErrorDetailCodeRateTypeNotSupported string = "RateTypeNotSupported"

	// ErrorDetailCodeCannotUpdateNestedObjects captures enum value "CannotUpdateNestedObjects"
	ErrorDetailCodeCannotUpdateNestedObjects string = "CannotUpdateNestedObjects"

	// ErrorDetailCodeUPCCodeInvalidChars captures enum value "UPCCodeInvalidChars"
	ErrorDetailCodeUPCCodeInvalidChars string = "UPCCodeInvalidChars"

	// ErrorDetailCodeUPCCodeInvalidLength captures enum value "UPCCodeInvalidLength"
	ErrorDetailCodeUPCCodeInvalidLength string = "UPCCodeInvalidLength"

	// ErrorDetailCodeIncorrectPathError captures enum value "IncorrectPathError"
	ErrorDetailCodeIncorrectPathError string = "IncorrectPathError"

	// ErrorDetailCodeInvalidJurisdictionType captures enum value "InvalidJurisdictionType"
	ErrorDetailCodeInvalidJurisdictionType string = "InvalidJurisdictionType"

	// ErrorDetailCodeMustConfirmResetLicenseKey captures enum value "MustConfirmResetLicenseKey"
	ErrorDetailCodeMustConfirmResetLicenseKey string = "MustConfirmResetLicenseKey"

	// ErrorDetailCodeDuplicateCompanyCode captures enum value "DuplicateCompanyCode"
	ErrorDetailCodeDuplicateCompanyCode string = "DuplicateCompanyCode"

	// ErrorDetailCodeTINFormatError captures enum value "TINFormatError"
	ErrorDetailCodeTINFormatError string = "TINFormatError"

	// ErrorDetailCodeDuplicateNexusError captures enum value "DuplicateNexusError"
	ErrorDetailCodeDuplicateNexusError string = "DuplicateNexusError"

	// ErrorDetailCodeUnknownNexusError captures enum value "UnknownNexusError"
	ErrorDetailCodeUnknownNexusError string = "UnknownNexusError"

	// ErrorDetailCodeParentNexusNotFound captures enum value "ParentNexusNotFound"
	ErrorDetailCodeParentNexusNotFound string = "ParentNexusNotFound"

	// ErrorDetailCodeInvalidTaxCodeType captures enum value "InvalidTaxCodeType"
	ErrorDetailCodeInvalidTaxCodeType string = "InvalidTaxCodeType"

	// ErrorDetailCodeCannotActivateCompany captures enum value "CannotActivateCompany"
	ErrorDetailCodeCannotActivateCompany string = "CannotActivateCompany"

	// ErrorDetailCodeDuplicateEntityProperty captures enum value "DuplicateEntityProperty"
	ErrorDetailCodeDuplicateEntityProperty string = "DuplicateEntityProperty"

	// ErrorDetailCodeReportingEntityError captures enum value "ReportingEntityError"
	ErrorDetailCodeReportingEntityError string = "ReportingEntityError"

	// ErrorDetailCodeInvalidReturnOperationError captures enum value "InvalidReturnOperationError"
	ErrorDetailCodeInvalidReturnOperationError string = "InvalidReturnOperationError"

	// ErrorDetailCodeCannotDeleteCompany captures enum value "CannotDeleteCompany"
	ErrorDetailCodeCannotDeleteCompany string = "CannotDeleteCompany"

	// ErrorDetailCodeCountryOverridesNotAvailable captures enum value "CountryOverridesNotAvailable"
	ErrorDetailCodeCountryOverridesNotAvailable string = "CountryOverridesNotAvailable"

	// ErrorDetailCodeJurisdictionOverrideMismatch captures enum value "JurisdictionOverrideMismatch"
	ErrorDetailCodeJurisdictionOverrideMismatch string = "JurisdictionOverrideMismatch"

	// ErrorDetailCodeDuplicateSystemTaxCode captures enum value "DuplicateSystemTaxCode"
	ErrorDetailCodeDuplicateSystemTaxCode string = "DuplicateSystemTaxCode"

	// ErrorDetailCodeSSTOverridesNotAvailable captures enum value "SSTOverridesNotAvailable"
	ErrorDetailCodeSSTOverridesNotAvailable string = "SSTOverridesNotAvailable"

	// ErrorDetailCodeNexusDateMismatch captures enum value "NexusDateMismatch"
	ErrorDetailCodeNexusDateMismatch string = "NexusDateMismatch"

	// ErrorDetailCodeNexusParentDateMismatch captures enum value "NexusParentDateMismatch"
	ErrorDetailCodeNexusParentDateMismatch string = "NexusParentDateMismatch"

	// ErrorDetailCodeBearerTokenParseUserIDError captures enum value "BearerTokenParseUserIdError"
	ErrorDetailCodeBearerTokenParseUserIDError string = "BearerTokenParseUserIdError"

	// ErrorDetailCodeRetrieveUserError captures enum value "RetrieveUserError"
	ErrorDetailCodeRetrieveUserError string = "RetrieveUserError"

	// ErrorDetailCodeInvalidConfigurationSetting captures enum value "InvalidConfigurationSetting"
	ErrorDetailCodeInvalidConfigurationSetting string = "InvalidConfigurationSetting"

	// ErrorDetailCodeInvalidConfigurationValue captures enum value "InvalidConfigurationValue"
	ErrorDetailCodeInvalidConfigurationValue string = "InvalidConfigurationValue"

	// ErrorDetailCodeInvalidEnumValue captures enum value "InvalidEnumValue"
	ErrorDetailCodeInvalidEnumValue string = "InvalidEnumValue"

	// ErrorDetailCodeTaxCodeAssociatedTaxRule captures enum value "TaxCodeAssociatedTaxRule"
	ErrorDetailCodeTaxCodeAssociatedTaxRule string = "TaxCodeAssociatedTaxRule"

	// ErrorDetailCodeCannotSwitchAccountID captures enum value "CannotSwitchAccountId"
	ErrorDetailCodeCannotSwitchAccountID string = "CannotSwitchAccountId"

	// ErrorDetailCodeRequestIncomplete captures enum value "RequestIncomplete"
	ErrorDetailCodeRequestIncomplete string = "RequestIncomplete"

	// ErrorDetailCodeAccountNotNew captures enum value "AccountNotNew"
	ErrorDetailCodeAccountNotNew string = "AccountNotNew"

	// ErrorDetailCodePasswordLengthInvalid captures enum value "PasswordLengthInvalid"
	ErrorDetailCodePasswordLengthInvalid string = "PasswordLengthInvalid"

	// ErrorDetailCodeInvalidPageKey captures enum value "InvalidPageKey"
	ErrorDetailCodeInvalidPageKey string = "InvalidPageKey"

	// ErrorDetailCodeInvalidEcmsOverrideCode captures enum value "InvalidEcmsOverrideCode"
	ErrorDetailCodeInvalidEcmsOverrideCode string = "InvalidEcmsOverrideCode"

	// ErrorDetailCodeAccountDoesNotExist captures enum value "AccountDoesNotExist"
	ErrorDetailCodeAccountDoesNotExist string = "AccountDoesNotExist"

	// ErrorDetailCodeInvalidTaxType captures enum value "InvalidTaxType"
	ErrorDetailCodeInvalidTaxType string = "InvalidTaxType"

	// ErrorDetailCodeIncorrectFieldValue captures enum value "IncorrectFieldValue"
	ErrorDetailCodeIncorrectFieldValue string = "IncorrectFieldValue"

	// ErrorDetailCodeLeadingOrTrailingException captures enum value "LeadingOrTrailingException"
	ErrorDetailCodeLeadingOrTrailingException string = "LeadingOrTrailingException"

	// ErrorDetailCodeNotEnoughAddressesInfo captures enum value "NotEnoughAddressesInfo"
	ErrorDetailCodeNotEnoughAddressesInfo string = "NotEnoughAddressesInfo"

	// ErrorDetailCodeReportNotInitiated captures enum value "ReportNotInitiated"
	ErrorDetailCodeReportNotInitiated string = "ReportNotInitiated"

	// ErrorDetailCodeFailedToBuildReport captures enum value "FailedToBuildReport"
	ErrorDetailCodeFailedToBuildReport string = "FailedToBuildReport"

	// ErrorDetailCodeReportNotFinished captures enum value "ReportNotFinished"
	ErrorDetailCodeReportNotFinished string = "ReportNotFinished"

	// ErrorDetailCodeFailedToDownloadReport captures enum value "FailedToDownloadReport"
	ErrorDetailCodeFailedToDownloadReport string = "FailedToDownloadReport"

	// ErrorDetailCodeMalformedFilterException captures enum value "MalformedFilterException"
	ErrorDetailCodeMalformedFilterException string = "MalformedFilterException"

	// ErrorDetailCodeExpectedConjunctionError captures enum value "ExpectedConjunctionError"
	ErrorDetailCodeExpectedConjunctionError string = "ExpectedConjunctionError"

	// ErrorDetailCodeCriteriaNotSupportedError captures enum value "CriteriaNotSupportedError"
	ErrorDetailCodeCriteriaNotSupportedError string = "CriteriaNotSupportedError"

	// ErrorDetailCodeCompanyAccountAndParentAccountMismatch captures enum value "CompanyAccountAndParentAccountMismatch"
	ErrorDetailCodeCompanyAccountAndParentAccountMismatch string = "CompanyAccountAndParentAccountMismatch"

	// ErrorDetailCodeInvalidFileContentType captures enum value "InvalidFileContentType"
	ErrorDetailCodeInvalidFileContentType string = "InvalidFileContentType"

	// ErrorDetailCodeRequestTooLarge captures enum value "RequestTooLarge"
	ErrorDetailCodeRequestTooLarge string = "RequestTooLarge"

	// ErrorDetailCodeEcmsDisabled captures enum value "EcmsDisabled"
	ErrorDetailCodeEcmsDisabled string = "EcmsDisabled"

	// ErrorDetailCodeUnknownConjunctionError captures enum value "UnknownConjunctionError"
	ErrorDetailCodeUnknownConjunctionError string = "UnknownConjunctionError"

	// ErrorDetailCodeNoLinesDiscounted captures enum value "NoLinesDiscounted"
	ErrorDetailCodeNoLinesDiscounted string = "NoLinesDiscounted"

	// ErrorDetailCodeFailedToDelete captures enum value "FailedToDelete"
	ErrorDetailCodeFailedToDelete string = "FailedToDelete"

	// ErrorDetailCodeCircularCompanyHierarchies captures enum value "CircularCompanyHierarchies"
	ErrorDetailCodeCircularCompanyHierarchies string = "CircularCompanyHierarchies"

	// ErrorDetailCodeDuplicateEntry captures enum value "DuplicateEntry"
	ErrorDetailCodeDuplicateEntry string = "DuplicateEntry"

	// ErrorDetailCodeDuplicateFieldNameInOrderBy captures enum value "DuplicateFieldNameInOrderBy"
	ErrorDetailCodeDuplicateFieldNameInOrderBy string = "DuplicateFieldNameInOrderBy"

	// ErrorDetailCodeCannotAdjustDocumentType captures enum value "CannotAdjustDocumentType"
	ErrorDetailCodeCannotAdjustDocumentType string = "CannotAdjustDocumentType"

	// ErrorDetailCodeUserNoAccess captures enum value "UserNoAccess"
	ErrorDetailCodeUserNoAccess string = "UserNoAccess"

	// ErrorDetailCodeInvalidEntry captures enum value "InvalidEntry"
	ErrorDetailCodeInvalidEntry string = "InvalidEntry"

	// ErrorDetailCodeTransactionAlreadyCancelled captures enum value "TransactionAlreadyCancelled"
	ErrorDetailCodeTransactionAlreadyCancelled string = "TransactionAlreadyCancelled"

	// ErrorDetailCodeQueryParameterOutOfRange captures enum value "QueryParameterOutOfRange"
	ErrorDetailCodeQueryParameterOutOfRange string = "QueryParameterOutOfRange"

	// ErrorDetailCodeBatchSalesAuditMustBeZippedError captures enum value "BatchSalesAuditMustBeZippedError"
	ErrorDetailCodeBatchSalesAuditMustBeZippedError string = "BatchSalesAuditMustBeZippedError"

	// ErrorDetailCodeBatchZipMustContainOneFileError captures enum value "BatchZipMustContainOneFileError"
	ErrorDetailCodeBatchZipMustContainOneFileError string = "BatchZipMustContainOneFileError"

	// ErrorDetailCodeBatchInvalidFileTypeError captures enum value "BatchInvalidFileTypeError"
	ErrorDetailCodeBatchInvalidFileTypeError string = "BatchInvalidFileTypeError"

	// ErrorDetailCodeBatchCannotSaveBatchFile captures enum value "BatchCannotSaveBatchFile"
	ErrorDetailCodeBatchCannotSaveBatchFile string = "BatchCannotSaveBatchFile"

	// ErrorDetailCodeBatchCannotGetBatchFile captures enum value "BatchCannotGetBatchFile"
	ErrorDetailCodeBatchCannotGetBatchFile string = "BatchCannotGetBatchFile"

	// ErrorDetailCodeBatchCannotDeleteBatchFile captures enum value "BatchCannotDeleteBatchFile"
	ErrorDetailCodeBatchCannotDeleteBatchFile string = "BatchCannotDeleteBatchFile"

	// ErrorDetailCodeBatchMustContainOneFile captures enum value "BatchMustContainOneFile"
	ErrorDetailCodeBatchMustContainOneFile string = "BatchMustContainOneFile"

	// ErrorDetailCodeMissingBatchFileContent captures enum value "MissingBatchFileContent"
	ErrorDetailCodeMissingBatchFileContent string = "MissingBatchFileContent"

	// ErrorDetailCodeBatchCannotBeDeletedWhileProcessing captures enum value "BatchCannotBeDeletedWhileProcessing"
	ErrorDetailCodeBatchCannotBeDeletedWhileProcessing string = "BatchCannotBeDeletedWhileProcessing"

	// ErrorDetailCodeInternalServerError captures enum value "InternalServerError"
	ErrorDetailCodeInternalServerError string = "InternalServerError"

	// ErrorDetailCodePointOfSaleFileSize captures enum value "PointOfSaleFileSize"
	ErrorDetailCodePointOfSaleFileSize string = "PointOfSaleFileSize"

	// ErrorDetailCodePointOfSaleSetup captures enum value "PointOfSaleSetup"
	ErrorDetailCodePointOfSaleSetup string = "PointOfSaleSetup"

	// ErrorDetailCodeInvalidInputDate captures enum value "InvalidInputDate"
	ErrorDetailCodeInvalidInputDate string = "InvalidInputDate"

	// ErrorDetailCodeGetTaxError captures enum value "GetTaxError"
	ErrorDetailCodeGetTaxError string = "GetTaxError"

	// ErrorDetailCodeAddressConflictException captures enum value "AddressConflictException"
	ErrorDetailCodeAddressConflictException string = "AddressConflictException"

	// ErrorDetailCodeDocumentCodeConflict captures enum value "DocumentCodeConflict"
	ErrorDetailCodeDocumentCodeConflict string = "DocumentCodeConflict"

	// ErrorDetailCodeMissingAddress captures enum value "MissingAddress"
	ErrorDetailCodeMissingAddress string = "MissingAddress"

	// ErrorDetailCodeInvalidParameterValue captures enum value "InvalidParameterValue"
	ErrorDetailCodeInvalidParameterValue string = "InvalidParameterValue"

	// ErrorDetailCodeFetchLimit captures enum value "FetchLimit"
	ErrorDetailCodeFetchLimit string = "FetchLimit"

	// ErrorDetailCodeInvalidAddress captures enum value "InvalidAddress"
	ErrorDetailCodeInvalidAddress string = "InvalidAddress"

	// ErrorDetailCodeAddressLocationNotFound captures enum value "AddressLocationNotFound"
	ErrorDetailCodeAddressLocationNotFound string = "AddressLocationNotFound"

	// ErrorDetailCodeMissingLine captures enum value "MissingLine"
	ErrorDetailCodeMissingLine string = "MissingLine"

	// ErrorDetailCodeInvalidAddressTextCase captures enum value "InvalidAddressTextCase"
	ErrorDetailCodeInvalidAddressTextCase string = "InvalidAddressTextCase"

	// ErrorDetailCodeDocumentNotCommitted captures enum value "DocumentNotCommitted"
	ErrorDetailCodeDocumentNotCommitted string = "DocumentNotCommitted"

	// ErrorDetailCodeInvalidDocumentTypesToFetch captures enum value "InvalidDocumentTypesToFetch"
	ErrorDetailCodeInvalidDocumentTypesToFetch string = "InvalidDocumentTypesToFetch"

	// ErrorDetailCodeTimeoutRequested captures enum value "TimeoutRequested"
	ErrorDetailCodeTimeoutRequested string = "TimeoutRequested"

	// ErrorDetailCodeInvalidPostalCode captures enum value "InvalidPostalCode"
	ErrorDetailCodeInvalidPostalCode string = "InvalidPostalCode"

	// ErrorDetailCodeInvalidSubscriptionDescription captures enum value "InvalidSubscriptionDescription"
	ErrorDetailCodeInvalidSubscriptionDescription string = "InvalidSubscriptionDescription"

	// ErrorDetailCodeInvalidSubscriptionTypeID captures enum value "InvalidSubscriptionTypeId"
	ErrorDetailCodeInvalidSubscriptionTypeID string = "InvalidSubscriptionTypeId"

	// ErrorDetailCodeCannotChangeFilingStatus captures enum value "CannotChangeFilingStatus"
	ErrorDetailCodeCannotChangeFilingStatus string = "CannotChangeFilingStatus"

	// ErrorDetailCodeFEINFormatError captures enum value "FEINFormatError"
	ErrorDetailCodeFEINFormatError string = "FEINFormatError"

	// ErrorDetailCodeServerUnreachable captures enum value "ServerUnreachable"
	ErrorDetailCodeServerUnreachable string = "ServerUnreachable"

	// ErrorDetailCodeSubscriptionRequired captures enum value "SubscriptionRequired"
	ErrorDetailCodeSubscriptionRequired string = "SubscriptionRequired"

	// ErrorDetailCodeAccountExists captures enum value "AccountExists"
	ErrorDetailCodeAccountExists string = "AccountExists"

	// ErrorDetailCodeInvitationOnly captures enum value "InvitationOnly"
	ErrorDetailCodeInvitationOnly string = "InvitationOnly"

	// ErrorDetailCodeAccountNotWhitelisted captures enum value "AccountNotWhitelisted"
	ErrorDetailCodeAccountNotWhitelisted string = "AccountNotWhitelisted"

	// ErrorDetailCodeFreeTrialNotAvailable captures enum value "FreeTrialNotAvailable"
	ErrorDetailCodeFreeTrialNotAvailable string = "FreeTrialNotAvailable"

	// ErrorDetailCodeAccountExistsDifferentEmail captures enum value "AccountExistsDifferentEmail"
	ErrorDetailCodeAccountExistsDifferentEmail string = "AccountExistsDifferentEmail"

	// ErrorDetailCodeAvalaraIdentityAPIError captures enum value "AvalaraIdentityApiError"
	ErrorDetailCodeAvalaraIdentityAPIError string = "AvalaraIdentityApiError"

	// ErrorDetailCodeInvalidIPAddress captures enum value "InvalidIPAddress"
	ErrorDetailCodeInvalidIPAddress string = "InvalidIPAddress"

	// ErrorDetailCodeOfferCodeAlreadyApplied captures enum value "OfferCodeAlreadyApplied"
	ErrorDetailCodeOfferCodeAlreadyApplied string = "OfferCodeAlreadyApplied"

	// ErrorDetailCodeAccountAlreadyExists captures enum value "AccountAlreadyExists"
	ErrorDetailCodeAccountAlreadyExists string = "AccountAlreadyExists"

	// ErrorDetailCodeLicenseKeyNameAlreadyExistsForAccount captures enum value "LicenseKeyNameAlreadyExistsForAccount"
	ErrorDetailCodeLicenseKeyNameAlreadyExistsForAccount string = "LicenseKeyNameAlreadyExistsForAccount"

	// ErrorDetailCodeUserAlreadyExist captures enum value "UserAlreadyExist"
	ErrorDetailCodeUserAlreadyExist string = "UserAlreadyExist"

	// ErrorDetailCodeUserNotFound captures enum value "UserNotFound"
	ErrorDetailCodeUserNotFound string = "UserNotFound"

	// ErrorDetailCodeUserManagementException captures enum value "UserManagementException"
	ErrorDetailCodeUserManagementException string = "UserManagementException"

	// ErrorDetailCodeRefundTypeAndPercentageMismatch captures enum value "RefundTypeAndPercentageMismatch"
	ErrorDetailCodeRefundTypeAndPercentageMismatch string = "RefundTypeAndPercentageMismatch"

	// ErrorDetailCodeInvalidDocumentTypeForRefund captures enum value "InvalidDocumentTypeForRefund"
	ErrorDetailCodeInvalidDocumentTypeForRefund string = "InvalidDocumentTypeForRefund"

	// ErrorDetailCodeRefundTypeAndLineMismatch captures enum value "RefundTypeAndLineMismatch"
	ErrorDetailCodeRefundTypeAndLineMismatch string = "RefundTypeAndLineMismatch"

	// ErrorDetailCodeRefundLinesRequired captures enum value "RefundLinesRequired"
	ErrorDetailCodeRefundLinesRequired string = "RefundLinesRequired"

	// ErrorDetailCodeInvalidRefundType captures enum value "InvalidRefundType"
	ErrorDetailCodeInvalidRefundType string = "InvalidRefundType"

	// ErrorDetailCodeRefundPercentageForTaxOnly captures enum value "RefundPercentageForTaxOnly"
	ErrorDetailCodeRefundPercentageForTaxOnly string = "RefundPercentageForTaxOnly"

	// ErrorDetailCodeLineNoOutOfRange captures enum value "LineNoOutOfRange"
	ErrorDetailCodeLineNoOutOfRange string = "LineNoOutOfRange"

	// ErrorDetailCodeRefundPercentageOutOfRange captures enum value "RefundPercentageOutOfRange"
	ErrorDetailCodeRefundPercentageOutOfRange string = "RefundPercentageOutOfRange"

	// ErrorDetailCodeRefundPercentageMissing captures enum value "RefundPercentageMissing"
	ErrorDetailCodeRefundPercentageMissing string = "RefundPercentageMissing"

	// ErrorDetailCodeMustUseCreateTransaction captures enum value "MustUseCreateTransaction"
	ErrorDetailCodeMustUseCreateTransaction string = "MustUseCreateTransaction"

	// ErrorDetailCodeMustAcceptTermsAndConditions captures enum value "MustAcceptTermsAndConditions"
	ErrorDetailCodeMustAcceptTermsAndConditions string = "MustAcceptTermsAndConditions"

	// ErrorDetailCodeFilingCalendarCannotBeDeleted captures enum value "FilingCalendarCannotBeDeleted"
	ErrorDetailCodeFilingCalendarCannotBeDeleted string = "FilingCalendarCannotBeDeleted"

	// ErrorDetailCodeInvalidEffectiveDate captures enum value "InvalidEffectiveDate"
	ErrorDetailCodeInvalidEffectiveDate string = "InvalidEffectiveDate"

	// ErrorDetailCodeNonOutletForm captures enum value "NonOutletForm"
	ErrorDetailCodeNonOutletForm string = "NonOutletForm"

	// ErrorDetailCodeOverlappingFilingCalendar captures enum value "OverlappingFilingCalendar"
	ErrorDetailCodeOverlappingFilingCalendar string = "OverlappingFilingCalendar"

	// ErrorDetailCodeFilingCalendarCannotBeEdited captures enum value "FilingCalendarCannotBeEdited"
	ErrorDetailCodeFilingCalendarCannotBeEdited string = "FilingCalendarCannotBeEdited"

	// ErrorDetailCodeCannotModifyLockedTransaction captures enum value "CannotModifyLockedTransaction"
	ErrorDetailCodeCannotModifyLockedTransaction string = "CannotModifyLockedTransaction"

	// ErrorDetailCodeLineAlreadyExists captures enum value "LineAlreadyExists"
	ErrorDetailCodeLineAlreadyExists string = "LineAlreadyExists"

	// ErrorDetailCodeLineDoesNotExist captures enum value "LineDoesNotExist"
	ErrorDetailCodeLineDoesNotExist string = "LineDoesNotExist"

	// ErrorDetailCodeLinesNotSpecified captures enum value "LinesNotSpecified"
	ErrorDetailCodeLinesNotSpecified string = "LinesNotSpecified"

	// ErrorDetailCodeLineDetailsDoesNotExist captures enum value "LineDetailsDoesNotExist"
	ErrorDetailCodeLineDetailsDoesNotExist string = "LineDetailsDoesNotExist"

	// ErrorDetailCodeCannotCreateTransactionWithDeletedDataSource captures enum value "CannotCreateTransactionWithDeletedDataSource"
	ErrorDetailCodeCannotCreateTransactionWithDeletedDataSource string = "CannotCreateTransactionWithDeletedDataSource"

	// ErrorDetailCodeShipToRegionRequiredWithDataSource captures enum value "ShipToRegionRequiredWithDataSource"
	ErrorDetailCodeShipToRegionRequiredWithDataSource string = "ShipToRegionRequiredWithDataSource"

	// ErrorDetailCodeInvalidBusinessType captures enum value "InvalidBusinessType"
	ErrorDetailCodeInvalidBusinessType string = "InvalidBusinessType"

	// ErrorDetailCodeCannotModifyExemptCert captures enum value "CannotModifyExemptCert"
	ErrorDetailCodeCannotModifyExemptCert string = "CannotModifyExemptCert"

	// ErrorDetailCodeCertificatesError captures enum value "CertificatesError"
	ErrorDetailCodeCertificatesError string = "CertificatesError"

	// ErrorDetailCodeMissingRequiredFields captures enum value "MissingRequiredFields"
	ErrorDetailCodeMissingRequiredFields string = "MissingRequiredFields"

	// ErrorDetailCodeCertificatesNotSetup captures enum value "CertificatesNotSetup"
	ErrorDetailCodeCertificatesNotSetup string = "CertificatesNotSetup"

	// ErrorDetailCodeConflictingExposureZone captures enum value "ConflictingExposureZone"
	ErrorDetailCodeConflictingExposureZone string = "ConflictingExposureZone"

	// ErrorDetailCodeMissingFieldToCreateExposureZone captures enum value "MissingFieldToCreateExposureZone"
	ErrorDetailCodeMissingFieldToCreateExposureZone string = "MissingFieldToCreateExposureZone"

	// ErrorDetailCodeMissingExemptReason captures enum value "MissingExemptReason"
	ErrorDetailCodeMissingExemptReason string = "MissingExemptReason"

	// ErrorDetailCodeInvalidExemptReason captures enum value "InvalidExemptReason"
	ErrorDetailCodeInvalidExemptReason string = "InvalidExemptReason"

	// ErrorDetailCodeInvalidExemptionOperation captures enum value "InvalidExemptionOperation"
	ErrorDetailCodeInvalidExemptionOperation string = "InvalidExemptionOperation"

	// ErrorDetailCodeConflictingFields captures enum value "ConflictingFields"
	ErrorDetailCodeConflictingFields string = "ConflictingFields"

	// ErrorDetailCodeInvalidPdfOrImageFile captures enum value "InvalidPdfOrImageFile"
	ErrorDetailCodeInvalidPdfOrImageFile string = "InvalidPdfOrImageFile"

	// ErrorDetailCodeInvalidCoverLetterTitle captures enum value "InvalidCoverLetterTitle"
	ErrorDetailCodeInvalidCoverLetterTitle string = "InvalidCoverLetterTitle"

	// ErrorDetailCodeAccountNotProvisioned captures enum value "AccountNotProvisioned"
	ErrorDetailCodeAccountNotProvisioned string = "AccountNotProvisioned"

	// ErrorDetailCodeInvalidRequestContentType captures enum value "InvalidRequestContentType"
	ErrorDetailCodeInvalidRequestContentType string = "InvalidRequestContentType"

	// ErrorDetailCodeExemptionPaginationLimits captures enum value "ExemptionPaginationLimits"
	ErrorDetailCodeExemptionPaginationLimits string = "ExemptionPaginationLimits"

	// ErrorDetailCodeExemptionSortLimits captures enum value "ExemptionSortLimits"
	ErrorDetailCodeExemptionSortLimits string = "ExemptionSortLimits"

	// ErrorDetailCodeCustomerCantBeBothShipToAndBillTo captures enum value "CustomerCantBeBothShipToAndBillTo"
	ErrorDetailCodeCustomerCantBeBothShipToAndBillTo string = "CustomerCantBeBothShipToAndBillTo"

	// ErrorDetailCodeBillToCustomerExpected captures enum value "BillToCustomerExpected"
	ErrorDetailCodeBillToCustomerExpected string = "BillToCustomerExpected"

	// ErrorDetailCodeShipToCustomerExpected captures enum value "ShipToCustomerExpected"
	ErrorDetailCodeShipToCustomerExpected string = "ShipToCustomerExpected"

	// ErrorDetailCodeEcmsSstCertsRequired captures enum value "EcmsSstCertsRequired"
	ErrorDetailCodeEcmsSstCertsRequired string = "EcmsSstCertsRequired"

	// ErrorDetailCodeTransactionNotCancelled captures enum value "TransactionNotCancelled"
	ErrorDetailCodeTransactionNotCancelled string = "TransactionNotCancelled"

	// ErrorDetailCodeTooManyTransactions captures enum value "TooManyTransactions"
	ErrorDetailCodeTooManyTransactions string = "TooManyTransactions"

	// ErrorDetailCodeOnlyTaxDateOverrideIsAllowed captures enum value "OnlyTaxDateOverrideIsAllowed"
	ErrorDetailCodeOnlyTaxDateOverrideIsAllowed string = "OnlyTaxDateOverrideIsAllowed"

	// ErrorDetailCodeTransactionAlreadyExists captures enum value "TransactionAlreadyExists"
	ErrorDetailCodeTransactionAlreadyExists string = "TransactionAlreadyExists"

	// ErrorDetailCodeDateMismatch captures enum value "DateMismatch"
	ErrorDetailCodeDateMismatch string = "DateMismatch"

	// ErrorDetailCodeInvalidDocumentStatusForVerify captures enum value "InvalidDocumentStatusForVerify"
	ErrorDetailCodeInvalidDocumentStatusForVerify string = "InvalidDocumentStatusForVerify"

	// ErrorDetailCodeTotalAmountMismatch captures enum value "TotalAmountMismatch"
	ErrorDetailCodeTotalAmountMismatch string = "TotalAmountMismatch"

	// ErrorDetailCodeTotalTaxMismatch captures enum value "TotalTaxMismatch"
	ErrorDetailCodeTotalTaxMismatch string = "TotalTaxMismatch"

	// ErrorDetailCodeInvalidDocumentType captures enum value "InvalidDocumentType"
	ErrorDetailCodeInvalidDocumentType string = "InvalidDocumentType"

	// ErrorDetailCodeMultiDocumentPartiallyLocked captures enum value "MultiDocumentPartiallyLocked"
	ErrorDetailCodeMultiDocumentPartiallyLocked string = "MultiDocumentPartiallyLocked"

	// ErrorDetailCodeTransactionIsCommitted captures enum value "TransactionIsCommitted"
	ErrorDetailCodeTransactionIsCommitted string = "TransactionIsCommitted"

	// ErrorDetailCodeInvalidDocumentStatus captures enum value "InvalidDocumentStatus"
	ErrorDetailCodeInvalidDocumentStatus string = "InvalidDocumentStatus"

	// ErrorDetailCodeCommsConfigClientIDMissing captures enum value "CommsConfigClientIdMissing"
	ErrorDetailCodeCommsConfigClientIDMissing string = "CommsConfigClientIdMissing"

	// ErrorDetailCodeCommsConfigClientIDBadValue captures enum value "CommsConfigClientIdBadValue"
	ErrorDetailCodeCommsConfigClientIDBadValue string = "CommsConfigClientIdBadValue"

	// ErrorDetailCodeAccountInNewStatusException captures enum value "AccountInNewStatusException"
	ErrorDetailCodeAccountInNewStatusException string = "AccountInNewStatusException"

	// ErrorDetailCodeWorksheetException captures enum value "WorksheetException"
	ErrorDetailCodeWorksheetException string = "WorksheetException"

	// ErrorDetailCodeInvalidAccountOverride captures enum value "InvalidAccountOverride"
	ErrorDetailCodeInvalidAccountOverride string = "InvalidAccountOverride"

	// ErrorDetailCodeAccountOverrideNotAuthorized captures enum value "AccountOverrideNotAuthorized"
	ErrorDetailCodeAccountOverrideNotAuthorized string = "AccountOverrideNotAuthorized"

	// ErrorDetailCodeFieldNotQueryableError captures enum value "FieldNotQueryableError"
	ErrorDetailCodeFieldNotQueryableError string = "FieldNotQueryableError"

	// ErrorDetailCodeUsernameRequired captures enum value "UsernameRequired"
	ErrorDetailCodeUsernameRequired string = "UsernameRequired"

	// ErrorDetailCodeInvalidAuditMessage captures enum value "InvalidAuditMessage"
	ErrorDetailCodeInvalidAuditMessage string = "InvalidAuditMessage"

	// ErrorDetailCodeFieldNotOrderableError captures enum value "FieldNotOrderableError"
	ErrorDetailCodeFieldNotOrderableError string = "FieldNotOrderableError"

	// ErrorDetailCodeCannotDeleteParentBeforeChildNexus captures enum value "CannotDeleteParentBeforeChildNexus"
	ErrorDetailCodeCannotDeleteParentBeforeChildNexus string = "CannotDeleteParentBeforeChildNexus"

	// ErrorDetailCodeNexusChildDateMismatch captures enum value "NexusChildDateMismatch"
	ErrorDetailCodeNexusChildDateMismatch string = "NexusChildDateMismatch"

	// ErrorDetailCodeRemoteValidationError captures enum value "RemoteValidationError"
	ErrorDetailCodeRemoteValidationError string = "RemoteValidationError"

	// ErrorDetailCodeCannotModifySstNexus captures enum value "CannotModifySstNexus"
	ErrorDetailCodeCannotModifySstNexus string = "CannotModifySstNexus"

	// ErrorDetailCodeInvalidLocalNexusTypeID captures enum value "InvalidLocalNexusTypeId"
	ErrorDetailCodeInvalidLocalNexusTypeID string = "InvalidLocalNexusTypeId"

	// ErrorDetailCodeAdvancedRuleRequestRuleError captures enum value "AdvancedRuleRequestRuleError"
	ErrorDetailCodeAdvancedRuleRequestRuleError string = "AdvancedRuleRequestRuleError"

	// ErrorDetailCodeAdvancedRuleResponseRuleError captures enum value "AdvancedRuleResponseRuleError"
	ErrorDetailCodeAdvancedRuleResponseRuleError string = "AdvancedRuleResponseRuleError"

	// ErrorDetailCodeAdvancedRuleError captures enum value "AdvancedRuleError"
	ErrorDetailCodeAdvancedRuleError string = "AdvancedRuleError"

	// ErrorDetailCodeTaxRuleRequiresNexus captures enum value "TaxRuleRequiresNexus"
	ErrorDetailCodeTaxRuleRequiresNexus string = "TaxRuleRequiresNexus"

	// ErrorDetailCodeUPCCodeNotUnique captures enum value "UPCCodeNotUnique"
	ErrorDetailCodeUPCCodeNotUnique string = "UPCCodeNotUnique"

	// ErrorDetailCodeTaxCodeAssociatedWithItemCodeNotFound captures enum value "TaxCodeAssociatedWithItemCodeNotFound"
	ErrorDetailCodeTaxCodeAssociatedWithItemCodeNotFound string = "TaxCodeAssociatedWithItemCodeNotFound"

	// ErrorDetailCodeDuplicateSystemForItem captures enum value "DuplicateSystemForItem"
	ErrorDetailCodeDuplicateSystemForItem string = "DuplicateSystemForItem"

	// ErrorDetailCodeCannotDismissGlobalNotification captures enum value "CannotDismissGlobalNotification"
	ErrorDetailCodeCannotDismissGlobalNotification string = "CannotDismissGlobalNotification"

	// ErrorDetailCodeCannotUpdateAccountTypeID captures enum value "CannotUpdateAccountTypeId"
	ErrorDetailCodeCannotUpdateAccountTypeID string = "CannotUpdateAccountTypeId"

	// ErrorDetailCodeTaxpayerNumberIsRequired captures enum value "TaxpayerNumberIsRequired"
	ErrorDetailCodeTaxpayerNumberIsRequired string = "TaxpayerNumberIsRequired"

	// ErrorDetailCodeRequestLimitExceeded captures enum value "RequestLimitExceeded"
	ErrorDetailCodeRequestLimitExceeded string = "RequestLimitExceeded"

	// ErrorDetailCodeConcurrentRequestLimitExceeded captures enum value "ConcurrentRequestLimitExceeded"
	ErrorDetailCodeConcurrentRequestLimitExceeded string = "ConcurrentRequestLimitExceeded"

	// ErrorDetailCodeInvalidDocumentTypeForInspect captures enum value "InvalidDocumentTypeForInspect"
	ErrorDetailCodeInvalidDocumentTypeForInspect string = "InvalidDocumentTypeForInspect"

	// ErrorDetailCodeServiceNotReady captures enum value "ServiceNotReady"
	ErrorDetailCodeServiceNotReady string = "ServiceNotReady"

	// ErrorDetailCodeUpdateLocationRemittanceMismatchTypeAndCategory captures enum value "UpdateLocationRemittanceMismatchTypeAndCategory"
	ErrorDetailCodeUpdateLocationRemittanceMismatchTypeAndCategory string = "UpdateLocationRemittanceMismatchTypeAndCategory"

	// ErrorDetailCodeUpdateLocationRemittanceCheckExistingEffectiveDateError captures enum value "UpdateLocationRemittanceCheckExistingEffectiveDateError"
	ErrorDetailCodeUpdateLocationRemittanceCheckExistingEffectiveDateError string = "UpdateLocationRemittanceCheckExistingEffectiveDateError"

	// ErrorDetailCodeUpdateLocationRemittanceCheckExistingEndDateError captures enum value "UpdateLocationRemittanceCheckExistingEndDateError"
	ErrorDetailCodeUpdateLocationRemittanceCheckExistingEndDateError string = "UpdateLocationRemittanceCheckExistingEndDateError"

	// ErrorDetailCodeErrorCountLimitExceededError captures enum value "ErrorCountLimitExceededError"
	ErrorDetailCodeErrorCountLimitExceededError string = "ErrorCountLimitExceededError"

	// ErrorDetailCodeRateLimitExceededError captures enum value "RateLimitExceededError"
	ErrorDetailCodeRateLimitExceededError string = "RateLimitExceededError"

	// ErrorDetailCodeTaxCodeAndTaxCodeIDMissing captures enum value "TaxCodeAndTaxCodeIdMissing"
	ErrorDetailCodeTaxCodeAndTaxCodeIDMissing string = "TaxCodeAndTaxCodeIdMissing"

	// ErrorDetailCodeNexusAlreadyExists captures enum value "NexusAlreadyExists"
	ErrorDetailCodeNexusAlreadyExists string = "NexusAlreadyExists"

	// ErrorDetailCodeInvalidAddressTypeAndMarketPlaceOusideUsaFlag captures enum value "InvalidAddressTypeAndMarketPlaceOusideUsaFlag"
	ErrorDetailCodeInvalidAddressTypeAndMarketPlaceOusideUsaFlag string = "InvalidAddressTypeAndMarketPlaceOusideUsaFlag"

	// ErrorDetailCodeInvalidSettingSet captures enum value "InvalidSettingSet"
	ErrorDetailCodeInvalidSettingSet string = "InvalidSettingSet"

	// ErrorDetailCodeInvalidSettingName captures enum value "InvalidSettingName"
	ErrorDetailCodeInvalidSettingName string = "InvalidSettingName"

	// ErrorDetailCodeInvalidSettingValue captures enum value "InvalidSettingValue"
	ErrorDetailCodeInvalidSettingValue string = "InvalidSettingValue"

	// ErrorDetailCodeTooManyUserDefinedFields captures enum value "TooManyUserDefinedFields"
	ErrorDetailCodeTooManyUserDefinedFields string = "TooManyUserDefinedFields"

	// ErrorDetailCodeDuplicateUserDefinedFieldsFound captures enum value "DuplicateUserDefinedFieldsFound"
	ErrorDetailCodeDuplicateUserDefinedFieldsFound string = "DuplicateUserDefinedFieldsFound"

	// ErrorDetailCodeInvalidNameForUserDefinedField captures enum value "InvalidNameForUserDefinedField"
	ErrorDetailCodeInvalidNameForUserDefinedField string = "InvalidNameForUserDefinedField"

	// ErrorDetailCodeUnsupportedFileFormat captures enum value "UnsupportedFileFormat"
	ErrorDetailCodeUnsupportedFileFormat string = "UnsupportedFileFormat"

	// ErrorDetailCodeUnsupportedOutputFileType captures enum value "UnsupportedOutputFileType"
	ErrorDetailCodeUnsupportedOutputFileType string = "UnsupportedOutputFileType"

	// ErrorDetailCodeTaxProfileNotProvided captures enum value "TaxProfileNotProvided"
	ErrorDetailCodeTaxProfileNotProvided string = "TaxProfileNotProvided"

	// ErrorDetailCodeInvalidTaxProfile captures enum value "InvalidTaxProfile"
	ErrorDetailCodeInvalidTaxProfile string = "InvalidTaxProfile"

	// ErrorDetailCodeCompanyTaxProfileEntryRequired captures enum value "CompanyTaxProfileEntryRequired"
	ErrorDetailCodeCompanyTaxProfileEntryRequired string = "CompanyTaxProfileEntryRequired"

	// ErrorDetailCodeErrorReadingTaxProfileEntry captures enum value "ErrorReadingTaxProfileEntry"
	ErrorDetailCodeErrorReadingTaxProfileEntry string = "ErrorReadingTaxProfileEntry"

	// ErrorDetailCodeTraceDataNotAvailable captures enum value "TraceDataNotAvailable"
	ErrorDetailCodeTraceDataNotAvailable string = "TraceDataNotAvailable"

	// ErrorDetailCodeInvalidParameterUnitMeasurementType captures enum value "InvalidParameterUnitMeasurementType"
	ErrorDetailCodeInvalidParameterUnitMeasurementType string = "InvalidParameterUnitMeasurementType"

	// ErrorDetailCodeParameterUnitRequired captures enum value "ParameterUnitRequired"
	ErrorDetailCodeParameterUnitRequired string = "ParameterUnitRequired"

	// ErrorDetailCodeInvalidParameterValueDataType captures enum value "InvalidParameterValueDataType"
	ErrorDetailCodeInvalidParameterValueDataType string = "InvalidParameterValueDataType"

	// ErrorDetailCodeInvalidParameterAttributeType captures enum value "InvalidParameterAttributeType"
	ErrorDetailCodeInvalidParameterAttributeType string = "InvalidParameterAttributeType"

	// ErrorDetailCodeSubscriptionRequiredForParameter captures enum value "SubscriptionRequiredForParameter"
	ErrorDetailCodeSubscriptionRequiredForParameter string = "SubscriptionRequiredForParameter"

	// ErrorDetailCodeInvalidAccountType captures enum value "InvalidAccountType"
	ErrorDetailCodeInvalidAccountType string = "InvalidAccountType"

	// ErrorDetailCodeInvalidFirmSubscriptions captures enum value "InvalidFirmSubscriptions"
	ErrorDetailCodeInvalidFirmSubscriptions string = "InvalidFirmSubscriptions"

	// ErrorDetailCodeGenericTaxCodeForItem captures enum value "GenericTaxCodeForItem"
	ErrorDetailCodeGenericTaxCodeForItem string = "GenericTaxCodeForItem"

	// ErrorDetailCodeCannotCertifyCompany captures enum value "CannotCertifyCompany"
	ErrorDetailCodeCannotCertifyCompany string = "CannotCertifyCompany"

	// ErrorDetailCodeNoVoidedDocuments captures enum value "NoVoidedDocuments"
	ErrorDetailCodeNoVoidedDocuments string = "NoVoidedDocuments"

	// ErrorDetailCodeInadequateCommittedDocuments captures enum value "InadequateCommittedDocuments"
	ErrorDetailCodeInadequateCommittedDocuments string = "InadequateCommittedDocuments"

	// ErrorDetailCodeDocumentCodeIsGUID captures enum value "DocumentCodeIsGuid"
	ErrorDetailCodeDocumentCodeIsGUID string = "DocumentCodeIsGuid"

	// ErrorDetailCodeCustomerVendorCodeIsGUID captures enum value "CustomerVendorCodeIsGuid"
	ErrorDetailCodeCustomerVendorCodeIsGUID string = "CustomerVendorCodeIsGuid"

	// ErrorDetailCodeInadequateDocumentLineCount captures enum value "InadequateDocumentLineCount"
	ErrorDetailCodeInadequateDocumentLineCount string = "InadequateDocumentLineCount"

	// ErrorDetailCodeSameDocumentDescription captures enum value "SameDocumentDescription"
	ErrorDetailCodeSameDocumentDescription string = "SameDocumentDescription"

	// ErrorDetailCodeNoExemptionNoOrCustomerUsageType captures enum value "NoExemptionNoOrCustomerUsageType"
	ErrorDetailCodeNoExemptionNoOrCustomerUsageType string = "NoExemptionNoOrCustomerUsageType"

	// ErrorDetailCodeInadequateUniqueAddresses captures enum value "InadequateUniqueAddresses"
	ErrorDetailCodeInadequateUniqueAddresses string = "InadequateUniqueAddresses"

	// ErrorDetailCodeItemCodesAreAllSame captures enum value "ItemCodesAreAllSame"
	ErrorDetailCodeItemCodesAreAllSame string = "ItemCodesAreAllSame"

	// ErrorDetailCodeTaxCodesAreAllSame captures enum value "TaxCodesAreAllSame"
	ErrorDetailCodeTaxCodesAreAllSame string = "TaxCodesAreAllSame"

	// ErrorDetailCodeLocationCodeNotUsed captures enum value "LocationCodeNotUsed"
	ErrorDetailCodeLocationCodeNotUsed string = "LocationCodeNotUsed"

	// ErrorDetailCodeRepeatedLinesInDocument captures enum value "RepeatedLinesInDocument"
	ErrorDetailCodeRepeatedLinesInDocument string = "RepeatedLinesInDocument"

	// ErrorDetailCodeTaxDateOverrideAndNegativeLineAmount captures enum value "TaxDateOverrideAndNegativeLineAmount"
	ErrorDetailCodeTaxDateOverrideAndNegativeLineAmount string = "TaxDateOverrideAndNegativeLineAmount"

	// ErrorDetailCodeAllUSDCurrencyCodes captures enum value "AllUSDCurrencyCodes"
	ErrorDetailCodeAllUSDCurrencyCodes string = "AllUSDCurrencyCodes"

	// ErrorDetailCodeNoVATBuyerID captures enum value "NoVATBuyerId"
	ErrorDetailCodeNoVATBuyerID string = "NoVATBuyerId"

	// ErrorDetailCodeAllUSCountryCodes captures enum value "AllUSCountryCodes"
	ErrorDetailCodeAllUSCountryCodes string = "AllUSCountryCodes"

	// ErrorDetailCodeNoDocumentsToTest captures enum value "NoDocumentsToTest"
	ErrorDetailCodeNoDocumentsToTest string = "NoDocumentsToTest"

	// ErrorDetailCodeNoShippingCharge captures enum value "NoShippingCharge"
	ErrorDetailCodeNoShippingCharge string = "NoShippingCharge"

	// ErrorDetailCodeFailedToUpdateCompanyLocation captures enum value "FailedToUpdateCompanyLocation"
	ErrorDetailCodeFailedToUpdateCompanyLocation string = "FailedToUpdateCompanyLocation"

	// ErrorDetailCodeCompanyLocationDateRangeOverlap captures enum value "CompanyLocationDateRangeOverlap"
	ErrorDetailCodeCompanyLocationDateRangeOverlap string = "CompanyLocationDateRangeOverlap"

	// ErrorDetailCodeFieldLengthError captures enum value "FieldLengthError"
	ErrorDetailCodeFieldLengthError string = "FieldLengthError"

	// ErrorDetailCodeInputContainsBlacklistedCharacters captures enum value "InputContainsBlacklistedCharacters"
	ErrorDetailCodeInputContainsBlacklistedCharacters string = "InputContainsBlacklistedCharacters"

	// ErrorDetailCodeCannotCreateNestedObjects captures enum value "CannotCreateNestedObjects"
	ErrorDetailCodeCannotCreateNestedObjects string = "CannotCreateNestedObjects"

	// ErrorDetailCodeUserSubjectIDNotUpdated captures enum value "UserSubjectIdNotUpdated"
	ErrorDetailCodeUserSubjectIDNotUpdated string = "UserSubjectIdNotUpdated"

	// ErrorDetailCodeBatchTransactionTypeError captures enum value "BatchTransactionTypeError"
	ErrorDetailCodeBatchTransactionTypeError string = "BatchTransactionTypeError"

	// ErrorDetailCodeBatchTransactionLineLimitExceeded captures enum value "BatchTransactionLineLimitExceeded"
	ErrorDetailCodeBatchTransactionLineLimitExceeded string = "BatchTransactionLineLimitExceeded"

	// ErrorDetailCodeBatchCompanyIDAndCompanyCodeMismatch captures enum value "BatchCompanyIdAndCompanyCodeMismatch"
	ErrorDetailCodeBatchCompanyIDAndCompanyCodeMismatch string = "BatchCompanyIdAndCompanyCodeMismatch"

	// ErrorDetailCodeBatchCannotBeCancelledStatusError captures enum value "BatchCannotBeCancelledStatusError"
	ErrorDetailCodeBatchCannotBeCancelledStatusError string = "BatchCannotBeCancelledStatusError"

	// ErrorDetailCodeBatchCannotBeCancelledFormatError captures enum value "BatchCannotBeCancelledFormatError"
	ErrorDetailCodeBatchCannotBeCancelledFormatError string = "BatchCannotBeCancelledFormatError"

	// ErrorDetailCodeInvalidParameterDataType captures enum value "InvalidParameterDataType"
	ErrorDetailCodeInvalidParameterDataType string = "InvalidParameterDataType"

	// ErrorDetailCodeTagDoesNotExist captures enum value "TagDoesNotExist"
	ErrorDetailCodeTagDoesNotExist string = "TagDoesNotExist"

	// ErrorDetailCodeObjectDeleted captures enum value "ObjectDeleted"
	ErrorDetailCodeObjectDeleted string = "ObjectDeleted"

	// ErrorDetailCodeAssociatedObjectsDeleted captures enum value "AssociatedObjectsDeleted"
	ErrorDetailCodeAssociatedObjectsDeleted string = "AssociatedObjectsDeleted"

	// ErrorDetailCodeCannotDownloadReport captures enum value "CannotDownloadReport"
	ErrorDetailCodeCannotDownloadReport string = "CannotDownloadReport"

	// ErrorDetailCodeInvalidUnitOfBasis captures enum value "InvalidUnitOfBasis"
	ErrorDetailCodeInvalidUnitOfBasis string = "InvalidUnitOfBasis"

	// ErrorDetailCodeNotApplicableUnitOfBasis captures enum value "NotApplicableUnitOfBasis"
	ErrorDetailCodeNotApplicableUnitOfBasis string = "NotApplicableUnitOfBasis"

	// ErrorDetailCodeInvalidRateTypeTaxTypeMapping captures enum value "InvalidRateTypeTaxTypeMapping"
	ErrorDetailCodeInvalidRateTypeTaxTypeMapping string = "InvalidRateTypeTaxTypeMapping"

	// ErrorDetailCodeInvalidTaxTypeGroup captures enum value "InvalidTaxTypeGroup"
	ErrorDetailCodeInvalidTaxTypeGroup string = "InvalidTaxTypeGroup"

	// ErrorDetailCodeInvalidTaxSubType captures enum value "InvalidTaxSubType"
	ErrorDetailCodeInvalidTaxSubType string = "InvalidTaxSubType"

	// ErrorDetailCodeInvalidProductTypeID captures enum value "InvalidProductTypeId"
	ErrorDetailCodeInvalidProductTypeID string = "InvalidProductTypeId"

	// ErrorDetailCodeInvalidTaxRuleType captures enum value "InvalidTaxRuleType"
	ErrorDetailCodeInvalidTaxRuleType string = "InvalidTaxRuleType"

	// ErrorDetailCodeInvalidHsCode captures enum value "InvalidHsCode"
	ErrorDetailCodeInvalidHsCode string = "InvalidHsCode"

	// ErrorDetailCodeNotApplicableTaxType captures enum value "NotApplicableTaxType"
	ErrorDetailCodeNotApplicableTaxType string = "NotApplicableTaxType"

	// ErrorDetailCodeInvalidTaxTypeCode captures enum value "InvalidTaxTypeCode"
	ErrorDetailCodeInvalidTaxTypeCode string = "InvalidTaxTypeCode"
)
View Source 
const (

	// ErrorDetailSeveritySuccess captures enum value "Success"
	ErrorDetailSeveritySuccess string = "Success"

	// ErrorDetailSeverityWarning captures enum value "Warning"
	ErrorDetailSeverityWarning string = "Warning"

	// ErrorDetailSeverityError captures enum value "Error"
	ErrorDetailSeverityError string = "Error"

	// ErrorDetailSeverityException captures enum value "Exception"
	ErrorDetailSeverityException string = "Exception"
)
View Source 
const (

	// ErrorTransactionModelBaseDocumentTypeSalesOrder captures enum value "SalesOrder"
	ErrorTransactionModelBaseDocumentTypeSalesOrder string = "SalesOrder"

	// ErrorTransactionModelBaseDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	ErrorTransactionModelBaseDocumentTypeSalesInvoice string = "SalesInvoice"

	// ErrorTransactionModelBaseDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	ErrorTransactionModelBaseDocumentTypePurchaseOrder string = "PurchaseOrder"

	// ErrorTransactionModelBaseDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	ErrorTransactionModelBaseDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// ErrorTransactionModelBaseDocumentTypeReturnOrder captures enum value "ReturnOrder"
	ErrorTransactionModelBaseDocumentTypeReturnOrder string = "ReturnOrder"

	// ErrorTransactionModelBaseDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	ErrorTransactionModelBaseDocumentTypeReturnInvoice string = "ReturnInvoice"

	// ErrorTransactionModelBaseDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	ErrorTransactionModelBaseDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// ErrorTransactionModelBaseDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	ErrorTransactionModelBaseDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// ErrorTransactionModelBaseDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	ErrorTransactionModelBaseDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// ErrorTransactionModelBaseDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	ErrorTransactionModelBaseDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// ErrorTransactionModelBaseDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	ErrorTransactionModelBaseDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// ErrorTransactionModelBaseDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	ErrorTransactionModelBaseDocumentTypeCustomsOrder string = "CustomsOrder"

	// ErrorTransactionModelBaseDocumentTypeAny captures enum value "Any"
	ErrorTransactionModelBaseDocumentTypeAny string = "Any"
)
View Source 
const (

	// ErrorTransactionOutputModelDocumentTypeSalesOrder captures enum value "SalesOrder"
	ErrorTransactionOutputModelDocumentTypeSalesOrder string = "SalesOrder"

	// ErrorTransactionOutputModelDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	ErrorTransactionOutputModelDocumentTypeSalesInvoice string = "SalesInvoice"

	// ErrorTransactionOutputModelDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	ErrorTransactionOutputModelDocumentTypePurchaseOrder string = "PurchaseOrder"

	// ErrorTransactionOutputModelDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	ErrorTransactionOutputModelDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// ErrorTransactionOutputModelDocumentTypeReturnOrder captures enum value "ReturnOrder"
	ErrorTransactionOutputModelDocumentTypeReturnOrder string = "ReturnOrder"

	// ErrorTransactionOutputModelDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	ErrorTransactionOutputModelDocumentTypeReturnInvoice string = "ReturnInvoice"

	// ErrorTransactionOutputModelDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	ErrorTransactionOutputModelDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// ErrorTransactionOutputModelDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	ErrorTransactionOutputModelDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// ErrorTransactionOutputModelDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	ErrorTransactionOutputModelDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// ErrorTransactionOutputModelDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	ErrorTransactionOutputModelDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// ErrorTransactionOutputModelDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	ErrorTransactionOutputModelDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// ErrorTransactionOutputModelDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	ErrorTransactionOutputModelDocumentTypeCustomsOrder string = "CustomsOrder"

	// ErrorTransactionOutputModelDocumentTypeAny captures enum value "Any"
	ErrorTransactionOutputModelDocumentTypeAny string = "Any"
)
View Source 
const (

	// ExportDocumentLineModelDateFilterDocumentDate captures enum value "DocumentDate"
	ExportDocumentLineModelDateFilterDocumentDate string = "DocumentDate"

	// ExportDocumentLineModelDateFilterModifiedDate captures enum value "ModifiedDate"
	ExportDocumentLineModelDateFilterModifiedDate string = "ModifiedDate"

	// ExportDocumentLineModelDateFilterPaymentDate captures enum value "PaymentDate"
	ExportDocumentLineModelDateFilterPaymentDate string = "PaymentDate"

	// ExportDocumentLineModelDateFilterReportingDate captures enum value "ReportingDate"
	ExportDocumentLineModelDateFilterReportingDate string = "ReportingDate"

	// ExportDocumentLineModelDateFilterTaxDate captures enum value "TaxDate"
	ExportDocumentLineModelDateFilterTaxDate string = "TaxDate"
)
View Source 
const (

	// ExportDocumentLineModelDocTypeConsumerUse captures enum value "ConsumerUse"
	ExportDocumentLineModelDocTypeConsumerUse string = "ConsumerUse"

	// ExportDocumentLineModelDocTypeSales captures enum value "Sales"
	ExportDocumentLineModelDocTypeSales string = "Sales"
)
View Source 
const (

	// ExportDocumentLineModelDocumentStatusTemporary captures enum value "Temporary"
	ExportDocumentLineModelDocumentStatusTemporary string = "Temporary"

	// ExportDocumentLineModelDocumentStatusSaved captures enum value "Saved"
	ExportDocumentLineModelDocumentStatusSaved string = "Saved"

	// ExportDocumentLineModelDocumentStatusPosted captures enum value "Posted"
	ExportDocumentLineModelDocumentStatusPosted string = "Posted"

	// ExportDocumentLineModelDocumentStatusCommitted captures enum value "Committed"
	ExportDocumentLineModelDocumentStatusCommitted string = "Committed"

	// ExportDocumentLineModelDocumentStatusCancelled captures enum value "Cancelled"
	ExportDocumentLineModelDocumentStatusCancelled string = "Cancelled"

	// ExportDocumentLineModelDocumentStatusAdjusted captures enum value "Adjusted"
	ExportDocumentLineModelDocumentStatusAdjusted string = "Adjusted"

	// ExportDocumentLineModelDocumentStatusQueued captures enum value "Queued"
	ExportDocumentLineModelDocumentStatusQueued string = "Queued"

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

	// ExportDocumentLineModelDocumentStatusAny captures enum value "Any"
	ExportDocumentLineModelDocumentStatusAny string = "Any"
)
View Source 
const (

	// FilingAdjustmentModelAccountTypeNone captures enum value "None"
	FilingAdjustmentModelAccountTypeNone string = "None"

	// FilingAdjustmentModelAccountTypeAccountsReceivableAccountsPayable captures enum value "AccountsReceivableAccountsPayable"
	FilingAdjustmentModelAccountTypeAccountsReceivableAccountsPayable string = "AccountsReceivableAccountsPayable"

	// FilingAdjustmentModelAccountTypeAccountsReceivable captures enum value "AccountsReceivable"
	FilingAdjustmentModelAccountTypeAccountsReceivable string = "AccountsReceivable"

	// FilingAdjustmentModelAccountTypeAccountsPayable captures enum value "AccountsPayable"
	FilingAdjustmentModelAccountTypeAccountsPayable string = "AccountsPayable"
)
View Source 
const (

	// FilingAdjustmentModelPeriodNone captures enum value "None"
	FilingAdjustmentModelPeriodNone string = "None"

	// FilingAdjustmentModelPeriodCurrentPeriod captures enum value "CurrentPeriod"
	FilingAdjustmentModelPeriodCurrentPeriod string = "CurrentPeriod"

	// FilingAdjustmentModelPeriodNextPeriod captures enum value "NextPeriod"
	FilingAdjustmentModelPeriodNextPeriod string = "NextPeriod"
)
View Source 
const (

	// FilingCalendarModelBulkAccountValidationStatusNew captures enum value "New"
	FilingCalendarModelBulkAccountValidationStatusNew string = "New"

	// FilingCalendarModelBulkAccountValidationStatusAdded captures enum value "Added"
	FilingCalendarModelBulkAccountValidationStatusAdded string = "Added"

	// FilingCalendarModelBulkAccountValidationStatusFailed captures enum value "Failed"
	FilingCalendarModelBulkAccountValidationStatusFailed string = "Failed"
)
View Source 
const (

	// FilingCalendarModelFilingFrequencyIDMonthly captures enum value "Monthly"
	FilingCalendarModelFilingFrequencyIDMonthly string = "Monthly"

	// FilingCalendarModelFilingFrequencyIDQuarterly captures enum value "Quarterly"
	FilingCalendarModelFilingFrequencyIDQuarterly string = "Quarterly"

	// FilingCalendarModelFilingFrequencyIDSemiAnnually captures enum value "SemiAnnually"
	FilingCalendarModelFilingFrequencyIDSemiAnnually string = "SemiAnnually"

	// FilingCalendarModelFilingFrequencyIDAnnually captures enum value "Annually"
	FilingCalendarModelFilingFrequencyIDAnnually string = "Annually"

	// FilingCalendarModelFilingFrequencyIDBimonthly captures enum value "Bimonthly"
	FilingCalendarModelFilingFrequencyIDBimonthly string = "Bimonthly"

	// FilingCalendarModelFilingFrequencyIDOccasional captures enum value "Occasional"
	FilingCalendarModelFilingFrequencyIDOccasional string = "Occasional"

	// FilingCalendarModelFilingFrequencyIDInverseQuarterly captures enum value "InverseQuarterly"
	FilingCalendarModelFilingFrequencyIDInverseQuarterly string = "InverseQuarterly"

	// FilingCalendarModelFilingFrequencyIDWeekly captures enum value "Weekly"
	FilingCalendarModelFilingFrequencyIDWeekly string = "Weekly"
)
View Source 
const (

	// FilingCalendarModelFilingTypeIDPaperReturn captures enum value "PaperReturn"
	FilingCalendarModelFilingTypeIDPaperReturn string = "PaperReturn"

	// FilingCalendarModelFilingTypeIDElectronicReturn captures enum value "ElectronicReturn"
	FilingCalendarModelFilingTypeIDElectronicReturn string = "ElectronicReturn"

	// FilingCalendarModelFilingTypeIDSER captures enum value "SER"
	FilingCalendarModelFilingTypeIDSER string = "SER"

	// FilingCalendarModelFilingTypeIDEFTPaper captures enum value "EFTPaper"
	FilingCalendarModelFilingTypeIDEFTPaper string = "EFTPaper"

	// FilingCalendarModelFilingTypeIDPhonePaper captures enum value "PhonePaper"
	FilingCalendarModelFilingTypeIDPhonePaper string = "PhonePaper"

	// FilingCalendarModelFilingTypeIDSignatureReady captures enum value "SignatureReady"
	FilingCalendarModelFilingTypeIDSignatureReady string = "SignatureReady"

	// FilingCalendarModelFilingTypeIDEfileCheck captures enum value "EfileCheck"
	FilingCalendarModelFilingTypeIDEfileCheck string = "EfileCheck"
)
View Source 
const (

	// FilingCalendarModelOutletTypeIDNone captures enum value "None"
	FilingCalendarModelOutletTypeIDNone string = "None"

	// FilingCalendarModelOutletTypeIDSchedule captures enum value "Schedule"
	FilingCalendarModelOutletTypeIDSchedule string = "Schedule"

	// FilingCalendarModelOutletTypeIDDuplicate captures enum value "Duplicate"
	FilingCalendarModelOutletTypeIDDuplicate string = "Duplicate"

	// FilingCalendarModelOutletTypeIDConsolidated captures enum value "Consolidated"
	FilingCalendarModelOutletTypeIDConsolidated string = "Consolidated"
)
View Source 
const (

	// FilingCalendarModelTaxTypeIDE captures enum value "E"
	FilingCalendarModelTaxTypeIDE string = "E"

	// FilingCalendarModelTaxTypeIDLodging captures enum value "Lodging"
	FilingCalendarModelTaxTypeIDLodging string = "Lodging"

	// FilingCalendarModelTaxTypeIDBottle captures enum value "Bottle"
	FilingCalendarModelTaxTypeIDBottle string = "Bottle"

	// FilingCalendarModelTaxTypeIDRentToOwn captures enum value "RentToOwn"
	FilingCalendarModelTaxTypeIDRentToOwn string = "RentToOwn"

	// FilingCalendarModelTaxTypeIDBikeTax captures enum value "BikeTax"
	FilingCalendarModelTaxTypeIDBikeTax string = "BikeTax"

	// FilingCalendarModelTaxTypeIDLandedCost captures enum value "LandedCost"
	FilingCalendarModelTaxTypeIDLandedCost string = "LandedCost"

	// FilingCalendarModelTaxTypeIDCheckoutBag captures enum value "CheckoutBag"
	FilingCalendarModelTaxTypeIDCheckoutBag string = "CheckoutBag"

	// FilingCalendarModelTaxTypeIDAlcohol captures enum value "Alcohol"
	FilingCalendarModelTaxTypeIDAlcohol string = "Alcohol"

	// FilingCalendarModelTaxTypeIDAmusement captures enum value "Amusement"
	FilingCalendarModelTaxTypeIDAmusement string = "Amusement"

	// FilingCalendarModelTaxTypeIDHospitality captures enum value "Hospitality"
	FilingCalendarModelTaxTypeIDHospitality string = "Hospitality"

	// FilingCalendarModelTaxTypeIDRentalLeasing captures enum value "RentalLeasing"
	FilingCalendarModelTaxTypeIDRentalLeasing string = "RentalLeasing"

	// FilingCalendarModelTaxTypeIDGrossReceipts captures enum value "GrossReceipts"
	FilingCalendarModelTaxTypeIDGrossReceipts string = "GrossReceipts"

	// FilingCalendarModelTaxTypeIDMattress captures enum value "Mattress"
	FilingCalendarModelTaxTypeIDMattress string = "Mattress"

	// FilingCalendarModelTaxTypeIDLumber captures enum value "Lumber"
	FilingCalendarModelTaxTypeIDLumber string = "Lumber"

	// FilingCalendarModelTaxTypeIDPaint captures enum value "Paint"
	FilingCalendarModelTaxTypeIDPaint string = "Paint"

	// FilingCalendarModelTaxTypeIDTires captures enum value "Tires"
	FilingCalendarModelTaxTypeIDTires string = "Tires"

	// FilingCalendarModelTaxTypeIDEI captures enum value "EI"
	FilingCalendarModelTaxTypeIDEI string = "EI"

	// FilingCalendarModelTaxTypeIDAll captures enum value "All"
	FilingCalendarModelTaxTypeIDAll string = "All"

	// FilingCalendarModelTaxTypeIDBothSalesAndUseTax captures enum value "BothSalesAndUseTax"
	FilingCalendarModelTaxTypeIDBothSalesAndUseTax string = "BothSalesAndUseTax"

	// FilingCalendarModelTaxTypeIDConsumerUseTax captures enum value "ConsumerUseTax"
	FilingCalendarModelTaxTypeIDConsumerUseTax string = "ConsumerUseTax"

	// FilingCalendarModelTaxTypeIDConsumersUseAndSellersUseTax captures enum value "ConsumersUseAndSellersUseTax"
	FilingCalendarModelTaxTypeIDConsumersUseAndSellersUseTax string = "ConsumersUseAndSellersUseTax"

	// FilingCalendarModelTaxTypeIDConsumerUseAndSalesTax captures enum value "ConsumerUseAndSalesTax"
	FilingCalendarModelTaxTypeIDConsumerUseAndSalesTax string = "ConsumerUseAndSalesTax"

	// FilingCalendarModelTaxTypeIDFee captures enum value "Fee"
	FilingCalendarModelTaxTypeIDFee string = "Fee"

	// FilingCalendarModelTaxTypeIDVATInputTax captures enum value "VATInputTax"
	FilingCalendarModelTaxTypeIDVATInputTax string = "VATInputTax"

	// FilingCalendarModelTaxTypeIDLightBulbs captures enum value "LightBulbs"
	FilingCalendarModelTaxTypeIDLightBulbs string = "LightBulbs"

	// FilingCalendarModelTaxTypeIDMeals captures enum value "Meals"
	FilingCalendarModelTaxTypeIDMeals string = "Meals"

	// FilingCalendarModelTaxTypeIDVATNonrecoverableInputTax captures enum value "VATNonrecoverableInputTax"
	FilingCalendarModelTaxTypeIDVATNonrecoverableInputTax string = "VATNonrecoverableInputTax"

	// FilingCalendarModelTaxTypeIDVATOutputTax captures enum value "VATOutputTax"
	FilingCalendarModelTaxTypeIDVATOutputTax string = "VATOutputTax"

	// FilingCalendarModelTaxTypeIDPIF captures enum value "PIF"
	FilingCalendarModelTaxTypeIDPIF string = "PIF"

	// FilingCalendarModelTaxTypeIDRental captures enum value "Rental"
	FilingCalendarModelTaxTypeIDRental string = "Rental"

	// FilingCalendarModelTaxTypeIDSalesTax captures enum value "SalesTax"
	FilingCalendarModelTaxTypeIDSalesTax string = "SalesTax"

	// FilingCalendarModelTaxTypeIDUseTax captures enum value "UseTax"
	FilingCalendarModelTaxTypeIDUseTax string = "UseTax"

	// FilingCalendarModelTaxTypeIDEWaste captures enum value "EWaste"
	FilingCalendarModelTaxTypeIDEWaste string = "EWaste"

	// FilingCalendarModelTaxTypeIDBatteries captures enum value "Batteries"
	FilingCalendarModelTaxTypeIDBatteries string = "Batteries"
)
View Source 
const (

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

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

	// FilingModelTypeTest captures enum value "Test"
	FilingModelTypeTest string = "Test"
)
View Source 
const (

	// FilingPaymentModelTypeCurrentPeriod captures enum value "CurrentPeriod"
	FilingPaymentModelTypeCurrentPeriod string = "CurrentPeriod"

	// FilingPaymentModelTypePrepayment captures enum value "Prepayment"
	FilingPaymentModelTypePrepayment string = "Prepayment"

	// FilingPaymentModelTypePriorPayment captures enum value "PriorPayment"
	FilingPaymentModelTypePriorPayment string = "PriorPayment"

	// FilingPaymentModelTypePriorCspFee captures enum value "PriorCspFee"
	FilingPaymentModelTypePriorCspFee string = "PriorCspFee"
)
View Source 
const (

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// FilingRegionModelStatusApprovedToFileOnBehalf captures enum value "ApprovedToFileOnBehalf"
	FilingRegionModelStatusApprovedToFileOnBehalf string = "ApprovedToFileOnBehalf"
)
View Source 
const (

	// FilingRequestDataModelFilingFrequencyIDMonthly captures enum value "Monthly"
	FilingRequestDataModelFilingFrequencyIDMonthly string = "Monthly"

	// FilingRequestDataModelFilingFrequencyIDQuarterly captures enum value "Quarterly"
	FilingRequestDataModelFilingFrequencyIDQuarterly string = "Quarterly"

	// FilingRequestDataModelFilingFrequencyIDSemiAnnually captures enum value "SemiAnnually"
	FilingRequestDataModelFilingFrequencyIDSemiAnnually string = "SemiAnnually"

	// FilingRequestDataModelFilingFrequencyIDAnnually captures enum value "Annually"
	FilingRequestDataModelFilingFrequencyIDAnnually string = "Annually"

	// FilingRequestDataModelFilingFrequencyIDBimonthly captures enum value "Bimonthly"
	FilingRequestDataModelFilingFrequencyIDBimonthly string = "Bimonthly"

	// FilingRequestDataModelFilingFrequencyIDOccasional captures enum value "Occasional"
	FilingRequestDataModelFilingFrequencyIDOccasional string = "Occasional"

	// FilingRequestDataModelFilingFrequencyIDInverseQuarterly captures enum value "InverseQuarterly"
	FilingRequestDataModelFilingFrequencyIDInverseQuarterly string = "InverseQuarterly"

	// FilingRequestDataModelFilingFrequencyIDWeekly captures enum value "Weekly"
	FilingRequestDataModelFilingFrequencyIDWeekly string = "Weekly"
)
View Source 
const (

	// FilingRequestDataModelTaxTypeIDE captures enum value "E"
	FilingRequestDataModelTaxTypeIDE string = "E"

	// FilingRequestDataModelTaxTypeIDLodging captures enum value "Lodging"
	FilingRequestDataModelTaxTypeIDLodging string = "Lodging"

	// FilingRequestDataModelTaxTypeIDBottle captures enum value "Bottle"
	FilingRequestDataModelTaxTypeIDBottle string = "Bottle"

	// FilingRequestDataModelTaxTypeIDRentToOwn captures enum value "RentToOwn"
	FilingRequestDataModelTaxTypeIDRentToOwn string = "RentToOwn"

	// FilingRequestDataModelTaxTypeIDBikeTax captures enum value "BikeTax"
	FilingRequestDataModelTaxTypeIDBikeTax string = "BikeTax"

	// FilingRequestDataModelTaxTypeIDLandedCost captures enum value "LandedCost"
	FilingRequestDataModelTaxTypeIDLandedCost string = "LandedCost"

	// FilingRequestDataModelTaxTypeIDCheckoutBag captures enum value "CheckoutBag"
	FilingRequestDataModelTaxTypeIDCheckoutBag string = "CheckoutBag"

	// FilingRequestDataModelTaxTypeIDAlcohol captures enum value "Alcohol"
	FilingRequestDataModelTaxTypeIDAlcohol string = "Alcohol"

	// FilingRequestDataModelTaxTypeIDAmusement captures enum value "Amusement"
	FilingRequestDataModelTaxTypeIDAmusement string = "Amusement"

	// FilingRequestDataModelTaxTypeIDHospitality captures enum value "Hospitality"
	FilingRequestDataModelTaxTypeIDHospitality string = "Hospitality"

	// FilingRequestDataModelTaxTypeIDRentalLeasing captures enum value "RentalLeasing"
	FilingRequestDataModelTaxTypeIDRentalLeasing string = "RentalLeasing"

	// FilingRequestDataModelTaxTypeIDGrossReceipts captures enum value "GrossReceipts"
	FilingRequestDataModelTaxTypeIDGrossReceipts string = "GrossReceipts"

	// FilingRequestDataModelTaxTypeIDMattress captures enum value "Mattress"
	FilingRequestDataModelTaxTypeIDMattress string = "Mattress"

	// FilingRequestDataModelTaxTypeIDLumber captures enum value "Lumber"
	FilingRequestDataModelTaxTypeIDLumber string = "Lumber"

	// FilingRequestDataModelTaxTypeIDPaint captures enum value "Paint"
	FilingRequestDataModelTaxTypeIDPaint string = "Paint"

	// FilingRequestDataModelTaxTypeIDTires captures enum value "Tires"
	FilingRequestDataModelTaxTypeIDTires string = "Tires"

	// FilingRequestDataModelTaxTypeIDEI captures enum value "EI"
	FilingRequestDataModelTaxTypeIDEI string = "EI"

	// FilingRequestDataModelTaxTypeIDAll captures enum value "All"
	FilingRequestDataModelTaxTypeIDAll string = "All"

	// FilingRequestDataModelTaxTypeIDBothSalesAndUseTax captures enum value "BothSalesAndUseTax"
	FilingRequestDataModelTaxTypeIDBothSalesAndUseTax string = "BothSalesAndUseTax"

	// FilingRequestDataModelTaxTypeIDConsumerUseTax captures enum value "ConsumerUseTax"
	FilingRequestDataModelTaxTypeIDConsumerUseTax string = "ConsumerUseTax"

	// FilingRequestDataModelTaxTypeIDConsumersUseAndSellersUseTax captures enum value "ConsumersUseAndSellersUseTax"
	FilingRequestDataModelTaxTypeIDConsumersUseAndSellersUseTax string = "ConsumersUseAndSellersUseTax"

	// FilingRequestDataModelTaxTypeIDConsumerUseAndSalesTax captures enum value "ConsumerUseAndSalesTax"
	FilingRequestDataModelTaxTypeIDConsumerUseAndSalesTax string = "ConsumerUseAndSalesTax"

	// FilingRequestDataModelTaxTypeIDFee captures enum value "Fee"
	FilingRequestDataModelTaxTypeIDFee string = "Fee"

	// FilingRequestDataModelTaxTypeIDVATInputTax captures enum value "VATInputTax"
	FilingRequestDataModelTaxTypeIDVATInputTax string = "VATInputTax"

	// FilingRequestDataModelTaxTypeIDLightBulbs captures enum value "LightBulbs"
	FilingRequestDataModelTaxTypeIDLightBulbs string = "LightBulbs"

	// FilingRequestDataModelTaxTypeIDMeals captures enum value "Meals"
	FilingRequestDataModelTaxTypeIDMeals string = "Meals"

	// FilingRequestDataModelTaxTypeIDVATNonrecoverableInputTax captures enum value "VATNonrecoverableInputTax"
	FilingRequestDataModelTaxTypeIDVATNonrecoverableInputTax string = "VATNonrecoverableInputTax"

	// FilingRequestDataModelTaxTypeIDVATOutputTax captures enum value "VATOutputTax"
	FilingRequestDataModelTaxTypeIDVATOutputTax string = "VATOutputTax"

	// FilingRequestDataModelTaxTypeIDPIF captures enum value "PIF"
	FilingRequestDataModelTaxTypeIDPIF string = "PIF"

	// FilingRequestDataModelTaxTypeIDRental captures enum value "Rental"
	FilingRequestDataModelTaxTypeIDRental string = "Rental"

	// FilingRequestDataModelTaxTypeIDSalesTax captures enum value "SalesTax"
	FilingRequestDataModelTaxTypeIDSalesTax string = "SalesTax"

	// FilingRequestDataModelTaxTypeIDUseTax captures enum value "UseTax"
	FilingRequestDataModelTaxTypeIDUseTax string = "UseTax"

	// FilingRequestDataModelTaxTypeIDEWaste captures enum value "EWaste"
	FilingRequestDataModelTaxTypeIDEWaste string = "EWaste"

	// FilingRequestDataModelTaxTypeIDBatteries captures enum value "Batteries"
	FilingRequestDataModelTaxTypeIDBatteries string = "Batteries"
)
View Source 
const (

	// FilingRequestModelFilingRequestStatusIDNew captures enum value "New"
	FilingRequestModelFilingRequestStatusIDNew string = "New"

	// FilingRequestModelFilingRequestStatusIDValidated captures enum value "Validated"
	FilingRequestModelFilingRequestStatusIDValidated string = "Validated"

	// FilingRequestModelFilingRequestStatusIDPending captures enum value "Pending"
	FilingRequestModelFilingRequestStatusIDPending string = "Pending"

	// FilingRequestModelFilingRequestStatusIDActive captures enum value "Active"
	FilingRequestModelFilingRequestStatusIDActive string = "Active"

	// FilingRequestModelFilingRequestStatusIDPendingStop captures enum value "PendingStop"
	FilingRequestModelFilingRequestStatusIDPendingStop string = "PendingStop"

	// FilingRequestModelFilingRequestStatusIDInactive captures enum value "Inactive"
	FilingRequestModelFilingRequestStatusIDInactive string = "Inactive"

	// FilingRequestModelFilingRequestStatusIDChangeRequest captures enum value "ChangeRequest"
	FilingRequestModelFilingRequestStatusIDChangeRequest string = "ChangeRequest"

	// FilingRequestModelFilingRequestStatusIDRequestApproved captures enum value "RequestApproved"
	FilingRequestModelFilingRequestStatusIDRequestApproved string = "RequestApproved"

	// FilingRequestModelFilingRequestStatusIDRequestDenied captures enum value "RequestDenied"
	FilingRequestModelFilingRequestStatusIDRequestDenied string = "RequestDenied"
)
View Source 
const (

	// FilingReturnModelAccrualTypeFiling captures enum value "Filing"
	FilingReturnModelAccrualTypeFiling string = "Filing"

	// FilingReturnModelAccrualTypeAccrual captures enum value "Accrual"
	FilingReturnModelAccrualTypeAccrual string = "Accrual"
)
View Source 
const (

	// FilingReturnModelFilingFrequencyMonthly captures enum value "Monthly"
	FilingReturnModelFilingFrequencyMonthly string = "Monthly"

	// FilingReturnModelFilingFrequencyQuarterly captures enum value "Quarterly"
	FilingReturnModelFilingFrequencyQuarterly string = "Quarterly"

	// FilingReturnModelFilingFrequencySemiAnnually captures enum value "SemiAnnually"
	FilingReturnModelFilingFrequencySemiAnnually string = "SemiAnnually"

	// FilingReturnModelFilingFrequencyAnnually captures enum value "Annually"
	FilingReturnModelFilingFrequencyAnnually string = "Annually"

	// FilingReturnModelFilingFrequencyBimonthly captures enum value "Bimonthly"
	FilingReturnModelFilingFrequencyBimonthly string = "Bimonthly"

	// FilingReturnModelFilingFrequencyOccasional captures enum value "Occasional"
	FilingReturnModelFilingFrequencyOccasional string = "Occasional"

	// FilingReturnModelFilingFrequencyInverseQuarterly captures enum value "InverseQuarterly"
	FilingReturnModelFilingFrequencyInverseQuarterly string = "InverseQuarterly"

	// FilingReturnModelFilingFrequencyWeekly captures enum value "Weekly"
	FilingReturnModelFilingFrequencyWeekly string = "Weekly"
)
View Source 
const (

	// FilingReturnModelFilingTypePaperReturn captures enum value "PaperReturn"
	FilingReturnModelFilingTypePaperReturn string = "PaperReturn"

	// FilingReturnModelFilingTypeElectronicReturn captures enum value "ElectronicReturn"
	FilingReturnModelFilingTypeElectronicReturn string = "ElectronicReturn"

	// FilingReturnModelFilingTypeSER captures enum value "SER"
	FilingReturnModelFilingTypeSER string = "SER"

	// FilingReturnModelFilingTypeEFTPaper captures enum value "EFTPaper"
	FilingReturnModelFilingTypeEFTPaper string = "EFTPaper"

	// FilingReturnModelFilingTypePhonePaper captures enum value "PhonePaper"
	FilingReturnModelFilingTypePhonePaper string = "PhonePaper"

	// FilingReturnModelFilingTypeSignatureReady captures enum value "SignatureReady"
	FilingReturnModelFilingTypeSignatureReady string = "SignatureReady"

	// FilingReturnModelFilingTypeEfileCheck captures enum value "EfileCheck"
	FilingReturnModelFilingTypeEfileCheck string = "EfileCheck"
)
View Source 
const (

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// FilingReturnModelStatusApprovedToFileOnBehalf captures enum value "ApprovedToFileOnBehalf"
	FilingReturnModelStatusApprovedToFileOnBehalf string = "ApprovedToFileOnBehalf"
)
View Source 
const (

	// FilingReturnModelBasicAccrualTypeFiling captures enum value "Filing"
	FilingReturnModelBasicAccrualTypeFiling string = "Filing"

	// FilingReturnModelBasicAccrualTypeAccrual captures enum value "Accrual"
	FilingReturnModelBasicAccrualTypeAccrual string = "Accrual"
)
View Source 
const (

	// FilingReturnModelBasicFilingFrequencyMonthly captures enum value "Monthly"
	FilingReturnModelBasicFilingFrequencyMonthly string = "Monthly"

	// FilingReturnModelBasicFilingFrequencyQuarterly captures enum value "Quarterly"
	FilingReturnModelBasicFilingFrequencyQuarterly string = "Quarterly"

	// FilingReturnModelBasicFilingFrequencySemiAnnually captures enum value "SemiAnnually"
	FilingReturnModelBasicFilingFrequencySemiAnnually string = "SemiAnnually"

	// FilingReturnModelBasicFilingFrequencyAnnually captures enum value "Annually"
	FilingReturnModelBasicFilingFrequencyAnnually string = "Annually"

	// FilingReturnModelBasicFilingFrequencyBimonthly captures enum value "Bimonthly"
	FilingReturnModelBasicFilingFrequencyBimonthly string = "Bimonthly"

	// FilingReturnModelBasicFilingFrequencyOccasional captures enum value "Occasional"
	FilingReturnModelBasicFilingFrequencyOccasional string = "Occasional"

	// FilingReturnModelBasicFilingFrequencyInverseQuarterly captures enum value "InverseQuarterly"
	FilingReturnModelBasicFilingFrequencyInverseQuarterly string = "InverseQuarterly"

	// FilingReturnModelBasicFilingFrequencyWeekly captures enum value "Weekly"
	FilingReturnModelBasicFilingFrequencyWeekly string = "Weekly"
)
View Source 
const (

	// FilingReturnModelBasicFilingTypePaperReturn captures enum value "PaperReturn"
	FilingReturnModelBasicFilingTypePaperReturn string = "PaperReturn"

	// FilingReturnModelBasicFilingTypeElectronicReturn captures enum value "ElectronicReturn"
	FilingReturnModelBasicFilingTypeElectronicReturn string = "ElectronicReturn"

	// FilingReturnModelBasicFilingTypeSER captures enum value "SER"
	FilingReturnModelBasicFilingTypeSER string = "SER"

	// FilingReturnModelBasicFilingTypeEFTPaper captures enum value "EFTPaper"
	FilingReturnModelBasicFilingTypeEFTPaper string = "EFTPaper"

	// FilingReturnModelBasicFilingTypePhonePaper captures enum value "PhonePaper"
	FilingReturnModelBasicFilingTypePhonePaper string = "PhonePaper"

	// FilingReturnModelBasicFilingTypeSignatureReady captures enum value "SignatureReady"
	FilingReturnModelBasicFilingTypeSignatureReady string = "SignatureReady"

	// FilingReturnModelBasicFilingTypeEfileCheck captures enum value "EfileCheck"
	FilingReturnModelBasicFilingTypeEfileCheck string = "EfileCheck"
)
View Source 
const (

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// FilingReturnModelBasicStatusApprovedToFileOnBehalf captures enum value "ApprovedToFileOnBehalf"
	FilingReturnModelBasicStatusApprovedToFileOnBehalf string = "ApprovedToFileOnBehalf"
)
View Source 
const (

	// FilingStatusChangeModelRequestedStatusNotConfiguredForCompliance captures enum value "NotConfiguredForCompliance"
	FilingStatusChangeModelRequestedStatusNotConfiguredForCompliance string = "NotConfiguredForCompliance"

	// FilingStatusChangeModelRequestedStatusNotYetFiling captures enum value "NotYetFiling"
	FilingStatusChangeModelRequestedStatusNotYetFiling string = "NotYetFiling"

	// FilingStatusChangeModelRequestedStatusFilingRequested captures enum value "FilingRequested"
	FilingStatusChangeModelRequestedStatusFilingRequested string = "FilingRequested"

	// FilingStatusChangeModelRequestedStatusFirstFiling captures enum value "FirstFiling"
	FilingStatusChangeModelRequestedStatusFirstFiling string = "FirstFiling"

	// FilingStatusChangeModelRequestedStatusActive captures enum value "Active"
	FilingStatusChangeModelRequestedStatusActive string = "Active"

	// FilingStatusChangeModelRequestedStatusNoReporting captures enum value "NoReporting"
	FilingStatusChangeModelRequestedStatusNoReporting string = "NoReporting"

	// FilingStatusChangeModelRequestedStatusInactive captures enum value "Inactive"
	FilingStatusChangeModelRequestedStatusInactive string = "Inactive"
)
View Source 
const (

	// FirmClientLinkageOutputModelStatusRequested captures enum value "Requested"
	FirmClientLinkageOutputModelStatusRequested string = "Requested"

	// FirmClientLinkageOutputModelStatusApproved captures enum value "Approved"
	FirmClientLinkageOutputModelStatusApproved string = "Approved"

	// FirmClientLinkageOutputModelStatusRejected captures enum value "Rejected"
	FirmClientLinkageOutputModelStatusRejected string = "Rejected"

	// FirmClientLinkageOutputModelStatusRevoked captures enum value "Revoked"
	FirmClientLinkageOutputModelStatusRevoked string = "Revoked"
)
View Source 
const (

	// JurisdictionModelTypeCountry captures enum value "Country"
	JurisdictionModelTypeCountry string = "Country"

	// JurisdictionModelTypeState captures enum value "State"
	JurisdictionModelTypeState string = "State"

	// JurisdictionModelTypeCounty captures enum value "County"
	JurisdictionModelTypeCounty string = "County"

	// JurisdictionModelTypeCity captures enum value "City"
	JurisdictionModelTypeCity string = "City"

	// JurisdictionModelTypeSpecial captures enum value "Special"
	JurisdictionModelTypeSpecial string = "Special"
)
View Source 
const (

	// JurisdictionOverrideModelBoundaryLevelAddress captures enum value "Address"
	JurisdictionOverrideModelBoundaryLevelAddress string = "Address"

	// JurisdictionOverrideModelBoundaryLevelZip9 captures enum value "Zip9"
	JurisdictionOverrideModelBoundaryLevelZip9 string = "Zip9"

	// JurisdictionOverrideModelBoundaryLevelZip5 captures enum value "Zip5"
	JurisdictionOverrideModelBoundaryLevelZip5 string = "Zip5"
)
View Source 
const (

	// LineItemModelMarketplaceLiabilityTypeMarketplace captures enum value "Marketplace"
	LineItemModelMarketplaceLiabilityTypeMarketplace string = "Marketplace"

	// LineItemModelMarketplaceLiabilityTypeSeller captures enum value "Seller"
	LineItemModelMarketplaceLiabilityTypeSeller string = "Seller"
)
View Source 
const (

	// LocationModelAddressCategoryIDStorefront captures enum value "Storefront"
	LocationModelAddressCategoryIDStorefront string = "Storefront"

	// LocationModelAddressCategoryIDMainOffice captures enum value "MainOffice"
	LocationModelAddressCategoryIDMainOffice string = "MainOffice"

	// LocationModelAddressCategoryIDWarehouse captures enum value "Warehouse"
	LocationModelAddressCategoryIDWarehouse string = "Warehouse"

	// LocationModelAddressCategoryIDSalesperson captures enum value "Salesperson"
	LocationModelAddressCategoryIDSalesperson string = "Salesperson"

	// LocationModelAddressCategoryIDOther captures enum value "Other"
	LocationModelAddressCategoryIDOther string = "Other"

	// LocationModelAddressCategoryIDSellerRemitsTax captures enum value "SellerRemitsTax"
	LocationModelAddressCategoryIDSellerRemitsTax string = "SellerRemitsTax"

	// LocationModelAddressCategoryIDMarketplaceRemitsTax captures enum value "MarketplaceRemitsTax"
	LocationModelAddressCategoryIDMarketplaceRemitsTax string = "MarketplaceRemitsTax"

	// LocationModelAddressCategoryIDNonPhysical captures enum value "NonPhysical"
	LocationModelAddressCategoryIDNonPhysical string = "NonPhysical"
)
View Source 
const (

	// LocationModelAddressTypeIDLocation captures enum value "Location"
	LocationModelAddressTypeIDLocation string = "Location"

	// LocationModelAddressTypeIDSalesperson captures enum value "Salesperson"
	LocationModelAddressTypeIDSalesperson string = "Salesperson"

	// LocationModelAddressTypeIDMarketplace captures enum value "Marketplace"
	LocationModelAddressTypeIDMarketplace string = "Marketplace"
)
View Source 
const (

	// LocationQuestionModelJurisdictionTypeCountry captures enum value "Country"
	LocationQuestionModelJurisdictionTypeCountry string = "Country"

	// LocationQuestionModelJurisdictionTypeState captures enum value "State"
	LocationQuestionModelJurisdictionTypeState string = "State"

	// LocationQuestionModelJurisdictionTypeCounty captures enum value "County"
	LocationQuestionModelJurisdictionTypeCounty string = "County"

	// LocationQuestionModelJurisdictionTypeCity captures enum value "City"
	LocationQuestionModelJurisdictionTypeCity string = "City"

	// LocationQuestionModelJurisdictionTypeSpecial captures enum value "Special"
	LocationQuestionModelJurisdictionTypeSpecial string = "Special"
)
View Source 
const (

	// MessageSeveritySuccess captures enum value "Success"
	MessageSeveritySuccess string = "Success"

	// MessageSeverityWarning captures enum value "Warning"
	MessageSeverityWarning string = "Warning"

	// MessageSeverityError captures enum value "Error"
	MessageSeverityError string = "Error"

	// MessageSeverityException captures enum value "Exception"
	MessageSeverityException string = "Exception"
)
View Source 
const (

	// MultiDocumentLineItemModelMarketplaceLiabilityTypeMarketplace captures enum value "Marketplace"
	MultiDocumentLineItemModelMarketplaceLiabilityTypeMarketplace string = "Marketplace"

	// MultiDocumentLineItemModelMarketplaceLiabilityTypeSeller captures enum value "Seller"
	MultiDocumentLineItemModelMarketplaceLiabilityTypeSeller string = "Seller"
)
View Source 
const (

	// MultiDocumentModelTypeSalesOrder captures enum value "SalesOrder"
	MultiDocumentModelTypeSalesOrder string = "SalesOrder"

	// MultiDocumentModelTypeSalesInvoice captures enum value "SalesInvoice"
	MultiDocumentModelTypeSalesInvoice string = "SalesInvoice"

	// MultiDocumentModelTypePurchaseOrder captures enum value "PurchaseOrder"
	MultiDocumentModelTypePurchaseOrder string = "PurchaseOrder"

	// MultiDocumentModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	MultiDocumentModelTypePurchaseInvoice string = "PurchaseInvoice"

	// MultiDocumentModelTypeReturnOrder captures enum value "ReturnOrder"
	MultiDocumentModelTypeReturnOrder string = "ReturnOrder"

	// MultiDocumentModelTypeReturnInvoice captures enum value "ReturnInvoice"
	MultiDocumentModelTypeReturnInvoice string = "ReturnInvoice"

	// MultiDocumentModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	MultiDocumentModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// MultiDocumentModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	MultiDocumentModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// MultiDocumentModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	MultiDocumentModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// MultiDocumentModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	MultiDocumentModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// MultiDocumentModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	MultiDocumentModelTypeCustomsInvoice string = "CustomsInvoice"

	// MultiDocumentModelTypeCustomsOrder captures enum value "CustomsOrder"
	MultiDocumentModelTypeCustomsOrder string = "CustomsOrder"

	// MultiDocumentModelTypeAny captures enum value "Any"
	MultiDocumentModelTypeAny string = "Any"
)
View Source 
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"
)
View Source 
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"
)
View Source 
const (

	// MultiTaxFilingReturnModelAccrualTypeFiling captures enum value "Filing"
	MultiTaxFilingReturnModelAccrualTypeFiling string = "Filing"

	// MultiTaxFilingReturnModelAccrualTypeAccrual captures enum value "Accrual"
	MultiTaxFilingReturnModelAccrualTypeAccrual string = "Accrual"
)
View Source 
const (

	// MultiTaxFilingReturnModelFilingFrequencyMonthly captures enum value "Monthly"
	MultiTaxFilingReturnModelFilingFrequencyMonthly string = "Monthly"

	// MultiTaxFilingReturnModelFilingFrequencyQuarterly captures enum value "Quarterly"
	MultiTaxFilingReturnModelFilingFrequencyQuarterly string = "Quarterly"

	// MultiTaxFilingReturnModelFilingFrequencySemiAnnually captures enum value "SemiAnnually"
	MultiTaxFilingReturnModelFilingFrequencySemiAnnually string = "SemiAnnually"

	// MultiTaxFilingReturnModelFilingFrequencyAnnually captures enum value "Annually"
	MultiTaxFilingReturnModelFilingFrequencyAnnually string = "Annually"

	// MultiTaxFilingReturnModelFilingFrequencyBimonthly captures enum value "Bimonthly"
	MultiTaxFilingReturnModelFilingFrequencyBimonthly string = "Bimonthly"

	// MultiTaxFilingReturnModelFilingFrequencyOccasional captures enum value "Occasional"
	MultiTaxFilingReturnModelFilingFrequencyOccasional string = "Occasional"

	// MultiTaxFilingReturnModelFilingFrequencyInverseQuarterly captures enum value "InverseQuarterly"
	MultiTaxFilingReturnModelFilingFrequencyInverseQuarterly string = "InverseQuarterly"

	// MultiTaxFilingReturnModelFilingFrequencyWeekly captures enum value "Weekly"
	MultiTaxFilingReturnModelFilingFrequencyWeekly string = "Weekly"
)
View Source 
const (

	// MultiTaxFilingReturnModelFilingTypePaperReturn captures enum value "PaperReturn"
	MultiTaxFilingReturnModelFilingTypePaperReturn string = "PaperReturn"

	// MultiTaxFilingReturnModelFilingTypeElectronicReturn captures enum value "ElectronicReturn"
	MultiTaxFilingReturnModelFilingTypeElectronicReturn string = "ElectronicReturn"

	// MultiTaxFilingReturnModelFilingTypeSER captures enum value "SER"
	MultiTaxFilingReturnModelFilingTypeSER string = "SER"

	// MultiTaxFilingReturnModelFilingTypeEFTPaper captures enum value "EFTPaper"
	MultiTaxFilingReturnModelFilingTypeEFTPaper string = "EFTPaper"

	// MultiTaxFilingReturnModelFilingTypePhonePaper captures enum value "PhonePaper"
	MultiTaxFilingReturnModelFilingTypePhonePaper string = "PhonePaper"

	// MultiTaxFilingReturnModelFilingTypeSignatureReady captures enum value "SignatureReady"
	MultiTaxFilingReturnModelFilingTypeSignatureReady string = "SignatureReady"

	// MultiTaxFilingReturnModelFilingTypeEfileCheck captures enum value "EfileCheck"
	MultiTaxFilingReturnModelFilingTypeEfileCheck string = "EfileCheck"
)
View Source 
const (

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// MultiTaxFilingReturnModelStatusApprovedToFileOnBehalf captures enum value "ApprovedToFileOnBehalf"
	MultiTaxFilingReturnModelStatusApprovedToFileOnBehalf string = "ApprovedToFileOnBehalf"
)
View Source 
const (

	// NewAccountRequestModelAccountTypeRegular captures enum value "Regular"
	NewAccountRequestModelAccountTypeRegular string = "Regular"

	// NewAccountRequestModelAccountTypeFirm captures enum value "Firm"
	NewAccountRequestModelAccountTypeFirm string = "Firm"

	// NewAccountRequestModelAccountTypeFirmClient captures enum value "FirmClient"
	NewAccountRequestModelAccountTypeFirmClient string = "FirmClient"
)
View Source 
const (

	// NexusModelJurisTypeIDSTA captures enum value "STA"
	NexusModelJurisTypeIDSTA string = "STA"

	// NexusModelJurisTypeIDCTY captures enum value "CTY"
	NexusModelJurisTypeIDCTY string = "CTY"

	// NexusModelJurisTypeIDCIT captures enum value "CIT"
	NexusModelJurisTypeIDCIT string = "CIT"

	// NexusModelJurisTypeIDSTJ captures enum value "STJ"
	NexusModelJurisTypeIDSTJ string = "STJ"

	// NexusModelJurisTypeIDCNT captures enum value "CNT"
	NexusModelJurisTypeIDCNT string = "CNT"
)
View Source 
const (

	// NexusModelJurisdictionTypeIDCountry captures enum value "Country"
	NexusModelJurisdictionTypeIDCountry string = "Country"

	// NexusModelJurisdictionTypeIDState captures enum value "State"
	NexusModelJurisdictionTypeIDState string = "State"

	// NexusModelJurisdictionTypeIDCounty captures enum value "County"
	NexusModelJurisdictionTypeIDCounty string = "County"

	// NexusModelJurisdictionTypeIDCity captures enum value "City"
	NexusModelJurisdictionTypeIDCity string = "City"

	// NexusModelJurisdictionTypeIDSpecial captures enum value "Special"
	NexusModelJurisdictionTypeIDSpecial string = "Special"
)
View Source 
const (

	// NexusModelLocalNexusTypeIDSelected captures enum value "Selected"
	NexusModelLocalNexusTypeIDSelected string = "Selected"

	// NexusModelLocalNexusTypeIDStateAdministered captures enum value "StateAdministered"
	NexusModelLocalNexusTypeIDStateAdministered string = "StateAdministered"

	// NexusModelLocalNexusTypeIDAll captures enum value "All"
	NexusModelLocalNexusTypeIDAll string = "All"
)
View Source 
const (

	// NexusModelNexusTypeIDNone captures enum value "None"
	NexusModelNexusTypeIDNone string = "None"

	// NexusModelNexusTypeIDSalesOrSellersUseTax captures enum value "SalesOrSellersUseTax"
	NexusModelNexusTypeIDSalesOrSellersUseTax string = "SalesOrSellersUseTax"

	// NexusModelNexusTypeIDSalesTax captures enum value "SalesTax"
	NexusModelNexusTypeIDSalesTax string = "SalesTax"

	// NexusModelNexusTypeIDSSTVolunteer captures enum value "SSTVolunteer"
	NexusModelNexusTypeIDSSTVolunteer string = "SSTVolunteer"

	// NexusModelNexusTypeIDSSTNonVolunteer captures enum value "SSTNonVolunteer"
	NexusModelNexusTypeIDSSTNonVolunteer string = "SSTNonVolunteer"
)
View Source 
const (

	// NexusModelSourcingMixed captures enum value "Mixed"
	NexusModelSourcingMixed string = "Mixed"

	// NexusModelSourcingDestination captures enum value "Destination"
	NexusModelSourcingDestination string = "Destination"

	// NexusModelSourcingOrigin captures enum value "Origin"
	NexusModelSourcingOrigin string = "Origin"
)
View Source 
const (

	// NoticeCommentModelCommentTypeInternal captures enum value "Internal"
	NoticeCommentModelCommentTypeInternal string = "Internal"

	// NoticeCommentModelCommentTypeCustomer captures enum value "Customer"
	NoticeCommentModelCommentTypeCustomer string = "Customer"

	// NoticeCommentModelCommentTypePOAAttachment captures enum value "POAAttachment"
	NoticeCommentModelCommentTypePOAAttachment string = "POAAttachment"

	// NoticeCommentModelCommentTypeNoticeVoucher captures enum value "NoticeVoucher"
	NoticeCommentModelCommentTypeNoticeVoucher string = "NoticeVoucher"
)
View Source 
const (

	// NoticeModelCustomerFundingOptionIDPull captures enum value "Pull"
	NoticeModelCustomerFundingOptionIDPull string = "Pull"

	// NoticeModelCustomerFundingOptionIDWire captures enum value "Wire"
	NoticeModelCustomerFundingOptionIDWire string = "Wire"
)
View Source 
const (

	// NoticeModelCustomerTypeIDAvaTaxReturns captures enum value "AvaTaxReturns"
	NoticeModelCustomerTypeIDAvaTaxReturns string = "AvaTaxReturns"

	// NoticeModelCustomerTypeIDStandAlone captures enum value "StandAlone"
	NoticeModelCustomerTypeIDStandAlone string = "StandAlone"

	// NoticeModelCustomerTypeIDStrategic captures enum value "Strategic"
	NoticeModelCustomerTypeIDStrategic string = "Strategic"

	// NoticeModelCustomerTypeIDSST captures enum value "SST"
	NoticeModelCustomerTypeIDSST string = "SST"

	// NoticeModelCustomerTypeIDTrustFile captures enum value "TrustFile"
	NoticeModelCustomerTypeIDTrustFile string = "TrustFile"

	// NoticeModelCustomerTypeIDPWC captures enum value "PWC"
	NoticeModelCustomerTypeIDPWC string = "PWC"

	// NoticeModelCustomerTypeIDHudsonGroup captures enum value "HudsonGroup"
	NoticeModelCustomerTypeIDHudsonGroup string = "HudsonGroup"

	// NoticeModelCustomerTypeIDMRA captures enum value "MRA"
	NoticeModelCustomerTypeIDMRA string = "MRA"

	// NoticeModelCustomerTypeIDNone captures enum value "None"
	NoticeModelCustomerTypeIDNone string = "None"
)
View Source 
const (

	// NoticeModelFilingFrequencyMonthly captures enum value "Monthly"
	NoticeModelFilingFrequencyMonthly string = "Monthly"

	// NoticeModelFilingFrequencyQuarterly captures enum value "Quarterly"
	NoticeModelFilingFrequencyQuarterly string = "Quarterly"

	// NoticeModelFilingFrequencySemiAnnually captures enum value "SemiAnnually"
	NoticeModelFilingFrequencySemiAnnually string = "SemiAnnually"

	// NoticeModelFilingFrequencyAnnually captures enum value "Annually"
	NoticeModelFilingFrequencyAnnually string = "Annually"

	// NoticeModelFilingFrequencyBimonthly captures enum value "Bimonthly"
	NoticeModelFilingFrequencyBimonthly string = "Bimonthly"

	// NoticeModelFilingFrequencyOccasional captures enum value "Occasional"
	NoticeModelFilingFrequencyOccasional string = "Occasional"

	// NoticeModelFilingFrequencyInverseQuarterly captures enum value "InverseQuarterly"
	NoticeModelFilingFrequencyInverseQuarterly string = "InverseQuarterly"

	// NoticeModelFilingFrequencyWeekly captures enum value "Weekly"
	NoticeModelFilingFrequencyWeekly string = "Weekly"
)
View Source 
const (

	// NoticeModelFilingTypeIDElectronicReturn captures enum value "ElectronicReturn"
	NoticeModelFilingTypeIDElectronicReturn string = "ElectronicReturn"

	// NoticeModelFilingTypeIDPaperReturn captures enum value "PaperReturn"
	NoticeModelFilingTypeIDPaperReturn string = "PaperReturn"

	// NoticeModelFilingTypeIDReturnNotFiled captures enum value "ReturnNotFiled"
	NoticeModelFilingTypeIDReturnNotFiled string = "ReturnNotFiled"

	// NoticeModelFilingTypeIDEFTPaper captures enum value "EFTPaper"
	NoticeModelFilingTypeIDEFTPaper string = "EFTPaper"

	// NoticeModelFilingTypeIDSER captures enum value "SER"
	NoticeModelFilingTypeIDSER string = "SER"

	// NoticeModelFilingTypeIDTrustfileEdi captures enum value "TrustfileEdi"
	NoticeModelFilingTypeIDTrustfileEdi string = "TrustfileEdi"

	// NoticeModelFilingTypeIDUploadFile captures enum value "UploadFile"
	NoticeModelFilingTypeIDUploadFile string = "UploadFile"

	// NoticeModelFilingTypeIDPaperManual captures enum value "PaperManual"
	NoticeModelFilingTypeIDPaperManual string = "PaperManual"

	// NoticeModelFilingTypeIDCertCapture captures enum value "CertCapture"
	NoticeModelFilingTypeIDCertCapture string = "CertCapture"

	// NoticeModelFilingTypeIDSignatureReady captures enum value "SignatureReady"
	NoticeModelFilingTypeIDSignatureReady string = "SignatureReady"
)
View Source 
const (

	// NoticeModelPriorityIDImmediateAttentionRequired captures enum value "ImmediateAttentionRequired"
	NoticeModelPriorityIDImmediateAttentionRequired string = "ImmediateAttentionRequired"

	// NoticeModelPriorityIDHigh captures enum value "High"
	NoticeModelPriorityIDHigh string = "High"

	// NoticeModelPriorityIDNormal captures enum value "Normal"
	NoticeModelPriorityIDNormal string = "Normal"

	// NoticeModelPriorityIDLow captures enum value "Low"
	NoticeModelPriorityIDLow string = "Low"
)
View Source 
const (

	// NotificationModelSeverityLevelIDNeutral captures enum value "Neutral"
	NotificationModelSeverityLevelIDNeutral string = "Neutral"

	// NotificationModelSeverityLevelIDAdvisory captures enum value "Advisory"
	NotificationModelSeverityLevelIDAdvisory string = "Advisory"

	// NotificationModelSeverityLevelIDBlocking captures enum value "Blocking"
	NotificationModelSeverityLevelIDBlocking string = "Blocking"

	// NotificationModelSeverityLevelIDComplete captures enum value "Complete"
	NotificationModelSeverityLevelIDComplete string = "Complete"
)
View Source 
const (

	// PingResultModelAuthenticationTypeNone captures enum value "None"
	PingResultModelAuthenticationTypeNone string = "None"

	// PingResultModelAuthenticationTypeUsernamePassword captures enum value "UsernamePassword"
	PingResultModelAuthenticationTypeUsernamePassword string = "UsernamePassword"

	// PingResultModelAuthenticationTypeAccountIDLicenseKey captures enum value "AccountIdLicenseKey"
	PingResultModelAuthenticationTypeAccountIDLicenseKey string = "AccountIdLicenseKey"

	// PingResultModelAuthenticationTypeOpenIDBearerToken captures enum value "OpenIdBearerToken"
	PingResultModelAuthenticationTypeOpenIDBearerToken string = "OpenIdBearerToken"
)
View Source 
const (

	// PointOfSaleDataRequestModelPartnerIDDMA captures enum value "DMA"
	PointOfSaleDataRequestModelPartnerIDDMA string = "DMA"

	// PointOfSaleDataRequestModelPartnerIDAX7 captures enum value "AX7"
	PointOfSaleDataRequestModelPartnerIDAX7 string = "AX7"
)
View Source 
const (

	// PointOfSaleDataRequestModelResponseTypeJSON captures enum value "Json"
	PointOfSaleDataRequestModelResponseTypeJSON string = "Json"

	// PointOfSaleDataRequestModelResponseTypeCsv captures enum value "Csv"
	PointOfSaleDataRequestModelResponseTypeCsv string = "Csv"

	// PointOfSaleDataRequestModelResponseTypeXML captures enum value "Xml"
	PointOfSaleDataRequestModelResponseTypeXML string = "Xml"
)
View Source 
const (

	// ProvisionStatusModelStatusProvisioned captures enum value "Provisioned"
	ProvisionStatusModelStatusProvisioned string = "Provisioned"

	// ProvisionStatusModelStatusInProgress captures enum value "InProgress"
	ProvisionStatusModelStatusInProgress string = "InProgress"

	// ProvisionStatusModelStatusNotProvisioned captures enum value "NotProvisioned"
	ProvisionStatusModelStatusNotProvisioned string = "NotProvisioned"
)
View Source 
const (

	// RateModelTypeCountry captures enum value "Country"
	RateModelTypeCountry string = "Country"

	// RateModelTypeState captures enum value "State"
	RateModelTypeState string = "State"

	// RateModelTypeCounty captures enum value "County"
	RateModelTypeCounty string = "County"

	// RateModelTypeCity captures enum value "City"
	RateModelTypeCity string = "City"

	// RateModelTypeSpecial captures enum value "Special"
	RateModelTypeSpecial string = "Special"
)
View Source 
const (

	// RefundTransactionModelRefundTypeFull captures enum value "Full"
	RefundTransactionModelRefundTypeFull string = "Full"

	// RefundTransactionModelRefundTypePartial captures enum value "Partial"
	RefundTransactionModelRefundTypePartial string = "Partial"

	// RefundTransactionModelRefundTypeTaxOnly captures enum value "TaxOnly"
	RefundTransactionModelRefundTypeTaxOnly string = "TaxOnly"

	// RefundTransactionModelRefundTypePercentage captures enum value "Percentage"
	RefundTransactionModelRefundTypePercentage string = "Percentage"
)
View Source 
const (

	// RemoveTransactionLineModelDocumentTypeSalesOrder captures enum value "SalesOrder"
	RemoveTransactionLineModelDocumentTypeSalesOrder string = "SalesOrder"

	// RemoveTransactionLineModelDocumentTypeSalesInvoice captures enum value "SalesInvoice"
	RemoveTransactionLineModelDocumentTypeSalesInvoice string = "SalesInvoice"

	// RemoveTransactionLineModelDocumentTypePurchaseOrder captures enum value "PurchaseOrder"
	RemoveTransactionLineModelDocumentTypePurchaseOrder string = "PurchaseOrder"

	// RemoveTransactionLineModelDocumentTypePurchaseInvoice captures enum value "PurchaseInvoice"
	RemoveTransactionLineModelDocumentTypePurchaseInvoice string = "PurchaseInvoice"

	// RemoveTransactionLineModelDocumentTypeReturnOrder captures enum value "ReturnOrder"
	RemoveTransactionLineModelDocumentTypeReturnOrder string = "ReturnOrder"

	// RemoveTransactionLineModelDocumentTypeReturnInvoice captures enum value "ReturnInvoice"
	RemoveTransactionLineModelDocumentTypeReturnInvoice string = "ReturnInvoice"

	// RemoveTransactionLineModelDocumentTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	RemoveTransactionLineModelDocumentTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// RemoveTransactionLineModelDocumentTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	RemoveTransactionLineModelDocumentTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// RemoveTransactionLineModelDocumentTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	RemoveTransactionLineModelDocumentTypeReverseChargeOrder string = "ReverseChargeOrder"

	// RemoveTransactionLineModelDocumentTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	RemoveTransactionLineModelDocumentTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// RemoveTransactionLineModelDocumentTypeCustomsInvoice captures enum value "CustomsInvoice"
	RemoveTransactionLineModelDocumentTypeCustomsInvoice string = "CustomsInvoice"

	// RemoveTransactionLineModelDocumentTypeCustomsOrder captures enum value "CustomsOrder"
	RemoveTransactionLineModelDocumentTypeCustomsOrder string = "CustomsOrder"

	// RemoveTransactionLineModelDocumentTypeAny captures enum value "Any"
	RemoveTransactionLineModelDocumentTypeAny string = "Any"
)
View Source 
const (

	// SendSalesRequestModelFormatSTANDARD captures enum value "STANDARD"
	SendSalesRequestModelFormatSTANDARD string = "STANDARD"

	// SendSalesRequestModelFormatDMA captures enum value "DMA"
	SendSalesRequestModelFormatDMA string = "DMA"

	// SendSalesRequestModelFormatDMANEW captures enum value "DMA_NEW"
	SendSalesRequestModelFormatDMANEW string = "DMA_NEW"
)
View Source 
const (

	// SendSalesRequestModelTypeCsv captures enum value "Csv"
	SendSalesRequestModelTypeCsv string = "Csv"

	// SendSalesRequestModelTypeJSON captures enum value "Json"
	SendSalesRequestModelTypeJSON string = "Json"
)
View Source 
const (

	// SkyscraperStatusModelScraperTypeLogin captures enum value "Login"
	SkyscraperStatusModelScraperTypeLogin string = "Login"

	// SkyscraperStatusModelScraperTypeCustomerDorData captures enum value "CustomerDorData"
	SkyscraperStatusModelScraperTypeCustomerDorData string = "CustomerDorData"
)
View Source 
const (

	// TaxAuthorityInfoJurisdictionTypeCountry captures enum value "Country"
	TaxAuthorityInfoJurisdictionTypeCountry string = "Country"

	// TaxAuthorityInfoJurisdictionTypeState captures enum value "State"
	TaxAuthorityInfoJurisdictionTypeState string = "State"

	// TaxAuthorityInfoJurisdictionTypeCounty captures enum value "County"
	TaxAuthorityInfoJurisdictionTypeCounty string = "County"

	// TaxAuthorityInfoJurisdictionTypeCity captures enum value "City"
	TaxAuthorityInfoJurisdictionTypeCity string = "City"

	// TaxAuthorityInfoJurisdictionTypeSpecial captures enum value "Special"
	TaxAuthorityInfoJurisdictionTypeSpecial string = "Special"
)
View Source 
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"
)
View Source 
const (

	// TaxRuleModelJurisTypeIDSTA captures enum value "STA"
	TaxRuleModelJurisTypeIDSTA string = "STA"

	// TaxRuleModelJurisTypeIDCTY captures enum value "CTY"
	TaxRuleModelJurisTypeIDCTY string = "CTY"

	// TaxRuleModelJurisTypeIDCIT captures enum value "CIT"
	TaxRuleModelJurisTypeIDCIT string = "CIT"

	// TaxRuleModelJurisTypeIDSTJ captures enum value "STJ"
	TaxRuleModelJurisTypeIDSTJ string = "STJ"

	// TaxRuleModelJurisTypeIDCNT captures enum value "CNT"
	TaxRuleModelJurisTypeIDCNT string = "CNT"
)
View Source 
const (

	// TaxRuleModelJurisdictionTypeIDCountry captures enum value "Country"
	TaxRuleModelJurisdictionTypeIDCountry string = "Country"

	// TaxRuleModelJurisdictionTypeIDState captures enum value "State"
	TaxRuleModelJurisdictionTypeIDState string = "State"

	// TaxRuleModelJurisdictionTypeIDCounty captures enum value "County"
	TaxRuleModelJurisdictionTypeIDCounty string = "County"

	// TaxRuleModelJurisdictionTypeIDCity captures enum value "City"
	TaxRuleModelJurisdictionTypeIDCity string = "City"

	// TaxRuleModelJurisdictionTypeIDSpecial captures enum value "Special"
	TaxRuleModelJurisdictionTypeIDSpecial string = "Special"
)
View Source 
const (

	// TaxRuleModelRateTypeIDReducedA captures enum value "ReducedA"
	TaxRuleModelRateTypeIDReducedA string = "ReducedA"

	// TaxRuleModelRateTypeIDReducedB captures enum value "ReducedB"
	TaxRuleModelRateTypeIDReducedB string = "ReducedB"

	// TaxRuleModelRateTypeIDFood captures enum value "Food"
	TaxRuleModelRateTypeIDFood string = "Food"

	// TaxRuleModelRateTypeIDGeneral captures enum value "General"
	TaxRuleModelRateTypeIDGeneral string = "General"

	// TaxRuleModelRateTypeIDIncreasedStandard captures enum value "IncreasedStandard"
	TaxRuleModelRateTypeIDIncreasedStandard string = "IncreasedStandard"

	// TaxRuleModelRateTypeIDLinenRental captures enum value "LinenRental"
	TaxRuleModelRateTypeIDLinenRental string = "LinenRental"

	// TaxRuleModelRateTypeIDMedical captures enum value "Medical"
	TaxRuleModelRateTypeIDMedical string = "Medical"

	// TaxRuleModelRateTypeIDConstruction captures enum value "Construction"
	TaxRuleModelRateTypeIDConstruction string = "Construction"

	// TaxRuleModelRateTypeIDParking captures enum value "Parking"
	TaxRuleModelRateTypeIDParking string = "Parking"

	// TaxRuleModelRateTypeIDSuperReduced captures enum value "SuperReduced"
	TaxRuleModelRateTypeIDSuperReduced string = "SuperReduced"

	// TaxRuleModelRateTypeIDReducedR captures enum value "ReducedR"
	TaxRuleModelRateTypeIDReducedR string = "ReducedR"

	// TaxRuleModelRateTypeIDStandard captures enum value "Standard"
	TaxRuleModelRateTypeIDStandard string = "Standard"

	// TaxRuleModelRateTypeIDLeasing captures enum value "Leasing"
	TaxRuleModelRateTypeIDLeasing string = "Leasing"

	// TaxRuleModelRateTypeIDLeasingLow captures enum value "LeasingLow"
	TaxRuleModelRateTypeIDLeasingLow string = "LeasingLow"

	// TaxRuleModelRateTypeIDServices captures enum value "Services"
	TaxRuleModelRateTypeIDServices string = "Services"

	// TaxRuleModelRateTypeIDZero captures enum value "Zero"
	TaxRuleModelRateTypeIDZero string = "Zero"
)
View Source 
const (

	// TaxRuleModelSourcingMixed captures enum value "Mixed"
	TaxRuleModelSourcingMixed string = "Mixed"

	// TaxRuleModelSourcingDestination captures enum value "Destination"
	TaxRuleModelSourcingDestination string = "Destination"

	// TaxRuleModelSourcingOrigin captures enum value "Origin"
	TaxRuleModelSourcingOrigin string = "Origin"
)
View Source 
const (

	// TaxRuleModelTaxRuleTypeIDRateRule captures enum value "RateRule"
	TaxRuleModelTaxRuleTypeIDRateRule string = "RateRule"

	// TaxRuleModelTaxRuleTypeIDRateOverrideRule captures enum value "RateOverrideRule"
	TaxRuleModelTaxRuleTypeIDRateOverrideRule string = "RateOverrideRule"

	// TaxRuleModelTaxRuleTypeIDBaseRule captures enum value "BaseRule"
	TaxRuleModelTaxRuleTypeIDBaseRule string = "BaseRule"

	// TaxRuleModelTaxRuleTypeIDExemptEntityRule captures enum value "ExemptEntityRule"
	TaxRuleModelTaxRuleTypeIDExemptEntityRule string = "ExemptEntityRule"

	// TaxRuleModelTaxRuleTypeIDProductTaxabilityRule captures enum value "ProductTaxabilityRule"
	TaxRuleModelTaxRuleTypeIDProductTaxabilityRule string = "ProductTaxabilityRule"

	// TaxRuleModelTaxRuleTypeIDNexusRule captures enum value "NexusRule"
	TaxRuleModelTaxRuleTypeIDNexusRule string = "NexusRule"

	// TaxRuleModelTaxRuleTypeIDRateCapRule captures enum value "RateCapRule"
	TaxRuleModelTaxRuleTypeIDRateCapRule string = "RateCapRule"

	// TaxRuleModelTaxRuleTypeIDTaxOverrideRule captures enum value "TaxOverrideRule"
	TaxRuleModelTaxRuleTypeIDTaxOverrideRule string = "TaxOverrideRule"

	// TaxRuleModelTaxRuleTypeIDFeeRule captures enum value "FeeRule"
	TaxRuleModelTaxRuleTypeIDFeeRule string = "FeeRule"

	// TaxRuleModelTaxRuleTypeIDOtherRule captures enum value "OtherRule"
	TaxRuleModelTaxRuleTypeIDOtherRule string = "OtherRule"
)
View Source 
const (

	// TaxRuleModelTaxTypeIDE captures enum value "E"
	TaxRuleModelTaxTypeIDE string = "E"

	// TaxRuleModelTaxTypeIDLodging captures enum value "Lodging"
	TaxRuleModelTaxTypeIDLodging string = "Lodging"

	// TaxRuleModelTaxTypeIDBottle captures enum value "Bottle"
	TaxRuleModelTaxTypeIDBottle string = "Bottle"

	// TaxRuleModelTaxTypeIDRentToOwn captures enum value "RentToOwn"
	TaxRuleModelTaxTypeIDRentToOwn string = "RentToOwn"

	// TaxRuleModelTaxTypeIDBikeTax captures enum value "BikeTax"
	TaxRuleModelTaxTypeIDBikeTax string = "BikeTax"

	// TaxRuleModelTaxTypeIDLandedCost captures enum value "LandedCost"
	TaxRuleModelTaxTypeIDLandedCost string = "LandedCost"

	// TaxRuleModelTaxTypeIDCheckoutBag captures enum value "CheckoutBag"
	TaxRuleModelTaxTypeIDCheckoutBag string = "CheckoutBag"

	// TaxRuleModelTaxTypeIDAlcohol captures enum value "Alcohol"
	TaxRuleModelTaxTypeIDAlcohol string = "Alcohol"

	// TaxRuleModelTaxTypeIDAmusement captures enum value "Amusement"
	TaxRuleModelTaxTypeIDAmusement string = "Amusement"

	// TaxRuleModelTaxTypeIDHospitality captures enum value "Hospitality"
	TaxRuleModelTaxTypeIDHospitality string = "Hospitality"

	// TaxRuleModelTaxTypeIDRentalLeasing captures enum value "RentalLeasing"
	TaxRuleModelTaxTypeIDRentalLeasing string = "RentalLeasing"

	// TaxRuleModelTaxTypeIDGrossReceipts captures enum value "GrossReceipts"
	TaxRuleModelTaxTypeIDGrossReceipts string = "GrossReceipts"

	// TaxRuleModelTaxTypeIDMattress captures enum value "Mattress"
	TaxRuleModelTaxTypeIDMattress string = "Mattress"

	// TaxRuleModelTaxTypeIDLumber captures enum value "Lumber"
	TaxRuleModelTaxTypeIDLumber string = "Lumber"

	// TaxRuleModelTaxTypeIDPaint captures enum value "Paint"
	TaxRuleModelTaxTypeIDPaint string = "Paint"

	// TaxRuleModelTaxTypeIDTires captures enum value "Tires"
	TaxRuleModelTaxTypeIDTires string = "Tires"

	// TaxRuleModelTaxTypeIDEI captures enum value "EI"
	TaxRuleModelTaxTypeIDEI string = "EI"

	// TaxRuleModelTaxTypeIDAll captures enum value "All"
	TaxRuleModelTaxTypeIDAll string = "All"

	// TaxRuleModelTaxTypeIDBothSalesAndUseTax captures enum value "BothSalesAndUseTax"
	TaxRuleModelTaxTypeIDBothSalesAndUseTax string = "BothSalesAndUseTax"

	// TaxRuleModelTaxTypeIDConsumerUseTax captures enum value "ConsumerUseTax"
	TaxRuleModelTaxTypeIDConsumerUseTax string = "ConsumerUseTax"

	// TaxRuleModelTaxTypeIDConsumersUseAndSellersUseTax captures enum value "ConsumersUseAndSellersUseTax"
	TaxRuleModelTaxTypeIDConsumersUseAndSellersUseTax string = "ConsumersUseAndSellersUseTax"

	// TaxRuleModelTaxTypeIDConsumerUseAndSalesTax captures enum value "ConsumerUseAndSalesTax"
	TaxRuleModelTaxTypeIDConsumerUseAndSalesTax string = "ConsumerUseAndSalesTax"

	// TaxRuleModelTaxTypeIDFee captures enum value "Fee"
	TaxRuleModelTaxTypeIDFee string = "Fee"

	// TaxRuleModelTaxTypeIDVATInputTax captures enum value "VATInputTax"
	TaxRuleModelTaxTypeIDVATInputTax string = "VATInputTax"

	// TaxRuleModelTaxTypeIDLightBulbs captures enum value "LightBulbs"
	TaxRuleModelTaxTypeIDLightBulbs string = "LightBulbs"

	// TaxRuleModelTaxTypeIDMeals captures enum value "Meals"
	TaxRuleModelTaxTypeIDMeals string = "Meals"

	// TaxRuleModelTaxTypeIDVATNonrecoverableInputTax captures enum value "VATNonrecoverableInputTax"
	TaxRuleModelTaxTypeIDVATNonrecoverableInputTax string = "VATNonrecoverableInputTax"

	// TaxRuleModelTaxTypeIDVATOutputTax captures enum value "VATOutputTax"
	TaxRuleModelTaxTypeIDVATOutputTax string = "VATOutputTax"

	// TaxRuleModelTaxTypeIDPIF captures enum value "PIF"
	TaxRuleModelTaxTypeIDPIF string = "PIF"

	// TaxRuleModelTaxTypeIDRental captures enum value "Rental"
	TaxRuleModelTaxTypeIDRental string = "Rental"

	// TaxRuleModelTaxTypeIDSalesTax captures enum value "SalesTax"
	TaxRuleModelTaxTypeIDSalesTax string = "SalesTax"

	// TaxRuleModelTaxTypeIDUseTax captures enum value "UseTax"
	TaxRuleModelTaxTypeIDUseTax string = "UseTax"

	// TaxRuleModelTaxTypeIDEWaste captures enum value "EWaste"
	TaxRuleModelTaxTypeIDEWaste string = "EWaste"

	// TaxRuleModelTaxTypeIDBatteries captures enum value "Batteries"
	TaxRuleModelTaxTypeIDBatteries string = "Batteries"
)
View Source 
const (

	// TransactionAddressModelBoundaryLevelAddress captures enum value "Address"
	TransactionAddressModelBoundaryLevelAddress string = "Address"

	// TransactionAddressModelBoundaryLevelZip9 captures enum value "Zip9"
	TransactionAddressModelBoundaryLevelZip9 string = "Zip9"

	// TransactionAddressModelBoundaryLevelZip5 captures enum value "Zip5"
	TransactionAddressModelBoundaryLevelZip5 string = "Zip5"
)
View Source 
const (

	// TransactionLineDetailModelJurisTypeSTA captures enum value "STA"
	TransactionLineDetailModelJurisTypeSTA string = "STA"

	// TransactionLineDetailModelJurisTypeCTY captures enum value "CTY"
	TransactionLineDetailModelJurisTypeCTY string = "CTY"

	// TransactionLineDetailModelJurisTypeCIT captures enum value "CIT"
	TransactionLineDetailModelJurisTypeCIT string = "CIT"

	// TransactionLineDetailModelJurisTypeSTJ captures enum value "STJ"
	TransactionLineDetailModelJurisTypeSTJ string = "STJ"

	// TransactionLineDetailModelJurisTypeCNT captures enum value "CNT"
	TransactionLineDetailModelJurisTypeCNT string = "CNT"
)
View Source 
const (

	// TransactionLineDetailModelJurisdictionTypeCountry captures enum value "Country"
	TransactionLineDetailModelJurisdictionTypeCountry string = "Country"

	// TransactionLineDetailModelJurisdictionTypeState captures enum value "State"
	TransactionLineDetailModelJurisdictionTypeState string = "State"

	// TransactionLineDetailModelJurisdictionTypeCounty captures enum value "County"
	TransactionLineDetailModelJurisdictionTypeCounty string = "County"

	// TransactionLineDetailModelJurisdictionTypeCity captures enum value "City"
	TransactionLineDetailModelJurisdictionTypeCity string = "City"

	// TransactionLineDetailModelJurisdictionTypeSpecial captures enum value "Special"
	TransactionLineDetailModelJurisdictionTypeSpecial string = "Special"
)
View Source 
const (

	// TransactionLineDetailModelLiabilityTypeSeller captures enum value "Seller"
	TransactionLineDetailModelLiabilityTypeSeller string = "Seller"

	// TransactionLineDetailModelLiabilityTypeBuyersAgent captures enum value "BuyersAgent"
	TransactionLineDetailModelLiabilityTypeBuyersAgent string = "BuyersAgent"
)
View Source 
const (

	// TransactionLineDetailModelNonTaxableTypeRateRule captures enum value "RateRule"
	TransactionLineDetailModelNonTaxableTypeRateRule string = "RateRule"

	// TransactionLineDetailModelNonTaxableTypeRateOverrideRule captures enum value "RateOverrideRule"
	TransactionLineDetailModelNonTaxableTypeRateOverrideRule string = "RateOverrideRule"

	// TransactionLineDetailModelNonTaxableTypeBaseRule captures enum value "BaseRule"
	TransactionLineDetailModelNonTaxableTypeBaseRule string = "BaseRule"

	// TransactionLineDetailModelNonTaxableTypeExemptEntityRule captures enum value "ExemptEntityRule"
	TransactionLineDetailModelNonTaxableTypeExemptEntityRule string = "ExemptEntityRule"

	// TransactionLineDetailModelNonTaxableTypeProductTaxabilityRule captures enum value "ProductTaxabilityRule"
	TransactionLineDetailModelNonTaxableTypeProductTaxabilityRule string = "ProductTaxabilityRule"

	// TransactionLineDetailModelNonTaxableTypeNexusRule captures enum value "NexusRule"
	TransactionLineDetailModelNonTaxableTypeNexusRule string = "NexusRule"

	// TransactionLineDetailModelNonTaxableTypeRateCapRule captures enum value "RateCapRule"
	TransactionLineDetailModelNonTaxableTypeRateCapRule string = "RateCapRule"

	// TransactionLineDetailModelNonTaxableTypeTaxOverrideRule captures enum value "TaxOverrideRule"
	TransactionLineDetailModelNonTaxableTypeTaxOverrideRule string = "TaxOverrideRule"

	// TransactionLineDetailModelNonTaxableTypeFeeRule captures enum value "FeeRule"
	TransactionLineDetailModelNonTaxableTypeFeeRule string = "FeeRule"

	// TransactionLineDetailModelNonTaxableTypeOtherRule captures enum value "OtherRule"
	TransactionLineDetailModelNonTaxableTypeOtherRule string = "OtherRule"
)
View Source 
const (

	// TransactionLineDetailModelRateTypeReducedA captures enum value "ReducedA"
	TransactionLineDetailModelRateTypeReducedA string = "ReducedA"

	// TransactionLineDetailModelRateTypeReducedB captures enum value "ReducedB"
	TransactionLineDetailModelRateTypeReducedB string = "ReducedB"

	// TransactionLineDetailModelRateTypeFood captures enum value "Food"
	TransactionLineDetailModelRateTypeFood string = "Food"

	// TransactionLineDetailModelRateTypeGeneral captures enum value "General"
	TransactionLineDetailModelRateTypeGeneral string = "General"

	// TransactionLineDetailModelRateTypeIncreasedStandard captures enum value "IncreasedStandard"
	TransactionLineDetailModelRateTypeIncreasedStandard string = "IncreasedStandard"

	// TransactionLineDetailModelRateTypeLinenRental captures enum value "LinenRental"
	TransactionLineDetailModelRateTypeLinenRental string = "LinenRental"

	// TransactionLineDetailModelRateTypeMedical captures enum value "Medical"
	TransactionLineDetailModelRateTypeMedical string = "Medical"

	// TransactionLineDetailModelRateTypeConstruction captures enum value "Construction"
	TransactionLineDetailModelRateTypeConstruction string = "Construction"

	// TransactionLineDetailModelRateTypeParking captures enum value "Parking"
	TransactionLineDetailModelRateTypeParking string = "Parking"

	// TransactionLineDetailModelRateTypeSuperReduced captures enum value "SuperReduced"
	TransactionLineDetailModelRateTypeSuperReduced string = "SuperReduced"

	// TransactionLineDetailModelRateTypeReducedR captures enum value "ReducedR"
	TransactionLineDetailModelRateTypeReducedR string = "ReducedR"

	// TransactionLineDetailModelRateTypeStandard captures enum value "Standard"
	TransactionLineDetailModelRateTypeStandard string = "Standard"

	// TransactionLineDetailModelRateTypeLeasing captures enum value "Leasing"
	TransactionLineDetailModelRateTypeLeasing string = "Leasing"

	// TransactionLineDetailModelRateTypeLeasingLow captures enum value "LeasingLow"
	TransactionLineDetailModelRateTypeLeasingLow string = "LeasingLow"

	// TransactionLineDetailModelRateTypeServices captures enum value "Services"
	TransactionLineDetailModelRateTypeServices string = "Services"

	// TransactionLineDetailModelRateTypeZero captures enum value "Zero"
	TransactionLineDetailModelRateTypeZero string = "Zero"
)
View Source 
const (

	// TransactionLineDetailModelSourcingMixed captures enum value "Mixed"
	TransactionLineDetailModelSourcingMixed string = "Mixed"

	// TransactionLineDetailModelSourcingDestination captures enum value "Destination"
	TransactionLineDetailModelSourcingDestination string = "Destination"

	// TransactionLineDetailModelSourcingOrigin captures enum value "Origin"
	TransactionLineDetailModelSourcingOrigin string = "Origin"
)
View Source 
const (

	// TransactionLineModelDeemedSupplierMarketplace captures enum value "Marketplace"
	TransactionLineModelDeemedSupplierMarketplace string = "Marketplace"

	// TransactionLineModelDeemedSupplierMerchant captures enum value "Merchant"
	TransactionLineModelDeemedSupplierMerchant string = "Merchant"
)
View Source 
const (

	// TransactionLineModelMarketplaceLiabilityTypeMarketplace captures enum value "Marketplace"
	TransactionLineModelMarketplaceLiabilityTypeMarketplace string = "Marketplace"

	// TransactionLineModelMarketplaceLiabilityTypeSeller captures enum value "Seller"
	TransactionLineModelMarketplaceLiabilityTypeSeller string = "Seller"
)
View Source 
const (

	// TransactionLineModelSourcingMixed captures enum value "Mixed"
	TransactionLineModelSourcingMixed string = "Mixed"

	// TransactionLineModelSourcingDestination captures enum value "Destination"
	TransactionLineModelSourcingDestination string = "Destination"

	// TransactionLineModelSourcingOrigin captures enum value "Origin"
	TransactionLineModelSourcingOrigin string = "Origin"
)
View Source 
const (

	// TransactionLineModelTaxOverrideTypeNone captures enum value "None"
	TransactionLineModelTaxOverrideTypeNone string = "None"

	// TransactionLineModelTaxOverrideTypeTaxAmount captures enum value "TaxAmount"
	TransactionLineModelTaxOverrideTypeTaxAmount string = "TaxAmount"

	// TransactionLineModelTaxOverrideTypeExemption captures enum value "Exemption"
	TransactionLineModelTaxOverrideTypeExemption string = "Exemption"

	// TransactionLineModelTaxOverrideTypeTaxDate captures enum value "TaxDate"
	TransactionLineModelTaxOverrideTypeTaxDate string = "TaxDate"

	// TransactionLineModelTaxOverrideTypeAccruedTaxAmount captures enum value "AccruedTaxAmount"
	TransactionLineModelTaxOverrideTypeAccruedTaxAmount string = "AccruedTaxAmount"

	// TransactionLineModelTaxOverrideTypeDeriveTaxable captures enum value "DeriveTaxable"
	TransactionLineModelTaxOverrideTypeDeriveTaxable string = "DeriveTaxable"

	// TransactionLineModelTaxOverrideTypeOutOfHarbor captures enum value "OutOfHarbor"
	TransactionLineModelTaxOverrideTypeOutOfHarbor string = "OutOfHarbor"

	// TransactionLineModelTaxOverrideTypeTaxAmountByTaxType captures enum value "TaxAmountByTaxType"
	TransactionLineModelTaxOverrideTypeTaxAmountByTaxType string = "TaxAmountByTaxType"
)
View Source 
const (

	// TransactionModelAdjustmentReasonNotAdjusted captures enum value "NotAdjusted"
	TransactionModelAdjustmentReasonNotAdjusted string = "NotAdjusted"

	// TransactionModelAdjustmentReasonSourcingIssue captures enum value "SourcingIssue"
	TransactionModelAdjustmentReasonSourcingIssue string = "SourcingIssue"

	// TransactionModelAdjustmentReasonReconciledWithGeneralLedger captures enum value "ReconciledWithGeneralLedger"
	TransactionModelAdjustmentReasonReconciledWithGeneralLedger string = "ReconciledWithGeneralLedger"

	// TransactionModelAdjustmentReasonExemptCertApplied captures enum value "ExemptCertApplied"
	TransactionModelAdjustmentReasonExemptCertApplied string = "ExemptCertApplied"

	// TransactionModelAdjustmentReasonPriceAdjusted captures enum value "PriceAdjusted"
	TransactionModelAdjustmentReasonPriceAdjusted string = "PriceAdjusted"

	// TransactionModelAdjustmentReasonProductReturned captures enum value "ProductReturned"
	TransactionModelAdjustmentReasonProductReturned string = "ProductReturned"

	// TransactionModelAdjustmentReasonProductExchanged captures enum value "ProductExchanged"
	TransactionModelAdjustmentReasonProductExchanged string = "ProductExchanged"

	// TransactionModelAdjustmentReasonBadDebt captures enum value "BadDebt"
	TransactionModelAdjustmentReasonBadDebt string = "BadDebt"

	// TransactionModelAdjustmentReasonOther captures enum value "Other"
	TransactionModelAdjustmentReasonOther string = "Other"

	// TransactionModelAdjustmentReasonOffline captures enum value "Offline"
	TransactionModelAdjustmentReasonOffline string = "Offline"
)
View Source 
const (

	// TransactionModelDeliveryTermsDAP captures enum value "DAP"
	TransactionModelDeliveryTermsDAP string = "DAP"

	// TransactionModelDeliveryTermsDDP captures enum value "DDP"
	TransactionModelDeliveryTermsDDP string = "DDP"
)
View Source 
const (

	// TransactionModelStatusTemporary captures enum value "Temporary"
	TransactionModelStatusTemporary string = "Temporary"

	// TransactionModelStatusSaved captures enum value "Saved"
	TransactionModelStatusSaved string = "Saved"

	// TransactionModelStatusPosted captures enum value "Posted"
	TransactionModelStatusPosted string = "Posted"

	// TransactionModelStatusCommitted captures enum value "Committed"
	TransactionModelStatusCommitted string = "Committed"

	// TransactionModelStatusCancelled captures enum value "Cancelled"
	TransactionModelStatusCancelled string = "Cancelled"

	// TransactionModelStatusAdjusted captures enum value "Adjusted"
	TransactionModelStatusAdjusted string = "Adjusted"

	// TransactionModelStatusQueued captures enum value "Queued"
	TransactionModelStatusQueued string = "Queued"

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

	// TransactionModelStatusAny captures enum value "Any"
	TransactionModelStatusAny string = "Any"
)
View Source 
const (

	// TransactionModelTaxOverrideTypeNone captures enum value "None"
	TransactionModelTaxOverrideTypeNone string = "None"

	// TransactionModelTaxOverrideTypeTaxAmount captures enum value "TaxAmount"
	TransactionModelTaxOverrideTypeTaxAmount string = "TaxAmount"

	// TransactionModelTaxOverrideTypeExemption captures enum value "Exemption"
	TransactionModelTaxOverrideTypeExemption string = "Exemption"

	// TransactionModelTaxOverrideTypeTaxDate captures enum value "TaxDate"
	TransactionModelTaxOverrideTypeTaxDate string = "TaxDate"

	// TransactionModelTaxOverrideTypeAccruedTaxAmount captures enum value "AccruedTaxAmount"
	TransactionModelTaxOverrideTypeAccruedTaxAmount string = "AccruedTaxAmount"

	// TransactionModelTaxOverrideTypeDeriveTaxable captures enum value "DeriveTaxable"
	TransactionModelTaxOverrideTypeDeriveTaxable string = "DeriveTaxable"

	// TransactionModelTaxOverrideTypeOutOfHarbor captures enum value "OutOfHarbor"
	TransactionModelTaxOverrideTypeOutOfHarbor string = "OutOfHarbor"

	// TransactionModelTaxOverrideTypeTaxAmountByTaxType captures enum value "TaxAmountByTaxType"
	TransactionModelTaxOverrideTypeTaxAmountByTaxType string = "TaxAmountByTaxType"
)
View Source 
const (

	// TransactionModelTypeSalesOrder captures enum value "SalesOrder"
	TransactionModelTypeSalesOrder string = "SalesOrder"

	// TransactionModelTypeSalesInvoice captures enum value "SalesInvoice"
	TransactionModelTypeSalesInvoice string = "SalesInvoice"

	// TransactionModelTypePurchaseOrder captures enum value "PurchaseOrder"
	TransactionModelTypePurchaseOrder string = "PurchaseOrder"

	// TransactionModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	TransactionModelTypePurchaseInvoice string = "PurchaseInvoice"

	// TransactionModelTypeReturnOrder captures enum value "ReturnOrder"
	TransactionModelTypeReturnOrder string = "ReturnOrder"

	// TransactionModelTypeReturnInvoice captures enum value "ReturnInvoice"
	TransactionModelTypeReturnInvoice string = "ReturnInvoice"

	// TransactionModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	TransactionModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// TransactionModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	TransactionModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// TransactionModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	TransactionModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// TransactionModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	TransactionModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// TransactionModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	TransactionModelTypeCustomsInvoice string = "CustomsInvoice"

	// TransactionModelTypeCustomsOrder captures enum value "CustomsOrder"
	TransactionModelTypeCustomsOrder string = "CustomsOrder"

	// TransactionModelTypeAny captures enum value "Any"
	TransactionModelTypeAny string = "Any"
)
View Source 
const (

	// TransactionSummaryJurisTypeCountry captures enum value "Country"
	TransactionSummaryJurisTypeCountry string = "Country"

	// TransactionSummaryJurisTypeState captures enum value "State"
	TransactionSummaryJurisTypeState string = "State"

	// TransactionSummaryJurisTypeCounty captures enum value "County"
	TransactionSummaryJurisTypeCounty string = "County"

	// TransactionSummaryJurisTypeCity captures enum value "City"
	TransactionSummaryJurisTypeCity string = "City"

	// TransactionSummaryJurisTypeSpecial captures enum value "Special"
	TransactionSummaryJurisTypeSpecial string = "Special"
)
View Source 
const (

	// TransactionSummaryRateTypeReducedA captures enum value "ReducedA"
	TransactionSummaryRateTypeReducedA string = "ReducedA"

	// TransactionSummaryRateTypeReducedB captures enum value "ReducedB"
	TransactionSummaryRateTypeReducedB string = "ReducedB"

	// TransactionSummaryRateTypeFood captures enum value "Food"
	TransactionSummaryRateTypeFood string = "Food"

	// TransactionSummaryRateTypeGeneral captures enum value "General"
	TransactionSummaryRateTypeGeneral string = "General"

	// TransactionSummaryRateTypeIncreasedStandard captures enum value "IncreasedStandard"
	TransactionSummaryRateTypeIncreasedStandard string = "IncreasedStandard"

	// TransactionSummaryRateTypeLinenRental captures enum value "LinenRental"
	TransactionSummaryRateTypeLinenRental string = "LinenRental"

	// TransactionSummaryRateTypeMedical captures enum value "Medical"
	TransactionSummaryRateTypeMedical string = "Medical"

	// TransactionSummaryRateTypeConstruction captures enum value "Construction"
	TransactionSummaryRateTypeConstruction string = "Construction"

	// TransactionSummaryRateTypeParking captures enum value "Parking"
	TransactionSummaryRateTypeParking string = "Parking"

	// TransactionSummaryRateTypeSuperReduced captures enum value "SuperReduced"
	TransactionSummaryRateTypeSuperReduced string = "SuperReduced"

	// TransactionSummaryRateTypeReducedR captures enum value "ReducedR"
	TransactionSummaryRateTypeReducedR string = "ReducedR"

	// TransactionSummaryRateTypeStandard captures enum value "Standard"
	TransactionSummaryRateTypeStandard string = "Standard"

	// TransactionSummaryRateTypeLeasing captures enum value "Leasing"
	TransactionSummaryRateTypeLeasing string = "Leasing"

	// TransactionSummaryRateTypeLeasingLow captures enum value "LeasingLow"
	TransactionSummaryRateTypeLeasingLow string = "LeasingLow"

	// TransactionSummaryRateTypeServices captures enum value "Services"
	TransactionSummaryRateTypeServices string = "Services"

	// TransactionSummaryRateTypeZero captures enum value "Zero"
	TransactionSummaryRateTypeZero string = "Zero"
)
View Source 
const (

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDStorefront captures enum value "Storefront"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDStorefront string = "Storefront"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDMainOffice captures enum value "MainOffice"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDMainOffice string = "MainOffice"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDWarehouse captures enum value "Warehouse"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDWarehouse string = "Warehouse"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDSalesperson captures enum value "Salesperson"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDSalesperson string = "Salesperson"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDOther captures enum value "Other"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDOther string = "Other"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDSellerRemitsTax captures enum value "SellerRemitsTax"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDSellerRemitsTax string = "SellerRemitsTax"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDMarketplaceRemitsTax captures enum value "MarketplaceRemitsTax"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDMarketplaceRemitsTax string = "MarketplaceRemitsTax"

	// UpdateCompanyLocationRemittanceModelAddressCategoryIDNonPhysical captures enum value "NonPhysical"
	UpdateCompanyLocationRemittanceModelAddressCategoryIDNonPhysical string = "NonPhysical"
)
View Source 
const (

	// UserEntitlementModelAccessLevelNone captures enum value "None"
	UserEntitlementModelAccessLevelNone string = "None"

	// UserEntitlementModelAccessLevelSingleCompany captures enum value "SingleCompany"
	UserEntitlementModelAccessLevelSingleCompany string = "SingleCompany"

	// UserEntitlementModelAccessLevelSingleAccount captures enum value "SingleAccount"
	UserEntitlementModelAccessLevelSingleAccount string = "SingleAccount"

	// UserEntitlementModelAccessLevelAllCompanies captures enum value "AllCompanies"
	UserEntitlementModelAccessLevelAllCompanies string = "AllCompanies"

	// UserEntitlementModelAccessLevelFirmManagedAccounts captures enum value "FirmManagedAccounts"
	UserEntitlementModelAccessLevelFirmManagedAccounts string = "FirmManagedAccounts"
)
View Source 
const (

	// UserModelPasswordStatusUserCannotChange captures enum value "UserCannotChange"
	UserModelPasswordStatusUserCannotChange string = "UserCannotChange"

	// UserModelPasswordStatusUserCanChange captures enum value "UserCanChange"
	UserModelPasswordStatusUserCanChange string = "UserCanChange"

	// UserModelPasswordStatusUserMustChange captures enum value "UserMustChange"
	UserModelPasswordStatusUserMustChange string = "UserMustChange"
)
View Source 
const (

	// UserModelSecurityRoleIDNoAccess captures enum value "NoAccess"
	UserModelSecurityRoleIDNoAccess string = "NoAccess"

	// UserModelSecurityRoleIDSiteAdmin captures enum value "SiteAdmin"
	UserModelSecurityRoleIDSiteAdmin string = "SiteAdmin"

	// UserModelSecurityRoleIDAccountOperator captures enum value "AccountOperator"
	UserModelSecurityRoleIDAccountOperator string = "AccountOperator"

	// UserModelSecurityRoleIDAccountAdmin captures enum value "AccountAdmin"
	UserModelSecurityRoleIDAccountAdmin string = "AccountAdmin"

	// UserModelSecurityRoleIDAccountUser captures enum value "AccountUser"
	UserModelSecurityRoleIDAccountUser string = "AccountUser"

	// UserModelSecurityRoleIDSystemAdmin captures enum value "SystemAdmin"
	UserModelSecurityRoleIDSystemAdmin string = "SystemAdmin"

	// UserModelSecurityRoleIDRegistrar captures enum value "Registrar"
	UserModelSecurityRoleIDRegistrar string = "Registrar"

	// UserModelSecurityRoleIDCSPTester captures enum value "CSPTester"
	UserModelSecurityRoleIDCSPTester string = "CSPTester"

	// UserModelSecurityRoleIDCSPAdmin captures enum value "CSPAdmin"
	UserModelSecurityRoleIDCSPAdmin string = "CSPAdmin"

	// UserModelSecurityRoleIDSystemOperator captures enum value "SystemOperator"
	UserModelSecurityRoleIDSystemOperator string = "SystemOperator"

	// UserModelSecurityRoleIDTechnicalSupportUser captures enum value "TechnicalSupportUser"
	UserModelSecurityRoleIDTechnicalSupportUser string = "TechnicalSupportUser"

	// UserModelSecurityRoleIDTechnicalSupportAdmin captures enum value "TechnicalSupportAdmin"
	UserModelSecurityRoleIDTechnicalSupportAdmin string = "TechnicalSupportAdmin"

	// UserModelSecurityRoleIDTreasuryUser captures enum value "TreasuryUser"
	UserModelSecurityRoleIDTreasuryUser string = "TreasuryUser"

	// UserModelSecurityRoleIDTreasuryAdmin captures enum value "TreasuryAdmin"
	UserModelSecurityRoleIDTreasuryAdmin string = "TreasuryAdmin"

	// UserModelSecurityRoleIDComplianceUser captures enum value "ComplianceUser"
	UserModelSecurityRoleIDComplianceUser string = "ComplianceUser"

	// UserModelSecurityRoleIDComplianceAdmin captures enum value "ComplianceAdmin"
	UserModelSecurityRoleIDComplianceAdmin string = "ComplianceAdmin"

	// UserModelSecurityRoleIDProStoresOperator captures enum value "ProStoresOperator"
	UserModelSecurityRoleIDProStoresOperator string = "ProStoresOperator"

	// UserModelSecurityRoleIDCompanyUser captures enum value "CompanyUser"
	UserModelSecurityRoleIDCompanyUser string = "CompanyUser"

	// UserModelSecurityRoleIDCompanyAdmin captures enum value "CompanyAdmin"
	UserModelSecurityRoleIDCompanyAdmin string = "CompanyAdmin"

	// UserModelSecurityRoleIDComplianceTempUser captures enum value "ComplianceTempUser"
	UserModelSecurityRoleIDComplianceTempUser string = "ComplianceTempUser"

	// UserModelSecurityRoleIDComplianceRootUser captures enum value "ComplianceRootUser"
	UserModelSecurityRoleIDComplianceRootUser string = "ComplianceRootUser"

	// UserModelSecurityRoleIDComplianceOperator captures enum value "ComplianceOperator"
	UserModelSecurityRoleIDComplianceOperator string = "ComplianceOperator"

	// UserModelSecurityRoleIDSSTAdmin captures enum value "SSTAdmin"
	UserModelSecurityRoleIDSSTAdmin string = "SSTAdmin"

	// UserModelSecurityRoleIDFirmUser captures enum value "FirmUser"
	UserModelSecurityRoleIDFirmUser string = "FirmUser"

	// UserModelSecurityRoleIDFirmAdmin captures enum value "FirmAdmin"
	UserModelSecurityRoleIDFirmAdmin string = "FirmAdmin"
)
View Source 
const (

	// VerifyMultiDocumentModelTypeSalesOrder captures enum value "SalesOrder"
	VerifyMultiDocumentModelTypeSalesOrder string = "SalesOrder"

	// VerifyMultiDocumentModelTypeSalesInvoice captures enum value "SalesInvoice"
	VerifyMultiDocumentModelTypeSalesInvoice string = "SalesInvoice"

	// VerifyMultiDocumentModelTypePurchaseOrder captures enum value "PurchaseOrder"
	VerifyMultiDocumentModelTypePurchaseOrder string = "PurchaseOrder"

	// VerifyMultiDocumentModelTypePurchaseInvoice captures enum value "PurchaseInvoice"
	VerifyMultiDocumentModelTypePurchaseInvoice string = "PurchaseInvoice"

	// VerifyMultiDocumentModelTypeReturnOrder captures enum value "ReturnOrder"
	VerifyMultiDocumentModelTypeReturnOrder string = "ReturnOrder"

	// VerifyMultiDocumentModelTypeReturnInvoice captures enum value "ReturnInvoice"
	VerifyMultiDocumentModelTypeReturnInvoice string = "ReturnInvoice"

	// VerifyMultiDocumentModelTypeInventoryTransferOrder captures enum value "InventoryTransferOrder"
	VerifyMultiDocumentModelTypeInventoryTransferOrder string = "InventoryTransferOrder"

	// VerifyMultiDocumentModelTypeInventoryTransferInvoice captures enum value "InventoryTransferInvoice"
	VerifyMultiDocumentModelTypeInventoryTransferInvoice string = "InventoryTransferInvoice"

	// VerifyMultiDocumentModelTypeReverseChargeOrder captures enum value "ReverseChargeOrder"
	VerifyMultiDocumentModelTypeReverseChargeOrder string = "ReverseChargeOrder"

	// VerifyMultiDocumentModelTypeReverseChargeInvoice captures enum value "ReverseChargeInvoice"
	VerifyMultiDocumentModelTypeReverseChargeInvoice string = "ReverseChargeInvoice"

	// VerifyMultiDocumentModelTypeCustomsInvoice captures enum value "CustomsInvoice"
	VerifyMultiDocumentModelTypeCustomsInvoice string = "CustomsInvoice"

	// VerifyMultiDocumentModelTypeCustomsOrder captures enum value "CustomsOrder"
	VerifyMultiDocumentModelTypeCustomsOrder string = "CustomsOrder"

	// VerifyMultiDocumentModelTypeAny captures enum value "Any"
	VerifyMultiDocumentModelTypeAny string = "Any"
)
View Source 
const (

	// VoidTransactionModelCodeUnspecified captures enum value "Unspecified"
	VoidTransactionModelCodeUnspecified string = "Unspecified"

	// VoidTransactionModelCodePostFailed captures enum value "PostFailed"
	VoidTransactionModelCodePostFailed string = "PostFailed"

	// VoidTransactionModelCodeDocDeleted captures enum value "DocDeleted"
	VoidTransactionModelCodeDocDeleted string = "DocDeleted"

	// VoidTransactionModelCodeDocVoided captures enum value "DocVoided"
	VoidTransactionModelCodeDocVoided string = "DocVoided"

	// VoidTransactionModelCodeAdjustmentCancelled captures enum value "AdjustmentCancelled"
	VoidTransactionModelCodeAdjustmentCancelled string = "AdjustmentCancelled"
)
View Source 
const (

	// WorksheetDocumentResultCodeSuccess captures enum value "Success"
	WorksheetDocumentResultCodeSuccess string = "Success"

	// WorksheetDocumentResultCodeWarning captures enum value "Warning"
	WorksheetDocumentResultCodeWarning string = "Warning"

	// WorksheetDocumentResultCodeError captures enum value "Error"
	WorksheetDocumentResultCodeError string = "Error"

	// WorksheetDocumentResultCodeException captures enum value "Exception"
	WorksheetDocumentResultCodeException string = "Exception"
)
View Source 
const (

	// WorksheetDocumentLineResultCodeSuccess captures enum value "Success"
	WorksheetDocumentLineResultCodeSuccess string = "Success"

	// WorksheetDocumentLineResultCodeWarning captures enum value "Warning"
	WorksheetDocumentLineResultCodeWarning string = "Warning"

	// WorksheetDocumentLineResultCodeError captures enum value "Error"
	WorksheetDocumentLineResultCodeError string = "Error"

	// WorksheetDocumentLineResultCodeException captures enum value "Exception"
	WorksheetDocumentLineResultCodeException string = "Exception"
)
View Source 
const (

	// ExportDocumentLineModelFormatCSV captures enum value "CSV"
	ExportDocumentLineModelFormatCSV string = "CSV"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AccountConfigurationModel ¶ 

type AccountConfigurationModel struct {

	// The unique ID number of the account to which this setting applies
	// Example: 0
	// Read Only: true
	AccountID int32 `json:"accountId,omitempty"`

	// The category of the configuration setting.  Avalara-defined categories include `AddressServiceConfig` and `TaxServiceConfig`.  Customer-defined categories begin with `X-`.
	// Example: TaxServiceConfig
	// Required: true
	// Max Length: 25
	// Min Length: 0
	Category *string `json:"category"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The name of the configuration setting
	// Example: MaxLines
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// The current value of the configuration setting
	// Example: 1000
	// Max Length: 200
	// Min Length: 0
	Value *string `json:"value,omitempty"`
}

AccountConfigurationModel Represents one configuration setting for this account Example: {"accountId":0,"category":"TaxServiceConfig","name":"MaxLines","value":"1000"}

swagger:model AccountConfigurationModel

func (*AccountConfigurationModel) ContextValidate ¶ 

func (m *AccountConfigurationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account configuration model based on the context it is used

func (*AccountConfigurationModel) MarshalBinary ¶ 

func (m *AccountConfigurationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountConfigurationModel) UnmarshalBinary ¶ 

func (m *AccountConfigurationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountConfigurationModel) Validate ¶ 

func (m *AccountConfigurationModel) Validate(formats strfmt.Registry) error

Validate validates this account configuration model

type AccountLicenseKeyModel ¶ 

type AccountLicenseKeyModel struct {

	// AccountId for required license key
	// Example: 123456789
	// Required: true
	AccountID *int32 `json:"accountId"`

	// The date when this record was created.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The user id for the user who created this record.
	// Example: 1
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date/time when this record was last modified.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user id of user who last modified this record.
	// Example: 1
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The unique name for license key per account
	// Example: ABCDEFGHIJK
	// Required: true
	// Max Length: 30
	// Min Length: 0
	Name *string `json:"name"`
}

AccountLicenseKeyModel An account user who is permitted to use AvaTax. Example: {"accountId":123456789,"createdDate":"2021-12-25T00:00:00+00:00","createdUserId":1,"modifiedDate":"2021-12-25T00:00:00+00:00","modifiedUserId":1,"name":"ABCDEFGHIJK"}

swagger:model AccountLicenseKeyModel

func (*AccountLicenseKeyModel) ContextValidate ¶ 

func (m *AccountLicenseKeyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account license key model based on the context it is used

func (*AccountLicenseKeyModel) MarshalBinary ¶ 

func (m *AccountLicenseKeyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountLicenseKeyModel) UnmarshalBinary ¶ 

func (m *AccountLicenseKeyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountLicenseKeyModel) Validate ¶ 

func (m *AccountLicenseKeyModel) Validate(formats strfmt.Registry) error

Validate validates this account license key model

type AccountMigrationStatusModel ¶ 

type AccountMigrationStatusModel struct {

	// The unique ID number assigned to this account.
	// Example: 12345
	// Required: true
	AccountID *int32 `json:"accountId"`

	// The Tss Read Write Mode.
	// Example: 0
	AccountMigrationStatusID int32 `json:"accountMigrationStatusId,omitempty"`

	// The name of this account.
	// Example: Test Account
	AccountName string `json:"accountName,omitempty"`

	// The date/time when this record was last modified.
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`
}

AccountMigrationStatusModel An AvaTax account. Example: {"accountId":12345,"accountMigrationStatusId":0,"accountName":"Test Account"}

swagger:model AccountMigrationStatusModel

func (*AccountMigrationStatusModel) ContextValidate ¶ 

func (m *AccountMigrationStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this account migration status model based on context it is used

func (*AccountMigrationStatusModel) MarshalBinary ¶ 

func (m *AccountMigrationStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountMigrationStatusModel) UnmarshalBinary ¶ 

func (m *AccountMigrationStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountMigrationStatusModel) Validate ¶ 

func (m *AccountMigrationStatusModel) Validate(formats strfmt.Registry) error

Validate validates this account migration status model

type AccountModel ¶ 

type AccountModel struct {

	// The current status of this account.
	// Example: Inactive
	// Enum: [Inactive Active Test New]
	AccountStatusID string `json:"accountStatusId,omitempty"`

	// The type of this account.
	// Example: Regular
	// Enum: [Regular Firm FirmClient]
	AccountTypeID string `json:"accountTypeId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// For system registrar use only.
	// Max Length: 100
	// Min Length: 0
	Crmid *string `json:"crmid,omitempty"`

	// The earliest date on which this account may be used.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// If this account has been closed, this is the last date the account was open.
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// The unique ID number assigned to this account.
	// Example: 12345
	// Required: true
	ID *int32 `json:"id"`

	// Is Saml based authentication used by this account for user to login via AI.
	// Example: false
	IsSamlEnabled bool `json:"isSamlEnabled,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The name of this account.
	// Example: Test Account
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// Optional: A list of subscriptions granted to this account.  To fetch this list, add the query string "?$include=Subscriptions" to your URL.
	Subscriptions []*SubscriptionModel `json:"subscriptions"`

	// Optional: A list of all the users belonging to this account.  To fetch this list, add the query string "?$include=Users" to your URL.
	Users []*UserModel `json:"users"`
}

AccountModel An AvaTax account. Example: {"accountStatusId":"Test","accountTypeId":"Regular","effectiveDate":"2021-12-25T00:00:00+00:00","id":12345,"isSamlEnabled":false,"name":"Test Account"}

swagger:model AccountModel

func (*AccountModel) ContextValidate ¶ 

func (m *AccountModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account model based on the context it is used

func (*AccountModel) MarshalBinary ¶ 

func (m *AccountModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountModel) UnmarshalBinary ¶ 

func (m *AccountModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountModel) Validate ¶ 

func (m *AccountModel) Validate(formats strfmt.Registry) error

Validate validates this account model

type AccountModelFetchResult ¶ 

type AccountModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*AccountModel `json:"value"`
}

AccountModelFetchResult account model fetch result

swagger:model AccountModelFetchResult

func (*AccountModelFetchResult) ContextValidate ¶ 

func (m *AccountModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account model fetch result based on the context it is used

func (*AccountModelFetchResult) MarshalBinary ¶ 

func (m *AccountModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountModelFetchResult) UnmarshalBinary ¶ 

func (m *AccountModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountModelFetchResult) Validate ¶ 

func (m *AccountModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this account model fetch result

type ActivateAccountModel ¶ 

type ActivateAccountModel struct {

	// Set this to true if and only if you accept Avalara's terms and conditions for your account.
	// Example: true
	AcceptAvalaraTermsAndConditions bool `json:"acceptAvalaraTermsAndConditions,omitempty"`

	// Set this to true if and only if you have fully read Avalara's terms and conditions for your account.
	// Example: true
	HaveReadAvalaraTermsAndConditions bool `json:"haveReadAvalaraTermsAndConditions,omitempty"`
}

ActivateAccountModel Represents a request to activate an account by reading and accepting its terms and conditions. Example: {"acceptAvalaraTermsAndConditions":true,"haveReadAvalaraTermsAndConditions":true}

swagger:model ActivateAccountModel

func (*ActivateAccountModel) ContextValidate ¶ 

func (m *ActivateAccountModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this activate account model based on context it is used

func (*ActivateAccountModel) MarshalBinary ¶ 

func (m *ActivateAccountModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ActivateAccountModel) UnmarshalBinary ¶ 

func (m *ActivateAccountModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ActivateAccountModel) Validate ¶ 

func (m *ActivateAccountModel) Validate(formats strfmt.Registry) error

Validate validates this activate account model

type AddTransactionLineModel ¶ 

type AddTransactionLineModel struct {

	// company code
	// Example: DEFAULT
	// Required: true
	CompanyCode *string `json:"companyCode"`

	// document type
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType string `json:"documentType,omitempty"`

	// List of lines to be added
	// Example: [{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}]
	// Required: true
	Lines []*LineItemModel `json:"lines"`

	// Option to renumber lines after add. After renumber, the line number becomes: "1", "2", "3", ...
	// Example: false
	Renumber bool `json:"renumber,omitempty"`

	// document code for the transaction to add lines
	// Example: 1234
	// Required: true
	TransactionCode *string `json:"transactionCode"`
}

AddTransactionLineModel Model to add specific lines to exising transaction Example: {"companyCode":"DEFAULT","documentType":"SalesInvoice","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"renumber":false,"transactionCode":"1234"}

swagger:model AddTransactionLineModel

func (*AddTransactionLineModel) ContextValidate ¶ 

func (m *AddTransactionLineModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this add transaction line model based on the context it is used

func (*AddTransactionLineModel) MarshalBinary ¶ 

func (m *AddTransactionLineModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddTransactionLineModel) UnmarshalBinary ¶ 

func (m *AddTransactionLineModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddTransactionLineModel) Validate ¶ 

func (m *AddTransactionLineModel) Validate(formats strfmt.Registry) error

Validate validates this add transaction line model

type AddressInfo ¶ 

type AddressInfo struct {

	// City component of the address
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// Geospatial latitude measurement, in Decimal Degrees floating point format.
	Latitude float64 `json:"latitude,omitempty"`

	// First line of the street address
	// Example: 2000 Main Street
	Line1 string `json:"line1,omitempty"`

	// Second line of the street address
	// Max Length: 100
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Third line of the street address
	// Max Length: 100
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// Geospatial longitude measurement, in Decimal Degrees floating point format.
	Longitude float64 `json:"longitude,omitempty"`

	// Postal Code / Zip Code component of the address.
	// Example: 92614
	// Max Length: 11
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`
}

AddressInfo Represents a base address element. Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}

swagger:model AddressInfo

func (*AddressInfo) ContextValidate ¶ 

func (m *AddressInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this address info based on context it is used

func (*AddressInfo) MarshalBinary ¶ 

func (m *AddressInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddressInfo) UnmarshalBinary ¶ 

func (m *AddressInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddressInfo) Validate ¶ 

func (m *AddressInfo) Validate(formats strfmt.Registry) error

Validate validates this address info

type AddressLocationInfo ¶ 

type AddressLocationInfo struct {

	// City component of the address
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// Geospatial latitude measurement, in Decimal Degrees floating point format.
	Latitude float64 `json:"latitude,omitempty"`

	// First line of the street address
	// Example: 2000 Main Street
	// Max Length: 100
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// Second line of the street address
	// Max Length: 100
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Third line of the street address
	// Max Length: 100
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// If you wish to use the address of an existing location for this company, specify the address here.
	// Otherwise, leave this value empty.
	//
	// The `locationCode` field on this object allows you to quickly use the address of an existing `locationModel` object instead
	// of having to retype the address completely.
	//
	// This field does not affect the behavior of transactions that must be filed on location-based tax returns.  To specify how a
	// transaction will be reported on location-based tax returns, please see the `reportingLocationCode` field
	// on the [CreateTransactionModel](https://developer.avalara.com/api-reference/avatax/rest/v2/models/CreateTransactionModel/) element.
	LocationCode string `json:"locationCode,omitempty"`

	// Geospatial longitude measurement, in Decimal Degrees floating point format.
	Longitude float64 `json:"longitude,omitempty"`

	// Postal Code / Zip Code component of the address.
	// Example: 92614
	// Max Length: 11
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`
}

AddressLocationInfo Represents an address to resolve. Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}

swagger:model AddressLocationInfo

func (*AddressLocationInfo) ContextValidate ¶ 

func (m *AddressLocationInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this address location info based on context it is used

func (*AddressLocationInfo) MarshalBinary ¶ 

func (m *AddressLocationInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddressLocationInfo) UnmarshalBinary ¶ 

func (m *AddressLocationInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddressLocationInfo) Validate ¶ 

func (m *AddressLocationInfo) Validate(formats strfmt.Registry) error

Validate validates this address location info

type AddressResolutionModel ¶ 

type AddressResolutionModel struct {

	// The original address
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	Address *AddressInfo `json:"address,omitempty"`

	// The geospatial coordinates of this address
	// Example: {"latitude":33.684884,"longitude":-117.851321}
	Coordinates *CoordinateInfo `json:"coordinates,omitempty"`

	// List of informational and warning messages regarding this address
	// Example: [{"details":"The physical location exists but there are no homes on this street. One reason might be railroad tracks or rivers running alongside this street, as they would prevent construction of homes in this location.","refersTo":"address","severity":"Error","source":"Avalara.AvaTax.Services.Address","summary":"The address is not deliverable."}]
	Messages []*AvaTaxMessage `json:"messages"`

	// The resolution quality of the geospatial coordinates
	// Example: NotCoded
	// Enum: [NotCoded External CountryCentroid RegionCentroid PartialCentroid PostalCentroidGood PostalCentroidBetter PostalCentroidBest Intersection Interpolated Rooftop Constant]
	ResolutionQuality string `json:"resolutionQuality,omitempty"`

	// List of informational and warning messages regarding this address
	// Example: [{"avalaraId":"AGAM","jurisdictionName":"CALIFORNIA","jurisdictionType":"State","signatureCode":"AGAM"}]
	TaxAuthorities []*TaxAuthorityInfo `json:"taxAuthorities"`

	// The validated address or addresses
	ValidatedAddresses []*ValidatedAddressInfo `json:"validatedAddresses"`
}

AddressResolutionModel Address Resolution Model Example: {"address":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"},"coordinates":{"latitude":33.684884,"longitude":-117.851321},"messages":[{"details":"The physical location exists but there are no homes on this street. One reason might be railroad tracks or rivers running alongside this street, as they would prevent construction of homes in this location.","refersTo":"address","severity":"Error","source":"Avalara.AvaTax.Services.Address","summary":"The address is not deliverable."}],"resolutionQuality":"Intersection","taxAuthorities":[{"avalaraId":"AGAM","jurisdictionName":"CALIFORNIA","jurisdictionType":"State","signatureCode":"AGAM"}]}

swagger:model AddressResolutionModel

func (*AddressResolutionModel) ContextValidate ¶ 

func (m *AddressResolutionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this address resolution model based on the context it is used

func (*AddressResolutionModel) MarshalBinary ¶ 

func (m *AddressResolutionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddressResolutionModel) UnmarshalBinary ¶ 

func (m *AddressResolutionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddressResolutionModel) Validate ¶ 

func (m *AddressResolutionModel) Validate(formats strfmt.Registry) error

Validate validates this address resolution model

type AddressValidationInfo ¶ 

type AddressValidationInfo struct {

	// City component of the address
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// Geospatial latitude measurement, in Decimal Degrees floating point format.
	Latitude float64 `json:"latitude,omitempty"`

	// First line of the street address
	// Example: 2000 Main Street
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// Second line of the street address
	// Max Length: 100
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Third line of the street address
	// Max Length: 100
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// Geospatial longitude measurement, in Decimal Degrees floating point format.
	Longitude float64 `json:"longitude,omitempty"`

	// Postal Code / Zip Code component of the address.
	// Example: 92614
	// Max Length: 11
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`

	// Specify the text case for the validated address result.  If not specified, will return uppercase.
	// Example: Upper
	// Enum: [Upper Mixed]
	TextCase string `json:"textCase,omitempty"`
}

AddressValidationInfo TextCase info for input address Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA","textCase":"Upper"}

swagger:model AddressValidationInfo

func (*AddressValidationInfo) ContextValidate ¶ 

func (m *AddressValidationInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this address validation info based on context it is used

func (*AddressValidationInfo) MarshalBinary ¶ 

func (m *AddressValidationInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddressValidationInfo) UnmarshalBinary ¶ 

func (m *AddressValidationInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddressValidationInfo) Validate ¶ 

func (m *AddressValidationInfo) Validate(formats strfmt.Registry) error

Validate validates this address validation info

type AddressesModel ¶ 

type AddressesModel struct {

	// The address where invoices and other billing-related information are sent to the buyer. This address type is only for India GST transactions.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	BillTo *AddressLocationInfo `json:"billTo,omitempty"`

	// The address where the goods are located or where services are rendered.This address type is valid only for VAT transactions.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	GoodsPlaceOrServiceRendered *AddressLocationInfo `json:"goodsPlaceOrServiceRendered,omitempty"`

	// The address of the buyer importing a good from another country.This address type is valid only for VAT transactions.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	Import *AddressLocationInfo `json:"import,omitempty"`

	// The place of business where you accept/approve the customer’s order,
	// thereby becoming contractually obligated to make the sale.  This address type is valid in the United States only
	// and only applies to tangible personal property.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	PointOfOrderAcceptance *AddressLocationInfo `json:"pointOfOrderAcceptance,omitempty"`

	// The place of business where you receive the customer's order.  This address type is valid in the United States only
	// and only applies to tangible personal property.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	PointOfOrderOrigin *AddressLocationInfo `json:"pointOfOrderOrigin,omitempty"`

	// The origination address where the products were shipped from, or from where the services originated.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	ShipFrom *AddressLocationInfo `json:"shipFrom,omitempty"`

	// The destination address where the products were shipped to, or where the services were delivered.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	ShipTo *AddressLocationInfo `json:"shipTo,omitempty"`

	// If this transaction occurred at a retail point-of-sale location, provide that single address here and leave
	// all other address types null.
	// Example: {"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	SingleLocation *AddressLocationInfo `json:"singleLocation,omitempty"`
}

AddressesModel Information about all the addresses involved in this transaction.

For a physical in-person transaction at a retail point-of-sale location, please specify only one address using the `singleLocation` field.

For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to a destination location such as a customer, please specify the `shipFrom` and `shipTo` addresses.

In the United States, some jurisdictions recognize the address types `pointOfOrderOrigin` and `pointOfOrderAcceptance`. These address types affect the sourcing models of some transactions.

If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses. Example: {"shipFrom":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"},"shipTo":{"city":"Seattle","country":"US","line1":"1100 2nd Ave","postalCode":"98101","region":"WA"}}

swagger:model AddressesModel

func (*AddressesModel) ContextValidate ¶ 

func (m *AddressesModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this addresses model based on the context it is used

func (*AddressesModel) MarshalBinary ¶ 

func (m *AddressesModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddressesModel) UnmarshalBinary ¶ 

func (m *AddressesModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddressesModel) Validate ¶ 

func (m *AddressesModel) Validate(formats strfmt.Registry) error

Validate validates this addresses model

type AdjustMultiDocumentModel ¶ 

type AdjustMultiDocumentModel struct {

	// If the AdjustmentReason is "Other", specify the reason here.
	//
	// This is required when the AdjustmentReason is 8 (Other).
	// Example: Price was dropped.
	AdjustDescription string `json:"adjustDescription,omitempty"`

	// A reason code indicating why this adjustment was made
	// Example: NotAdjusted
	// Required: true
	// Enum: [NotAdjusted SourcingIssue ReconciledWithGeneralLedger ExemptCertApplied PriceAdjusted ProductReturned ProductExchanged BadDebt Other Offline]
	AdjustmentReason *string `json:"adjustmentReason"`

	// Replace the current MultiDocument transaction with tax data calculated for this new MultiDocument transaction
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	// Required: true
	NewTransaction *CreateMultiDocumentModel `json:"newTransaction"`
}

AdjustMultiDocumentModel Replace an existing MultiDocument transaction recorded in AvaTax with a new one. Example: {"adjustDescription":"Price was dropped.","adjustmentReason":"PriceAdjusted","newTransaction":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}

swagger:model AdjustMultiDocumentModel

func (*AdjustMultiDocumentModel) ContextValidate ¶ 

func (m *AdjustMultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this adjust multi document model based on the context it is used

func (*AdjustMultiDocumentModel) MarshalBinary ¶ 

func (m *AdjustMultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdjustMultiDocumentModel) UnmarshalBinary ¶ 

func (m *AdjustMultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdjustMultiDocumentModel) Validate ¶ 

func (m *AdjustMultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this adjust multi document model

type AdjustTransactionModel ¶ 

type AdjustTransactionModel struct {

	// If the AdjustmentReason is "Other", specify the reason here.
	//
	// This is required when the AdjustmentReason is 8 (Other).
	// Example: Price drop before shipping
	AdjustmentDescription string `json:"adjustmentDescription,omitempty"`

	// A reason code indicating why this adjustment was made
	// Example: NotAdjusted
	// Required: true
	// Enum: [NotAdjusted SourcingIssue ReconciledWithGeneralLedger ExemptCertApplied PriceAdjusted ProductReturned ProductExchanged BadDebt Other Offline]
	AdjustmentReason *string `json:"adjustmentReason"`

	// Replace the current transaction with tax data calculated for this new transaction
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	// Required: true
	NewTransaction *CreateTransactionModel `json:"newTransaction"`
}

AdjustTransactionModel Replace an existing transaction recorded in AvaTax with a new one. Example: {"adjustmentDescription":"Price drop before shipping","adjustmentReason":"PriceAdjusted","newTransaction":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}

swagger:model AdjustTransactionModel

func (*AdjustTransactionModel) ContextValidate ¶ 

func (m *AdjustTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this adjust transaction model based on the context it is used

func (*AdjustTransactionModel) MarshalBinary ¶ 

func (m *AdjustTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdjustTransactionModel) UnmarshalBinary ¶ 

func (m *AdjustTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdjustTransactionModel) Validate ¶ 

func (m *AdjustTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this adjust transaction model

type AdvancedRuleCustomerDataSchemaModel ¶ 

type AdvancedRuleCustomerDataSchemaModel struct {

	// Customer data schema
	CustomerDataSchema string `json:"customerDataSchema,omitempty"`

	// Unique identifier for the rule
	// Example: 1ddd8c0a73ca4beb888c07ff1aacf2bc
	RuleID string `json:"ruleId,omitempty"`
}

AdvancedRuleCustomerDataSchemaModel Model for retrieving customer data schema Example: {"ruleId":"1ddd8c0a73ca4beb888c07ff1aacf2bc"}

swagger:model AdvancedRuleCustomerDataSchemaModel

func (*AdvancedRuleCustomerDataSchemaModel) ContextValidate ¶ 

func (m *AdvancedRuleCustomerDataSchemaModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this advanced rule customer data schema model based on context it is used

func (*AdvancedRuleCustomerDataSchemaModel) MarshalBinary ¶ 

func (m *AdvancedRuleCustomerDataSchemaModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleCustomerDataSchemaModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleCustomerDataSchemaModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleCustomerDataSchemaModel) Validate ¶ 

func (m *AdvancedRuleCustomerDataSchemaModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule customer data schema model

type AdvancedRuleExecutionModel ¶ 

type AdvancedRuleExecutionModel struct {

	// Should we keep running if we hit an exception
	// Example: false
	ContinueOnError bool `json:"continueOnError,omitempty"`

	// Json data used for rule execution
	CustomerData string `json:"customerData,omitempty"`

	// Unique identifier of customer data used in rule execution
	// Example: 54af4422e9374e8490ab7600f679e4f4
	// Read Only: true
	CustomerDataID string `json:"customerDataId,omitempty"`

	// Is rule execution enabled
	// Example: true
	Enabled bool `json:"enabled,omitempty"`

	// Date rule execution ends
	// Example: 9999-12-31T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Name of rule execution
	// Required: true
	Name *string `json:"name"`

	// Advanced rule to execute
	// Example: {"arEntitlementRequired":false,"description":"Replaces a target value on the transaction with a replacement value","name":"Generic replace rule","ruleId":"710c3d61e2f44b63b916e3dc2fc3ea8e"}
	// Read Only: true
	Rule *AdvancedRuleModel `json:"rule,omitempty"`

	// Rule execution unique identifier
	// Example: 6e34db67798747a389433672a4a79fc5
	// Read Only: true
	RuleExecutionID string `json:"ruleExecutionId,omitempty"`

	// Unique identifier of rule to execute
	// Example: 2b82cb271b7b47489220dd93d6b2faf8
	// Required: true
	RuleID *string `json:"ruleId"`

	// Date rule execution starts
	// Example: 2021-12-25T00:00:00Z
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`
}

AdvancedRuleExecutionModel Model representing an execution of an advanced rule for a company Example: {"continueOnError":false,"customerDataId":"54af4422e9374e8490ab7600f679e4f4","enabled":true,"endDate":"9999-12-31T00:00:00","rule":{"arEntitlementRequired":false,"description":"Replaces a target value on the transaction with a replacement value","name":"Generic replace rule","ruleId":"710c3d61e2f44b63b916e3dc2fc3ea8e"},"ruleExecutionId":"6e34db67798747a389433672a4a79fc5","ruleId":"2b82cb271b7b47489220dd93d6b2faf8","startDate":"2021-12-25T00:00:00Z"}

swagger:model AdvancedRuleExecutionModel

func (*AdvancedRuleExecutionModel) ContextValidate ¶ 

func (m *AdvancedRuleExecutionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this advanced rule execution model based on the context it is used

func (*AdvancedRuleExecutionModel) MarshalBinary ¶ 

func (m *AdvancedRuleExecutionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleExecutionModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleExecutionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleExecutionModel) Validate ¶ 

func (m *AdvancedRuleExecutionModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule execution model

type AdvancedRuleExecutionModelFetchResult ¶ 

type AdvancedRuleExecutionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*AdvancedRuleExecutionModel `json:"value"`
}

AdvancedRuleExecutionModelFetchResult advanced rule execution model fetch result

swagger:model AdvancedRuleExecutionModelFetchResult

func (*AdvancedRuleExecutionModelFetchResult) ContextValidate ¶ 

func (m *AdvancedRuleExecutionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this advanced rule execution model fetch result based on the context it is used

func (*AdvancedRuleExecutionModelFetchResult) MarshalBinary ¶ 

func (m *AdvancedRuleExecutionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleExecutionModelFetchResult) UnmarshalBinary ¶ 

func (m *AdvancedRuleExecutionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleExecutionModelFetchResult) Validate ¶ 

func (m *AdvancedRuleExecutionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this advanced rule execution model fetch result

type AdvancedRuleExecutionOrderModel ¶ 

type AdvancedRuleExecutionOrderModel struct {

	// The rule execution Ids in the desired order
	// Example: ["820e1e13dfea49cd835064fe1ddd6d1c","5312f524670f4e68bc49deab19a7921e"]
	// Required: true
	RuleExecutionIds []string `json:"ruleExecutionIds"`
}

AdvancedRuleExecutionOrderModel Model for updating rule execution order Example: {"ruleExecutionIds":["820e1e13dfea49cd835064fe1ddd6d1c","5312f524670f4e68bc49deab19a7921e"]}

swagger:model AdvancedRuleExecutionOrderModel

func (*AdvancedRuleExecutionOrderModel) ContextValidate ¶ 

func (m *AdvancedRuleExecutionOrderModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this advanced rule execution order model based on context it is used

func (*AdvancedRuleExecutionOrderModel) MarshalBinary ¶ 

func (m *AdvancedRuleExecutionOrderModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleExecutionOrderModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleExecutionOrderModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleExecutionOrderModel) Validate ¶ 

func (m *AdvancedRuleExecutionOrderModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule execution order model

type AdvancedRuleFullDetailsModel ¶ 

type AdvancedRuleFullDetailsModel struct {

	// Account Ids the rule is visible for in CUP, when IsVisibleInCUP = false
	AccountsVisibleFor []int32 `json:"accountsVisibleFor"`

	// Approver of the rule
	ApprovedBy string `json:"approvedBy,omitempty"`

	// Advance Rules limited availability
	// Example: false
	ArEntitlementRequired bool `json:"arEntitlementRequired,omitempty"`

	// Creator of the rule
	CreatedBy string `json:"createdBy,omitempty"`

	// When the rule was created
	CreatedOn string `json:"createdOn,omitempty"`

	// The JSON schema for customer data if it is required for the rule
	CustomerDataSchema string `json:"customerDataSchema,omitempty"`

	// Script run for validating customer data
	CustomerDataValidatorScript string `json:"customerDataValidatorScript,omitempty"`

	// Description of the rule
	// Example: This is just an example
	Description string `json:"description,omitempty"`

	// Execution position. Both, Before or After
	ExecutionPosition string `json:"executionPosition,omitempty"`

	// Has the rule been approved
	// Example: false
	IsApproved bool `json:"isApproved,omitempty"`

	// Is this a system rule as opposed to customer-facing
	// Example: false
	IsSystemRule bool `json:"isSystemRule,omitempty"`

	// Is this a rule created for testing
	// Example: true
	IsTest bool `json:"isTest,omitempty"`

	// Is the rule displayed in the CUP UI
	// Example: false
	IsVisibleInCUP bool `json:"isVisibleInCUP,omitempty"`

	// Last updater of the rule
	ModifiedBy string `json:"modifiedBy,omitempty"`

	// When the rule was last updated
	ModifiedOn string `json:"modifiedOn,omitempty"`

	// Rule name
	// Example: Generic replace rule
	// Required: true
	Name *string `json:"name"`

	// Unique identifier for a rule
	// Example: 15ba54328b5743ae9e9f1f07045951ca
	RuleID string `json:"ruleId,omitempty"`

	// The code script for the rule
	// Required: true
	Script *string `json:"script"`

	// The version of the rule
	// Example: 0
	Version int32 `json:"version,omitempty"`
}

AdvancedRuleFullDetailsModel Model for Advanced Rules when full details are requested Example: {"arEntitlementRequired":false,"description":"This is just an example","isApproved":false,"isSystemRule":false,"isTest":true,"isVisibleInCUP":false,"name":"Generic replace rule","ruleId":"15ba54328b5743ae9e9f1f07045951ca","version":0}

swagger:model AdvancedRuleFullDetailsModel

func (*AdvancedRuleFullDetailsModel) ContextValidate ¶ 

func (m *AdvancedRuleFullDetailsModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this advanced rule full details model based on context it is used

func (*AdvancedRuleFullDetailsModel) MarshalBinary ¶ 

func (m *AdvancedRuleFullDetailsModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleFullDetailsModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleFullDetailsModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleFullDetailsModel) Validate ¶ 

func (m *AdvancedRuleFullDetailsModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule full details model

type AdvancedRuleFullDetailsModelFetchResult ¶ 

type AdvancedRuleFullDetailsModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*AdvancedRuleFullDetailsModel `json:"value"`
}

AdvancedRuleFullDetailsModelFetchResult advanced rule full details model fetch result

swagger:model AdvancedRuleFullDetailsModelFetchResult

func (*AdvancedRuleFullDetailsModelFetchResult) ContextValidate ¶ 

func (m *AdvancedRuleFullDetailsModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this advanced rule full details model fetch result based on the context it is used

func (*AdvancedRuleFullDetailsModelFetchResult) MarshalBinary ¶ 

func (m *AdvancedRuleFullDetailsModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleFullDetailsModelFetchResult) UnmarshalBinary ¶ 

func (m *AdvancedRuleFullDetailsModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleFullDetailsModelFetchResult) Validate ¶ 

func (m *AdvancedRuleFullDetailsModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this advanced rule full details model fetch result

type AdvancedRuleLookupFileModel ¶ 

type AdvancedRuleLookupFileModel struct {

	// Content of the lookup file.
	// Example: SWQsTWF0ZXJpYWxHcm91cCxUYXhDb2RlIA0KMSw0MjM0NSxTQzE1MDMwNg0KMiw0MjM0NixTQzE1MDMwNg0KMywxMTExMSxQMDAwMDAwMA0KNCw0NDQ0NCxEQzAxMDAwMA0KNSw5MDk5OSxTUDE0MDAwMA==
	// Required: true
	// Format: byte
	Content *strfmt.Base64 `json:"content"`

	// Lookup file CreatedDate
	CreatedDate string `json:"createdDate,omitempty"`

	// File extension (e.g. CSV).
	// Example: .csv
	// Required: true
	// Max Length: 10
	// Min Length: 0
	FileExtension *string `json:"fileExtension"`

	// CompanyLookupFile unique identifier
	// Read Only: true
	ID string `json:"id,omitempty"`

	// Is this a lookup file in use for any rule
	InUse bool `json:"inUse,omitempty"`

	// Is this a lookup file created for testing
	// Example: false
	IsTest bool `json:"isTest,omitempty"`

	// LookupFile unique identifier
	LookupFileID string `json:"lookupFileId,omitempty"`

	// Lookup file ModifiedDate
	ModifiedDate string `json:"modifiedDate,omitempty"`

	// Name of lookup file
	// Example: sampleLookupFile
	// Required: true
	// Max Length: 100
	// Min Length: 0
	Name *string `json:"name"`

	// Lookup file version
	Version int32 `json:"version,omitempty"`
}

AdvancedRuleLookupFileModel Model representing a lookup file for a company Example: {"content":"SWQsTWF0ZXJpYWxHcm91cCxUYXhDb2RlIA0KMSw0MjM0NSxTQzE1MDMwNg0KMiw0MjM0NixTQzE1MDMwNg0KMywxMTExMSxQMDAwMDAwMA0KNCw0NDQ0NCxEQzAxMDAwMA0KNSw5MDk5OSxTUDE0MDAwMA==","fileExtension":".csv","isTest":false,"name":"sampleLookupFile"}

swagger:model AdvancedRuleLookupFileModel

func (*AdvancedRuleLookupFileModel) ContextValidate ¶ 

func (m *AdvancedRuleLookupFileModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this advanced rule lookup file model based on the context it is used

func (*AdvancedRuleLookupFileModel) MarshalBinary ¶ 

func (m *AdvancedRuleLookupFileModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleLookupFileModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleLookupFileModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleLookupFileModel) Validate ¶ 

func (m *AdvancedRuleLookupFileModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule lookup file model

type AdvancedRuleLookupFileModelFetchResult ¶ 

type AdvancedRuleLookupFileModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*AdvancedRuleLookupFileModel `json:"value"`
}

AdvancedRuleLookupFileModelFetchResult advanced rule lookup file model fetch result

swagger:model AdvancedRuleLookupFileModelFetchResult

func (*AdvancedRuleLookupFileModelFetchResult) ContextValidate ¶ 

func (m *AdvancedRuleLookupFileModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this advanced rule lookup file model fetch result based on the context it is used

func (*AdvancedRuleLookupFileModelFetchResult) MarshalBinary ¶ 

func (m *AdvancedRuleLookupFileModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleLookupFileModelFetchResult) UnmarshalBinary ¶ 

func (m *AdvancedRuleLookupFileModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleLookupFileModelFetchResult) Validate ¶ 

func (m *AdvancedRuleLookupFileModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this advanced rule lookup file model fetch result

type AdvancedRuleModel ¶ 

type AdvancedRuleModel struct {

	// Advance Rules limited availability
	// Example: false
	ArEntitlementRequired bool `json:"arEntitlementRequired,omitempty"`

	// Description of the rule
	// Example: Replaces a target value on the transaction with a replacement value
	Description string `json:"description,omitempty"`

	// Execution position. Both, Before or After
	ExecutionPosition string `json:"executionPosition,omitempty"`

	// Rule name
	// Example: Generic replace rule
	// Required: true
	Name *string `json:"name"`

	// Unique identifier for a rule
	// Example: 2bdf14892fb748d7a8f9aac261d4c5f3
	RuleID string `json:"ruleId,omitempty"`
}

AdvancedRuleModel A generic global advanced rule encapsulating a script Example: {"arEntitlementRequired":false,"description":"Replaces a target value on the transaction with a replacement value","name":"Generic replace rule","ruleId":"2bdf14892fb748d7a8f9aac261d4c5f3"}

swagger:model AdvancedRuleModel

func (*AdvancedRuleModel) ContextValidate ¶ 

func (m *AdvancedRuleModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this advanced rule model based on context it is used

func (*AdvancedRuleModel) MarshalBinary ¶ 

func (m *AdvancedRuleModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleModel) Validate ¶ 

func (m *AdvancedRuleModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule model

type AdvancedRuleVisibilityModel ¶ 

type AdvancedRuleVisibilityModel struct {

	// The account Id for which the rule is to be visible/not visible
	AccountID int32 `json:"accountId,omitempty"`

	// Should the rule be visible or not visible
	IsVisible bool `json:"isVisible,omitempty"`
}

AdvancedRuleVisibilityModel Model for toggling visibility of an advanced rule for an account Example: {"accountId":0,"isVisible":true}

swagger:model AdvancedRuleVisibilityModel

func (*AdvancedRuleVisibilityModel) ContextValidate ¶ 

func (m *AdvancedRuleVisibilityModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this advanced rule visibility model based on context it is used

func (*AdvancedRuleVisibilityModel) MarshalBinary ¶ 

func (m *AdvancedRuleVisibilityModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AdvancedRuleVisibilityModel) UnmarshalBinary ¶ 

func (m *AdvancedRuleVisibilityModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AdvancedRuleVisibilityModel) Validate ¶ 

func (m *AdvancedRuleVisibilityModel) Validate(formats strfmt.Registry) error

Validate validates this advanced rule visibility model

type ApproveAdvancedRuleModel ¶ 

type ApproveAdvancedRuleModel struct {

	// Should the rule be approved
	// Example: true
	IsApproved bool `json:"isApproved,omitempty"`
}

ApproveAdvancedRuleModel Model for changing the approved status of an advanced rule Example: {"isApproved":true}

swagger:model ApproveAdvancedRuleModel

func (*ApproveAdvancedRuleModel) ContextValidate ¶ 

func (m *ApproveAdvancedRuleModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this approve advanced rule model based on context it is used

func (*ApproveAdvancedRuleModel) MarshalBinary ¶ 

func (m *ApproveAdvancedRuleModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ApproveAdvancedRuleModel) UnmarshalBinary ¶ 

func (m *ApproveAdvancedRuleModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ApproveAdvancedRuleModel) Validate ¶ 

func (m *ApproveAdvancedRuleModel) Validate(formats strfmt.Registry) error

Validate validates this approve advanced rule model

type ApproveFilingsModel ¶ 

type ApproveFilingsModel struct {

	// Set this value to true in order to approve the filings.
	// Example: true
	// Required: true
	Approve *bool `json:"approve"`
}

ApproveFilingsModel Approve a set of filings. Example: {"approve":true}

swagger:model ApproveFilingsModel

func (*ApproveFilingsModel) ContextValidate ¶ 

func (m *ApproveFilingsModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this approve filings model based on context it is used

func (*ApproveFilingsModel) MarshalBinary ¶ 

func (m *ApproveFilingsModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ApproveFilingsModel) UnmarshalBinary ¶ 

func (m *ApproveFilingsModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ApproveFilingsModel) Validate ¶ 

func (m *ApproveFilingsModel) Validate(formats strfmt.Registry) error

Validate validates this approve filings model

type AuditEvent ¶ 

type AuditEvent struct {

	// audit event Id
	AuditEventID int64 `json:"auditEventId,omitempty"`

	// audit event level Id
	AuditEventLevelID int32 `json:"auditEventLevelId,omitempty"`

	// details
	Details string `json:"details,omitempty"`

	// event timestamp
	// Format: date-time
	EventTimestamp strfmt.DateTime `json:"eventTimestamp,omitempty"`

	// source
	Source string `json:"source,omitempty"`

	// summary
	Summary string `json:"summary,omitempty"`

	// transaction Id
	TransactionID int64 `json:"transactionId,omitempty"`
}

AuditEvent audit event

swagger:model AuditEvent

func (*AuditEvent) ContextValidate ¶ 

func (m *AuditEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this audit event based on context it is used

func (*AuditEvent) MarshalBinary ¶ 

func (m *AuditEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditEvent) UnmarshalBinary ¶ 

func (m *AuditEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditEvent) Validate ¶ 

func (m *AuditEvent) Validate(formats strfmt.Registry) error

Validate validates this audit event

type AuditModel ¶ 

type AuditModel struct {

	// The unique ID number of the account to which the user belongs.
	AccountID int32 `json:"accountId,omitempty"`

	// If your API call specified a `AdapterName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this
	// variable will contain its value.  This information is self-reported by the client and is not guaranteed to be present.
	AdapterName string `json:"adapterName,omitempty"`

	// If your API call specified a `AdapterVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this
	// variable will contain its value.  This information is self-reported by the client and is not guaranteed to be present.
	AdapterVersion string `json:"adapterVersion,omitempty"`

	// Reserved for Avalara internal usage.
	AuditMessage string `json:"auditMessage,omitempty"`

	// If your API call specified a `ClientName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this
	// variable will contain its value.  This information is self-reported by the client and is not guaranteed to be present.
	ClientName string `json:"clientName,omitempty"`

	// If your API call specified a `ClientVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this
	// variable will contain its value.  This information is self-reported by the client and is not guaranteed to be present.
	ClientVersion string `json:"clientVersion,omitempty"`

	// If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced.
	//
	// Please note that not all data layers support this measurement.
	DatabaseCallCount int32 `json:"databaseCallCount,omitempty"`

	// If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests.
	//
	// Please note that not all data layers support this measurement.
	DatabaseCallDuration string `json:"databaseCallDuration,omitempty"`

	// If this API call reported an error, this contains the name of the error that was returned.  You can look up more
	// information about AvaTax error messages on the [AvaTax REST Error Page](https://developer.avalara.com/avatax/errors/).
	ErrorMessage string `json:"errorMessage,omitempty"`

	// Reserved for Avalara internal usage.
	Events []*AuditEvent `json:"events"`

	// The origin IP address from which AvaTax received this API call.  If you use a proxy layer or other
	// gateway, this IP address may be the address of the gateway.  This information is not guaranteed
	// to be accurate and may change based on network conditions between your site and AvaTax.
	IPAddress string `json:"ipAddress,omitempty"`

	// Reserved for Avalara internal usage.
	IsQueued bool `json:"isQueued,omitempty"`

	// Reserved for Avalara internal usage.
	LoadBalancerDuration int32 `json:"loadBalancerDuration,omitempty"`

	// If your API call specified a `MachineName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this
	// variable will contain its value.  This information is self-reported by the client and is not guaranteed to be present.
	MachineName string `json:"machineName,omitempty"`

	// The operation name of this API call.
	Operation string `json:"operation,omitempty"`

	// If this API call returned an array of information, this value contains the number of records returned.
	RecordCount int32 `json:"recordCount,omitempty"`

	// Reserved for Avalara internal usage.
	ReferenceAuthorization string `json:"referenceAuthorization,omitempty"`

	// A context-dependent reference code for this API call.  This reference code is not guaranteed to contain a specific value
	// and may be used differently by various API calls.
	ReferenceCode string `json:"referenceCode,omitempty"`

	// A context-dependent reference ID for this API call.  This reference ID is not guaranteed to contain a specific value
	// and may be used differently by various API calls.
	ReferenceID int64 `json:"referenceId,omitempty"`

	// If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services.
	RemoteCallDuration string `json:"remoteCallDuration,omitempty"`

	// Reserved for Avalara internal usage.
	RemoteCalls []*AuditModel `json:"remoteCalls"`

	// If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client.
	//
	// This request body is represented as a string, exactly as it was received from the client.  Regardless of whether the request was JSON,
	// Base64 encoded bytes, or a CSV file, this contains the exact contents of the request body.
	RequestBody string `json:"requestBody,omitempty"`

	// The original request URL as provided by the client.
	RequestURL string `json:"requestUrl,omitempty"`

	// The entire response body sent from the AvaTax server to the client.  This value is returned as a string regardless of whether the results
	// were JSON-formatted text, CSV files, or raw strings.
	ResponseBody string `json:"responseBody,omitempty"`

	// The HTTP response code that was sent by the server.
	ResponseStatus int32 `json:"responseStatus,omitempty"`

	// The number of milliseconds that the AvaTax server took to respond to this API call.
	ServerDuration int32 `json:"serverDuration,omitempty"`

	// The server name of the AvaTax server that responded to this API call.
	ServerName string `json:"serverName,omitempty"`

	// The server timestamp, in UTC, of the time when the server received this API call.
	// Format: date-time
	ServerTimestamp strfmt.DateTime `json:"serverTimestamp,omitempty"`

	// The software version number of the currently deployed AvaTax API software on the server that responded to this API call.
	ServerVersion string `json:"serverVersion,omitempty"`

	// The service name of the AvaTax API service that responded to this API call.
	ServiceName string `json:"serviceName,omitempty"`

	// If the API contained a specific type of error code, this value would contain the unique ID number of the severity level
	// of the response returned to the client.
	SeverityLevelID int32 `json:"severityLevelId,omitempty"`

	// A unique ID number referring to this individual API call.
	TransactionID int64 `json:"transactionId,omitempty"`

	// The unique ID number of the user that performed this API call.
	UserID int32 `json:"userId,omitempty"`
}

AuditModel Provides detailed information about an API call.

The information on this record was captured by AvaTax when your API call was made. If you are unsure why you received an error, you can fetch these audit objects and examine the `RequestUrl`, `RequestBody`, and `ErrorMessage` fields to determine root cause for the error. Example: {"accountId":123,"adapterVersion":"1.0","clientName":"Swagger UI","clientVersion":"12.3.0","databaseCallCount":1,"databaseCallDuration":"00:00:00","errorMessage":"","ipAddress":"123.0.0.123","isQueued":false,"loadBalancerDuration":0,"machineName":"AV-T1234-56789","operation":"QueryCompanies","recordCount":32309,"referenceAuthorization":"","referenceCode":"/api/v2/companies","referenceId":0,"remoteCallDuration":"00:00:00","requestUrl":"/api/v2/companies","responseBody":"{\r\n \"@recordsetCount\": 0,\r\n \"value\": [],\r\n \"@nextLink\": \"/api/v2/companies?%24top=10\u0026%24skip=10\"\r\n}","responseStatus":200,"serverDuration":12345,"serverName":"AV-T1234-56789","serverTimestamp":"2021-12-25T17:08:35.5816044Z","serverVersion":"12.3.0.0","serviceName":"AccountSvcJson","severityLevelId":0,"transactionId":123,"userId":123}

swagger:model AuditModel

func (*AuditModel) ContextValidate ¶ 

func (m *AuditModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this audit model based on the context it is used

func (*AuditModel) MarshalBinary ¶ 

func (m *AuditModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditModel) UnmarshalBinary ¶ 

func (m *AuditModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditModel) Validate ¶ 

func (m *AuditModel) Validate(formats strfmt.Registry) error

Validate validates this audit model

type AuditModelFetchResult ¶ 

type AuditModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*AuditModel `json:"value"`
}

AuditModelFetchResult audit model fetch result

swagger:model AuditModelFetchResult

func (*AuditModelFetchResult) ContextValidate ¶ 

func (m *AuditModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this audit model fetch result based on the context it is used

func (*AuditModelFetchResult) MarshalBinary ¶ 

func (m *AuditModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditModelFetchResult) UnmarshalBinary ¶ 

func (m *AuditModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditModelFetchResult) Validate ¶ 

func (m *AuditModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this audit model fetch result

type AuditMultiDocumentModel ¶ 

type AuditMultiDocumentModel struct {

	// api call status
	// Example: OriginalApiCallAvailable
	// Enum: [OriginalApiCallAvailable ReconstructedApiCallAvailable Any]
	APICallStatus string `json:"apiCallStatus,omitempty"`

	// Represents the unique code of this MultiDocument transaction.
	//
	// A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`.
	Code string `json:"code,omitempty"`

	// Original API request/response
	// Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"},"response":{"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"83f6bfaa-9852-4e9c-8862-bc8af26c52da","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}}
	Original *OriginalAPIRequestResponseModel `json:"original,omitempty"`

	// Reconstructed API request/response pair that can be used to adjust or re-create this MultiDocument transaction.
	// Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}
	Reconstructed *ReconstructedMultiDocumentModel `json:"reconstructed,omitempty"`

	// Length of time the original API call took
	// Format: date-time
	ServerDuration strfmt.DateTime `json:"serverDuration,omitempty"`

	// Server timestamp, in UTC, of the date/time when the original transaction was created
	// Example: 2021-12-25T17:08:45.5498302Z
	// Format: date-time
	ServerTimestamp strfmt.DateTime `json:"serverTimestamp,omitempty"`

	// Represents the document type of this MultiDocument transaction.  For more information about
	// document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/).
	//
	// A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`.
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type string `json:"type,omitempty"`
}

AuditMultiDocumentModel Information about a previously created MultiDocument transaction Example: {"apiCallStatus":"ReconstructedApiCallAvailable","reconstructed":{"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}},"serverTimestamp":"2021-12-25T17:08:45.5498302Z","type":"SalesOrder"}

swagger:model AuditMultiDocumentModel

func (*AuditMultiDocumentModel) ContextValidate ¶ 

func (m *AuditMultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this audit multi document model based on the context it is used

func (*AuditMultiDocumentModel) MarshalBinary ¶ 

func (m *AuditMultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditMultiDocumentModel) UnmarshalBinary ¶ 

func (m *AuditMultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditMultiDocumentModel) Validate ¶ 

func (m *AuditMultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this audit multi document model

type AuditTransactionModel ¶ 

type AuditTransactionModel struct {

	// api call status
	// Example: OriginalApiCallAvailable
	// Enum: [OriginalApiCallAvailable ReconstructedApiCallAvailable Any]
	APICallStatus string `json:"apiCallStatus,omitempty"`

	// Unique ID number of the company that created this transaction
	// Example: 0
	CompanyID int32 `json:"companyId,omitempty"`

	// Original API request/response
	// Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"},"response":{"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"64f00cfd-56a9-4025-becd-e54b2ef8053c","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}}
	Original *OriginalAPIRequestResponseModel `json:"original,omitempty"`

	// Reconstructed API request/response
	// Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}
	Reconstructed *ReconstructedAPIRequestResponseModel `json:"reconstructed,omitempty"`

	// Length of time the original API call took
	// Format: date-time
	ServerDuration strfmt.DateTime `json:"serverDuration,omitempty"`

	// Server timestamp, in UTC, of the date/time when the original transaction was created
	// Example: 2021-12-25T17:08:47.5120263Z
	// Format: date-time
	ServerTimestamp strfmt.DateTime `json:"serverTimestamp,omitempty"`
}

AuditTransactionModel Information about a previously created transaction Example: {"apiCallStatus":"ReconstructedApiCallAvailable","companyId":0,"reconstructed":{"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}},"serverTimestamp":"2021-12-25T17:08:47.5120263Z"}

swagger:model AuditTransactionModel

func (*AuditTransactionModel) ContextValidate ¶ 

func (m *AuditTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this audit transaction model based on the context it is used

func (*AuditTransactionModel) MarshalBinary ¶ 

func (m *AuditTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditTransactionModel) UnmarshalBinary ¶ 

func (m *AuditTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditTransactionModel) Validate ¶ 

func (m *AuditTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this audit transaction model

type AvaFileFormModel ¶ 

type AvaFileFormModel struct {

	// The country this form is submitted for
	// Example: US
	Country string `json:"country,omitempty"`

	// A description of the submitted form
	// Example: State, Local, and District Sales and Use Tax Return
	Description string `json:"description,omitempty"`

	// The type of the due date
	// Example: ByDay
	// Enum: [ByDay ByLastDay BySecondLastDay]
	DueDateTypeID string `json:"dueDateTypeId,omitempty"`

	// Due date
	// Example: 20
	DueDay int32 `json:"dueDay,omitempty"`

	// The date this form starts to take effect
	// Example: 2005-04-01T00:00:00
	// Format: date-time
	EffDate strfmt.DateTime `json:"effDate,omitempty"`

	// The type of E-file due date.
	// Example: ByDay
	// Enum: [ByDay ByLastDay BySecondLastDay]
	EfileDueDateTypeID string `json:"efileDueDateTypeId,omitempty"`

	// The date by when the E-filing should be submitted
	// Example: 20
	EfileDueDay int32 `json:"efileDueDay,omitempty"`

	// The time of day by when the E-filing should be submitted
	// Example: 1900-01-01T00:00:00
	// Format: date-time
	EfileDueTime strfmt.DateTime `json:"efileDueTime,omitempty"`

	// The date the form finishes to take effect
	// Example: 9999-12-31T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// The type of Filing option
	// Example: Paper
	// Enum: [Paper OptionalEfile MandatoryEfile]
	FilingOptionTypeID string `json:"filingOptionTypeId,omitempty"`

	// Name of the submitted form
	// Example: CA BOE 401 A2
	FormName string `json:"formName,omitempty"`

	// The type of the form being submitted
	// Example: SalesAndUse
	// Enum: [SalesAndUse Sales SellersUse Lodging SalesAndLodging ConsumerUse ResortAndRental TouristAndRental Prepayment PrepaymentAllowed]
	FormTypeID string `json:"formTypeId,omitempty"`

	// Whether the customer has discount
	// Example: false
	HasVendorDiscount bool `json:"hasVendorDiscount,omitempty"`

	// Unique Id of the form
	// Example: 2415
	ID int32 `json:"id,omitempty"`

	// The outlet type of the form
	// Example: None
	// Enum: [None Schedule Duplicate Consolidated]
	OutletTypeID string `json:"outletTypeId,omitempty"`

	// State/Province/Region where the form is submitted for
	// Example: CA
	Region string `json:"region,omitempty"`

	// Name of the file being returned
	// Example: CABOE401A2
	ReturnName string `json:"returnName,omitempty"`

	// The way system does the rounding
	// Example: None
	// Enum: [None Nearest Up Down]
	RoundingTypeID string `json:"roundingTypeId,omitempty"`
}

AvaFileFormModel Represents information about a tax form known to Avalara Example: {"country":"US","description":"State, Local, and District Sales and Use Tax Return","dueDateTypeId":"ByDay","dueDay":20,"effDate":"2005-04-01T00:00:00","efileDueDateTypeId":"ByDay","efileDueDay":20,"efileDueTime":"1900-01-01T00:00:00","endDate":"9999-12-31T00:00:00","filingOptionTypeId":"Paper","formName":"CA BOE 401 A2","formTypeId":"SalesAndUse","hasVendorDiscount":false,"id":2415,"region":"CA","returnName":"CABOE401A2","roundingTypeId":"None"}

swagger:model AvaFileFormModel

func (*AvaFileFormModel) ContextValidate ¶ 

func (m *AvaFileFormModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this ava file form model based on context it is used

func (*AvaFileFormModel) MarshalBinary ¶ 

func (m *AvaFileFormModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AvaFileFormModel) UnmarshalBinary ¶ 

func (m *AvaFileFormModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AvaFileFormModel) Validate ¶ 

func (m *AvaFileFormModel) Validate(formats strfmt.Registry) error

Validate validates this ava file form model

type AvaFileFormModelFetchResult ¶ 

type AvaFileFormModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*AvaFileFormModel `json:"value"`
}

AvaFileFormModelFetchResult ava file form model fetch result

swagger:model AvaFileFormModelFetchResult

func (*AvaFileFormModelFetchResult) ContextValidate ¶ 

func (m *AvaFileFormModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this ava file form model fetch result based on the context it is used

func (*AvaFileFormModelFetchResult) MarshalBinary ¶ 

func (m *AvaFileFormModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AvaFileFormModelFetchResult) UnmarshalBinary ¶ 

func (m *AvaFileFormModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AvaFileFormModelFetchResult) Validate ¶ 

func (m *AvaFileFormModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this ava file form model fetch result

type AvaTaxMessage ¶ 

type AvaTaxMessage struct {

	// Detailed information that explains what the summary provided
	// Example: Address: 123 Main Street, Irvine, CA 92615 US, TaxRegion:2127863, Latitude: 33.657808, Longitude: -117.968489
	Details string `json:"details,omitempty"`

	// Information about what object in your request this message refers to
	// Example: Addresses[0] - TaxDate: 2017-09-21 00:00:00Z
	RefersTo string `json:"refersTo,omitempty"`

	// A category that indicates how severely this message affects the results
	// Example: Success
	Severity string `json:"severity,omitempty"`

	// The name of the code or service that generated this message
	// Example: Avalara.AvaTax.Services.Tax.Steps
	Source string `json:"source,omitempty"`

	// A brief summary of what this message tells us
	// Example: Using JAAS
	Summary string `json:"summary,omitempty"`
}

AvaTaxMessage Informational or warning messages returned by AvaTax with a transaction Example: {"details":"Address: 123 Main Street, Irvine, CA 92615 US, TaxRegion:2127863, Latitude: 33.657808, Longitude: -117.968489","refersTo":"Addresses[0] - TaxDate: 2017-09-21 00:00:00Z","severity":"Success","source":"Avalara.AvaTax.Services.Tax.Steps","summary":"Using JAAS"}

swagger:model AvaTaxMessage

func (*AvaTaxMessage) ContextValidate ¶ 

func (m *AvaTaxMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this ava tax message based on context it is used

func (*AvaTaxMessage) MarshalBinary ¶ 

func (m *AvaTaxMessage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AvaTaxMessage) UnmarshalBinary ¶ 

func (m *AvaTaxMessage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AvaTaxMessage) Validate ¶ 

func (m *AvaTaxMessage) Validate(formats strfmt.Registry) error

Validate validates this ava tax message

type AvailableCycleModel ¶ 

type AvailableCycleModel struct {

	// Cycle Name
	CycleName string `json:"cycleName,omitempty"`

	// Filing Due Date
	// Format: date-time
	FilingDueDate strfmt.DateTime `json:"filingDueDate,omitempty"`

	// Transactional Period End
	// Format: date-time
	TransactionalPeriodEnd strfmt.DateTime `json:"transactionalPeriodEnd,omitempty"`

	// Transactional Period Start
	// Format: date-time
	TransactionalPeriodStart strfmt.DateTime `json:"transactionalPeriodStart,omitempty"`
}

AvailableCycleModel Available Cycle object Example: {"cycleName":"","filingDueDate":"2021-12-25T17:08:42.5220618+00:00","transactionalPeriodEnd":"2022-01-24T17:08:42.5220811+00:00","transactionalPeriodStart":"2021-12-25T17:08:42.522095+00:00"}

swagger:model AvailableCycleModel

func (*AvailableCycleModel) ContextValidate ¶ 

func (m *AvailableCycleModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this available cycle model based on context it is used

func (*AvailableCycleModel) MarshalBinary ¶ 

func (m *AvailableCycleModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AvailableCycleModel) UnmarshalBinary ¶ 

func (m *AvailableCycleModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AvailableCycleModel) Validate ¶ 

func (m *AvailableCycleModel) Validate(formats strfmt.Registry) error

Validate validates this available cycle model

type BatchAdjustTransactionModel ¶ 

type BatchAdjustTransactionModel struct {

	// If the AdjustmentReason is "Other", specify the reason here.
	//
	// This is required when the AdjustmentReason is 8 (Other).
	// Example: Price drop before shipping
	AdjustmentDescription string `json:"adjustmentDescription,omitempty"`

	// A reason code indicating why this adjustment was made
	// Example: NotAdjusted
	// Required: true
	// Enum: [NotAdjusted SourcingIssue ReconciledWithGeneralLedger ExemptCertApplied PriceAdjusted ProductReturned ProductExchanged BadDebt Other Offline]
	AdjustmentReason *string `json:"adjustmentReason"`

	// Specifies the code of the company for this transaction.
	// Required: true
	// Max Length: 50
	// Min Length: 0
	CompanyCode *string `json:"companyCode"`

	// Specifies the type of document to void.
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType string `json:"documentType,omitempty"`

	// Replace the current transaction with tax data calculated for this new transaction
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	// Required: true
	NewTransaction *CreateTransactionModel `json:"newTransaction"`

	// Please specify the transaction code of the transacion to void.
	// Required: true
	TransactionCode *string `json:"transactionCode"`
}

BatchAdjustTransactionModel Replace an existing transaction recorded in AvaTax with a new one. Example: {"adjustmentDescription":"Price drop before shipping","adjustmentReason":"PriceAdjusted","companyCode":"DEFAULT","documentType":"SalesInvoice","newTransaction":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"},"transactionCode":"60fd584d-9790-4e01-80c9-2b0eaf28ff16"}

swagger:model BatchAdjustTransactionModel

func (*BatchAdjustTransactionModel) ContextValidate ¶ 

func (m *BatchAdjustTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch adjust transaction model based on the context it is used

func (*BatchAdjustTransactionModel) MarshalBinary ¶ 

func (m *BatchAdjustTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchAdjustTransactionModel) UnmarshalBinary ¶ 

func (m *BatchAdjustTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchAdjustTransactionModel) Validate ¶ 

func (m *BatchAdjustTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this batch adjust transaction model

type BatchFileModel ¶ 

type BatchFileModel struct {

	// The unique ID number of the batch that this file belongs to.
	// Read Only: true
	BatchID int32 `json:"batchId,omitempty"`

	// Content of the batch file.
	// Example: UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==
	// Required: true
	// Format: byte
	Content *strfmt.Base64 `json:"content"`

	// Size of content, in bytes.
	// Example: 0
	// Read Only: true
	ContentLength int32 `json:"contentLength,omitempty"`

	// Content mime type (e.g. text/csv).  This is used for HTTP downloading.
	// Example: text/csv
	// Max Length: 100
	// Min Length: 0
	ContentType *string `json:"contentType,omitempty"`

	// Number of errors that occurred when processing this file.
	ErrorCount int32 `json:"errorCount,omitempty"`

	// File extension (e.g. CSV).
	// Example: .csv
	// Max Length: 10
	// Min Length: 0
	FileExtension *string `json:"fileExtension,omitempty"`

	// Path to the file - name/S3 key
	// Example: samplebatch.csv
	FilePath string `json:"filePath,omitempty"`

	// The unique ID number assigned to this batch file.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// Logical Name of file (e.g. "Input" or "Error").
	// Example: samplebatch.csv
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name,omitempty"`
}

BatchFileModel Represents one file in a batch upload. Example: {"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","contentLength":0,"contentType":"text/csv","fileExtension":".csv","filePath":"samplebatch.csv","name":"samplebatch.csv"}

swagger:model BatchFileModel

func (*BatchFileModel) ContextValidate ¶ 

func (m *BatchFileModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch file model based on the context it is used

func (*BatchFileModel) MarshalBinary ¶ 

func (m *BatchFileModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchFileModel) UnmarshalBinary ¶ 

func (m *BatchFileModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchFileModel) Validate ¶ 

func (m *BatchFileModel) Validate(formats strfmt.Registry) error

Validate validates this batch file model

type BatchModel ¶ 

type BatchModel struct {

	// The Account ID number of the account that owns this batch.
	AccountID int32 `json:"accountId,omitempty"`

	// The agent used to create this batch
	// Example: manual
	// Max Length: 50
	// Min Length: 0
	BatchAgent *string `json:"batchAgent,omitempty"`

	// The Company ID number of the company that owns this batch.
	CompanyID int32 `json:"companyId,omitempty"`

	// The date/time when this batch was completely processed
	// Read Only: true
	// Format: date-time
	CompletedDate strfmt.DateTime `json:"completedDate,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The current record being processed
	// Read Only: true
	CurrentRecord int32 `json:"currentRecord,omitempty"`

	// The list of files contained in this batch.
	// Example: [{"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","contentLength":0,"contentType":"text/csv","fileExtension":".csv","filePath":"samplebatch.csv","name":"samplebatch.csv"}]
	Files []*BatchFileModel `json:"files"`

	// The unique ID number of this batch.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The user-friendly readable name for this batch.
	// Example: TestBatch
	// Required: true
	// Max Length: 194
	// Min Length: 0
	Name *string `json:"name"`

	// Any optional flags provided for this batch
	// Max Length: 200
	// Min Length: 0
	Options *string `json:"options,omitempty"`

	// The number of records in this batch; determined by the server
	// Read Only: true
	RecordCount int32 `json:"recordCount,omitempty"`

	// The date/time when this batch started processing
	// Read Only: true
	// Format: date-time
	StartedDate strfmt.DateTime `json:"startedDate,omitempty"`

	// This batch's current processing status
	// Example: Waiting
	// Read Only: true
	// Enum: [Waiting SystemErrors Cancelled Completed Creating Deleted Errors Paused Processing Cancelling]
	Status string `json:"status,omitempty"`

	// The type of this batch.
	// Example: AvaCertUpdate
	// Required: true
	// Enum: [AvaCertUpdate AvaCertUpdateAll BatchMaintenance CompanyLocationImport DocumentImport ExemptCertImport ItemImport SalesAuditExport SstpTestDeckImport TaxRuleImport TransactionImport UPCBulkImport UPCValidationImport CustomerSupplierImport]
	Type *string `json:"type"`
}

BatchModel Represents a batch of uploaded documents. Example: {"batchAgent":"manual","files":[{"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","contentLength":0,"contentType":"text/csv","fileExtension":".csv","filePath":"samplebatch.csv","name":"samplebatch.csv"}],"name":"TestBatch","type":"TransactionImport"}

swagger:model BatchModel

func (*BatchModel) ContextValidate ¶ 

func (m *BatchModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch model based on the context it is used

func (*BatchModel) MarshalBinary ¶ 

func (m *BatchModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchModel) UnmarshalBinary ¶ 

func (m *BatchModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchModel) Validate ¶ 

func (m *BatchModel) Validate(formats strfmt.Registry) error

Validate validates this batch model

type BatchModelFetchResult ¶ 

type BatchModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*BatchModel `json:"value"`
}

BatchModelFetchResult batch model fetch result

swagger:model BatchModelFetchResult

func (*BatchModelFetchResult) ContextValidate ¶ 

func (m *BatchModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch model fetch result based on the context it is used

func (*BatchModelFetchResult) MarshalBinary ¶ 

func (m *BatchModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchModelFetchResult) UnmarshalBinary ¶ 

func (m *BatchModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchModelFetchResult) Validate ¶ 

func (m *BatchModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this batch model fetch result

type BatchVoidTransactionModel ¶ 

type BatchVoidTransactionModel struct {

	// Please specify the reason for voiding or cancelling this transaction.
	// To void the transaction, please specify the reason 'DocVoided'.
	// If you do not provide a reason, the void command will fail.
	// Example: Unspecified
	// Required: true
	// Enum: [Unspecified PostFailed DocDeleted DocVoided AdjustmentCancelled]
	Code *string `json:"code"`

	// Company Code - Specify the code of the company for this transaction.
	// Required: true
	// Max Length: 50
	// Min Length: 0
	CompanyCode *string `json:"companyCode"`

	// Specifies the type of document to void.
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType string `json:"documentType,omitempty"`

	// Please specify the transaction code of the transacion to void.
	// Required: true
	TransactionCode *string `json:"transactionCode"`
}

BatchVoidTransactionModel A request to void a previously created transaction. Example: {"code":"DocVoided","companyCode":"DEFAULT","documentType":"SalesInvoice","transactionCode":"7778a257-783c-463e-924a-ad5d8940a512"}

swagger:model BatchVoidTransactionModel

func (*BatchVoidTransactionModel) ContextValidate ¶ 

func (m *BatchVoidTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this batch void transaction model based on context it is used

func (*BatchVoidTransactionModel) MarshalBinary ¶ 

func (m *BatchVoidTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchVoidTransactionModel) UnmarshalBinary ¶ 

func (m *BatchVoidTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchVoidTransactionModel) Validate ¶ 

func (m *BatchVoidTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this batch void transaction model

type BulkLockTransactionModel ¶ 

type BulkLockTransactionModel struct {

	// List of documents to lock
	// Example: [1,2,3,4,5]
	// Required: true
	DocumentIds []int64 `json:"documentIds"`

	// The lock status to set for the documents designated in this API
	// Example: true
	// Required: true
	IsLocked *bool `json:"isLocked"`
}

BulkLockTransactionModel Bulk lock documents model Example: {"documentIds":[1,2,3,4,5],"isLocked":true}

swagger:model BulkLockTransactionModel

func (*BulkLockTransactionModel) ContextValidate ¶ 

func (m *BulkLockTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this bulk lock transaction model based on context it is used

func (*BulkLockTransactionModel) MarshalBinary ¶ 

func (m *BulkLockTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BulkLockTransactionModel) UnmarshalBinary ¶ 

func (m *BulkLockTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BulkLockTransactionModel) Validate ¶ 

func (m *BulkLockTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this bulk lock transaction model

type BulkLockTransactionResult ¶ 

type BulkLockTransactionResult struct {

	// Number of records that have been modified
	NumberOfRecords int32 `json:"numberOfRecords,omitempty"`
}

BulkLockTransactionResult Returns information about transactions that were locked Example: {"numberOfRecords":42}

swagger:model BulkLockTransactionResult

func (*BulkLockTransactionResult) ContextValidate ¶ 

func (m *BulkLockTransactionResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this bulk lock transaction result based on context it is used

func (*BulkLockTransactionResult) MarshalBinary ¶ 

func (m *BulkLockTransactionResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BulkLockTransactionResult) UnmarshalBinary ¶ 

func (m *BulkLockTransactionResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BulkLockTransactionResult) Validate ¶ 

func (m *BulkLockTransactionResult) Validate(formats strfmt.Registry) error

Validate validates this bulk lock transaction result

type CertExpressInvitationModel ¶ 

type CertExpressInvitationModel struct {

	// The unique ID number of the AvaTax company that sent this invitation.
	CompanyID int32 `json:"companyId,omitempty"`

	// The attached cover letter object to this request.
	// Example: {"createdDate":"0001-01-01T00:00:00","description":"Please upload your certificate to CertCapture","modifiedDate":"0001-01-01T00:00:00","subject":"Please submit your exemption certificate","title":"STANDARD_REQUEST","version":0}
	// Read Only: true
	CoverLetter *CoverLetterModel `json:"coverLetter,omitempty"`

	// True if this invitation contained a cover letter only.
	// Read Only: true
	CoverLettersOnly *bool `json:"coverLettersOnly,omitempty"`

	// The customer who received this invitation.
	// Example: {"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"4346d9f4-b0c4-4d6b-8b42-83b9f509da29","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"}
	// Read Only: true
	Customer *CustomerModel `json:"customer,omitempty"`

	// The unique code of the customer that received this invitation.
	// Note: This field is case sensitive. To have exemption certificates apply, this value should
	// be the same as the one passed to create a customer.
	// Example: ABC
	CustomerCode string `json:"customerCode,omitempty"`

	// The date of the invitation.
	// Format: date-time
	Date strfmt.DateTime `json:"date,omitempty"`

	// Indicates the method that was used to deliver this CertExpress invitation.
	// Example: Email
	// Enum: [Email Fax Download]
	DeliveryMethod string `json:"deliveryMethod,omitempty"`

	// The status of the emails associated with this invitation.  If this invitation was sent via email,
	// this value will change to `Sent` when the email message has been sent.
	// Read Only: true
	EmailStatus string `json:"emailStatus,omitempty"`

	// The list of exemption reasons identified by this CertExpress invitation.
	//
	// For a list of reason codes, please call `ListCertificateExemptReasons`.
	ExemptReasons []int32 `json:"exemptReasons"`

	// When an invitation is sent, it contains a list of exposure zones for which the customer is invited to upload
	// their exemption certificates.  This list contains the ID numbers of the exposure zones identified.
	//
	// For a list of exposure zones, please call `ListCertificateExposureZones`.
	ExposureZones []int32 `json:"exposureZones"`

	// A unique ID number representing this CertExpress invitation.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The custom message delivered with this invitation.
	Message string `json:"message,omitempty"`

	// The email address to which this invitation was sent.  If this invitation was presented as a weblink, this value will be null.
	Recipient string `json:"recipient,omitempty"`

	// The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.
	//
	// This value is only usable if the status of this invitation is `Ready` and the request was created with type `Download`.
	// NOTE: This link usually takes a few minutes to be available.
	RequestLink string `json:"requestLink,omitempty"`
}

CertExpressInvitationModel Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record. Example: {"customerCode":"ABC"}

swagger:model CertExpressInvitationModel

func (*CertExpressInvitationModel) ContextValidate ¶ 

func (m *CertExpressInvitationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cert express invitation model based on the context it is used

func (*CertExpressInvitationModel) MarshalBinary ¶ 

func (m *CertExpressInvitationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertExpressInvitationModel) UnmarshalBinary ¶ 

func (m *CertExpressInvitationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertExpressInvitationModel) Validate ¶ 

func (m *CertExpressInvitationModel) Validate(formats strfmt.Registry) error

Validate validates this cert express invitation model

type CertExpressInvitationModelFetchResult ¶ 

type CertExpressInvitationModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CertExpressInvitationModel `json:"value"`
}

CertExpressInvitationModelFetchResult cert express invitation model fetch result

swagger:model CertExpressInvitationModelFetchResult

func (*CertExpressInvitationModelFetchResult) ContextValidate ¶ 

func (m *CertExpressInvitationModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cert express invitation model fetch result based on the context it is used

func (*CertExpressInvitationModelFetchResult) MarshalBinary ¶ 

func (m *CertExpressInvitationModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertExpressInvitationModelFetchResult) UnmarshalBinary ¶ 

func (m *CertExpressInvitationModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertExpressInvitationModelFetchResult) Validate ¶ 

func (m *CertExpressInvitationModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this cert express invitation model fetch result

type CertExpressInvitationStatusModel ¶ 

type CertExpressInvitationStatusModel struct {

	// The CertExpress invitation for the customer.  If you specified an email address in the invitation
	// request, this invitation will be sent via email.  Otherwise, you are expected to direct the customer
	// using a hyperlink directly in your application.
	// Example: {"customerCode":"ABC"}
	Invitation *CertExpressInvitationModel `json:"invitation,omitempty"`

	// The status of the CertExpress invitation for this customer.  If this status says
	// Example: InProgress
	// Enum: [InProgress Ready]
	Status string `json:"status,omitempty"`
}

CertExpressInvitationStatusModel Represent what is the current status of certificate request Example: {"invitation":{"customerCode":"ABC"},"status":"InProgress"}

swagger:model CertExpressInvitationStatusModel

func (*CertExpressInvitationStatusModel) ContextValidate ¶ 

func (m *CertExpressInvitationStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cert express invitation status model based on the context it is used

func (*CertExpressInvitationStatusModel) MarshalBinary ¶ 

func (m *CertExpressInvitationStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertExpressInvitationStatusModel) UnmarshalBinary ¶ 

func (m *CertExpressInvitationStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertExpressInvitationStatusModel) Validate ¶ 

func (m *CertExpressInvitationStatusModel) Validate(formats strfmt.Registry) error

Validate validates this cert express invitation status model

type CertificateAttributeModel ¶ 

type CertificateAttributeModel struct {

	// A full help text description of the certificate attribute.
	Description string `json:"description,omitempty"`

	// A unique ID number representing this certificate attribute.
	// Example: 0
	ID int32 `json:"id,omitempty"`

	// This value is true if this is a system-defined certificate attribute.  System-defined attributes
	// cannot be modified or deleted on the CertCapture website.
	// Example: false
	IsSystemCode bool `json:"isSystemCode,omitempty"`

	// A friendly readable name for this certificate attribute.
	// Example: DIRECT PAY
	Name string `json:"name,omitempty"`
}

CertificateAttributeModel A certificate attribute can be thought of as a feature or flag that is applied to a certificate. A single certificate can be linked to zero, one, or many certificate attributes. The full list of attributes can be obtained by calling the `ListCertificateAttributes` API. Example: {"id":0,"isSystemCode":false,"name":"DIRECT PAY"}

swagger:model CertificateAttributeModel

func (*CertificateAttributeModel) ContextValidate ¶ 

func (m *CertificateAttributeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this certificate attribute model based on context it is used

func (*CertificateAttributeModel) MarshalBinary ¶ 

func (m *CertificateAttributeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertificateAttributeModel) UnmarshalBinary ¶ 

func (m *CertificateAttributeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertificateAttributeModel) Validate ¶ 

func (m *CertificateAttributeModel) Validate(formats strfmt.Registry) error

Validate validates this certificate attribute model

type CertificateAttributeModelFetchResult ¶ 

type CertificateAttributeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CertificateAttributeModel `json:"value"`
}

CertificateAttributeModelFetchResult certificate attribute model fetch result

swagger:model CertificateAttributeModelFetchResult

func (*CertificateAttributeModelFetchResult) ContextValidate ¶ 

func (m *CertificateAttributeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this certificate attribute model fetch result based on the context it is used

func (*CertificateAttributeModelFetchResult) MarshalBinary ¶ 

func (m *CertificateAttributeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertificateAttributeModelFetchResult) UnmarshalBinary ¶ 

func (m *CertificateAttributeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertificateAttributeModelFetchResult) Validate ¶ 

func (m *CertificateAttributeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this certificate attribute model fetch result

type CertificateModel ¶ 

type CertificateModel struct {

	// A list of certificate attributes that apply to this certificate.
	//
	// You can fetch this data by specifying `$include=attributes` when calling a certificate fetch API.
	Attributes []*CertificateAttributeModel `json:"attributes"`

	// Description of business for the certificate. For example, `Retail trade`, `Professional services`, or `Construction`.
	// Example: Business Services
	BusinessNumberType string `json:"businessNumberType,omitempty"`

	// The unique ID number of the AvaTax company that recorded this certificate.
	CompanyID int32 `json:"companyId,omitempty"`

	// The date/time when this record was created.
	// Example: 2021-12-25T17:08:37.796337Z
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// A list of customers to which this certificate applies.  You can fetch this data by specifying
	// `$include=customers` when calling a certificate fetch API.
	// Example: [{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"73539ce2-dddf-425c-bacf-69cd418bea17","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"},{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"953880f2-6390-495c-9ce3-e12ab9ee2a6b","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"}]
	Customers []*CustomerModel `json:"customers"`

	// This value is true if there exists scanned PDF copy of this certificate or the PDF version of the form that the customer filled via the CertCapture wizard on S3 bucket.
	// Example: false
	// Read Only: true
	DocumentExists *bool `json:"documentExists,omitempty"`

	// The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
	EcmsID int32 `json:"ecmsId,omitempty"`

	// The status of current AvaTax Exemption Certificate  that refers to this certificate.
	EcmsStatus string `json:"ecmsStatus,omitempty"`

	// If this certificate provides exemption from transactional taxes, what percentage of the transaction
	// is considered exempt?
	//
	// For a fully exempt certificate, this percentage should be 100.
	// Example: 0
	ExemptPercentage float64 `json:"exemptPercentage,omitempty"`

	// Indicates the tax number passed in for the certificate.
	// Example: Exempt-1234
	ExemptionNumber string `json:"exemptionNumber,omitempty"`

	// The exemption reason associated with this certificate.  For example, the reason code for exemption
	// for purposes of resale is `RESALE`.
	//
	// For a list of exemption reasons, call `ListCertificateExemptReasons`.
	// Example: {"name":"RESALE"}
	// Required: true
	ExemptionReason *ExemptionReasonModel `json:"exemptionReason"`

	// Expiration date when this certificate will no longer be valid.
	// Example: 2020-12-31T00:00:00
	// Required: true
	// Format: date
	ExpirationDate *strfmt.Date `json:"expirationDate"`

	// The exposure zone where this certificate is valid.
	// Example: {"name":"Washington"}
	// Required: true
	ExposureZone *ExposureZoneModel `json:"exposureZone"`

	// File name for the image of this certificate.
	//
	// When creating a certificate, if you do not upload a PDF or JPG image, you must specify the filename
	// of the certificate as it is tracked in your repository.
	//
	// To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file,
	// or an array of JPG `pages`.  The API will return an error if you omit these fields or if you attempt to
	// put values in more than one of them.
	// Example: 878e7641-12be-490d-9f14-f7054dea8cc3
	Filename string `json:"filename,omitempty"`

	// Unique ID number of this certificate.
	// Example: 0
	ID int32 `json:"id,omitempty"`

	// This value is true if this certificate is a single (or standalone) certificate.  This value is set
	// during the audit stage of the certificate validation process.
	// Example: false
	// Read Only: true
	IsSingleCertificate *bool `json:"isSingleCertificate,omitempty"`

	// The date/time when this record was last modified.
	// Example: 2021-12-25T17:08:37.7963369Z
	// Format: date
	ModifiedDate strfmt.Date `json:"modifiedDate,omitempty"`

	// Number of pages contained within this certificate.
	// Example: 0
	// Read Only: true
	PageCount int32 `json:"pageCount,omitempty"`

	// This field is available for input only.  To retrieve the image after creation, use the
	// `DownloadCertificateImage` API.
	//
	// When creating a certificate, you may optionally provide a list of JPG images, one per page, in
	// Base64 URLEncoded format.  These JPG images are automatically combined into a single downloadable
	// PDF and can be retrieved back later as either the original JPG images or the combined PDF.
	//
	// To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file,
	// or an array of JPG `pages`.  The API will return an error if you omit these fields or if you attempt to
	// put values in more than one of them.
	Pages []string `json:"pages"`

	// This field is available for input only.  To retrieve the image after creation, use the
	// `DownloadCertificateImage` API.
	//
	// When creating a certificate, you may optionally provide a PDF image in Base64 URLEncoded format.
	// PDFs are automatically parsed into individual page JPG images and can be retrieved back
	// later as either the original PDF or the individual pages.
	//
	// To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file,
	// or an array of JPG `pages`.  The API will return an error if you omit these fields or if you attempt to
	// put values in more than one of them.
	Pdf string `json:"pdf,omitempty"`

	// A list of purchase order numbers that are valid for use with this certificate.
	//
	// If this certificate is applicable for all purchase order numbers, this field will be empty.
	//
	// You can fetch this data by specifying `$include=po_numbers` when calling a certificate fetch API.
	PoNumbers []*PoNumberModel `json:"poNumbers"`

	// The date when this certificate was signed.
	// Example: 2016-02-01T00:00:00
	// Required: true
	// Format: date
	SignedDate *strfmt.Date `json:"signedDate"`

	// The status of the certificate
	// Read Only: true
	Status string `json:"status,omitempty"`

	// The tax number type for the certificate. For example, `FEIN`, `Social Security Number`, or `Employer Identification Number`.
	// Example: FEIN
	TaxNumberType string `json:"taxNumberType,omitempty"`

	// True if this certificate is marked as valid.  A valid certificate can be considered for exemption purposes.
	// When a certificate is marked invalid, it will no longer be considered when calculating exemption for
	// a customer.
	// Example: true
	Valid bool `json:"valid,omitempty"`

	// The exemption reason that CertCapture audit/internal logic identifies for created certificate.
	// Example: {"name":"EXPOSURE"}
	ValidatedExemptionReason *ExemptionReasonModel `json:"validatedExemptionReason,omitempty"`

	// This value is true if the certificate has gone through the certificate validation process.
	// For more information on the certificate validation process, please see the Avalara Help Center.
	// Example: false
	// Read Only: true
	Verified *bool `json:"verified,omitempty"`
}

CertificateModel A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on criteria you specify when you store the certificate. To view or manage your certificates directly, please log onto the administrative website for the product you purchased. Example: {"businessNumberType":"Business Services","createdDate":"2021-12-25T17:08:37.796337Z","customers":[{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"73539ce2-dddf-425c-bacf-69cd418bea17","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"},{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"953880f2-6390-495c-9ce3-e12ab9ee2a6b","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"}],"documentExists":false,"exemptPercentage":0,"exemptionNumber":"Exempt-1234","exemptionReason":{"name":"RESALE"},"expirationDate":"2020-12-31","exposureZone":{"name":"Washington"},"filename":"878e7641-12be-490d-9f14-f7054dea8cc3","id":0,"isSingleCertificate":false,"modifiedDate":"2021-12-25","pageCount":0,"signedDate":"2016-02-01","taxNumberType":"FEIN","valid":true,"verified":false}

swagger:model CertificateModel

func (*CertificateModel) ContextValidate ¶ 

func (m *CertificateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this certificate model based on the context it is used

func (*CertificateModel) MarshalBinary ¶ 

func (m *CertificateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertificateModel) UnmarshalBinary ¶ 

func (m *CertificateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertificateModel) Validate ¶ 

func (m *CertificateModel) Validate(formats strfmt.Registry) error

Validate validates this certificate model

type CertificateModelFetchResult ¶ 

type CertificateModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CertificateModel `json:"value"`
}

CertificateModelFetchResult certificate model fetch result

swagger:model CertificateModelFetchResult

func (*CertificateModelFetchResult) ContextValidate ¶ 

func (m *CertificateModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this certificate model fetch result based on the context it is used

func (*CertificateModelFetchResult) MarshalBinary ¶ 

func (m *CertificateModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CertificateModelFetchResult) UnmarshalBinary ¶ 

func (m *CertificateModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CertificateModelFetchResult) Validate ¶ 

func (m *CertificateModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this certificate model fetch result

type ChangeTransactionCodeModel ¶ 

type ChangeTransactionCodeModel struct {

	// To change the transaction code for this transaction, specify the new transaction code here.
	// Example: 32e7c858-ec35-4a43-ae0b-00d738dfcd98
	// Required: true
	// Max Length: 50
	// Min Length: 0
	NewCode *string `json:"newCode"`
}

ChangeTransactionCodeModel Settle this transaction with your ledger by verifying its amounts. If the transaction is not yet committed, you may specify the "commit" value to commit it to the ledger and allow it to be reported. You may also optionally change the transaction's code by specifying the "newTransactionCode" value. Example: {"newCode":"32e7c858-ec35-4a43-ae0b-00d738dfcd98"}

swagger:model ChangeTransactionCodeModel

func (*ChangeTransactionCodeModel) ContextValidate ¶ 

func (m *ChangeTransactionCodeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this change transaction code model based on context it is used

func (*ChangeTransactionCodeModel) MarshalBinary ¶ 

func (m *ChangeTransactionCodeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ChangeTransactionCodeModel) UnmarshalBinary ¶ 

func (m *ChangeTransactionCodeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ChangeTransactionCodeModel) Validate ¶ 

func (m *ChangeTransactionCodeModel) Validate(formats strfmt.Registry) error

Validate validates this change transaction code model

type ClassificationModel ¶ 

type ClassificationModel struct {

	// The product code of an item in a given system.
	// Example: 9011900000
	// Required: true
	// Max Length: 25
	// Min Length: 0
	ProductCode *string `json:"productCode"`

	// The system code in which the product belongs.
	// Example: TARIC
	// Max Length: 25
	// Min Length: 0
	SystemCode *string `json:"systemCode,omitempty"`
}

ClassificationModel Represents a classification for a given item. Example: {"productCode":"9011900000","systemCode":"TARIC"}

swagger:model ClassificationModel

func (*ClassificationModel) ContextValidate ¶ 

func (m *ClassificationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this classification model based on context it is used

func (*ClassificationModel) MarshalBinary ¶ 

func (m *ClassificationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClassificationModel) UnmarshalBinary ¶ 

func (m *ClassificationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClassificationModel) Validate ¶ 

func (m *ClassificationModel) Validate(formats strfmt.Registry) error

Validate validates this classification model

type ClassificationParameterUsageMapModel ¶ 

type ClassificationParameterUsageMapModel struct {

	// The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
	// Example: Product
	AttributeType string `json:"attributeType,omitempty"`

	// The data type of the property.
	// Example: NumericMeasured
	DataType string `json:"dataType,omitempty"`

	// Help text to be shown to the user when they are filling out this parameter.  Help text may include HTML links to additional
	// content with more information about a parameter.
	// Example: A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.
	HelpText string `json:"helpText,omitempty"`

	// A help url that provides more information about the parameter
	HelpURL string `json:"helpUrl,omitempty"`

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

	// Label that helps the user to identify a parameter
	// Example: Screen Size
	Label string `json:"label,omitempty"`

	// The unit of measurement type of the parameter
	// Example: Length
	MeasurementType string `json:"measurementType,omitempty"`

	// The name of the property.  To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call.
	// Example: ScreenSize
	Name string `json:"name,omitempty"`

	// The id of the parameter.
	// Example: 12345
	ParameterID int64 `json:"parameterId,omitempty"`

	// tax type group id for the classification parameter usage item.
	// Example: EWaste
	TaxTypeGroupID string `json:"taxTypeGroupId,omitempty"`

	// If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
	Values []string `json:"values"`

	// This defines if the parameter is recommeded ,optional or mandatory
	// Example: Required
	// Enum: [Required Recommended Optional Conditional]
	Visibility string `json:"visibility,omitempty"`
}

ClassificationParameterUsageMapModel usage of system defined parameters. Example: {"attributeType":"Product","dataType":"NumericMeasured","helpText":"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.","id":12345,"label":"Screen Size","measurementType":"Length","name":"ScreenSize","parameterId":12345,"taxTypeGroupId":"EWaste","visibility":"Required"}

swagger:model ClassificationParameterUsageMapModel

func (*ClassificationParameterUsageMapModel) ContextValidate ¶ 

func (m *ClassificationParameterUsageMapModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this classification parameter usage map model based on context it is used

func (*ClassificationParameterUsageMapModel) MarshalBinary ¶ 

func (m *ClassificationParameterUsageMapModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClassificationParameterUsageMapModel) UnmarshalBinary ¶ 

func (m *ClassificationParameterUsageMapModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClassificationParameterUsageMapModel) Validate ¶ 

func (m *ClassificationParameterUsageMapModel) Validate(formats strfmt.Registry) error

Validate validates this classification parameter usage map model

type ClassificationParameterUsageMapModelFetchResult ¶ 

type ClassificationParameterUsageMapModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ClassificationParameterUsageMapModel `json:"value"`
}

ClassificationParameterUsageMapModelFetchResult classification parameter usage map model fetch result

swagger:model ClassificationParameterUsageMapModelFetchResult

func (*ClassificationParameterUsageMapModelFetchResult) ContextValidate ¶ 

func (m *ClassificationParameterUsageMapModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this classification parameter usage map model fetch result based on the context it is used

func (*ClassificationParameterUsageMapModelFetchResult) MarshalBinary ¶ 

func (m *ClassificationParameterUsageMapModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClassificationParameterUsageMapModelFetchResult) UnmarshalBinary ¶ 

func (m *ClassificationParameterUsageMapModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClassificationParameterUsageMapModelFetchResult) Validate ¶ 

func (m *ClassificationParameterUsageMapModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this classification parameter usage map model fetch result

type CommitMultiDocumentModel ¶ 

type CommitMultiDocumentModel struct {

	// Represents the unique code of this MultiDocument transaction.
	//
	// A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`.        ///
	// Example: 3ac79777-3281-4dcb-9f71-eb0c023165d1
	// Required: true
	Code *string `json:"code"`

	// Set this value to be `true` to commit this transaction.
	//
	// Committing a transaction allows it to be reported on a tax filing.  Uncommitted transactions will not be reported.
	// Example: true
	// Required: true
	Commit *bool `json:"commit"`

	// Represents the document type of this MultiDocument transaction.  For more information about
	// document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/).
	//
	// A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`.
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type string `json:"type,omitempty"`
}

CommitMultiDocumentModel Commit this MultiDocument object so that all transactions within it can be reported on a tax filing. Example: {"code":"3ac79777-3281-4dcb-9f71-eb0c023165d1","commit":true,"type":"SalesInvoice"}

swagger:model CommitMultiDocumentModel

func (*CommitMultiDocumentModel) ContextValidate ¶ 

func (m *CommitMultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this commit multi document model based on context it is used

func (*CommitMultiDocumentModel) MarshalBinary ¶ 

func (m *CommitMultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CommitMultiDocumentModel) UnmarshalBinary ¶ 

func (m *CommitMultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CommitMultiDocumentModel) Validate ¶ 

func (m *CommitMultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this commit multi document model

type CommitTransactionModel ¶ 

type CommitTransactionModel struct {

	// Set this value to be `true` to commit this transaction.
	//
	// Committing a transaction allows it to be reported on a tax filing.  Uncommitted transactions will not be reported.
	// Example: true
	// Required: true
	Commit *bool `json:"commit"`
}

CommitTransactionModel Commit this transaction as permanent so that it can be reported on a tax filing. Example: {"commit":true}

swagger:model CommitTransactionModel

func (*CommitTransactionModel) ContextValidate ¶ 

func (m *CommitTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this commit transaction model based on context it is used

func (*CommitTransactionModel) MarshalBinary ¶ 

func (m *CommitTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CommitTransactionModel) UnmarshalBinary ¶ 

func (m *CommitTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CommitTransactionModel) Validate ¶ 

func (m *CommitTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this commit transaction model

type CommunicationsTSPairModel ¶ 

type CommunicationsTSPairModel struct {

	// The name of the service type.
	AvaTaxCommunicationsServiceType string `json:"AvaTax.Communications.ServiceType,omitempty"`

	// The name of the transaction type.
	AvaTaxCommunicationsTransactionType string `json:"AvaTax.Communications.TransactionType,omitempty"`

	// The description of the transaction/service type pair.
	// Example: Basic monthly flat-rate charge for cellular/wireless service.
	Description string `json:"description,omitempty"`

	// List of the parameters (among Charge, Minutes and Lines) that will be used for calculation for this T/S pair.
	// Example: ["AvaTax.Communications.Charge","AvaTax.Communications.Minutes"]
	RequiredParameters []string `json:"requiredParameters"`

	// The numeric Id of the service type.
	// Example: 6
	// Required: true
	ServiceTypeID *int32 `json:"serviceTypeId"`

	// The numeric Id of the transaction type.
	// Example: 13
	// Required: true
	TransactionTypeID *int32 `json:"transactionTypeId"`
}

CommunicationsTSPairModel Represents a transaction/service type pair for telecommunications tax Example: {"AvaTax.Communications.ServiceType":"Access Charge","AvaTax.Communications.TransactionType":"Cellular","description":"Basic monthly flat-rate charge for cellular/wireless service.","requiredParameters":["AvaTax.Communications.Charge","AvaTax.Communications.Minutes"],"serviceTypeId":6,"transactionTypeId":13}

swagger:model CommunicationsTSPairModel

func (*CommunicationsTSPairModel) ContextValidate ¶ 

func (m *CommunicationsTSPairModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this communications t s pair model based on context it is used

func (*CommunicationsTSPairModel) MarshalBinary ¶ 

func (m *CommunicationsTSPairModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CommunicationsTSPairModel) UnmarshalBinary ¶ 

func (m *CommunicationsTSPairModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CommunicationsTSPairModel) Validate ¶ 

func (m *CommunicationsTSPairModel) Validate(formats strfmt.Registry) error

Validate validates this communications t s pair model

type CommunicationsTSPairModelFetchResult ¶ 

type CommunicationsTSPairModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CommunicationsTSPairModel `json:"value"`
}

CommunicationsTSPairModelFetchResult communications t s pair model fetch result

swagger:model CommunicationsTSPairModelFetchResult

func (*CommunicationsTSPairModelFetchResult) ContextValidate ¶ 

func (m *CommunicationsTSPairModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this communications t s pair model fetch result based on the context it is used

func (*CommunicationsTSPairModelFetchResult) MarshalBinary ¶ 

func (m *CommunicationsTSPairModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CommunicationsTSPairModelFetchResult) UnmarshalBinary ¶ 

func (m *CommunicationsTSPairModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CommunicationsTSPairModelFetchResult) Validate ¶ 

func (m *CommunicationsTSPairModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this communications t s pair model fetch result

type CommunicationsTransactionTypeModel ¶ 

type CommunicationsTransactionTypeModel struct {

	// The name of the transaction type.
	AvaTaxCommunicationsTransactionType string `json:"AvaTax.Communications.TransactionType,omitempty"`

	// The numeric Id of the transaction type.
	// Example: 13
	// Required: true
	TransactionTypeID *int32 `json:"transactionTypeId"`
}

CommunicationsTransactionTypeModel Represents information about a type of telecommunications transaction Example: {"AvaTax.Communications.TransactionType":"Cellular","transactionTypeId":13}

swagger:model CommunicationsTransactionTypeModel

func (*CommunicationsTransactionTypeModel) ContextValidate ¶ 

func (m *CommunicationsTransactionTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this communications transaction type model based on context it is used

func (*CommunicationsTransactionTypeModel) MarshalBinary ¶ 

func (m *CommunicationsTransactionTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CommunicationsTransactionTypeModel) UnmarshalBinary ¶ 

func (m *CommunicationsTransactionTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CommunicationsTransactionTypeModel) Validate ¶ 

func (m *CommunicationsTransactionTypeModel) Validate(formats strfmt.Registry) error

Validate validates this communications transaction type model

type CommunicationsTransactionTypeModelFetchResult ¶ 

type CommunicationsTransactionTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CommunicationsTransactionTypeModel `json:"value"`
}

CommunicationsTransactionTypeModelFetchResult communications transaction type model fetch result

swagger:model CommunicationsTransactionTypeModelFetchResult

func (*CommunicationsTransactionTypeModelFetchResult) ContextValidate ¶ 

func (m *CommunicationsTransactionTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this communications transaction type model fetch result based on the context it is used

func (*CommunicationsTransactionTypeModelFetchResult) MarshalBinary ¶ 

func (m *CommunicationsTransactionTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CommunicationsTransactionTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *CommunicationsTransactionTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CommunicationsTransactionTypeModelFetchResult) Validate ¶ 

func (m *CommunicationsTransactionTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this communications transaction type model fetch result

type CompanyAddress ¶ 

type CompanyAddress struct {

	// City
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// Address Line1
	// Example: 2000 Main Street
	// Required: true
	// Max Length: 100
	// Min Length: 0
	Line *string `json:"line"`

	// Postal Code
	// Example: 92614
	// Required: true
	// Max Length: 10
	// Min Length: 0
	PostalCode *string `json:"postalCode"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`
}

CompanyAddress Company Address Information Example: {"city":"Irvine","country":"US","line":"2000 Main Street","postalCode":"92614","region":"CA"}

swagger:model CompanyAddress

func (*CompanyAddress) ContextValidate ¶ 

func (m *CompanyAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this company address based on context it is used

func (*CompanyAddress) MarshalBinary ¶ 

func (m *CompanyAddress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyAddress) UnmarshalBinary ¶ 

func (m *CompanyAddress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyAddress) Validate ¶ 

func (m *CompanyAddress) Validate(formats strfmt.Registry) error

Validate validates this company address

type CompanyConfigurationModel ¶ 

type CompanyConfigurationModel struct {

	// The category of the configuration setting.  Avalara-defined categories include `AddressServiceConfig` and `TaxServiceConfig`.  Customer-defined categories begin with `X-`.
	// Example: AvaCertServiceConfig
	// Required: true
	// Max Length: 25
	// Min Length: 0
	Category *string `json:"category"`

	// The unique ID number of the account to which this setting applies
	// Example: 0
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The name of the configuration setting
	// Example: AllowPending
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// The current value of the configuration setting
	// Example: true
	// Max Length: 1000
	// Min Length: 0
	Value *string `json:"value,omitempty"`
}

CompanyConfigurationModel Represents one configuration setting for this company Example: {"category":"AvaCertServiceConfig","companyId":0,"name":"AllowPending","value":"true"}

swagger:model CompanyConfigurationModel

func (*CompanyConfigurationModel) ContextValidate ¶ 

func (m *CompanyConfigurationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company configuration model based on the context it is used

func (*CompanyConfigurationModel) MarshalBinary ¶ 

func (m *CompanyConfigurationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyConfigurationModel) UnmarshalBinary ¶ 

func (m *CompanyConfigurationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyConfigurationModel) Validate ¶ 

func (m *CompanyConfigurationModel) Validate(formats strfmt.Registry) error

Validate validates this company configuration model

type CompanyDistanceThresholdModel ¶ 

type CompanyDistanceThresholdModel struct {

	// The ID number of the company that defined this distance threshold.
	// Example: 0
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// The destination country for this threshold.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: BR
	// Required: true
	DestinationCountry *string `json:"destinationCountry"`

	// For distance threshold values that change over time, this is the earliest date for which this distance
	// threshold is valid.  If null, this distance threshold is valid for all dates earlier than the `endDate` field.
	// Format: date-time
	EffDate strfmt.DateTime `json:"effDate,omitempty"`

	// For distance threshold values that change over time, this is the latest date for which this distance
	// threshold is valid.  If null, this distance threshold is valid for all dates later than the `effDate` field.
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// A unique ID number representing this distance threshold object.
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The origin country for this threshold.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: FR
	// Required: true
	OriginCountry *string `json:"originCountry"`

	// True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries.
	//
	// If you set this value to `false`, your value added taxes will be calculated using the origin country.  Otherwise, value
	// added taxes will be calculated on the destination country.
	// Example: false
	ThresholdExceeded bool `json:"thresholdExceeded,omitempty"`

	// Indicates the distance threshold type.
	//
	// This value can be either `Sale` or `Purchase`.
	// Example: Sale
	// Required: true
	// Max Length: 20
	// Min Length: 0
	Type *string `json:"type"`
}

CompanyDistanceThresholdModel A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes.

Distance thresholds only apply to sales of goods in certain countries. A distance threshold is applied for each ship-from/ship-to combination of countries. The threshold amount is defined by the ship-to country.

Generally, if you have exceeded a distance threshold for taxes between a pair of countries, your tax calculation will be determined to be the rate in the destination country. If you have not exceeded the threshold, your tax calculation will be determined to be the rate in the origin country.

The amount of a threshold is not tracked or managed in AvaTax, but the decision of your tax compliance department as to whether you have exceeded this threshold is maintained in this object.

By default, you are considered to have exceeded tax thresholds. If you wish to change this default, you can create a company-distance-threshold object to select the correct behavior for this origin/destination tax calculation process. Example: {"companyId":0,"destinationCountry":"BR","id":0,"originCountry":"FR","thresholdExceeded":false,"type":"Sale"}

swagger:model CompanyDistanceThresholdModel

func (*CompanyDistanceThresholdModel) ContextValidate ¶ 

func (m *CompanyDistanceThresholdModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company distance threshold model based on the context it is used

func (*CompanyDistanceThresholdModel) MarshalBinary ¶ 

func (m *CompanyDistanceThresholdModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyDistanceThresholdModel) UnmarshalBinary ¶ 

func (m *CompanyDistanceThresholdModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyDistanceThresholdModel) Validate ¶ 

func (m *CompanyDistanceThresholdModel) Validate(formats strfmt.Registry) error

Validate validates this company distance threshold model

type CompanyDistanceThresholdModelFetchResult ¶ 

type CompanyDistanceThresholdModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CompanyDistanceThresholdModel `json:"value"`
}

CompanyDistanceThresholdModelFetchResult company distance threshold model fetch result

swagger:model CompanyDistanceThresholdModelFetchResult

func (*CompanyDistanceThresholdModelFetchResult) ContextValidate ¶ 

func (m *CompanyDistanceThresholdModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company distance threshold model fetch result based on the context it is used

func (*CompanyDistanceThresholdModelFetchResult) MarshalBinary ¶ 

func (m *CompanyDistanceThresholdModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyDistanceThresholdModelFetchResult) UnmarshalBinary ¶ 

func (m *CompanyDistanceThresholdModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyDistanceThresholdModelFetchResult) Validate ¶ 

func (m *CompanyDistanceThresholdModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this company distance threshold model fetch result

type CompanyInitializationModel ¶ 

type CompanyInitializationModel struct {

	// City
	// Example: Irvine
	// Required: true
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city"`

	// Company Code - used to distinguish between companies within your accounting system
	// Example: DEFAULT
	// Max Length: 25
	// Min Length: 0
	CompanyCode *string `json:"companyCode,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// Email
	// Example: bob@example.org
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email"`

	// Fax Number
	// Max Length: 25
	// Min Length: 0
	FaxNumber *string `json:"faxNumber,omitempty"`

	// First Name
	// Example: Bob
	// Required: true
	// Max Length: 50
	// Min Length: 0
	FirstName *string `json:"firstName"`

	// Set this field to true if the taxPayerIdNumber is a FEIN.
	IsFein bool `json:"isFein,omitempty"`

	// Last Name
	// Example: Example
	// Required: true
	// Max Length: 50
	// Min Length: 0
	LastName *string `json:"lastName"`

	// Address Line1
	// Example: 2000 Main Street
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1"`

	// Line2
	// Max Length: 50
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Line3
	// Max Length: 50
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// Mobile Number
	// Example: 714 555-1212
	// Max Length: 25
	// Min Length: 0
	MobileNumber *string `json:"mobileNumber,omitempty"`

	// Company Name
	// Example: Bob's Artisan Pottery
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// Parent Company ID
	ParentCompanyID int32 `json:"parentCompanyId,omitempty"`

	// Phone Number
	// Example: 714 555-2121
	// Required: true
	// Max Length: 25
	// Min Length: 0
	PhoneNumber *string `json:"phoneNumber"`

	// Postal Code
	// Example: 92614
	// Required: true
	// Max Length: 10
	// Min Length: 0
	PostalCode *string `json:"postalCode"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	// Required: true
	Region *string `json:"region"`

	// United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your
	// Social Security Number if you are an individual.
	// This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
	// Example: 12-3456789
	// Max Length: 11
	// Min Length: 0
	TaxpayerIDNumber *string `json:"taxpayerIdNumber,omitempty"`

	// Title
	// Example: Owner
	// Max Length: 50
	// Min Length: 0
	Title *string `json:"title,omitempty"`

	// Vat Registration Id - leave blank if not known.
	// Max Length: 25
	// Min Length: 0
	VatRegistrationID *string `json:"vatRegistrationId,omitempty"`
}

CompanyInitializationModel Company Initialization Model Example: {"city":"Irvine","companyCode":"DEFAULT","country":"US","email":"bob@example.org","firstName":"Bob","isFein":false,"lastName":"Example","line1":"2000 Main Street","mobileNumber":"714 555-1212","name":"Bob's Artisan Pottery","phoneNumber":"714 555-2121","postalCode":"92614","region":"CA","taxpayerIdNumber":"12-3456789","title":"Owner"}

swagger:model CompanyInitializationModel

func (*CompanyInitializationModel) ContextValidate ¶ 

func (m *CompanyInitializationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this company initialization model based on context it is used

func (*CompanyInitializationModel) MarshalBinary ¶ 

func (m *CompanyInitializationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyInitializationModel) UnmarshalBinary ¶ 

func (m *CompanyInitializationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyInitializationModel) Validate ¶ 

func (m *CompanyInitializationModel) Validate(formats strfmt.Registry) error

Validate validates this company initialization model

type CompanyModel ¶ 

type CompanyModel struct {

	// The unique ID number of the account this company belongs to.
	// Example: 123456789
	// Required: true
	AccountID *int32 `json:"accountId"`

	// This is the three character ISO-4217 currency code of the default currency used by this company.
	// Example: USD
	// Max Length: 3
	// Min Length: 0
	BaseCurrencyCode *string `json:"baseCurrencyCode,omitempty"`

	// Business Identification No
	// Max Length: 25
	// Min Length: 0
	BusinessIdentificationNo *string `json:"businessIdentificationNo,omitempty"`

	// A unique code that references this company within your account.
	// Example: DEFAULT
	// Max Length: 25
	// Min Length: 0
	CompanyCode *string `json:"companyCode,omitempty"`

	// Optional: A list of contacts defined for this company.  To fetch this list, add the query string `?$include=Contacts` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	Contacts []*ContactModel `json:"contacts"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The two character ISO-3166 country code of the default country for this company.
	// Example: US
	// Required: true
	// Max Length: 2
	// Min Length: 2
	DefaultCountry *string `json:"defaultCountry"`

	// If set, this is the unique ID number of the default location for this company.
	DefaultLocationID int32 `json:"defaultLocationId,omitempty"`

	// DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API.
	//
	// Read Only: true
	ExemptCerts []*EcmsModel `json:"exemptCerts"`

	// Set this flag to true to give this company its own unique tax profile.
	// If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions.
	// If this flag is false, this company will inherit all profile values from its parent.
	// Example: true
	HasProfile bool `json:"hasProfile,omitempty"`

	// The unique ID number of this company.
	// Example: 12345
	// Required: true
	ID *int32 `json:"id"`

	// Set this value to true to indicate that you are still working to finish configuring this company.
	// While this value is true, no tax reporting will occur and the company will not be usable for transactions.
	// Example: false
	InProgress bool `json:"inProgress,omitempty"`

	// This flag indicates whether tax activity can occur for this company.  Set this flag to true to permit the company to process transactions.
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// This flag is true if this company is the default company for this account.  Only one company may be set as the default.
	// Example: false
	IsDefault bool `json:"isDefault,omitempty"`

	// Set this field to true if the taxPayerIdNumber is a FEIN.
	IsFein bool `json:"isFein,omitempty"`

	// Set this flag to true if this company must file its own tax returns.
	// For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company.
	// Example: false
	IsReportingEntity bool `json:"isReportingEntity,omitempty"`

	// Set this flag to true to indicate that this company is a test company.
	// If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes.
	// Example: true
	IsTest bool `json:"isTest,omitempty"`

	// Optional: A list of items defined for this company.  To fetch this list, add the query string `?$include=Items` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	Items []*ItemModel `json:"items"`

	// Optional: A list of locations defined for this company.  To fetch this list, add the query string `?$include=Locations` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	Locations []*LocationModel `json:"locations"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing.
	// Max Length: 2
	// Min Length: 0
	MossCountry *string `json:"mossCountry,omitempty"`

	// The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing.
	// Max Length: 25
	// Min Length: 0
	MossID *string `json:"mossId,omitempty"`

	// The name of this company, as shown to customers.
	// Example: Default Company
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// Optional: A list of nexus defined for this company.  To fetch this list, add the query string `?$include=Nexus` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	Nexus []*NexusModel `json:"nexus"`

	// Optional: A list of non reporting child companies associated with this company.  To fetch this list, add the query string `?$include=NonReportingChildren` to your URL.
	// Read Only: true
	NonReportingChildCompanies []*CompanyModel `json:"nonReportingChildCompanies"`

	// The parameters of a company
	// Read Only: true
	Parameters []*CompanyParameterDetailModel `json:"parameters"`

	// If this company is fully owned by another company, this is the unique identity of the parent company.
	ParentCompanyID int32 `json:"parentCompanyId,omitempty"`

	// Indicates whether this company prefers to round amounts at the document level or line level.
	// Example: Line
	// Enum: [Line Document]
	RoundingLevelID string `json:"roundingLevelId,omitempty"`

	// Optional: A list of settings defined for this company.  To fetch this list, add the query string `?$include=Settings` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	Settings []*SettingModel `json:"settings"`

	// If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program.
	// Format: date
	SstEffectiveDate strfmt.Date `json:"sstEffectiveDate,omitempty"`

	// If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board.
	// Max Length: 9
	// Min Length: 0
	SstPid *string `json:"sstPid,omitempty"`

	// The customers and suppliers of a company
	// Read Only: true
	Supplierandcustomers []*CustomerSupplierModel `json:"supplierandcustomers"`

	// Optional: A list of tax codes defined for this company.  To fetch this list, add the query string `?$include=TaxCodes` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	TaxCodes []*TaxCodeModel `json:"taxCodes"`

	// Used to apply tax detail dependency at a jurisdiction level.
	// Example: Document
	// Enum: [Document State TaxRegion Address]
	TaxDependencyLevelID string `json:"taxDependencyLevelId,omitempty"`

	// Optional: A list of tax rules defined for this company.  To fetch this list, add the query string `?$include=TaxRules` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	TaxRules []*TaxRuleModel `json:"taxRules"`

	// For United States companies, this field contains your Taxpayer Identification Number.
	// This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation,
	// or SSN for a Social Security Number if this company is a person.
	// This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
	// Example: 123456789
	// Max Length: 11
	// Min Length: 0
	TaxpayerIDNumber *string `json:"taxpayerIdNumber,omitempty"`

	// Optional: A list of UPCs defined for this company.  To fetch this list, add the query string `?$include=UPCs` to your URL.
	//
	// When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company.
	// The `UpdateCompany` API does not permit updating nested objects.
	Upcs []*UPCModel `json:"upcs"`

	// Set this value to true to receive warnings in API calls via SOAP.
	WarningsEnabled bool `json:"warningsEnabled,omitempty"`
}

CompanyModel A company or business entity. Example: {"accountId":123456789,"baseCurrencyCode":"USD","companyCode":"DEFAULT","defaultCountry":"US","hasProfile":true,"id":12345,"inProgress":false,"isActive":true,"isDefault":false,"isFein":false,"isReportingEntity":false,"isTest":true,"name":"Default Company","roundingLevelId":"Line","taxDependencyLevelId":"Document","taxpayerIdNumber":"123456789"}

swagger:model CompanyModel

func (*CompanyModel) ContextValidate ¶ 

func (m *CompanyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company model based on the context it is used

func (*CompanyModel) MarshalBinary ¶ 

func (m *CompanyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyModel) UnmarshalBinary ¶ 

func (m *CompanyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyModel) Validate ¶ 

func (m *CompanyModel) Validate(formats strfmt.Registry) error

Validate validates this company model

type CompanyModelFetchResult ¶ 

type CompanyModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CompanyModel `json:"value"`
}

CompanyModelFetchResult company model fetch result

swagger:model CompanyModelFetchResult

func (*CompanyModelFetchResult) ContextValidate ¶ 

func (m *CompanyModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company model fetch result based on the context it is used

func (*CompanyModelFetchResult) MarshalBinary ¶ 

func (m *CompanyModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyModelFetchResult) UnmarshalBinary ¶ 

func (m *CompanyModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyModelFetchResult) Validate ¶ 

func (m *CompanyModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this company model fetch result

type CompanyParameterDetailModel ¶ 

type CompanyParameterDetailModel struct {

	// CompanyId associated with the parameter
	// Example: 0
	CompanyID int32 `json:"companyId,omitempty"`

	// Identifier for company parameter
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The parameter's name
	// Example: IsPrimaryAddress
	// Required: true
	Name *string `json:"name"`

	// The unit of measurement code for the parameter
	Unit string `json:"unit,omitempty"`

	// The value of the parameter
	// Example: true
	// Required: true
	Value *string `json:"value"`
}

CompanyParameterDetailModel Represents a parameter associated with a company. Example: {"companyId":0,"id":0,"name":"IsPrimaryAddress","value":"true"}

swagger:model CompanyParameterDetailModel

func (*CompanyParameterDetailModel) ContextValidate ¶ 

func (m *CompanyParameterDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company parameter detail model based on the context it is used

func (*CompanyParameterDetailModel) MarshalBinary ¶ 

func (m *CompanyParameterDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyParameterDetailModel) UnmarshalBinary ¶ 

func (m *CompanyParameterDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyParameterDetailModel) Validate ¶ 

func (m *CompanyParameterDetailModel) Validate(formats strfmt.Registry) error

Validate validates this company parameter detail model

type CompanyParameterDetailModelFetchResult ¶ 

type CompanyParameterDetailModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CompanyParameterDetailModel `json:"value"`
}

CompanyParameterDetailModelFetchResult company parameter detail model fetch result

swagger:model CompanyParameterDetailModelFetchResult

func (*CompanyParameterDetailModelFetchResult) ContextValidate ¶ 

func (m *CompanyParameterDetailModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company parameter detail model fetch result based on the context it is used

func (*CompanyParameterDetailModelFetchResult) MarshalBinary ¶ 

func (m *CompanyParameterDetailModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyParameterDetailModelFetchResult) UnmarshalBinary ¶ 

func (m *CompanyParameterDetailModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyParameterDetailModelFetchResult) Validate ¶ 

func (m *CompanyParameterDetailModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this company parameter detail model fetch result

type CompanyReturnSettingModel ¶ 

type CompanyReturnSettingModel struct {

	// The CompanyReturn Id
	// Example: 123
	// Required: true
	CompanyReturnID *int64 `json:"companyReturnId"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Filing question code as defined in TaxFormCatalog.
	// Example: EfileUsername
	// Max Length: 255
	// Min Length: 0
	FilingQuestionCode *string `json:"filingQuestionCode,omitempty"`

	// The TaxFormCatalog filingQuestionId.
	// Example: 26
	// Required: true
	FilingQuestionID *int64 `json:"filingQuestionId"`

	// The unique ID of this CompanyReturnsSetting
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The value of this setting
	// Example: bobExample
	Value string `json:"value,omitempty"`
}

CompanyReturnSettingModel company return setting model Example: {"companyReturnId":123,"filingQuestionCode":"EfileUsername","filingQuestionId":26,"id":0,"value":"bobExample"}

swagger:model CompanyReturnSettingModel

func (*CompanyReturnSettingModel) ContextValidate ¶ 

func (m *CompanyReturnSettingModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company return setting model based on the context it is used

func (*CompanyReturnSettingModel) MarshalBinary ¶ 

func (m *CompanyReturnSettingModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyReturnSettingModel) UnmarshalBinary ¶ 

func (m *CompanyReturnSettingModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyReturnSettingModel) Validate ¶ 

func (m *CompanyReturnSettingModel) Validate(formats strfmt.Registry) error

Validate validates this company return setting model

type CompanyUserDefinedFieldModel ¶ 

type CompanyUserDefinedFieldModel struct {

	// The id of the company to which the datasource belongs to.
	// Example: 12345
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Example: 123
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The unique ID number of this connection.
	// Example: String
	// Enum: [String Number Date Boolean]
	DataType string `json:"dataType,omitempty"`

	// The unique ID number of this connection.
	// Example: General Ledger Account Number
	// Required: true
	// Max Length: 4096
	// Min Length: 0
	FriendlyName *string `json:"friendlyName"`

	// The id of the datasource.
	// Example: 1
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Example: 12
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The extractor/connector id.
	// Example: UDF1
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// The category of user defined type For Example: Document level or Line level UDF.
	// Example: Document
	// Enum: [Document Line]
	UserDefinedFieldType string `json:"userDefinedFieldType,omitempty"`
}

CompanyUserDefinedFieldModel company user defined field model Example: {"companyId":12345,"createdDate":"2021-12-25T00:00:00+00:00","createdUserId":123,"dataType":"String","friendlyName":"General Ledger Account Number","id":1,"modifiedDate":"2021-12-25T00:00:00+00:00","modifiedUserId":12,"name":"UDF1","userDefinedFieldType":"Document"}

swagger:model CompanyUserDefinedFieldModel

func (*CompanyUserDefinedFieldModel) ContextValidate ¶ 

func (m *CompanyUserDefinedFieldModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company user defined field model based on the context it is used

func (*CompanyUserDefinedFieldModel) MarshalBinary ¶ 

func (m *CompanyUserDefinedFieldModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyUserDefinedFieldModel) UnmarshalBinary ¶ 

func (m *CompanyUserDefinedFieldModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyUserDefinedFieldModel) Validate ¶ 

func (m *CompanyUserDefinedFieldModel) Validate(formats strfmt.Registry) error

Validate validates this company user defined field model

type CompanyUserDefinedFieldModelFetchResult ¶ 

type CompanyUserDefinedFieldModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CompanyUserDefinedFieldModel `json:"value"`
}

CompanyUserDefinedFieldModelFetchResult company user defined field model fetch result

swagger:model CompanyUserDefinedFieldModelFetchResult

func (*CompanyUserDefinedFieldModelFetchResult) ContextValidate ¶ 

func (m *CompanyUserDefinedFieldModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this company user defined field model fetch result based on the context it is used

func (*CompanyUserDefinedFieldModelFetchResult) MarshalBinary ¶ 

func (m *CompanyUserDefinedFieldModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CompanyUserDefinedFieldModelFetchResult) UnmarshalBinary ¶ 

func (m *CompanyUserDefinedFieldModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CompanyUserDefinedFieldModelFetchResult) Validate ¶ 

func (m *CompanyUserDefinedFieldModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this company user defined field model fetch result

type ComplianceAggregatedTaxRateModel ¶ 

type ComplianceAggregatedTaxRateModel struct {

	// The date this rate is starts to take effect.
	// Example: 1900-01-01T00:00:00
	// Read Only: true
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The date this rate is no longer active.
	// Example: 9999-12-21T00:00:00
	// Read Only: true
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The compontent rate.
	// Example: 0.005
	// Read Only: true
	Rate float64 `json:"rate,omitempty"`

	// The rate type of the rate.
	// Example: G
	// Read Only: true
	RateTypeID string `json:"rateTypeId,omitempty"`

	// The stack rate based on the aggregation method.
	// Example: 0.005
	// Read Only: true
	StackRate float64 `json:"stackRate,omitempty"`

	// The tax type of the rate.
	// Example: S
	// Read Only: true
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

ComplianceAggregatedTaxRateModel A model for aggregated rates. Example: {"effectiveDate":"1900-01-01","endDate":"9999-12-21","rate":0.005,"rateTypeId":"G","stackRate":0.005,"taxTypeId":"S"}

swagger:model ComplianceAggregatedTaxRateModel

func (*ComplianceAggregatedTaxRateModel) ContextValidate ¶ 

func (m *ComplianceAggregatedTaxRateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this compliance aggregated tax rate model based on the context it is used

func (*ComplianceAggregatedTaxRateModel) MarshalBinary ¶ 

func (m *ComplianceAggregatedTaxRateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceAggregatedTaxRateModel) UnmarshalBinary ¶ 

func (m *ComplianceAggregatedTaxRateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceAggregatedTaxRateModel) Validate ¶ 

func (m *ComplianceAggregatedTaxRateModel) Validate(formats strfmt.Registry) error

Validate validates this compliance aggregated tax rate model

type ComplianceJurisdictionModel ¶ 

type ComplianceJurisdictionModel struct {

	// The name of the city.
	// Example: QUINCY
	// Read Only: true
	City string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country of this jurisdiction.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// The name of the county.
	// Example: ADAMS
	// Read Only: true
	County string `json:"county,omitempty"`

	// The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
	// Example: CIT
	// Read Only: true
	JurisdictionTypeID string `json:"jurisdictionTypeId,omitempty"`

	// The name of the jurisdiction.
	// Example: QUINCY
	// Read Only: true
	Name string `json:"name,omitempty"`

	// Optional: A list of rates for this jurisdiction. To fetch this list, add the query string `?$include=TaxRates` to your URL.
	// Example: [{"effectiveDate":"1900-01-01","endDate":"9999-12-21","rate":0.005,"rateTypeId":"G","stackRate":0.005,"taxTypeId":"S"}]
	Rates []*ComplianceAggregatedTaxRateModel `json:"rates"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: IL
	// Read Only: true
	Region string `json:"region,omitempty"`

	// The state assigned code for the jurisdiction.
	// Example: 001-0001-3 QUINCY
	// Read Only: true
	StateAssignedCode string `json:"stateAssignedCode,omitempty"`

	// The id of the tax authority.
	// Example: 275
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The id of the tax region.
	// Example: 2062642
	// Read Only: true
	TaxRegionID int32 `json:"taxRegionId,omitempty"`

	// The name of the tax region.
	// Read Only: true
	TaxRegionName string `json:"taxRegionName,omitempty"`
}

ComplianceJurisdictionModel Model for distinct jurisdictions. Example: {"city":"QUINCY","country":"US","county":"ADAMS","jurisdictionTypeId":"CIT","name":"QUINCY","rates":[{"effectiveDate":"1900-01-01","endDate":"9999-12-21","rate":0.005,"rateTypeId":"G","stackRate":0.005,"taxTypeId":"S"}],"region":"IL","stateAssignedCode":"001-0001-3 QUINCY","taxAuthorityId":275,"taxRegionId":2062642}

swagger:model ComplianceJurisdictionModel

func (*ComplianceJurisdictionModel) ContextValidate ¶ 

func (m *ComplianceJurisdictionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this compliance jurisdiction model based on the context it is used

func (*ComplianceJurisdictionModel) MarshalBinary ¶ 

func (m *ComplianceJurisdictionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceJurisdictionModel) UnmarshalBinary ¶ 

func (m *ComplianceJurisdictionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceJurisdictionModel) Validate ¶ 

func (m *ComplianceJurisdictionModel) Validate(formats strfmt.Registry) error

Validate validates this compliance jurisdiction model

type ComplianceJurisdictionRateModel ¶ 

type ComplianceJurisdictionRateModel struct {

	// Name or ISO 3166 code identifying the country of this jurisdiction.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// The date this rate is starts to take effect.
	// Example: 1900-01-01T00:00:00
	// Read Only: true
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The date this rate is no longer active.
	// Example: 9999-12-21T00:00:00
	// Read Only: true
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The id of the jurisdiction.
	// Example: 1
	// Read Only: true
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
	// Example: CIT
	// Read Only: true
	JurisdictionTypeID string `json:"jurisdictionTypeId,omitempty"`

	// The name of the jurisdiction.
	// Example: ALABAMA
	// Read Only: true
	Name string `json:"name,omitempty"`

	// The compontent rate.
	// Example: 0.005
	// Read Only: true
	Rate float64 `json:"rate,omitempty"`

	// The rate type.
	// Example: G
	// Read Only: true
	RateTypeID string `json:"rateTypeId,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: AL
	// Read Only: true
	Region string `json:"region,omitempty"`

	// The state assigned code.
	// Example: ALABAMA
	// Read Only: true
	StateAssignedCode string `json:"stateAssignedCode,omitempty"`

	// The id of the tax authority.
	// Example: 271
	// Read Only: true
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The tax type.
	// Example: S
	// Read Only: true
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

ComplianceJurisdictionRateModel A flattened model for jurisdictions and rates. Example: {"country":"US","effectiveDate":"1900-01-01","endDate":"9999-12-21","jurisdictionId":1,"jurisdictionTypeId":"CIT","name":"ALABAMA","rate":0.005,"rateTypeId":"G","region":"AL","stateAssignedCode":"ALABAMA","taxAuthorityId":271,"taxTypeId":"S"}

swagger:model ComplianceJurisdictionRateModel

func (*ComplianceJurisdictionRateModel) ContextValidate ¶ 

func (m *ComplianceJurisdictionRateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this compliance jurisdiction rate model based on the context it is used

func (*ComplianceJurisdictionRateModel) MarshalBinary ¶ 

func (m *ComplianceJurisdictionRateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceJurisdictionRateModel) UnmarshalBinary ¶ 

func (m *ComplianceJurisdictionRateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceJurisdictionRateModel) Validate ¶ 

func (m *ComplianceJurisdictionRateModel) Validate(formats strfmt.Registry) error

Validate validates this compliance jurisdiction rate model

type ComplianceTaxRateModel ¶ 

type ComplianceTaxRateModel struct {

	// The date this rate is starts to take effect.
	// Example: 1900-01-01T00:00:00
	// Read Only: true
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The date this rate is no longer active.
	// Example: 2011-04-30T00:00:00
	// Read Only: true
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The unique id of the rate.
	// Example: 1
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The id of the jurisdiction.
	// Example: 1
	// Read Only: true
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// The tax rate.
	// Example: 0.05
	// Read Only: true
	Rate float64 `json:"rate,omitempty"`

	// The rate type.
	// Example: F
	// Read Only: true
	RateTypeID string `json:"rateTypeId,omitempty"`

	// The rate type tax type mapping id.
	// Example: 46
	// Read Only: true
	RateTypeTaxTypeMappingID int32 `json:"rateTypeTaxTypeMappingId,omitempty"`

	// The name of the tax.
	// Example: AL STATE TAX
	// Read Only: true
	TaxName string `json:"taxName,omitempty"`

	// The id of the tax region.
	// Example: 4574
	// Read Only: true
	TaxRegionID int32 `json:"taxRegionId,omitempty"`

	// The tax type.
	// Example: S
	// Read Only: true
	TaxTypeID string `json:"taxTypeId,omitempty"`

	// The unit of basis.
	// Example: 13
	// Read Only: true
	UnitOfBasisID int64 `json:"unitOfBasisId,omitempty"`
}

ComplianceTaxRateModel The tax rate model. Example: {"effectiveDate":"1900-01-01","endDate":"2011-04-30","id":1,"jurisdictionId":1,"rate":0.05,"rateTypeId":"F","rateTypeTaxTypeMappingId":46,"taxName":"AL STATE TAX","taxRegionId":4574,"taxTypeId":"S","unitOfBasisId":13}

swagger:model ComplianceTaxRateModel

func (*ComplianceTaxRateModel) ContextValidate ¶ 

func (m *ComplianceTaxRateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this compliance tax rate model based on the context it is used

func (*ComplianceTaxRateModel) MarshalBinary ¶ 

func (m *ComplianceTaxRateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceTaxRateModel) UnmarshalBinary ¶ 

func (m *ComplianceTaxRateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceTaxRateModel) Validate ¶ 

func (m *ComplianceTaxRateModel) Validate(formats strfmt.Registry) error

Validate validates this compliance tax rate model

type ContactModel ¶ 

type ContactModel struct {

	// The city of the postal mailing address of this contact.
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// The unique ID number of the company to which this contact belongs.
	// Example: 12345
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// A unique code for this contact.
	// Example: TestContact49b9d360cada46
	// Required: true
	// Max Length: 25
	// Min Length: 0
	ContactCode *string `json:"contactCode"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The email address of this contact.
	// Example: bob@example.org
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email,omitempty"`

	// The facsimile phone number for this contact.
	// Max Length: 25
	// Min Length: 0
	Fax *string `json:"fax,omitempty"`

	// The first or given name of this contact.
	// Example: Bob
	// Max Length: 50
	// Min Length: 0
	FirstName *string `json:"firstName,omitempty"`

	// The unique ID number of this contact.
	// Example: 56789
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The last or family name of this contact.
	// Example: McExample
	// Max Length: 50
	// Min Length: 0
	LastName *string `json:"lastName,omitempty"`

	// The first line of the postal mailing address of this contact.
	// Example: 2000 Main Street
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// The second line of the postal mailing address of this contact.
	// Max Length: 50
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// The third line of the postal mailing address of this contact.
	// Max Length: 50
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// The middle name of this contact.
	// Max Length: 50
	// Min Length: 0
	MiddleName *string `json:"middleName,omitempty"`

	// The mobile phone number for this contact.
	// Max Length: 25
	// Min Length: 0
	Mobile *string `json:"mobile,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The main phone number for this contact.
	// Example: 714 555-1212
	// Max Length: 25
	// Min Length: 0
	Phone *string `json:"phone,omitempty"`

	// The postal code or zip code of the postal mailing address of this contact.
	// Example: 92614
	// Max Length: 10
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`

	// Professional title of this contact.
	// Example: Owner
	// Max Length: 50
	// Min Length: 0
	Title *string `json:"title,omitempty"`
}

ContactModel A contact person for a company. Example: {"city":"Irvine","companyId":12345,"contactCode":"TestContact49b9d360cada46","country":"US","email":"bob@example.org","firstName":"Bob","id":56789,"lastName":"McExample","line1":"2000 Main Street","phone":"714 555-1212","postalCode":"92614","region":"CA","title":"Owner"}

swagger:model ContactModel

func (*ContactModel) ContextValidate ¶ 

func (m *ContactModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this contact model based on the context it is used

func (*ContactModel) MarshalBinary ¶ 

func (m *ContactModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ContactModel) UnmarshalBinary ¶ 

func (m *ContactModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ContactModel) Validate ¶ 

func (m *ContactModel) Validate(formats strfmt.Registry) error

Validate validates this contact model

type ContactModelFetchResult ¶ 

type ContactModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ContactModel `json:"value"`
}

ContactModelFetchResult contact model fetch result

swagger:model ContactModelFetchResult

func (*ContactModelFetchResult) ContextValidate ¶ 

func (m *ContactModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this contact model fetch result based on the context it is used

func (*ContactModelFetchResult) MarshalBinary ¶ 

func (m *ContactModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ContactModelFetchResult) UnmarshalBinary ¶ 

func (m *ContactModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ContactModelFetchResult) Validate ¶ 

func (m *ContactModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this contact model fetch result

type CoordinateInfo ¶ 

type CoordinateInfo struct {

	// Latitude
	// Example: 33.684884
	Latitude float64 `json:"latitude,omitempty"`

	// Longitude
	// Example: -117.851321
	Longitude float64 `json:"longitude,omitempty"`
}

CoordinateInfo Coordinate Info Example: {"latitude":33.684884,"longitude":-117.851321}

swagger:model CoordinateInfo

func (*CoordinateInfo) ContextValidate ¶ 

func (m *CoordinateInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this coordinate info based on context it is used

func (*CoordinateInfo) MarshalBinary ¶ 

func (m *CoordinateInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CoordinateInfo) UnmarshalBinary ¶ 

func (m *CoordinateInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CoordinateInfo) Validate ¶ 

func (m *CoordinateInfo) Validate(formats strfmt.Registry) error

Validate validates this coordinate info

type CoverLetterModel ¶ 

type CoverLetterModel struct {

	// Is this cover letter active
	Active bool `json:"active,omitempty"`

	// The unique ID number of the AvaTax company that received this certificate.
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Example: 0001-01-01T00:00:00
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// A full description of the cover letter's contents and message.
	// Example: Please upload your certificate to CertCapture
	Description string `json:"description,omitempty"`

	// A unique ID number representing a cover letter sent with a CertExpress invitation.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Example: 0001-01-01T00:00:00
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// How many pages this cover letter encompasses
	// Read Only: true
	PageCount int32 `json:"pageCount,omitempty"`

	// The subject message used when sending the cover letter via email.
	// Example: Please submit your exemption certificate
	Subject string `json:"subject,omitempty"`

	// The file name of the cover letter template
	TemplateFilename string `json:"templateFilename,omitempty"`

	// The title used when sending the cover letter.
	// Example: STANDARD_REQUEST
	Title string `json:"title,omitempty"`

	// The version number of the template
	// Example: 0
	Version int32 `json:"version,omitempty"`
}

CoverLetterModel The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent. Example: {"createdDate":"0001-01-01T00:00:00","description":"Please upload your certificate to CertCapture","modifiedDate":"0001-01-01T00:00:00","subject":"Please submit your exemption certificate","title":"STANDARD_REQUEST","version":0}

swagger:model CoverLetterModel

func (*CoverLetterModel) ContextValidate ¶ 

func (m *CoverLetterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cover letter model based on the context it is used

func (*CoverLetterModel) MarshalBinary ¶ 

func (m *CoverLetterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CoverLetterModel) UnmarshalBinary ¶ 

func (m *CoverLetterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CoverLetterModel) Validate ¶ 

func (m *CoverLetterModel) Validate(formats strfmt.Registry) error

Validate validates this cover letter model

type CoverLetterModelFetchResult ¶ 

type CoverLetterModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CoverLetterModel `json:"value"`
}

CoverLetterModelFetchResult cover letter model fetch result

swagger:model CoverLetterModelFetchResult

func (*CoverLetterModelFetchResult) ContextValidate ¶ 

func (m *CoverLetterModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cover letter model fetch result based on the context it is used

func (*CoverLetterModelFetchResult) MarshalBinary ¶ 

func (m *CoverLetterModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CoverLetterModelFetchResult) UnmarshalBinary ¶ 

func (m *CoverLetterModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CoverLetterModelFetchResult) Validate ¶ 

func (m *CoverLetterModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this cover letter model fetch result

type CreateCertExpressInvitationModel ¶ 

type CreateCertExpressInvitationModel struct {

	// If this invitation is sent via email or download, please specify the cover letter to use when building this
	// invitation.  For a list of cover letters, please call `ListCoverLetters`.
	// Example: STANDARD_REQUEST
	CoverLetterTitle string `json:"coverLetterTitle,omitempty"`

	// Specify the type of invitation.  CertExpress invitations can be delivered via email, web link, or
	// facsimile.
	//
	// * If you specify `Email`, the invitation will be delivered via email.  Please ask the customer to ensure that
	// * If you specify `Fax`, the invitation will be sent via fax to the customer's fax number on file.
	// * If you specify `Download`, the invitation will be prepared as a web link that you can display to the customer.
	// Example: Email
	// Enum: [Email Fax Download]
	DeliveryMethod string `json:"deliveryMethod,omitempty"`

	// You may optionally specify a list of exemption reasons to pre-populate in this CertExpress invitation.
	// If you list exemption reasons, the customer will have part of their form already filled in when they visit
	// the CertExpress website.
	//
	// For a list of available exemption reasons, please call `ListCertificateExemptReasons`.
	// Example: [70]
	ExemptReasons []int32 `json:"exemptReasons"`

	// You may optionally specify a list of exposure zones to request in this CertExpress invitation.  If you list
	// more than one exposure zone, the customer will be prompted to provide an exemption certificate for each one.
	// If you do not provide a list of exposure zones, the customer will be prompted to select an exposure zone.
	//
	// For a list of available exposure zones, please call `ListCertificateExposureZones`.
	// Example: [89]
	ExposureZones []int32 `json:"exposureZones"`

	// If the value of `deliveryMethod` is set to `Email`, please specify the email address of the recipient
	// for the request.
	// Example: bob@example.org
	Recipient string `json:"recipient,omitempty"`
}

CreateCertExpressInvitationModel Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record. Example: {"coverLetterTitle":"STANDARD_REQUEST","deliveryMethod":"Download","exemptReasons":[70],"exposureZones":[89],"recipient":"bob@example.org"}

swagger:model CreateCertExpressInvitationModel

func (*CreateCertExpressInvitationModel) ContextValidate ¶ 

func (m *CreateCertExpressInvitationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create cert express invitation model based on context it is used

func (*CreateCertExpressInvitationModel) MarshalBinary ¶ 

func (m *CreateCertExpressInvitationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateCertExpressInvitationModel) UnmarshalBinary ¶ 

func (m *CreateCertExpressInvitationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateCertExpressInvitationModel) Validate ¶ 

func (m *CreateCertExpressInvitationModel) Validate(formats strfmt.Registry) error

Validate validates this create cert express invitation model

type CreateECommerceTokenInputModel ¶ 

type CreateECommerceTokenInputModel struct {

	// The customer's number that the token will be issued for.
	// Example: 1
	// Required: true
	CustomerNumber *string `json:"customerNumber"`
}

CreateECommerceTokenInputModel A model used to initialize a new CertCapture eCommerce token. Example: {"customerNumber":"1"}

swagger:model CreateECommerceTokenInputModel

func (*CreateECommerceTokenInputModel) ContextValidate ¶ 

func (m *CreateECommerceTokenInputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create e commerce token input model based on context it is used

func (*CreateECommerceTokenInputModel) MarshalBinary ¶ 

func (m *CreateECommerceTokenInputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateECommerceTokenInputModel) UnmarshalBinary ¶ 

func (m *CreateECommerceTokenInputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateECommerceTokenInputModel) Validate ¶ 

func (m *CreateECommerceTokenInputModel) Validate(formats strfmt.Registry) error

Validate validates this create e commerce token input model

type CreateMultiDocumentModel ¶ 

type CreateMultiDocumentModel struct {

	// Default addresses for all lines in this document.
	//
	// These addresses are the default values that will be used for any lines that do not have their own
	// address information.  If you specify addresses for a line, then no default addresses will be loaded
	// for that line.
	// Example: {"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}}
	Addresses *AddressesModel `json:"addresses,omitempty"`

	// Set this value to true to allow this API call to adjust the MultiDocument model if one already exists.
	//
	// If you omit this field, or if the value is `null`, you will receive an error if you try to create two MultiDocument
	// objects with the same `code`.
	AllowAdjust bool `json:"allowAdjust,omitempty"`

	// BatchCode for batch operations.
	// Max Length: 25
	// Min Length: 0
	BatchCode *string `json:"batchCode,omitempty"`

	// VAT business identification number for the customer for this transaction.  This number will be used for all lines
	// in the transaction, except for those lines where you have defined a different business identification number.
	//
	// If you specify a VAT business identification number for the customer in this transaction and you have also set up
	// a business identification number for your company during company setup, this transaction will be treated as a
	// business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
	// Max Length: 25
	// Min Length: 0
	BusinessIdentificationNo *string `json:"businessIdentificationNo,omitempty"`

	// The transaction code of the MultiDocument transaction.
	//
	// All individual transactions within this MultiDocument object will have this code as a prefix.
	//
	// If you leave the `code` field blank, a GUID will be assigned.
	// Max Length: 45
	// Min Length: 0
	Code *string `json:"code,omitempty"`

	// Causes the document to be committed if true.  This option is only applicable for invoice document
	// types, not orders.
	// Example: true
	Commit bool `json:"commit,omitempty"`

	// Company Code - Specify the code of the company creating this transaction here.  If you leave this value null,
	// your account's default company will be used instead.
	// Example: DEFAULT
	// Max Length: 50
	// Min Length: 0
	CompanyCode *string `json:"companyCode,omitempty"`

	// The three-character ISO 4217 currency code for this transaction.
	// Example: USD
	// Max Length: 3
	// Min Length: 0
	CurrencyCode *string `json:"currencyCode,omitempty"`

	// Customer Code - The client application customer reference code.
	// Note: This field is case sensitive. To have exemption certificates apply, this value should
	// be the same as the one passed to create a customer.
	// Example: ABC
	// Required: true
	// Max Length: 50
	// Min Length: 0
	CustomerCode *string `json:"customerCode"`

	// The name of the supplier / exporter / seller.
	// For sales doctype enter the name of your own company for which you are reporting.
	// For purchases doctype enter the name of the supplier you have purchased from.
	// Max Length: 200
	// Min Length: 0
	CustomerSupplierName *string `json:"customerSupplierName,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
	// Customer Usage Type - The client application customer or usage type.
	// Max Length: 25
	// Min Length: 0
	CustomerUsageType *string `json:"customerUsageType,omitempty"`

	// The Id of the datasource from which this transaction originated.
	// This value will be overridden by the system to take the datasource Id from the call header.
	DataSourceID int32 `json:"dataSourceId,omitempty"`

	// Transaction Date - The date on the invoice, purchase order, etc.
	//
	// By default, this date will be used to calculate the tax rates for the transaction.  If you wish to use a
	// different date to calculate tax rates, please specify a `taxOverride` of type `taxDate`.
	// Example: 2021-12-25T00:00:00+00:00
	// Required: true
	// Format: date
	Date *strfmt.Date `json:"date"`

	// If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`.
	// Example: Normal
	// Enum: [Normal Diagnostic]
	DebugLevel string `json:"debugLevel,omitempty"`

	// The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not.
	// Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that  indicate that Import Duty and Tax should be included in the transaction total.
	// This field is also used for reports.
	// This field is used for future feature support. This field is not currently in use.
	// Example: DAP
	// Enum: [DAP DDP]
	DeliveryTerms string `json:"deliveryTerms,omitempty"`

	// User-supplied description for this transaction.
	// Example: Yarn
	// Max Length: 2048
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// Discount - The discount amount to apply to the document.  This value will be applied only to lines
	// that have the `discounted` flag set to true.  If no lines have `discounted` set to true, this discount
	// cannot be applied.
	Discount float64 `json:"discount,omitempty"`

	// User-supplied email address relevant for this transaction.
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email,omitempty"`

	// Entity Use Code - The client application customer or usage type.  For a list of
	// available usage types, use [ListEntityUseCodes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/) API.
	// Max Length: 25
	// Min Length: 0
	EntityUseCode *string `json:"entityUseCode,omitempty"`

	// Currency exchange rate from this transaction to the company base currency.
	//
	// This only needs to be set if the transaction currency is different than the company base currency.
	// It defaults to 1.0.
	ExchangeRate float64 `json:"exchangeRate,omitempty"`

	// Optional three-character ISO 4217 reporting exchange rate currency code for this transaction. The default value is USD.
	// Max Length: 3
	// Min Length: 0
	ExchangeRateCurrencyCode *string `json:"exchangeRateCurrencyCode,omitempty"`

	// Effective date of the exchange rate.
	// Format: date
	ExchangeRateEffectiveDate strfmt.Date `json:"exchangeRateEffectiveDate,omitempty"`

	// Exemption Number for this document.
	//
	// If you specify an exemption number for this document, this document will be considered exempt, and you
	// may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor
	// to verify your exemptions.
	// Note: This is same as 'exemptNo' in TransactionModel.
	// Max Length: 25
	// Min Length: 0
	ExemptionNo *string `json:"exemptionNo,omitempty"`

	// Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record.
	//
	// Some taxes only apply if the seller is the importer of record for a product.  In cases where companies are working together to
	// ship products, there may be mutual agreement as to which company is the entity designated as importer of record.  The importer
	// of record will then be the company designated to pay taxes marked as being obligated to the importer of record.
	//
	// Set this value to `true` to consider your company as the importer of record and collect these taxes.
	//
	// This value may also be set at the Nexus level.  See `NexusModel` for more information.
	IsSellerImporterOfRecord bool `json:"isSellerImporterOfRecord,omitempty"`

	// Lines that will appear on the invoice.
	//
	// For a MultiDocument transaction, each line may represent a different company or reporting location code.  AvaTax
	// will separate this MultiDocument transaction object into many different transactions, one for each pair of legal
	// entities, so that each legal entity can file their transactional taxes correctly.
	// Example: [{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}]
	// Required: true
	Lines []*MultiDocumentLineItemModel `json:"lines"`

	// Special parameters for this transaction.
	//
	// To get a full list of available parameters, please use the [ListParameters](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListParameters/) endpoint.
	Parameters []*TransactionParameterModel `json:"parameters"`

	// Sets the Point of Sale Lane Code sent by the User for this document.
	// Max Length: 50
	// Min Length: 0
	PosLaneCode *string `json:"posLaneCode,omitempty"`

	// Purchase Order Number for this document.
	//
	// This is required for single use exemption certificates to match the order and invoice with the certificate.
	// Example: 2021-12-25-001
	// Max Length: 50
	// Min Length: 0
	PurchaseOrderNo *string `json:"purchaseOrderNo,omitempty"`

	// Customer-provided Reference Code with information about this transaction.
	//
	// This field could be used to reference the original document for a return invoice, or for any other
	// reference purpose.
	// Max Length: 1024
	// Min Length: 0
	ReferenceCode *string `json:"referenceCode,omitempty"`

	// Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
	//
	// This value is used by Avalara Managed Returns to group documents together by reporting locations
	// for tax authorities that require location-based reporting.
	// Max Length: 50
	// Min Length: 0
	ReportingLocationCode *string `json:"reportingLocationCode,omitempty"`

	// Salesperson Code - The client application salesperson reference code.
	// Max Length: 25
	// Min Length: 0
	SalespersonCode *string `json:"salespersonCode,omitempty"`

	// Specifies whether the tax calculation is handled Local, Remote, or Automatic (default).  This only
	// applies when using an AvaLocal server.
	// Example: Automatic
	// Enum: [Automatic Local Remote]
	ServiceMode string `json:"serviceMode,omitempty"`

	// Specifies a tax override for the entire document
	// Example: {"reason":"Precalculated Tax","taxAmount":6.25,"taxDate":"2021-12-25","type":"TaxAmount"}
	TaxOverride *TaxOverrideModel `json:"taxOverride,omitempty"`

	// Specifies the type of document to create.  A document type ending with `Invoice` is a permanent transaction
	// that will be recorded in AvaTax.  A document type ending with `Order` is a temporary estimate that will not
	// be preserved.
	//
	// If you omit this value, the API will assume you want to create a `SalesOrder`.
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type string `json:"type,omitempty"`

	// Custom user fields/flex fields for this transaction.
	UserDefinedFields []*TransactionUserDefinedFieldModel `json:"userDefinedFields"`
}

CreateMultiDocumentModel A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.

A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately. Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}

swagger:model CreateMultiDocumentModel

func (*CreateMultiDocumentModel) ContextValidate ¶ 

func (m *CreateMultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create multi document model based on the context it is used

func (*CreateMultiDocumentModel) MarshalBinary ¶ 

func (m *CreateMultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateMultiDocumentModel) UnmarshalBinary ¶ 

func (m *CreateMultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateMultiDocumentModel) Validate ¶ 

func (m *CreateMultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this create multi document model

type CreateNoticeResponsibilityTypeModel ¶ 

type CreateNoticeResponsibilityTypeModel struct {

	// The description name of this notice responsibility
	// Example: Customer-Invalid login (Return filed manual)
	Description string `json:"description,omitempty"`

	// Defines if the responsibility is active
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// The sort order of this responsibility
	// Example: 175
	SortOrder int32 `json:"sortOrder,omitempty"`
}

CreateNoticeResponsibilityTypeModel Model to create a new tax notice responsibility type. Example: {"description":"Customer-Invalid login (Return filed manual)","isActive":true,"sortOrder":175}

swagger:model CreateNoticeResponsibilityTypeModel

func (*CreateNoticeResponsibilityTypeModel) ContextValidate ¶ 

func (m *CreateNoticeResponsibilityTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create notice responsibility type model based on context it is used

func (*CreateNoticeResponsibilityTypeModel) MarshalBinary ¶ 

func (m *CreateNoticeResponsibilityTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateNoticeResponsibilityTypeModel) UnmarshalBinary ¶ 

func (m *CreateNoticeResponsibilityTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateNoticeResponsibilityTypeModel) Validate ¶ 

func (m *CreateNoticeResponsibilityTypeModel) Validate(formats strfmt.Registry) error

Validate validates this create notice responsibility type model

type CreateNoticeRootCauseTypeModel ¶ 

type CreateNoticeRootCauseTypeModel struct {

	// The description name of this notice RootCause
	// Example: Customer-Invalid login (Return filed manual)
	Description string `json:"description,omitempty"`

	// Defines if the RootCause is active
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// The sort order of this RootCause
	// Example: 55
	SortOrder int32 `json:"sortOrder,omitempty"`
}

CreateNoticeRootCauseTypeModel Model to create a new tax notice root cause type. Example: {"description":"Customer-Invalid login (Return filed manual)","isActive":true,"sortOrder":55}

swagger:model CreateNoticeRootCauseTypeModel

func (*CreateNoticeRootCauseTypeModel) ContextValidate ¶ 

func (m *CreateNoticeRootCauseTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create notice root cause type model based on context it is used

func (*CreateNoticeRootCauseTypeModel) MarshalBinary ¶ 

func (m *CreateNoticeRootCauseTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateNoticeRootCauseTypeModel) UnmarshalBinary ¶ 

func (m *CreateNoticeRootCauseTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateNoticeRootCauseTypeModel) Validate ¶ 

func (m *CreateNoticeRootCauseTypeModel) Validate(formats strfmt.Registry) error

Validate validates this create notice root cause type model

type CreateOrAdjustTransactionModel ¶ 

type CreateOrAdjustTransactionModel struct {

	// If the AdjustmentReason is "Other", specify the reason here.
	//
	// This is required when the AdjustmentReason is 8 (Other).
	// Example: Test Description
	AdjustmentDescription string `json:"adjustmentDescription,omitempty"`

	// A reason code indicating why this adjustment was made
	// Example: NotAdjusted
	// Enum: [NotAdjusted SourcingIssue ReconciledWithGeneralLedger ExemptCertApplied PriceAdjusted ProductReturned ProductExchanged BadDebt Other Offline]
	AdjustmentReason string `json:"adjustmentReason,omitempty"`

	// The create transaction model to be created or updated.
	//
	// If the transaction does not exist, create transaction.
	// If the transaction exists, adjust the existing transaction.
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	// Required: true
	CreateTransactionModel *CreateTransactionModel `json:"createTransactionModel"`
}

CreateOrAdjustTransactionModel Create or adjust transaction model Example: {"adjustmentDescription":"Test Description","adjustmentReason":"Other","createTransactionModel":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}

swagger:model CreateOrAdjustTransactionModel

func (*CreateOrAdjustTransactionModel) ContextValidate ¶ 

func (m *CreateOrAdjustTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create or adjust transaction model based on the context it is used

func (*CreateOrAdjustTransactionModel) MarshalBinary ¶ 

func (m *CreateOrAdjustTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateOrAdjustTransactionModel) UnmarshalBinary ¶ 

func (m *CreateOrAdjustTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateOrAdjustTransactionModel) Validate ¶ 

func (m *CreateOrAdjustTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this create or adjust transaction model

type CreateTransactionBatchRequestModel ¶ 

type CreateTransactionBatchRequestModel struct {

	// The user-friendly readable name for this batch.
	// Required: true
	// Max Length: 194
	// Min Length: 0
	Name *string `json:"name"`

	// The list of transactions contained in this batch.
	// Required: true
	Transactions []*TransactionBatchItemModel `json:"transactions"`
}

CreateTransactionBatchRequestModel Represents a create transaction batch request model. Example: {"name":"TestBatch-637760489175671342","transactions":[{"createTransactionModel":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"code":"MyTransaction-637760489175669736","commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}},{"adjustTransactionModel":{"adjustmentDescription":"Price drop before shipping","adjustmentReason":"PriceAdjusted","companyCode":"DEFAULT","documentType":"SalesInvoice","newTransaction":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"code":"MyTransaction-637760489175669736","commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":90,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"},"transactionCode":"MyTransaction-637760489175669736"}},{"createOrAdjustTransactionModel":{"adjustmentDescription":"Test Description","adjustmentReason":"Other","createTransactionModel":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"code":"MyTransaction-637760489175669736","commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":80,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}},{"voidTransactionModel":{"code":"DocVoided","companyCode":"DEFAULT","documentType":"SalesInvoice","transactionCode":"MyTransaction-637760489175669736"}}]}

swagger:model CreateTransactionBatchRequestModel

func (*CreateTransactionBatchRequestModel) ContextValidate ¶ 

func (m *CreateTransactionBatchRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create transaction batch request model based on the context it is used

func (*CreateTransactionBatchRequestModel) MarshalBinary ¶ 

func (m *CreateTransactionBatchRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateTransactionBatchRequestModel) UnmarshalBinary ¶ 

func (m *CreateTransactionBatchRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateTransactionBatchRequestModel) Validate ¶ 

func (m *CreateTransactionBatchRequestModel) Validate(formats strfmt.Registry) error

Validate validates this create transaction batch request model

type CreateTransactionBatchResponseModel ¶ 

type CreateTransactionBatchResponseModel struct {

	// The Account ID number of the account that owns this batch.
	AccountID int32 `json:"accountId,omitempty"`

	// The Company ID number of the company that owns this batch.
	CompanyID int32 `json:"companyId,omitempty"`

	// The date/time when this batch was completely processed
	// Read Only: true
	// Format: date-time
	CompletedDate strfmt.DateTime `json:"completedDate,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The current record being processed
	// Read Only: true
	CurrentRecord int32 `json:"currentRecord,omitempty"`

	// The list of files contained in this batch.
	// Example: [{"contentLength":2393,"contentType":"application/json","fileExtension":"JSON","filePath":"Input.json","name":"Input"}]
	Files []*BatchFileModel `json:"files"`

	// The unique ID number of this batch.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The user-friendly readable name for this batch.
	// Example: TestBatch
	// Required: true
	// Max Length: 194
	// Min Length: 0
	Name *string `json:"name"`

	// The number of records in this batch; determined by the server
	// Read Only: true
	RecordCount int32 `json:"recordCount,omitempty"`

	// The date/time when this batch started processing
	// Read Only: true
	// Format: date-time
	StartedDate strfmt.DateTime `json:"startedDate,omitempty"`

	// This batch's current processing status
	// Example: Waiting
	// Read Only: true
	// Enum: [Waiting SystemErrors Cancelled Completed Creating Deleted Errors Paused Processing Cancelling]
	Status string `json:"status,omitempty"`
}

CreateTransactionBatchResponseModel Represents a create transaction batch response model. Example: {"files":[{"contentLength":2393,"contentType":"application/json","fileExtension":"JSON","filePath":"Input.json","name":"Input"}],"name":"TestBatch"}

swagger:model CreateTransactionBatchResponseModel

func (*CreateTransactionBatchResponseModel) ContextValidate ¶ 

func (m *CreateTransactionBatchResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create transaction batch response model based on the context it is used

func (*CreateTransactionBatchResponseModel) MarshalBinary ¶ 

func (m *CreateTransactionBatchResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateTransactionBatchResponseModel) UnmarshalBinary ¶ 

func (m *CreateTransactionBatchResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateTransactionBatchResponseModel) Validate ¶ 

func (m *CreateTransactionBatchResponseModel) Validate(formats strfmt.Registry) error

Validate validates this create transaction batch response model

type CreateTransactionModel ¶ 

type CreateTransactionModel struct {

	// Default addresses for all lines in this document.
	//
	// These addresses are the default values that will be used for any lines that do not have their own
	// address information.  If you specify addresses for a line, then no default addresses will be loaded
	// for that line.
	// Example: {"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}}
	Addresses *AddressesModel `json:"addresses,omitempty"`

	// BatchCode for batch operations.
	// Max Length: 25
	// Min Length: 0
	BatchCode *string `json:"batchCode,omitempty"`

	// VAT business identification number for the customer for this transaction.  This number will be used for all lines
	// in the transaction, except for those lines where you have defined a different business identification number.
	//
	// If you specify a VAT business identification number for the customer in this transaction and you have also set up
	// a business identification number for your company during company setup, this transaction will be treated as a
	// business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
	// Max Length: 25
	// Min Length: 0
	BusinessIdentificationNo *string `json:"businessIdentificationNo,omitempty"`

	// The internal reference code used by the client application.  This is used for operations such as
	// Get, Adjust, Settle, and Void.  If you leave the transaction code blank, a GUID will be assigned to each transaction.
	// Max Length: 50
	// Min Length: 0
	Code *string `json:"code,omitempty"`

	// Causes the document to be committed if true.  This option is only applicable for invoice document
	// types, not orders.
	// Example: true
	Commit bool `json:"commit,omitempty"`

	// Company Code - Specify the code of the company creating this transaction here.  If you leave this value null,
	// your account's default company will be used instead.
	// Example: DEFAULT
	// Max Length: 50
	// Min Length: 0
	CompanyCode *string `json:"companyCode,omitempty"`

	// The three-character ISO 4217 currency code for this transaction.
	// Example: USD
	// Max Length: 3
	// Min Length: 0
	CurrencyCode *string `json:"currencyCode,omitempty"`

	// Customer Code - The client application customer reference code.
	// Note: This field is case sensitive. To have exemption certificates apply, this value should
	// be the same as the one passed to create a customer.
	// Example: ABC
	// Required: true
	// Max Length: 50
	// Min Length: 0
	CustomerCode *string `json:"customerCode"`

	// The name of the supplier / exporter / seller.
	// For sales doctype enter the name of your own company for which you are reporting.
	// For purchases doctype enter the name of the supplier you have purchased from.
	// Max Length: 200
	// Min Length: 0
	CustomerSupplierName *string `json:"customerSupplierName,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
	// Customer Usage Type - The client application customer or usage type.
	// Max Length: 25
	// Min Length: 0
	CustomerUsageType *string `json:"customerUsageType,omitempty"`

	// The Id of the datasource from which this transaction originated.
	// This value will be overridden by the system to take the datasource Id from the call header.
	DataSourceID int32 `json:"dataSourceId,omitempty"`

	// Transaction Date - The date on the invoice, purchase order, etc.
	//
	// By default, this date will be used to calculate the tax rates for the transaction.  If you wish to use a
	// different date to calculate tax rates, please specify a `taxOverride` of type `taxDate`.
	// Example: 2021-12-25T00:00:00+00:00
	// Required: true
	// Format: date
	Date *strfmt.Date `json:"date"`

	// If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`.
	// Example: Normal
	// Enum: [Normal Diagnostic]
	DebugLevel string `json:"debugLevel,omitempty"`

	// The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not.
	// Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that  indicate that Import Duty and Tax should be included in the transaction total.
	// This field is also used for reports.
	// This field is used for future feature support. This field is not currently in use.
	// Example: DAP
	// Enum: [DAP DDP]
	DeliveryTerms string `json:"deliveryTerms,omitempty"`

	// User-supplied description for this transaction.
	// Example: Yarn
	// Max Length: 2048
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// Discount - The discount amount to apply to the document.  This value will be applied only to lines
	// that have the `discounted` flag set to true.  If no lines have `discounted` set to true, this discount
	// cannot be applied.
	Discount float64 `json:"discount,omitempty"`

	// User-supplied email address relevant for this transaction.
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email,omitempty"`

	// Entity Use Code - The client application customer or usage type.  For a list of
	// available usage types, use [ListEntityUseCodes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/) API.
	// Max Length: 25
	// Min Length: 0
	EntityUseCode *string `json:"entityUseCode,omitempty"`

	// Currency exchange rate from this transaction to the company base currency.
	//
	// This only needs to be set if the transaction currency is different than the company base currency.
	// It defaults to 1.0.
	ExchangeRate float64 `json:"exchangeRate,omitempty"`

	// Optional three-character ISO 4217 reporting exchange rate currency code for this transaction. The default value is USD.
	// Max Length: 3
	// Min Length: 0
	ExchangeRateCurrencyCode *string `json:"exchangeRateCurrencyCode,omitempty"`

	// Effective date of the exchange rate.
	// Format: date
	ExchangeRateEffectiveDate strfmt.Date `json:"exchangeRateEffectiveDate,omitempty"`

	// Exemption Number for this document.
	//
	// If you specify an exemption number for this document, this document will be considered exempt, and you
	// may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor
	// to verify your exemptions.
	// Note: This is same as 'exemptNo' in TransactionModel.
	// Max Length: 25
	// Min Length: 0
	ExemptionNo *string `json:"exemptionNo,omitempty"`

	// Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record.
	//
	// Some taxes only apply if the seller is the importer of record for a product.  In cases where companies are working together to
	// ship products, there may be mutual agreement as to which company is the entity designated as importer of record.  The importer
	// of record will then be the company designated to pay taxes marked as being obligated to the importer of record.
	//
	// Set this value to `true` to consider your company as the importer of record and collect these taxes.
	//
	// This value may also be set at the Nexus level.  See `NexusModel` for more information.
	IsSellerImporterOfRecord bool `json:"isSellerImporterOfRecord,omitempty"`

	// A list of line items that will appear on this transaction.
	// Example: [{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}]
	// Required: true
	Lines []*LineItemModel `json:"lines"`

	// Special parameters for this transaction.
	//
	// To get a full list of available parameters, please use the [ListParameters](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListParameters/) endpoint.
	Parameters []*TransactionParameterModel `json:"parameters"`

	// Sets the Point of Sale Lane Code sent by the User for this document.
	// Max Length: 50
	// Min Length: 0
	PosLaneCode *string `json:"posLaneCode,omitempty"`

	// Purchase Order Number for this document.
	//
	// This is required for single use exemption certificates to match the order and invoice with the certificate.
	// Example: 2021-12-25-001
	// Max Length: 50
	// Min Length: 0
	PurchaseOrderNo *string `json:"purchaseOrderNo,omitempty"`

	// Customer-provided Reference Code with information about this transaction.
	//
	// This field could be used to reference the original document for a return invoice, or for any other
	// reference purpose.
	// Max Length: 1024
	// Min Length: 0
	ReferenceCode *string `json:"referenceCode,omitempty"`

	// Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
	//
	// This value is used by Avalara Managed Returns to group documents together by reporting locations
	// for tax authorities that require location-based reporting.
	// Max Length: 50
	// Min Length: 0
	ReportingLocationCode *string `json:"reportingLocationCode,omitempty"`

	// Salesperson Code - The client application salesperson reference code.
	// Max Length: 25
	// Min Length: 0
	SalespersonCode *string `json:"salespersonCode,omitempty"`

	// Specifies whether the tax calculation is handled Local, Remote, or Automatic (default).  This only
	// applies when using an AvaLocal server.
	// Example: Automatic
	// Enum: [Automatic Local Remote]
	ServiceMode string `json:"serviceMode,omitempty"`

	// Specifies a tax override for the entire document
	// Example: {"reason":"Precalculated Tax","taxAmount":6.25,"taxDate":"2021-12-25","type":"TaxAmount"}
	TaxOverride *TaxOverrideModel `json:"taxOverride,omitempty"`

	// Specifies the type of document to create.  A document type ending with `Invoice` is a permanent transaction
	// that will be recorded in AvaTax.  A document type ending with `Order` is a temporary estimate that will not
	// be preserved.
	//
	// If you omit this value, the API will assume you want to create a `SalesOrder`.
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type string `json:"type,omitempty"`

	// Custom user fields/flex fields for this transaction.
	UserDefinedFields []*TransactionUserDefinedFieldModel `json:"userDefinedFields"`
}

CreateTransactionModel Create a transaction Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}

swagger:model CreateTransactionModel

func (*CreateTransactionModel) ContextValidate ¶ 

func (m *CreateTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create transaction model based on the context it is used

func (*CreateTransactionModel) MarshalBinary ¶ 

func (m *CreateTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateTransactionModel) UnmarshalBinary ¶ 

func (m *CreateTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateTransactionModel) Validate ¶ 

func (m *CreateTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this create transaction model

type CurrencyModel ¶ 

type CurrencyModel struct {

	// The ISO 4217 currency code for this currency.
	// Example: AED
	Code string `json:"code,omitempty"`

	// The number of decimal digits to use when formatting a currency value for display.
	// Example: 2
	DecimalDigits int32 `json:"decimalDigits,omitempty"`

	// A friendly human-readable name representing this currency.
	// Example: UAE Dirham
	Description string `json:"description,omitempty"`
}

CurrencyModel Represents an ISO 4217 currency code used for designating the currency of a transaction. Example: {"code":"AED","decimalDigits":2,"description":"UAE Dirham"}

swagger:model CurrencyModel

func (*CurrencyModel) ContextValidate ¶ 

func (m *CurrencyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this currency model based on context it is used

func (*CurrencyModel) MarshalBinary ¶ 

func (m *CurrencyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CurrencyModel) UnmarshalBinary ¶ 

func (m *CurrencyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CurrencyModel) Validate ¶ 

func (m *CurrencyModel) Validate(formats strfmt.Registry) error

Validate validates this currency model

type CurrencyModelFetchResult ¶ 

type CurrencyModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CurrencyModel `json:"value"`
}

CurrencyModelFetchResult currency model fetch result

swagger:model CurrencyModelFetchResult

func (*CurrencyModelFetchResult) ContextValidate ¶ 

func (m *CurrencyModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this currency model fetch result based on the context it is used

func (*CurrencyModelFetchResult) MarshalBinary ¶ 

func (m *CurrencyModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CurrencyModelFetchResult) UnmarshalBinary ¶ 

func (m *CurrencyModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CurrencyModelFetchResult) Validate ¶ 

func (m *CurrencyModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this currency model fetch result

type CustomFieldModel ¶ 

type CustomFieldModel struct {

	// The name of the custom field.
	// Example: Customer Type
	Name string `json:"name,omitempty"`

	// The value of the custom field.
	// Example: my customer type
	Value string `json:"value,omitempty"`
}

CustomFieldModel A custom field provides extra information about a customer or certificate.

Custom fields are provided to permit you to store additional information about an exemption certificate or customer. They are available to support additional use cases beyond that supported directly by Avalara's exemption certificate software.

For more information about custom fields, see the [Avalara Help Center article about custom fields](https://help.avalara.com/0021_Avalara_CertCapture/All_About_CertCapture/Edit_or_Remove_Details_about_Customers). Example: {"name":"Customer Type","value":"my customer type"}

swagger:model CustomFieldModel

func (*CustomFieldModel) ContextValidate ¶ 

func (m *CustomFieldModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this custom field model based on context it is used

func (*CustomFieldModel) MarshalBinary ¶ 

func (m *CustomFieldModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomFieldModel) UnmarshalBinary ¶ 

func (m *CustomFieldModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomFieldModel) Validate ¶ 

func (m *CustomFieldModel) Validate(formats strfmt.Registry) error

Validate validates this custom field model

type CustomerAttributeModel ¶ 

type CustomerAttributeModel struct {

	// A full help text description of the attribute.
	// Example: Customer address change is needed.
	Description string `json:"description,omitempty"`

	// A unique ID number representing this attribute.
	// Example: 1
	ID int32 `json:"id,omitempty"`

	// A flag denotes that this attribute can't be removed/added to a customer record
	// Example: true
	IsChangeable bool `json:"isChangeable,omitempty"`

	// A flag denotes that future exemption certificate request won't be mailed to the customer
	// Example: true
	IsNonDeliver bool `json:"isNonDeliver,omitempty"`

	// This value is true if this is a system-defined attribute.  System-defined attributes
	// cannot be modified or deleted on the CertCapture website.
	// Example: false
	IsSystemCode bool `json:"isSystemCode,omitempty"`

	// A friendly readable name for this attribute.
	// Example: ADDRESS CHANGE NEEDED
	Name string `json:"name,omitempty"`
}

CustomerAttributeModel A Customer's linked attribute denoting what features applied to the customer. A customer can be linked to multiple customer attributes and vice versa. Example: {"description":"Customer address change is needed.","id":1,"isChangeable":true,"isNonDeliver":true,"isSystemCode":false,"name":"ADDRESS CHANGE NEEDED"}

swagger:model CustomerAttributeModel

func (*CustomerAttributeModel) ContextValidate ¶ 

func (m *CustomerAttributeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this customer attribute model based on context it is used

func (*CustomerAttributeModel) MarshalBinary ¶ 

func (m *CustomerAttributeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerAttributeModel) UnmarshalBinary ¶ 

func (m *CustomerAttributeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerAttributeModel) Validate ¶ 

func (m *CustomerAttributeModel) Validate(formats strfmt.Registry) error

Validate validates this customer attribute model

type CustomerAttributeModelFetchResult ¶ 

type CustomerAttributeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CustomerAttributeModel `json:"value"`
}

CustomerAttributeModelFetchResult customer attribute model fetch result

swagger:model CustomerAttributeModelFetchResult

func (*CustomerAttributeModelFetchResult) ContextValidate ¶ 

func (m *CustomerAttributeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this customer attribute model fetch result based on the context it is used

func (*CustomerAttributeModelFetchResult) MarshalBinary ¶ 

func (m *CustomerAttributeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerAttributeModelFetchResult) UnmarshalBinary ¶ 

func (m *CustomerAttributeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerAttributeModelFetchResult) Validate ¶ 

func (m *CustomerAttributeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this customer attribute model fetch result

type CustomerModel ¶ 

type CustomerModel struct {

	// A customer-configurable alternate ID number for this customer.  You may set this value to match any
	// other system that would like to reference this customer record.
	// Example: 987654321
	AlternateID string `json:"alternateId,omitempty"`

	// Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped
	// to the attention of a specific person or department name.
	// Example: Attn: Receiving
	AttnName string `json:"attnName,omitempty"`

	// A list of attributes that apply to this customer.
	//
	// You can fetch this data by specifying `$include=attributes` when calling a customer fetch API.
	Attributes []*CustomerAttributeModel `json:"attributes"`

	// A list of exemption certficates that apply to this customer.  You can fetch this data by specifying
	// `$include=certificates` when calling a customer fetch API.
	Certificates []*CertificateModel `json:"certificates"`

	// City component of the street address of this customer.
	// Example: Irvine
	// Required: true
	City *string `json:"city"`

	// The unique ID number of the AvaTax company that recorded this customer.
	// Example: 0
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// The name of the main contact person for this customer.
	// Example: Alice Smith
	ContactName string `json:"contactName,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// A list of custom fields defined on this customer.
	//
	// For more information about custom fields, see the [Avalara Help Center article about custom fields](https://help.avalara.com/0021_Avalara_CertCapture/All_About_CertCapture/Edit_or_Remove_Details_about_Customers).
	CustomFields []*CustomFieldModel `json:"customFields"`

	// The unique code identifying this customer.  Must be unique within your company.
	//
	// This code should be used in the `customerCode` field of any call that creates or adjusts a transaction
	// in order to ensure that all exemptions that apply to this customer are correctly considered.
	//
	// Note: This field is case sensitive.
	// Example: e696d2a2-9771-4d13-90e9-fd0f9891a0e1
	// Required: true
	CustomerCode *string `json:"customerCode"`

	// The main email address for this customer.
	// Example: dr.bob.example@example.org
	EmailAddress string `json:"emailAddress,omitempty"`

	// A list of exposure zones where you do business with this customer.
	//
	// To keep track of certificates that are needed for each customer, set this value to a list of all exposure zones where you
	// sell products to this customer.  You can find a list of exposure zones by calling `ListExposureZones`.
	//
	// This field is often called "Ship-To States" or "Ship-To Zones", since it generally refers to locations where you ship products
	// when this customer makes a purchase.
	//
	// This field is useful for audit purposes since it helps you ensure you have the necessary certificates for each customer.
	// Example: [{"name":"Washington"}]
	ExposureZones []*ExposureZoneModel `json:"exposureZones"`

	// The fax phone number for this customer, if any.
	// Example: 949.555.1213
	FaxNumber string `json:"faxNumber,omitempty"`

	// Unique ID number of this customer.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// True if this customer record is specifically used for bill-to purposes.
	IsBill bool `json:"isBill,omitempty"`

	// True if this customer record is specifically used for ship-to purposes.
	IsShip bool `json:"isShip,omitempty"`

	// Date when this customer last executed a transaction.
	// Example: 2008-10-08T00:00:00
	// Read Only: true
	// Format: date-time
	LastTransaction strfmt.DateTime `json:"lastTransaction,omitempty"`

	// First line of the street address of this customer.
	// Example: 645 Main Street
	// Required: true
	Line1 *string `json:"line1"`

	// Second line of the street address of this customer.
	Line2 string `json:"line2,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// A friendly name identifying this customer.
	// Example: Dr. Bob Example
	// Required: true
	Name *string `json:"name"`

	// The main phone number for this customer.
	// Example: (949) 555-1212
	PhoneNumber string `json:"phoneNumber,omitempty"`

	// Postal Code / Zip Code component of the address of this customer.
	// Example: 92614
	// Required: true
	PostalCode *string `json:"postalCode"`

	// ISO 3166 code identifying the region within the country.
	// Two and three character ISO 3166 region codes.
	//
	// For a full list of all supported codes, please see the Definitions API `ListRegions`.
	// Example: CA
	// Required: true
	// Max Length: 3
	// Min Length: 0
	Region *string `json:"region"`

	// A list of ship-to customer records that are connected to this bill-to customer.
	//
	// Customer records represent businesses or individuals who can provide exemption certificates.  Some customers
	// may have certificates that are linked to their shipping address or their billing address.  To group these
	// customer records together, you may link multiple bill-to and ship-to addresses together to represent a single
	// entity that has multiple different addresses of different kinds.
	ShipTos []*CustomerModel `json:"shipTos"`

	// For customers in the United States, this field is the federal taxpayer ID number.  For businesses, this is
	// a Federal Employer Identification Number.  For individuals, this will be a Social Security Number.
	TaxpayerIDNumber string `json:"taxpayerIdNumber,omitempty"`
}

CustomerModel Represents a customer to whom you sell products and/or services. Example: {"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"e696d2a2-9771-4d13-90e9-fd0f9891a0e1","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"}

swagger:model CustomerModel

func (*CustomerModel) ContextValidate ¶ 

func (m *CustomerModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this customer model based on the context it is used

func (*CustomerModel) MarshalBinary ¶ 

func (m *CustomerModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerModel) UnmarshalBinary ¶ 

func (m *CustomerModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerModel) Validate ¶ 

func (m *CustomerModel) Validate(formats strfmt.Registry) error

Validate validates this customer model

type CustomerModelFetchResult ¶ 

type CustomerModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CustomerModel `json:"value"`
}

CustomerModelFetchResult customer model fetch result

swagger:model CustomerModelFetchResult

func (*CustomerModelFetchResult) ContextValidate ¶ 

func (m *CustomerModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this customer model fetch result based on the context it is used

func (*CustomerModelFetchResult) MarshalBinary ¶ 

func (m *CustomerModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerModelFetchResult) UnmarshalBinary ¶ 

func (m *CustomerModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerModelFetchResult) Validate ¶ 

func (m *CustomerModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this customer model fetch result

type CustomerSupplierCountryParamModel ¶ 

type CustomerSupplierCountryParamModel struct {

	// business identification no
	// Max Length: 25
	// Min Length: 0
	BusinessIdentificationNo *string `json:"businessIdentificationNo,omitempty"`

	// CompanyId associated with the parameter
	// Example: 0
	CompanyID int32 `json:"companyId,omitempty"`

	// country
	// Required: true
	Country *string `json:"country"`

	// customer code
	CustomerCode string `json:"customerCode,omitempty"`

	// Identifier for company parameter
	CustomerID int64 `json:"customerId,omitempty"`

	// Identifier for company parameter
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// is established
	IsEstablished bool `json:"isEstablished,omitempty"`

	// is registered through fiscal rep
	IsRegisteredThroughFiscalRep bool `json:"isRegisteredThroughFiscalRep,omitempty"`
}

CustomerSupplierCountryParamModel Represents a parameter associated with a company. Example: {"businessIdentificationNo":"123456789","companyId":0,"customerId":0,"id":0,"isEstablished":true,"isRegisteredThroughFiscalRep":false}

swagger:model CustomerSupplierCountryParamModel

func (*CustomerSupplierCountryParamModel) ContextValidate ¶ 

func (m *CustomerSupplierCountryParamModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this customer supplier country param model based on the context it is used

func (*CustomerSupplierCountryParamModel) MarshalBinary ¶ 

func (m *CustomerSupplierCountryParamModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerSupplierCountryParamModel) UnmarshalBinary ¶ 

func (m *CustomerSupplierCountryParamModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerSupplierCountryParamModel) Validate ¶ 

func (m *CustomerSupplierCountryParamModel) Validate(formats strfmt.Registry) error

Validate validates this customer supplier country param model

type CustomerSupplierModel ¶ 

type CustomerSupplierModel struct {

	// CompanyId associated with the parameter
	// Example: 0
	CompanyID int32 `json:"companyId,omitempty"`

	// CustomerCode
	// Required: true
	CustomerCode *string `json:"customerCode"`

	// Identifier for company parameter
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`
}

CustomerSupplierModel Represents a parameter associated with a company. Example: {"companyId":0,"customerCode":"Magento","id":0}

swagger:model CustomerSupplierModel

func (*CustomerSupplierModel) ContextValidate ¶ 

func (m *CustomerSupplierModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this customer supplier model based on the context it is used

func (*CustomerSupplierModel) MarshalBinary ¶ 

func (m *CustomerSupplierModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerSupplierModel) UnmarshalBinary ¶ 

func (m *CustomerSupplierModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerSupplierModel) Validate ¶ 

func (m *CustomerSupplierModel) Validate(formats strfmt.Registry) error

Validate validates this customer supplier model

type CustomerSupplierModelFetchResult ¶ 

type CustomerSupplierModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*CustomerSupplierModel `json:"value"`
}

CustomerSupplierModelFetchResult customer supplier model fetch result

swagger:model CustomerSupplierModelFetchResult

func (*CustomerSupplierModelFetchResult) ContextValidate ¶ 

func (m *CustomerSupplierModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this customer supplier model fetch result based on the context it is used

func (*CustomerSupplierModelFetchResult) MarshalBinary ¶ 

func (m *CustomerSupplierModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomerSupplierModelFetchResult) UnmarshalBinary ¶ 

func (m *CustomerSupplierModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomerSupplierModelFetchResult) Validate ¶ 

func (m *CustomerSupplierModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this customer supplier model fetch result

type CycleAddOptionModel ¶ 

type CycleAddOptionModel struct {

	// True if this form can be added and filed for the current cycle. "Current cycle" is considered one month before the month of today's date.
	// Example: true
	Available bool `json:"available,omitempty"`

	// A list of outlet codes that can be assigned to this form for the current cycle
	// Example: []
	AvailableLocationCodes []string `json:"availableLocationCodes"`

	// A descriptive name of the cycle and due date of form.
	// Example: Monthly filing for April 2018, due May 20 2018.
	CycleName string `json:"cycleName,omitempty"`

	// An explanation for why this form cannot be added for the current cycle
	CycleUnavailableReason string `json:"cycleUnavailableReason,omitempty"`

	// The jurisdiction-assigned due date for the form
	// Example: 2018-05-20T00:00:00
	// Format: date
	FilingDueDate strfmt.Date `json:"filingDueDate,omitempty"`

	// A code assigned to the filing frequency
	// Example: M
	FilingFrequencyCode string `json:"filingFrequencyCode,omitempty"`

	// The filing frequency of the request
	// Example: Monthly
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequencyID string `json:"filingFrequencyId,omitempty"`

	// The filing frequency of the form
	// Example: Monthly
	FrequencyName string `json:"frequencyName,omitempty"`

	// The period end date for the customer's last transaction in the jurisdiction being added
	// Example: 2018-04-30T00:00:00
	// Format: date
	TransactionalPeriodEnd strfmt.Date `json:"transactionalPeriodEnd,omitempty"`

	// The period start date for the customer's first transaction in the jurisdiction being added
	// Example: 2018-04-01T00:00:00
	// Format: date
	TransactionalPeriodStart strfmt.Date `json:"transactionalPeriodStart,omitempty"`
}

CycleAddOptionModel Model with options for adding a new filing calendar Example: {"available":true,"availableLocationCodes":[],"cycleName":"Monthly filing for April 2018, due May 20 2018.","cycleUnavailableReason":"","filingDueDate":"2018-05-20","filingFrequencyCode":"M","frequencyName":"Monthly","transactionalPeriodEnd":"2018-04-30","transactionalPeriodStart":"2018-04-01"}

swagger:model CycleAddOptionModel

func (*CycleAddOptionModel) ContextValidate ¶ 

func (m *CycleAddOptionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this cycle add option model based on context it is used

func (*CycleAddOptionModel) MarshalBinary ¶ 

func (m *CycleAddOptionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleAddOptionModel) UnmarshalBinary ¶ 

func (m *CycleAddOptionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleAddOptionModel) Validate ¶ 

func (m *CycleAddOptionModel) Validate(formats strfmt.Registry) error

Validate validates this cycle add option model

type CycleEditOptionModel ¶ 

type CycleEditOptionModel struct {

	// The effective date of the filing calendar (only applies if cloning).
	// Format: date
	ClonedCalendarEffDate strfmt.Date `json:"clonedCalendarEffDate,omitempty"`

	// Whether or not the user should be warned of a change, because some changes are risky and may be being done not in accordance with jurisdiction rules.
	// For example, user would be warned if user changes filing frequency to new frequency with a start date during an accrual month of the existing frequency.
	// Example: false
	CustomerMustApprove bool `json:"customerMustApprove,omitempty"`

	// The expired end date of the old filing calendar (only applies if cloning).
	// Format: date
	ExpiredCalendarEndDate strfmt.Date `json:"expiredCalendarEndDate,omitempty"`

	// The message to present to the user when calendar is successfully or unsuccessfully changed.
	// Example: Clone unnecessary.  No approved instances of filing calendar
	Message string `json:"message,omitempty"`

	// True if the filing calendar must be cloned to allow this change; false if the existing filing calendar can be changed itself.
	// Example: false
	MustCloneFilingCalendar bool `json:"mustCloneFilingCalendar,omitempty"`

	// Whether or not changes can be made to the filing calendar.
	// Example: true
	Success bool `json:"success,omitempty"`
}

CycleEditOptionModel Model with options for actual filing calendar output based on user edits to filing calendar. Example: {"customerMustApprove":false,"message":"Clone unnecessary. No approved instances of filing calendar","mustCloneFilingCalendar":false,"success":true}

swagger:model CycleEditOptionModel

func (*CycleEditOptionModel) ContextValidate ¶ 

func (m *CycleEditOptionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this cycle edit option model based on context it is used

func (*CycleEditOptionModel) MarshalBinary ¶ 

func (m *CycleEditOptionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleEditOptionModel) UnmarshalBinary ¶ 

func (m *CycleEditOptionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleEditOptionModel) Validate ¶ 

func (m *CycleEditOptionModel) Validate(formats strfmt.Registry) error

Validate validates this cycle edit option model

type CycleExpireModel ¶ 

type CycleExpireModel struct {

	// A list of options for expiring the filing calendar.
	// Example: [{"cycleName":"Monthly filing for December 2016, due January 20 2017.","filingDueDate":"2017-01-20","transactionalPeriodEnd":"2016-12-31","transactionalPeriodStart":"2016-12-01"}]
	CycleExpirationOptions []*CycleExpireOptionModel `json:"cycleExpirationOptions"`

	// The message to present to the user if expiration is successful or unsuccessful.
	Message string `json:"message,omitempty"`

	// Whether or not the filing calendar can be expired.
	// e.g. if user makes end date of a calendar earlier than latest filing, this would be set to false.
	// Example: true
	Success bool `json:"success,omitempty"`
}

CycleExpireModel Cycle Safe Expiration results. Example: {"cycleExpirationOptions":[{"cycleName":"Monthly filing for December 2016, due January 20 2017.","filingDueDate":"2017-01-20","transactionalPeriodEnd":"2016-12-31","transactionalPeriodStart":"2016-12-01"}],"success":true}

swagger:model CycleExpireModel

func (*CycleExpireModel) ContextValidate ¶ 

func (m *CycleExpireModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cycle expire model based on the context it is used

func (*CycleExpireModel) MarshalBinary ¶ 

func (m *CycleExpireModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleExpireModel) UnmarshalBinary ¶ 

func (m *CycleExpireModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleExpireModel) Validate ¶ 

func (m *CycleExpireModel) Validate(formats strfmt.Registry) error

Validate validates this cycle expire model

type CycleExpireOptionModel ¶ 

type CycleExpireOptionModel struct {

	// A descriptive name of the cycle and due date of the form.
	// Example: Monthly filing for December 2016, due January 20 2017.
	CycleName string `json:"cycleName,omitempty"`

	// The jurisdiction-assigned due date for the form.
	// Example: 2017-01-20T00:00:00
	// Format: date
	FilingDueDate strfmt.Date `json:"filingDueDate,omitempty"`

	// The period end date for the customer's last transaction in the jurisdiction being expired.
	// Example: 2016-12-31T00:00:00
	// Format: date
	TransactionalPeriodEnd strfmt.Date `json:"transactionalPeriodEnd,omitempty"`

	// The period start date for the customer's first transaction in the jurisdiction being expired.
	// Example: 2016-12-01T00:00:00
	// Format: date
	TransactionalPeriodStart strfmt.Date `json:"transactionalPeriodStart,omitempty"`
}

CycleExpireOptionModel Options for expiring a filing calendar. Example: {"cycleName":"Monthly filing for December 2016, due January 20 2017.","filingDueDate":"2017-01-20","transactionalPeriodEnd":"2016-12-31","transactionalPeriodStart":"2016-12-01"}

swagger:model CycleExpireOptionModel

func (*CycleExpireOptionModel) ContextValidate ¶ 

func (m *CycleExpireOptionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this cycle expire option model based on context it is used

func (*CycleExpireOptionModel) MarshalBinary ¶ 

func (m *CycleExpireOptionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleExpireOptionModel) UnmarshalBinary ¶ 

func (m *CycleExpireOptionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleExpireOptionModel) Validate ¶ 

func (m *CycleExpireOptionModel) Validate(formats strfmt.Registry) error

Validate validates this cycle expire option model

type CycleSafeEditRequestModel ¶ 

type CycleSafeEditRequestModel struct {

	// Company Identifier
	// Example: 0
	CompanyID int32 `json:"companyId,omitempty"`

	// Filing calendar edits
	// Example: [{"destination":"","fieldName":"","newValue":"","oldValue":"","questionCode":"","questionId":0}]
	Edits []*CycleSafeFilingCalendarEditModel `json:"edits"`

	// Filing Calendar Identifier
	// Example: 0
	FilingCalendarID int64 `json:"filingCalendarId,omitempty"`

	// Tax Form Code
	TaxFormCode string `json:"taxFormCode,omitempty"`
}

CycleSafeEditRequestModel Options for expiring a filing calendar. Example: {"companyId":0,"edits":[{"destination":"","fieldName":"","newValue":"","oldValue":"","questionCode":"","questionId":0}],"filingCalendarId":0,"taxFormCode":""}

swagger:model CycleSafeEditRequestModel

func (*CycleSafeEditRequestModel) ContextValidate ¶ 

func (m *CycleSafeEditRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cycle safe edit request model based on the context it is used

func (*CycleSafeEditRequestModel) MarshalBinary ¶ 

func (m *CycleSafeEditRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleSafeEditRequestModel) UnmarshalBinary ¶ 

func (m *CycleSafeEditRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleSafeEditRequestModel) Validate ¶ 

func (m *CycleSafeEditRequestModel) Validate(formats strfmt.Registry) error

Validate validates this cycle safe edit request model

type CycleSafeFilingCalendarEditModel ¶ 

type CycleSafeFilingCalendarEditModel struct {

	// Destination is used to identify filing questions' type Other or Settings.
	Destination string `json:"destination,omitempty"`

	// Field To Edit
	FieldName string `json:"fieldName,omitempty"`

	// New Value
	NewValue interface{} `json:"newValue,omitempty"`

	// Old Value
	OldValue interface{} `json:"oldValue,omitempty"`

	// The filing question code.
	QuestionCode string `json:"questionCode,omitempty"`

	// Question
	// Example: 0
	QuestionID int64 `json:"questionId,omitempty"`
}

CycleSafeFilingCalendarEditModel Filing Calendar Edit Example: {"destination":"","fieldName":"","newValue":"","oldValue":"","questionCode":"","questionId":0}

swagger:model CycleSafeFilingCalendarEditModel

func (*CycleSafeFilingCalendarEditModel) ContextValidate ¶ 

func (m *CycleSafeFilingCalendarEditModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this cycle safe filing calendar edit model based on context it is used

func (*CycleSafeFilingCalendarEditModel) MarshalBinary ¶ 

func (m *CycleSafeFilingCalendarEditModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleSafeFilingCalendarEditModel) UnmarshalBinary ¶ 

func (m *CycleSafeFilingCalendarEditModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleSafeFilingCalendarEditModel) Validate ¶ 

func (m *CycleSafeFilingCalendarEditModel) Validate(formats strfmt.Registry) error

Validate validates this cycle safe filing calendar edit model

type CycleSafeOptionResultModel ¶ 

type CycleSafeOptionResultModel struct {

	// Cloned Calendar Effective Date
	// Format: date-time
	ClonedCalendarEffDate strfmt.DateTime `json:"clonedCalendarEffDate,omitempty"`

	// Expired Calendar End Date
	// Format: date-time
	ExpiredCalendarEndDate strfmt.DateTime `json:"expiredCalendarEndDate,omitempty"`

	// Frequencies Available
	FrequenciesAvailable []*FrequencyAvailableModel `json:"frequenciesAvailable"`

	// Boolean if the Filing Calendar must be cloned
	MustCloneFilingCalendar bool `json:"mustCloneFilingCalendar,omitempty"`

	// Tax Form Code
	TaxFormCode string `json:"taxFormCode,omitempty"`
}

CycleSafeOptionResultModel CycleSafe Option Result Example: {"clonedCalendarEffDate":"2021-12-25T17:08:42.5279435+00:00","expiredCalendarEndDate":"2022-01-24T17:08:42.5279669+00:00","frequenciesAvailable":[],"mustCloneFilingCalendar":false,"taxFormCode":""}

swagger:model CycleSafeOptionResultModel

func (*CycleSafeOptionResultModel) ContextValidate ¶ 

func (m *CycleSafeOptionResultModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cycle safe option result model based on the context it is used

func (*CycleSafeOptionResultModel) MarshalBinary ¶ 

func (m *CycleSafeOptionResultModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CycleSafeOptionResultModel) UnmarshalBinary ¶ 

func (m *CycleSafeOptionResultModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CycleSafeOptionResultModel) Validate ¶ 

func (m *CycleSafeOptionResultModel) Validate(formats strfmt.Registry) error

Validate validates this cycle safe option result model

type DataSourceModel ¶ 

type DataSourceModel struct {

	// The id of the company to which the datasource belongs to.
	// Example: 12345
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// The date when this record was created.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Example: 123
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date when this record was deleted.
	// Read Only: true
	// Format: date-time
	DeletedDate strfmt.DateTime `json:"deletedDate,omitempty"`

	// Specifies any implementation-specific information along with the DataSource.This field has no internal meaning in AvaTax and is purely for the convenience of the DataSource API user
	// Example: Test Path
	ExternalState string `json:"externalState,omitempty"`

	// The id of the datasource.
	// Example: 1
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The unique ID number of this connection.
	// Example: 0a9cd4d9-d4f8-4db6-a0c0-62f44dc69699
	// Read Only: true
	Instance string `json:"instance,omitempty"`

	// True if this data source is authorized.
	// Example: false
	IsAuthorized bool `json:"isAuthorized,omitempty"`

	// The connection using the connection_id is enabled. The customer is responsible to enable or disable.
	// Example: false
	IsEnabled bool `json:"isEnabled,omitempty"`

	// If all the information has been transferred from the extractor to the database.
	// Example: false
	IsSynced bool `json:"isSynced,omitempty"`

	// The date when the information was last synched.
	// Format: date-time
	LastSyncedDate strfmt.DateTime `json:"lastSyncedDate,omitempty"`

	// The date/time when this record was last modified.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Example: 12
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// Specifies the name of the extractor
	// Example: TestName
	Name string `json:"name,omitempty"`

	// Specifies whether transactions created by this data source needs to re-calculate tax or not
	Recalculate bool `json:"recalculate,omitempty"`

	// The extractor/connector id.
	// Example: Amazon v2 Extractor
	// Required: true
	Source *string `json:"source"`
}

DataSourceModel Data source object Example: {"companyId":12345,"createdDate":"2021-12-25T00:00:00+00:00","createdUserId":123,"externalState":"Test Path","id":1,"instance":"0a9cd4d9-d4f8-4db6-a0c0-62f44dc69699","isAuthorized":false,"isEnabled":false,"isSynced":false,"modifiedDate":"2021-12-25T00:00:00+00:00","modifiedUserId":12,"name":"TestName","source":"Amazon v2 Extractor"}

swagger:model DataSourceModel

func (*DataSourceModel) ContextValidate ¶ 

func (m *DataSourceModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data source model based on the context it is used

func (*DataSourceModel) MarshalBinary ¶ 

func (m *DataSourceModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataSourceModel) UnmarshalBinary ¶ 

func (m *DataSourceModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataSourceModel) Validate ¶ 

func (m *DataSourceModel) Validate(formats strfmt.Registry) error

Validate validates this data source model

type DataSourceModelFetchResult ¶ 

type DataSourceModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*DataSourceModel `json:"value"`
}

DataSourceModelFetchResult data source model fetch result

swagger:model DataSourceModelFetchResult

func (*DataSourceModelFetchResult) ContextValidate ¶ 

func (m *DataSourceModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data source model fetch result based on the context it is used

func (*DataSourceModelFetchResult) MarshalBinary ¶ 

func (m *DataSourceModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataSourceModelFetchResult) UnmarshalBinary ¶ 

func (m *DataSourceModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataSourceModelFetchResult) Validate ¶ 

func (m *DataSourceModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this data source model fetch result

type DeclareNexusByAddressModel ¶ 

type DeclareNexusByAddressModel struct {

	// City component of the address
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// The earliest date on which your company does business at this address.  If you omit
	// a value in this field, nexus will be declared at the earliest possible date for this
	// jurisdiction.
	// Example: 2018-01-01T00:00:00
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// The date on which your company stopped doing business at this address, or empty if
	// your company has no plans to stop doing business at this address.
	// Example: 2020-12-31T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Geospatial latitude measurement, in Decimal Degrees floating point format.
	Latitude float64 `json:"latitude,omitempty"`

	// First line of the street address
	// Example: 2000 Main Street
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// Second line of the street address
	// Max Length: 100
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Third line of the street address
	// Max Length: 100
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// Geospatial longitude measurement, in Decimal Degrees floating point format.
	Longitude float64 `json:"longitude,omitempty"`

	// Postal Code / Zip Code component of the address.
	// Example: 92614
	// Max Length: 11
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`

	// Specify the text case for the validated address result.  If not specified, will return uppercase.
	// Example: Upper
	// Enum: [Upper Mixed]
	TextCase string `json:"textCase,omitempty"`
}

DeclareNexusByAddressModel Use this object to provide an address and date range where your company does business. This address will be used to determine what jurisdictions you should declare nexus and calculate tax. Example: {"city":"Irvine","country":"US","effectiveDate":"2018-01-01T00:00:00","endDate":"2020-12-31T00:00:00","line1":"2000 Main Street","postalCode":"92614","region":"CA"}

swagger:model DeclareNexusByAddressModel

func (*DeclareNexusByAddressModel) ContextValidate ¶ 

func (m *DeclareNexusByAddressModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this declare nexus by address model based on context it is used

func (*DeclareNexusByAddressModel) MarshalBinary ¶ 

func (m *DeclareNexusByAddressModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeclareNexusByAddressModel) UnmarshalBinary ¶ 

func (m *DeclareNexusByAddressModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeclareNexusByAddressModel) Validate ¶ 

func (m *DeclareNexusByAddressModel) Validate(formats strfmt.Registry) error

Validate validates this declare nexus by address model

type DeleteErrorTransactionResponseModel ¶ 

type DeleteErrorTransactionResponseModel struct {

	// The internal reference code (used by the client application) of the error transaction
	// Example: 91cba92f-d649-409f-9d22-dcf0ee550fde
	// Required: true
	// Max Length: 50
	// Min Length: 0
	DocumentCode *string `json:"documentCode"`

	// Type of transaction of the error transaction
	// Example: SalesOrder
	// Required: true
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType *string `json:"documentType"`

	// Result of the deletion
	// Example: Success
	// Enum: [Success Failure]
	Result string `json:"result,omitempty"`
}

DeleteErrorTransactionResponseModel Response model of a single error transaction delete Example: {"documentCode":"91cba92f-d649-409f-9d22-dcf0ee550fde","documentType":"SalesOrder","result":"Success"}

swagger:model DeleteErrorTransactionResponseModel

func (*DeleteErrorTransactionResponseModel) ContextValidate ¶ 

func (m *DeleteErrorTransactionResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this delete error transaction response model based on context it is used

func (*DeleteErrorTransactionResponseModel) MarshalBinary ¶ 

func (m *DeleteErrorTransactionResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeleteErrorTransactionResponseModel) UnmarshalBinary ¶ 

func (m *DeleteErrorTransactionResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeleteErrorTransactionResponseModel) Validate ¶ 

func (m *DeleteErrorTransactionResponseModel) Validate(formats strfmt.Registry) error

Validate validates this delete error transaction response model

type DeleteErrorTransactionsRequestModel ¶ 

type DeleteErrorTransactionsRequestModel struct {

	// List of error transactions to be deleted
	// Example: [{"documentCode":"2e604c50-82f9-43e0-90ba-5e95fd27625f","documentType":"SalesOrder"}]
	// Required: true
	Models []*ErrorTransactionModelBase `json:"models"`
}

DeleteErrorTransactionsRequestModel Request model for when a user is deleting multiple error transaction Example: {"models":[{"documentCode":"2e604c50-82f9-43e0-90ba-5e95fd27625f","documentType":"SalesOrder"}]}

swagger:model DeleteErrorTransactionsRequestModel

func (*DeleteErrorTransactionsRequestModel) ContextValidate ¶ 

func (m *DeleteErrorTransactionsRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this delete error transactions request model based on the context it is used

func (*DeleteErrorTransactionsRequestModel) MarshalBinary ¶ 

func (m *DeleteErrorTransactionsRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeleteErrorTransactionsRequestModel) UnmarshalBinary ¶ 

func (m *DeleteErrorTransactionsRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeleteErrorTransactionsRequestModel) Validate ¶ 

func (m *DeleteErrorTransactionsRequestModel) Validate(formats strfmt.Registry) error

Validate validates this delete error transactions request model

type DeleteErrorTransactionsResponseModel ¶ 

type DeleteErrorTransactionsResponseModel struct {

	// The individual result of each error transaction in the request batch
	// Example: [{"documentCode":"b921b5a2-0836-4617-8688-f49d1b24dc91","documentType":"SalesOrder","result":"Success"}]
	Results []*DeleteErrorTransactionResponseModel `json:"results"`
}

DeleteErrorTransactionsResponseModel Response model of error transaction batch delete Example: {"results":[{"documentCode":"b921b5a2-0836-4617-8688-f49d1b24dc91","documentType":"SalesOrder","result":"Success"}]}

swagger:model DeleteErrorTransactionsResponseModel

func (*DeleteErrorTransactionsResponseModel) ContextValidate ¶ 

func (m *DeleteErrorTransactionsResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this delete error transactions response model based on the context it is used

func (*DeleteErrorTransactionsResponseModel) MarshalBinary ¶ 

func (m *DeleteErrorTransactionsResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeleteErrorTransactionsResponseModel) UnmarshalBinary ¶ 

func (m *DeleteErrorTransactionsResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeleteErrorTransactionsResponseModel) Validate ¶ 

func (m *DeleteErrorTransactionsResponseModel) Validate(formats strfmt.Registry) error

Validate validates this delete error transactions response model

type DenormalizedJurisModel ¶ 

type DenormalizedJurisModel struct {

	// The jurisdiction's city.
	// This should exist on the TaxRegion, but in practice often doesn't.
	City string `json:"city,omitempty"`

	// The jurisdiction's country.
	// This should exist on the TaxRegion, but in practice often doesn't.
	Country string `json:"country,omitempty"`

	// The jurisdiction's county.
	// This should exist on the TaxRegion, but in practice often doesn't.
	County string `json:"county,omitempty"`

	// The jurisdiction's effective date.
	// Example: 1900-01-01T00:00:00
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// The jurisdiction's end date.
	// Example: 2013-11-30T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Is Acm flag
	// Example: true
	IsAcm bool `json:"isAcm,omitempty"`

	// Is Sst flag
	// Example: true
	IsSst bool `json:"isSst,omitempty"`

	// The jurisdiction's code.
	// Example: 20
	JurisCode string `json:"jurisCode,omitempty"`

	// The jurisdiction's name.
	// Example: KANSAS
	JurisName string `json:"jurisName,omitempty"`

	// The jurisdiction's type.
	// Example: Country
	// Enum: [Country State County City Special]
	JurisType string `json:"jurisType,omitempty"`

	// The jurisdiction's id.
	// Example: 20
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// The jurisdiction's region.
	// This should exist on the TaxRegion, but in practice often doesn't.
	State string `json:"state,omitempty"`

	// The state assigned code.
	StateAssignedCode string `json:"stateAssignedCode,omitempty"`

	// The id of the tax authority.
	// Example: 280
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`
}

DenormalizedJurisModel Represents information about a single legal taxing jurisdiction within a specific Avalara tax region. Example: {"effectiveDate":"1900-01-01T00:00:00","endDate":"2013-11-30T00:00:00","isAcm":true,"isSst":true,"jurisCode":"20","jurisName":"KANSAS","jurisType":"State","jurisdictionId":20,"taxAuthorityId":280}

swagger:model DenormalizedJurisModel

func (*DenormalizedJurisModel) ContextValidate ¶ 

func (m *DenormalizedJurisModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this denormalized juris model based on context it is used

func (*DenormalizedJurisModel) MarshalBinary ¶ 

func (m *DenormalizedJurisModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DenormalizedJurisModel) UnmarshalBinary ¶ 

func (m *DenormalizedJurisModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DenormalizedJurisModel) Validate ¶ 

func (m *DenormalizedJurisModel) Validate(formats strfmt.Registry) error

Validate validates this denormalized juris model

type DeterminationFactorModel ¶ 

type DeterminationFactorModel struct {

	// Determination reason code.
	// Example: NoNexus
	Code string `json:"code,omitempty"`

	// The name of the user who created the determination factor.
	CreatedBy string `json:"createdBy,omitempty"`

	// Determination reason description.
	// Example: No tax was calculated because no nexus was declared in XYZ.
	Description string `json:"description,omitempty"`

	// The ids of any applied determination factor.
	Ids []string `json:"ids"`

	// The name of any applied determination factor.
	Names []string `json:"names"`
}

DeterminationFactorModel This object represents a single determination factor for a line that is being inspected through the InspectLine API. Example: {"code":"NoNexus","description":"No tax was calculated because no nexus was declared in XYZ."}

swagger:model DeterminationFactorModel

func (*DeterminationFactorModel) ContextValidate ¶ 

func (m *DeterminationFactorModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this determination factor model based on context it is used

func (*DeterminationFactorModel) MarshalBinary ¶ 

func (m *DeterminationFactorModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeterminationFactorModel) UnmarshalBinary ¶ 

func (m *DeterminationFactorModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeterminationFactorModel) Validate ¶ 

func (m *DeterminationFactorModel) Validate(formats strfmt.Registry) error

Validate validates this determination factor model

type ECommerceTokenOutputModel ¶ 

type ECommerceTokenOutputModel struct {

	// The list of clients that the token is valid for.
	// Example: [1,2,3]
	ClientIds []int64 `json:"clientIds"`

	// The date the token was created.
	// Example: 2000-01-01T00:00:00
	// Required: true
	// Format: date-time
	CreatedDate *strfmt.DateTime `json:"createdDate"`

	// The date that the token will expire.
	// Example: 2000-01-01T00:00:00
	// Required: true
	// Format: date-time
	ExpirationDate *strfmt.DateTime `json:"expirationDate"`

	// The JWT token that authorizes the gencert tool to operate.
	// Example: jwt token for gencert utility
	// Required: true
	Token *string `json:"token"`
}

ECommerceTokenOutputModel The resource model returned by the ECommerceTokenController's endpoints. Example: {"clientIds":[1,2,3],"createdDate":"2000-01-01T00:00:00","expirationDate":"2000-01-01T00:00:00","token":"jwt token for gencert utility"}

swagger:model ECommerceTokenOutputModel

func (*ECommerceTokenOutputModel) ContextValidate ¶ 

func (m *ECommerceTokenOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this e commerce token output model based on context it is used

func (*ECommerceTokenOutputModel) MarshalBinary ¶ 

func (m *ECommerceTokenOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ECommerceTokenOutputModel) UnmarshalBinary ¶ 

func (m *ECommerceTokenOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ECommerceTokenOutputModel) Validate ¶ 

func (m *ECommerceTokenOutputModel) Validate(formats strfmt.Registry) error

Validate validates this e commerce token output model

type ECommerceTokenOutputModelFetchResult ¶ 

type ECommerceTokenOutputModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ECommerceTokenOutputModel `json:"value"`
}

ECommerceTokenOutputModelFetchResult e commerce token output model fetch result

swagger:model ECommerceTokenOutputModelFetchResult

func (*ECommerceTokenOutputModelFetchResult) ContextValidate ¶ 

func (m *ECommerceTokenOutputModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this e commerce token output model fetch result based on the context it is used

func (*ECommerceTokenOutputModelFetchResult) MarshalBinary ¶ 

func (m *ECommerceTokenOutputModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ECommerceTokenOutputModelFetchResult) UnmarshalBinary ¶ 

func (m *ECommerceTokenOutputModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ECommerceTokenOutputModelFetchResult) Validate ¶ 

func (m *ECommerceTokenOutputModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this e commerce token output model fetch result

type EcmsDetailModel ¶ 

type EcmsDetailModel struct {

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// End date of this exempt certificate
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Unique, system-assigned identifier of a ExemptCertDetail record.
	// Example: 1235
	// Required: true
	ExemptCertDetailID *int32 `json:"exemptCertDetailId"`

	// The calc_id associated with a certificate in CertCapture.
	// Example: 1111
	// Required: true
	ExemptCertID *int32 `json:"exemptCertId"`

	// The customer Tax Id Number (tax_number) associated with a certificate. This is same as exemptionNo in Transactions.
	// Max Length: 100
	// Min Length: 0
	IDNo *string `json:"idNo,omitempty"`

	// The type of idNo (tax_number) associated with a certificate.
	// Example: Driver's Licence Number, Permit Number.
	// Example: TIN
	// Max Length: 50
	// Min Length: 0
	IDType *string `json:"idType,omitempty"`

	// Is the tax code list an exculsion list?
	// Example: 0
	IsTaxCodeListExclusionList int32 `json:"isTaxCodeListExclusionList,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: WA
	// Required: true
	Region *string `json:"region"`

	// State FIPS
	// Example: AAA
	// Required: true
	// Max Length: 2
	// Min Length: 0
	StateFips *string `json:"stateFips"`

	// optional: list of tax code associated with this exempt certificate detail
	TaxCodes []*EcmsDetailTaxCodeModel `json:"taxCodes"`
}

EcmsDetailModel Represents an ECMS record, used internally by AvaTax to track information about exemptions. Example: {"country":"US","endDate":"2021-12-25T00:00:00+00:00","exemptCertDetailId":1235,"exemptCertId":1111,"idType":"TIN","isTaxCodeListExclusionList":0,"region":"WA","stateFips":"AAA"}

swagger:model EcmsDetailModel

func (*EcmsDetailModel) ContextValidate ¶ 

func (m *EcmsDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this ecms detail model based on the context it is used

func (*EcmsDetailModel) MarshalBinary ¶ 

func (m *EcmsDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EcmsDetailModel) UnmarshalBinary ¶ 

func (m *EcmsDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EcmsDetailModel) Validate ¶ 

func (m *EcmsDetailModel) Validate(formats strfmt.Registry) error

Validate validates this ecms detail model

type EcmsDetailTaxCodeModel ¶ 

type EcmsDetailTaxCodeModel struct {

	// exempt certificate detail id
	// Example: 1235
	ExemptCertDetailID int32 `json:"exemptCertDetailId,omitempty"`

	// Id of the exempt certificate detail tax code
	// Example: 4316
	ExemptCertDetailTaxCodeID int32 `json:"exemptCertDetailTaxCodeId,omitempty"`

	// tax code id
	// Example: 0
	TaxCodeID int32 `json:"taxCodeId,omitempty"`
}

EcmsDetailTaxCodeModel ecms detail tax code model Example: {"exemptCertDetailId":1235,"exemptCertDetailTaxCodeId":4316,"taxCodeId":0}

swagger:model EcmsDetailTaxCodeModel

func (*EcmsDetailTaxCodeModel) ContextValidate ¶ 

func (m *EcmsDetailTaxCodeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this ecms detail tax code model based on context it is used

func (*EcmsDetailTaxCodeModel) MarshalBinary ¶ 

func (m *EcmsDetailTaxCodeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EcmsDetailTaxCodeModel) UnmarshalBinary ¶ 

func (m *EcmsDetailTaxCodeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EcmsDetailTaxCodeModel) Validate ¶ 

func (m *EcmsDetailTaxCodeModel) Validate(formats strfmt.Registry) error

Validate validates this ecms detail tax code model

type EcmsModel ¶ 

type EcmsModel struct {

	// Address line 1
	// Max Length: 50
	// Min Length: 0
	Address1 *string `json:"address1,omitempty"`

	// Address line 2
	// Max Length: 50
	// Min Length: 0
	Address2 *string `json:"address2,omitempty"`

	// Address line 3
	// Max Length: 50
	// Min Length: 0
	Address3 *string `json:"address3,omitempty"`

	// If the certificate record was synced from an AvaTax Certs account(as opposed to being entered in ECMS directly),
	// the unique AvaTax Certs identifier for the certificate record. Usually same as the Id of a Certificate.
	// Max Length: 10
	// Min Length: 0
	AvaCertID *string `json:"avaCertId,omitempty"`

	// Business type the customer belongs to.
	// Example: 2
	// Required: true
	BusinessTypeID *int32 `json:"businessTypeId"`

	// Other description for this business type
	// Max Length: 255
	// Min Length: 0
	BusinessTypeOtherDescription *string `json:"businessTypeOtherDescription,omitempty"`

	// City
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Company ID
	// Example: 456
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// Name or ISO 3166 code identifying the country that issued this ECMS certificate.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Required: true
	CountryIssued *string `json:"countryIssued"`

	// Date when this exempt certificate was created
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// User that creates the certificate
	// Example: 0
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Customer code
	// Example: ABA
	// Required: true
	// Max Length: 50
	// Min Length: 0
	CustomerCode *string `json:"customerCode"`

	// Customer name
	// Max Length: 100
	// Min Length: 0
	CustomerName *string `json:"customerName,omitempty"`

	// Exempt Cert details
	Details []*EcmsDetailModel `json:"details"`

	// Document Reference Number, in the case of single-use exemption certificates, the DocumentCode or PurchaseOrderNo to which the certificate should apply.
	// Max Length: 50
	// Min Length: 0
	DocumentRefNo *string `json:"documentRefNo,omitempty"`

	// Effective date for this exempt certificate
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// The calc_id associated with a certificate in CertCapture.
	// Example: 123
	// Required: true
	ExemptCertID *int32 `json:"exemptCertId"`

	// Review status for this exempt certificate
	// Example: Pending
	// Enum: [Pending Accepted Rejected]
	ExemptCertReviewStatusID string `json:"exemptCertReviewStatusId,omitempty"`

	// Status for this exempt certificate
	// Example: Inactive
	// Required: true
	// Enum: [Inactive Active Expired Revoked]
	ExemptCertStatusID *string `json:"exemptCertStatusId"`

	// The type of exemption certificate. Permitted values are: Blanket and Single.
	// Example: Blanket
	// Required: true
	// Enum: [Blanket SingleUse]
	ExemptCertTypeID *string `json:"exemptCertTypeId"`

	// Exempt reason associated with the certificate, coded by CustomerUsageType.
	// Example: A - Federal Government.
	// Example: A
	// Max Length: 1
	// Min Length: 0
	ExemptReasonID *string `json:"exemptReasonId,omitempty"`

	// Other description for exempt reason i.e. Populated on if exemptReasonId is 'L' - Other.
	// Example: test
	// Max Length: 255
	// Min Length: 0
	ExemptReasonOtherDescription *string `json:"exemptReasonOtherDescription,omitempty"`

	// When this exempt certificate will expire
	// Format: date-time
	ExpiryDate strfmt.DateTime `json:"expiryDate,omitempty"`

	// Date when last transaction with this exempt certificate happened
	// Read Only: true
	// Format: date-time
	LastTransactionDate strfmt.DateTime `json:"lastTransactionDate,omitempty"`

	// Date when this exempt certificate was modified
	// Example: 0001-01-01T00:00:00
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// Who modified this exempt certificate
	// Example: 0
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// Postal code / zip code
	// Max Length: 10
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	// Required: true
	Region *string `json:"region"`

	// A list of applicable regions for this exempt certificate.
	//
	// To list more than one applicable region, separate the list of region codes with commas.
	// Example: CA
	// Required: true
	// Max Length: 200
	// Min Length: 0
	RegionsApplicable *string `json:"regionsApplicable"`
}

EcmsModel Exempt certificate Example: {"businessTypeId":2,"companyId":456,"country":"US","createdUserId":0,"customerCode":"ABA","exemptCertId":123,"exemptCertReviewStatusId":"Pending","exemptCertStatusId":"Active","exemptCertTypeId":"SingleUse","exemptReasonId":"A","exemptReasonOtherDescription":"test","modifiedDate":"0001-01-01T00:00:00","modifiedUserId":0,"region":"CA","regionsApplicable":"CA"}

swagger:model EcmsModel

func (*EcmsModel) ContextValidate ¶ 

func (m *EcmsModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this ecms model based on the context it is used

func (*EcmsModel) MarshalBinary ¶ 

func (m *EcmsModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EcmsModel) UnmarshalBinary ¶ 

func (m *EcmsModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EcmsModel) Validate ¶ 

func (m *EcmsModel) Validate(formats strfmt.Registry) error

Validate validates this ecms model

type EcmsModelFetchResult ¶ 

type EcmsModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*EcmsModel `json:"value"`
}

EcmsModelFetchResult ecms model fetch result

swagger:model EcmsModelFetchResult

func (*EcmsModelFetchResult) ContextValidate ¶ 

func (m *EcmsModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this ecms model fetch result based on the context it is used

func (*EcmsModelFetchResult) MarshalBinary ¶ 

func (m *EcmsModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EcmsModelFetchResult) UnmarshalBinary ¶ 

func (m *EcmsModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EcmsModelFetchResult) Validate ¶ 

func (m *EcmsModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this ecms model fetch result

type EntityUseCodeModel ¶ 

type EntityUseCodeModel struct {

	// The Avalara-recognized entity use code for this definition
	// Example: A
	Code string `json:"code,omitempty"`

	// Text describing the meaning of this use code
	Description string `json:"description,omitempty"`

	// The name of this entity use code
	// Example: FEDERAL GOV
	Name string `json:"name,omitempty"`

	// A list of countries where this use code is valid
	// Example: ["US"]
	ValidCountries []string `json:"validCountries"`
}

EntityUseCodeModel Represents a code describing the intended use for a product that may affect its taxability Example: {"code":"A","description":"","name":"FEDERAL GOV","validCountries":["US"]}

swagger:model EntityUseCodeModel

func (*EntityUseCodeModel) ContextValidate ¶ 

func (m *EntityUseCodeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this entity use code model based on context it is used

func (*EntityUseCodeModel) MarshalBinary ¶ 

func (m *EntityUseCodeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EntityUseCodeModel) UnmarshalBinary ¶ 

func (m *EntityUseCodeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EntityUseCodeModel) Validate ¶ 

func (m *EntityUseCodeModel) Validate(formats strfmt.Registry) error

Validate validates this entity use code model

type EntityUseCodeModelFetchResult ¶ 

type EntityUseCodeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*EntityUseCodeModel `json:"value"`
}

EntityUseCodeModelFetchResult entity use code model fetch result

swagger:model EntityUseCodeModelFetchResult

func (*EntityUseCodeModelFetchResult) ContextValidate ¶ 

func (m *EntityUseCodeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this entity use code model fetch result based on the context it is used

func (*EntityUseCodeModelFetchResult) MarshalBinary ¶ 

func (m *EntityUseCodeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EntityUseCodeModelFetchResult) UnmarshalBinary ¶ 

func (m *EntityUseCodeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EntityUseCodeModelFetchResult) Validate ¶ 

func (m *EntityUseCodeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this entity use code model fetch result

type ErrorCodeOutputModel ¶ 

type ErrorCodeOutputModel struct {

	// Number of error code recorded
	// Example: 123
	Count int32 `json:"count,omitempty"`

	// Name of the error code
	// Example: GetTaxError
	ErrorCode string `json:"errorCode,omitempty"`
}

ErrorCodeOutputModel Model that has the matching count for an errorcode Example: {"count":123,"errorCode":"GetTaxError"}

swagger:model ErrorCodeOutputModel

func (*ErrorCodeOutputModel) ContextValidate ¶ 

func (m *ErrorCodeOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error code output model based on context it is used

func (*ErrorCodeOutputModel) MarshalBinary ¶ 

func (m *ErrorCodeOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorCodeOutputModel) UnmarshalBinary ¶ 

func (m *ErrorCodeOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorCodeOutputModel) Validate ¶ 

func (m *ErrorCodeOutputModel) Validate(formats strfmt.Registry) error

Validate validates this error code output model

type ErrorCodeOutputModelCappedFetchResult ¶ 

type ErrorCodeOutputModelCappedFetchResult struct {

	// at is recordset count capped
	AtIsRecordsetCountCapped bool `json:"@isRecordsetCountCapped,omitempty"`

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ErrorCodeOutputModel `json:"value"`
}

ErrorCodeOutputModelCappedFetchResult error code output model capped fetch result

swagger:model ErrorCodeOutputModelCappedFetchResult

func (*ErrorCodeOutputModelCappedFetchResult) ContextValidate ¶ 

func (m *ErrorCodeOutputModelCappedFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error code output model capped fetch result based on the context it is used

func (*ErrorCodeOutputModelCappedFetchResult) MarshalBinary ¶ 

func (m *ErrorCodeOutputModelCappedFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorCodeOutputModelCappedFetchResult) UnmarshalBinary ¶ 

func (m *ErrorCodeOutputModelCappedFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorCodeOutputModelCappedFetchResult) Validate ¶ 

func (m *ErrorCodeOutputModelCappedFetchResult) Validate(formats strfmt.Registry) error

Validate validates this error code output model capped fetch result

type ErrorDetail ¶ 

type ErrorDetail struct {

	// code
	// Example: ServerConfiguration
	// Enum: [ServerConfiguration AccountInvalidException CompanyInvalidException EntityNotFoundError ValueRequiredError RangeError RangeCompareError RangeSetError TaxpayerNumberRequired EntityLimitExceeded CommonPassword WeakPassword StringLengthError MaxStringLengthError EmailValidationError EmailMissingError InvalidQueryField InvalidQueryValue SyntaxError TooManyParametersError UnterminatedValueError DeleteUserSelfError OldPasswordInvalid CannotChangePassword ReadOnly DateFormatError NoDefaultCompany AccountTypeNotSupported InvalidAuthenticationType AuthenticationException AuthorizationException ValidationException InactiveUserError AuthenticationIncomplete BasicAuthIncorrect IdentityServerError BearerTokenInvalid ModelRequiredException AccountExpiredException BearerTokenNotSupported InvalidSecurityRole InvalidRegistrarAction RemoteServerError NoFilterCriteriaException OpenClauseException JsonFormatError InvalidDecimalValue PermissionRequired UnhandledException InactiveAccount LinkageNotAllowed LinkageStatusUpdateNotSupported ReportingCompanyMustHaveContactsError CompanyProfileNotSet CannotAssignUserToCompany MustAssignUserToCompany InvalidTaxTypeMapping ModelStateInvalid DateRangeError InvalidDateRangeError RuleMustHaveTaxCode RuleTypeRestricted AllJurisRuleLimits InvalidCompanyLocationSetting InvalidAdjustmentType DeleteInformation DisableAuthenticationForSamlBasedAccounts DisableResetPasswordForSamlBasedAccounts OutOfRange UnspecifiedTimeZone CannotCreateDeletedObjects CannotModifyDeletedObjects ReturnNameNotFound InvalidAddressTypeAndCategory DefaultCompanyLocation InvalidCountry InvalidCountryRegion BrazilValidationError BrazilExemptValidationError BrazilPisCofinsError JurisdictionNotFoundError MedicalExciseError RateDependsTaxabilityError InvalidRateTypeCode RateTypeNotSupported CannotUpdateNestedObjects UPCCodeInvalidChars UPCCodeInvalidLength IncorrectPathError InvalidJurisdictionType MustConfirmResetLicenseKey DuplicateCompanyCode TINFormatError DuplicateNexusError UnknownNexusError ParentNexusNotFound InvalidTaxCodeType CannotActivateCompany DuplicateEntityProperty ReportingEntityError InvalidReturnOperationError CannotDeleteCompany CountryOverridesNotAvailable JurisdictionOverrideMismatch DuplicateSystemTaxCode SSTOverridesNotAvailable NexusDateMismatch NexusParentDateMismatch BearerTokenParseUserIdError RetrieveUserError InvalidConfigurationSetting InvalidConfigurationValue InvalidEnumValue TaxCodeAssociatedTaxRule CannotSwitchAccountId RequestIncomplete AccountNotNew PasswordLengthInvalid InvalidPageKey InvalidEcmsOverrideCode AccountDoesNotExist InvalidTaxType IncorrectFieldValue LeadingOrTrailingException NotEnoughAddressesInfo ReportNotInitiated FailedToBuildReport ReportNotFinished FailedToDownloadReport MalformedFilterException ExpectedConjunctionError CriteriaNotSupportedError CompanyAccountAndParentAccountMismatch InvalidFileContentType RequestTooLarge EcmsDisabled UnknownConjunctionError NoLinesDiscounted FailedToDelete CircularCompanyHierarchies DuplicateEntry DuplicateFieldNameInOrderBy CannotAdjustDocumentType UserNoAccess InvalidEntry TransactionAlreadyCancelled QueryParameterOutOfRange BatchSalesAuditMustBeZippedError BatchZipMustContainOneFileError BatchInvalidFileTypeError BatchCannotSaveBatchFile BatchCannotGetBatchFile BatchCannotDeleteBatchFile BatchMustContainOneFile MissingBatchFileContent BatchCannotBeDeletedWhileProcessing InternalServerError PointOfSaleFileSize PointOfSaleSetup InvalidInputDate GetTaxError AddressConflictException DocumentCodeConflict MissingAddress InvalidParameterValue FetchLimit InvalidAddress AddressLocationNotFound MissingLine InvalidAddressTextCase DocumentNotCommitted InvalidDocumentTypesToFetch TimeoutRequested InvalidPostalCode InvalidSubscriptionDescription InvalidSubscriptionTypeId CannotChangeFilingStatus FEINFormatError ServerUnreachable SubscriptionRequired AccountExists InvitationOnly AccountNotWhitelisted FreeTrialNotAvailable AccountExistsDifferentEmail AvalaraIdentityApiError InvalidIPAddress OfferCodeAlreadyApplied AccountAlreadyExists LicenseKeyNameAlreadyExistsForAccount UserAlreadyExist UserNotFound UserManagementException RefundTypeAndPercentageMismatch InvalidDocumentTypeForRefund RefundTypeAndLineMismatch RefundLinesRequired InvalidRefundType RefundPercentageForTaxOnly LineNoOutOfRange RefundPercentageOutOfRange RefundPercentageMissing MustUseCreateTransaction MustAcceptTermsAndConditions FilingCalendarCannotBeDeleted InvalidEffectiveDate NonOutletForm OverlappingFilingCalendar FilingCalendarCannotBeEdited CannotModifyLockedTransaction LineAlreadyExists LineDoesNotExist LinesNotSpecified LineDetailsDoesNotExist CannotCreateTransactionWithDeletedDataSource ShipToRegionRequiredWithDataSource InvalidBusinessType CannotModifyExemptCert CertificatesError MissingRequiredFields CertificatesNotSetup ConflictingExposureZone MissingFieldToCreateExposureZone MissingExemptReason InvalidExemptReason InvalidExemptionOperation ConflictingFields InvalidPdfOrImageFile InvalidCoverLetterTitle AccountNotProvisioned InvalidRequestContentType ExemptionPaginationLimits ExemptionSortLimits CustomerCantBeBothShipToAndBillTo BillToCustomerExpected ShipToCustomerExpected EcmsSstCertsRequired TransactionNotCancelled TooManyTransactions OnlyTaxDateOverrideIsAllowed TransactionAlreadyExists DateMismatch InvalidDocumentStatusForVerify TotalAmountMismatch TotalTaxMismatch InvalidDocumentType MultiDocumentPartiallyLocked TransactionIsCommitted InvalidDocumentStatus CommsConfigClientIdMissing CommsConfigClientIdBadValue AccountInNewStatusException WorksheetException InvalidAccountOverride AccountOverrideNotAuthorized FieldNotQueryableError UsernameRequired InvalidAuditMessage FieldNotOrderableError CannotDeleteParentBeforeChildNexus NexusChildDateMismatch RemoteValidationError CannotModifySstNexus InvalidLocalNexusTypeId AdvancedRuleRequestRuleError AdvancedRuleResponseRuleError AdvancedRuleError TaxRuleRequiresNexus UPCCodeNotUnique TaxCodeAssociatedWithItemCodeNotFound DuplicateSystemForItem CannotDismissGlobalNotification CannotUpdateAccountTypeId TaxpayerNumberIsRequired RequestLimitExceeded ConcurrentRequestLimitExceeded InvalidDocumentTypeForInspect ServiceNotReady UpdateLocationRemittanceMismatchTypeAndCategory UpdateLocationRemittanceCheckExistingEffectiveDateError UpdateLocationRemittanceCheckExistingEndDateError ErrorCountLimitExceededError RateLimitExceededError TaxCodeAndTaxCodeIdMissing NexusAlreadyExists InvalidAddressTypeAndMarketPlaceOusideUsaFlag InvalidSettingSet InvalidSettingName InvalidSettingValue TooManyUserDefinedFields DuplicateUserDefinedFieldsFound InvalidNameForUserDefinedField UnsupportedFileFormat UnsupportedOutputFileType TaxProfileNotProvided InvalidTaxProfile CompanyTaxProfileEntryRequired ErrorReadingTaxProfileEntry TraceDataNotAvailable InvalidParameterUnitMeasurementType ParameterUnitRequired InvalidParameterValueDataType InvalidParameterAttributeType SubscriptionRequiredForParameter InvalidAccountType InvalidFirmSubscriptions GenericTaxCodeForItem CannotCertifyCompany NoVoidedDocuments InadequateCommittedDocuments DocumentCodeIsGuid CustomerVendorCodeIsGuid InadequateDocumentLineCount SameDocumentDescription NoExemptionNoOrCustomerUsageType InadequateUniqueAddresses ItemCodesAreAllSame TaxCodesAreAllSame LocationCodeNotUsed RepeatedLinesInDocument TaxDateOverrideAndNegativeLineAmount AllUSDCurrencyCodes NoVATBuyerId AllUSCountryCodes NoDocumentsToTest NoShippingCharge FailedToUpdateCompanyLocation CompanyLocationDateRangeOverlap FieldLengthError InputContainsBlacklistedCharacters CannotCreateNestedObjects UserSubjectIdNotUpdated BatchTransactionTypeError BatchTransactionLineLimitExceeded BatchCompanyIdAndCompanyCodeMismatch BatchCannotBeCancelledStatusError BatchCannotBeCancelledFormatError InvalidParameterDataType TagDoesNotExist ObjectDeleted AssociatedObjectsDeleted CannotDownloadReport InvalidUnitOfBasis NotApplicableUnitOfBasis InvalidRateTypeTaxTypeMapping InvalidTaxTypeGroup InvalidTaxSubType InvalidProductTypeId InvalidTaxRuleType InvalidHsCode NotApplicableTaxType InvalidTaxTypeCode]
	Code string `json:"code,omitempty"`

	// description
	// Example: Object successfully marked as deleted.
	Description string `json:"description,omitempty"`

	// fault code
	// Example: Client
	FaultCode string `json:"faultCode,omitempty"`

	// fault sub code
	FaultSubCode string `json:"faultSubCode,omitempty"`

	// help link
	// Example: http://developer.avalara.com/avatax/errors/DeleteInformation
	// Read Only: true
	HelpLink string `json:"helpLink,omitempty"`

	// message
	// Example: The entity was marked as deleted.
	Message string `json:"message,omitempty"`

	// number
	// Example: 142
	Number int32 `json:"number,omitempty"`

	// refers to
	RefersTo string `json:"refersTo,omitempty"`

	// severity
	// Example: Success
	// Enum: [Success Warning Error Exception]
	Severity string `json:"severity,omitempty"`
}

ErrorDetail error detail Example: {"code":"DeleteInformation","description":"Object successfully marked as deleted.","faultCode":"Client","helpLink":"http://developer.avalara.com/avatax/errors/DeleteInformation","message":"The entity was marked as deleted.","number":142,"severity":"Success"}

swagger:model ErrorDetail

func (*ErrorDetail) ContextValidate ¶ 

func (m *ErrorDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error detail based on the context it is used

func (*ErrorDetail) MarshalBinary ¶ 

func (m *ErrorDetail) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorDetail) UnmarshalBinary ¶ 

func (m *ErrorDetail) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorDetail) Validate ¶ 

func (m *ErrorDetail) Validate(formats strfmt.Registry) error

Validate validates this error detail

type ErrorTransactionModelBase ¶ 

type ErrorTransactionModelBase struct {

	// The internal reference code (used by the client application) of the error transaction
	// Example: 11193b53-a14a-4bfa-821a-563c41dadf1b
	// Required: true
	// Max Length: 50
	// Min Length: 0
	DocumentCode *string `json:"documentCode"`

	// Type of transaction of the error transaction
	// Example: SalesOrder
	// Required: true
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType *string `json:"documentType"`
}

ErrorTransactionModelBase Base model class for single error transaction delete request Example: {"documentCode":"11193b53-a14a-4bfa-821a-563c41dadf1b","documentType":"SalesOrder"}

swagger:model ErrorTransactionModelBase

func (*ErrorTransactionModelBase) ContextValidate ¶ 

func (m *ErrorTransactionModelBase) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error transaction model base based on context it is used

func (*ErrorTransactionModelBase) MarshalBinary ¶ 

func (m *ErrorTransactionModelBase) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorTransactionModelBase) UnmarshalBinary ¶ 

func (m *ErrorTransactionModelBase) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorTransactionModelBase) Validate ¶ 

func (m *ErrorTransactionModelBase) Validate(formats strfmt.Registry) error

Validate validates this error transaction model base

type ErrorTransactionOutputModel ¶ 

type ErrorTransactionOutputModel struct {

	// The amount of the transaction.
	// Example: 2.34
	Amount float64 `json:"amount,omitempty"`

	// The full JSON of the transaction creation request
	// Example: {\r\n  \"id\": 123456789,\r\n  \"code\": \"a0538d37-c476-4e4a-9c2e-a62d740583b8\",\r\n  \"companyId\": 12345,\r\n  \"date\": \"2019-08-29\",\r\n  \"status\": \"Committed\",\r\n  \"type\": \"SalesInvoice\",\r\n  \"currencyCode\": \"USD\",\r\n  \"entityUseCode\": \"\",\r\n  \"customerVendorCode\": \"ABC\",\r\n  \"customerCode\": \"ABC\",\r\n  \"exemptNo\": \"\",\r\n  \"reconciled\": true,\r\n  \"locationCode\": \"DEFAULT\",\r\n  \"salespersonCode\": \"DEF\",\r\n  \"taxOverrideType\": \"None\",\r\n  \"taxOverrideAmount\": 0,\r\n  \"taxOverrideReason\": \"\",\r\n  \"totalAmount\": 1000,\r\n  \"totalExempt\": 0,\r\n  \"totalDiscount\": 0,\r\n  \"totalTax\": 62.5,\r\n  \"totalTaxable\": 1000,\r\n  \"totalTaxCalculated\": 62.5,\r\n  \"adjustmentReason\": \"NotAdjusted\",\r\n  \"adjustmentDescription\": \"\",\r\n  \"locked\": false,\r\n  \"region\": \"CA\",\r\n  \"country\": \"US\",\r\n  \"version\": 0,\r\n  \"originAddressId\": 123456789,\r\n  \"destinationAddressId\": 123456789,\r\n  \"isSellerImporterOfRecord\": false,\r\n  \"description\": \"Yarn\",\r\n  \"taxDate\": \"2019-08-29T00:00:00-07:00\",\r\n  \"lines\": [\r\n    {\r\n      \"id\": 123456789,\r\n      \"transactionId\": 123456789,\r\n      \"lineNumber\": \"1\",\r\n      \"boundaryOverrideId\": 0,\r\n      \"entityUseCode\": \"\",\r\n      \"description\": \"Yarn\",\r\n      \"destinationAddressId\": 12345,\r\n      \"originAddressId\": 123456789,\r\n      \"discountAmount\": 100,\r\n      \"discountTypeId\": 0,\r\n      \"exemptAmount\": 0,\r\n      \"exemptCertId\": 0,\r\n      \"exemptNo\": \"\",\r\n      \"isItemTaxable\": true,\r\n      \"isSSTP\": false,\r\n      \"itemCode\": \"116292\",\r\n      \"lineAmount\": 1000,\r\n      \"quantity\": 1,\r\n      \"ref1\": \"Note: Deliver to Bob\",\r\n      \"reportingDate\": \"2019-08-29\",\r\n      \"revAccount\": \"\",\r\n      \"sourcing\": \"Destination\",\r\n      \"tax\": 62.5,\r\n      \"taxableAmount\": 1000,\r\n      \"taxCalculated\": 62.5,\r\n      \"taxCode\": \"PS081282\",\r\n      \"taxDate\": \"2019-08-29\",\r\n      \"taxEngine\": \"\",\r\n      \"taxOverrideType\": \"None\",\r\n      \"taxOverrideAmount\": 0,\r\n      \"taxOverrideReason\": \"\",\r\n      \"taxIncluded\": false,\r\n      \"details\": [\r\n        {\r\n          \"id\": 123456789,\r\n          \"transactionLineId\": 123456789,\r\n          \"transactionId\": 123456789,\r\n          \"addressId\": 12345,\r\n          \"country\": \"US\",\r\n          \"region\": \"CA\",\r\n          \"stateFIPS\": \"06\",\r\n          \"exemptAmount\": 0,\r\n          \"exemptReasonId\": 4,\r\n          \"inState\": false,\r\n          \"jurisCode\": \"06\",\r\n          \"jurisName\": \"CALIFORNIA\",\r\n          \"jurisdictionId\": 5000531,\r\n          \"signatureCode\": \"AGAM\",\r\n          \"stateAssignedNo\": \"\",\r\n          \"jurisType\": \"STA\",\r\n          \"nonTaxableAmount\": 0,\r\n          \"nonTaxableRuleId\": 0,\r\n          \"nonTaxableType\": \"BaseRule\",\r\n          \"rate\": 0.0625,\r\n          \"rateRuleId\": 1321915,\r\n          \"rateSourceId\": 3,\r\n          \"serCode\": \"\",\r\n          \"sourcing\": \"Destination\",\r\n          \"tax\": 62.5,\r\n          \"taxableAmount\": 1000,\r\n          \"taxType\": \"Sales\",\r\n          \"taxName\": \"CA STATE TAX\",\r\n          \"taxAuthorityTypeId\": 45,\r\n          \"taxRegionId\": 2127184,\r\n          \"taxCalculated\": 62.5,\r\n          \"taxOverride\": 0,\r\n          \"rateType\": \"General\"\r\n        }\r\n      ],\r\n      \"vatNumberTypeId\": 0\r\n    }\r\n  ],\r\n  \"addresses\": [\r\n    {\r\n      \"id\": 0,\r\n      \"transactionId\": 0,\r\n      \"boundaryLevel\": \"Address\",\r\n      \"line1\": \"100 Ravine Lane Northeast #220\",\r\n      \"city\": \"Bainbridge Island\",\r\n      \"region\": \"WA\",\r\n      \"postalCode\": \"98110\",\r\n      \"country\": \"US\",\r\n      \"taxRegionId\": 0\r\n    }\r\n  ],\r\n  \"taxDetailsByTaxType\": [\r\n    {\r\n      \"taxType\": \"SalesAndUse\",\r\n      \"totalTaxable\": 100,\r\n      \"totalExempt\": 0.05,\r\n      \"totalNonTaxable\": 0,\r\n      \"totalTax\": 0.625\r\n    }\r\n  ]\r\n}
	AvataxCreateTransactionJSON string `json:"avataxCreateTransactionJson,omitempty"`

	// The full JSON of the error result from transaction creation
	// Example: {\r\n  \"error\": {\r\n    \"code\": \"GetTaxError\",\r\n    \"message\": \"Invalid or missing state/province code (CQ).\",\r\n    \"target\": \"Unknown\",\r\n    \"details\": [\r\n      {\r\n        \"code\": \"GetTaxError\",\r\n        \"number\": 300,\r\n        \"message\": \"Invalid or missing state/province code (CQ).\",\r\n        \"description\": \"CQ is not a known state or province.\",\r\n        \"faultCode\": \"GetTaxError\",\r\n        \"helpLink\": \"http://developer.avalara.com/avatax/errors/GetTaxError\",\r\n        \"refersTo\": \"Addresses[0]\",\r\n        \"severity\": \"Error\"\r\n      }\r\n    ]\r\n  }\r\n}
	AvataxErrorJSON string `json:"avataxErrorJson,omitempty"`

	// The datasource instance that made the transaction creation call
	// Example: e5ac5e1f-e4e9-41eb-84af-8afb85fb7623
	Datasource string `json:"datasource,omitempty"`

	// The Datasource source of the transaction creation call.
	// Example: Extractor
	DatasourceSource string `json:"datasourceSource,omitempty"`

	// The internal reference code (used by the client application) of the error transaction
	// Example: c28bdf16-d5b7-4290-95c3-e352355ef7f1
	// Required: true
	// Max Length: 50
	// Min Length: 0
	DocumentCode *string `json:"documentCode"`

	// The date of the document
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	DocumentDate strfmt.DateTime `json:"documentDate,omitempty"`

	// Type of transaction of the error transaction
	// Example: SalesOrder
	// Required: true
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType *string `json:"documentType"`

	// Error code of the error result from transaction creation
	// Example: GetTaxError
	ErrorCode string `json:"errorCode,omitempty"`

	// Error message of the error result from transaction creation
	// Example: Invalid or missing state/province code (CQ).
	ErrorMessage string `json:"errorMessage,omitempty"`

	// The date that this ErrorTransaction will be automatically purged from the detabase.
	// Example: 2023-02-25T00:00:00+00:00
	// Format: date-time
	ExpiresAt strfmt.DateTime `json:"expiresAt,omitempty"`

	// The country of the ship to address for the transaction creation call.
	// Example: US
	ShipToCountry string `json:"shipToCountry,omitempty"`

	// The region of the ship to address for the transaction creation call.
	// Example: WA
	ShipToRegion string `json:"shipToRegion,omitempty"`
}

ErrorTransactionOutputModel Error Transaction Model Example: {"amount":2.34,"avataxCreateTransactionJson":"{\r\n \"id\": 123456789,\r\n \"code\": \"a0538d37-c476-4e4a-9c2e-a62d740583b8\",\r\n \"companyId\": 12345,\r\n \"date\": \"2019-08-29\",\r\n \"status\": \"Committed\",\r\n \"type\": \"SalesInvoice\",\r\n \"currencyCode\": \"USD\",\r\n \"entityUseCode\": \"\",\r\n \"customerVendorCode\": \"ABC\",\r\n \"customerCode\": \"ABC\",\r\n \"exemptNo\": \"\",\r\n \"reconciled\": true,\r\n \"locationCode\": \"DEFAULT\",\r\n \"salespersonCode\": \"DEF\",\r\n \"taxOverrideType\": \"None\",\r\n \"taxOverrideAmount\": 0,\r\n \"taxOverrideReason\": \"\",\r\n \"totalAmount\": 1000,\r\n \"totalExempt\": 0,\r\n \"totalDiscount\": 0,\r\n \"totalTax\": 62.5,\r\n \"totalTaxable\": 1000,\r\n \"totalTaxCalculated\": 62.5,\r\n \"adjustmentReason\": \"NotAdjusted\",\r\n \"adjustmentDescription\": \"\",\r\n \"locked\": false,\r\n \"region\": \"CA\",\r\n \"country\": \"US\",\r\n \"version\": 0,\r\n \"originAddressId\": 123456789,\r\n \"destinationAddressId\": 123456789,\r\n \"isSellerImporterOfRecord\": false,\r\n \"description\": \"Yarn\",\r\n \"taxDate\": \"2019-08-29T00:00:00-07:00\",\r\n \"lines\": [\r\n {\r\n \"id\": 123456789,\r\n \"transactionId\": 123456789,\r\n \"lineNumber\": \"1\",\r\n \"boundaryOverrideId\": 0,\r\n \"entityUseCode\": \"\",\r\n \"description\": \"Yarn\",\r\n \"destinationAddressId\": 12345,\r\n \"originAddressId\": 123456789,\r\n \"discountAmount\": 100,\r\n \"discountTypeId\": 0,\r\n \"exemptAmount\": 0,\r\n \"exemptCertId\": 0,\r\n \"exemptNo\": \"\",\r\n \"isItemTaxable\": true,\r\n \"isSSTP\": false,\r\n \"itemCode\": \"116292\",\r\n \"lineAmount\": 1000,\r\n \"quantity\": 1,\r\n \"ref1\": \"Note: Deliver to Bob\",\r\n \"reportingDate\": \"2019-08-29\",\r\n \"revAccount\": \"\",\r\n \"sourcing\": \"Destination\",\r\n \"tax\": 62.5,\r\n \"taxableAmount\": 1000,\r\n \"taxCalculated\": 62.5,\r\n \"taxCode\": \"PS081282\",\r\n \"taxDate\": \"2019-08-29\",\r\n \"taxEngine\": \"\",\r\n \"taxOverrideType\": \"None\",\r\n \"taxOverrideAmount\": 0,\r\n \"taxOverrideReason\": \"\",\r\n \"taxIncluded\": false,\r\n \"details\": [\r\n {\r\n \"id\": 123456789,\r\n \"transactionLineId\": 123456789,\r\n \"transactionId\": 123456789,\r\n \"addressId\": 12345,\r\n \"country\": \"US\",\r\n \"region\": \"CA\",\r\n \"stateFIPS\": \"06\",\r\n \"exemptAmount\": 0,\r\n \"exemptReasonId\": 4,\r\n \"inState\": false,\r\n \"jurisCode\": \"06\",\r\n \"jurisName\": \"CALIFORNIA\",\r\n \"jurisdictionId\": 5000531,\r\n \"signatureCode\": \"AGAM\",\r\n \"stateAssignedNo\": \"\",\r\n \"jurisType\": \"STA\",\r\n \"nonTaxableAmount\": 0,\r\n \"nonTaxableRuleId\": 0,\r\n \"nonTaxableType\": \"BaseRule\",\r\n \"rate\": 0.0625,\r\n \"rateRuleId\": 1321915,\r\n \"rateSourceId\": 3,\r\n \"serCode\": \"\",\r\n \"sourcing\": \"Destination\",\r\n \"tax\": 62.5,\r\n \"taxableAmount\": 1000,\r\n \"taxType\": \"Sales\",\r\n \"taxName\": \"CA STATE TAX\",\r\n \"taxAuthorityTypeId\": 45,\r\n \"taxRegionId\": 2127184,\r\n \"taxCalculated\": 62.5,\r\n \"taxOverride\": 0,\r\n \"rateType\": \"General\"\r\n }\r\n ],\r\n \"vatNumberTypeId\": 0\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"id\": 0,\r\n \"transactionId\": 0,\r\n \"boundaryLevel\": \"Address\",\r\n \"line1\": \"100 Ravine Lane Northeast #220\",\r\n \"city\": \"Bainbridge Island\",\r\n \"region\": \"WA\",\r\n \"postalCode\": \"98110\",\r\n \"country\": \"US\",\r\n \"taxRegionId\": 0\r\n }\r\n ],\r\n \"taxDetailsByTaxType\": [\r\n {\r\n \"taxType\": \"SalesAndUse\",\r\n \"totalTaxable\": 100,\r\n \"totalExempt\": 0.05,\r\n \"totalNonTaxable\": 0,\r\n \"totalTax\": 0.625\r\n }\r\n ]\r\n}","avataxErrorJson":"{\r\n \"error\": {\r\n \"code\": \"GetTaxError\",\r\n \"message\": \"Invalid or missing state/province code (CQ).\",\r\n \"target\": \"Unknown\",\r\n \"details\": [\r\n {\r\n \"code\": \"GetTaxError\",\r\n \"number\": 300,\r\n \"message\": \"Invalid or missing state/province code (CQ).\",\r\n \"description\": \"CQ is not a known state or province.\",\r\n \"faultCode\": \"GetTaxError\",\r\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/GetTaxError\",\r\n \"refersTo\": \"Addresses[0]\",\r\n \"severity\": \"Error\"\r\n }\r\n ]\r\n }\r\n}","datasource":"e5ac5e1f-e4e9-41eb-84af-8afb85fb7623","datasourceSource":"Extractor","documentCode":"c28bdf16-d5b7-4290-95c3-e352355ef7f1","documentDate":"2021-12-25T00:00:00+00:00","documentType":"SalesOrder","errorCode":"GetTaxError","errorMessage":"Invalid or missing state/province code (CQ).","expiresAt":"2023-02-25T00:00:00+00:00","shipToCountry":"US","shipToRegion":"WA"}

swagger:model ErrorTransactionOutputModel

func (*ErrorTransactionOutputModel) ContextValidate ¶ 

func (m *ErrorTransactionOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error transaction output model based on context it is used

func (*ErrorTransactionOutputModel) MarshalBinary ¶ 

func (m *ErrorTransactionOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorTransactionOutputModel) UnmarshalBinary ¶ 

func (m *ErrorTransactionOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorTransactionOutputModel) Validate ¶ 

func (m *ErrorTransactionOutputModel) Validate(formats strfmt.Registry) error

Validate validates this error transaction output model

type ErrorTransactionOutputModelCappedFetchResult ¶ 

type ErrorTransactionOutputModelCappedFetchResult struct {

	// at is recordset count capped
	AtIsRecordsetCountCapped bool `json:"@isRecordsetCountCapped,omitempty"`

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ErrorTransactionOutputModel `json:"value"`
}

ErrorTransactionOutputModelCappedFetchResult error transaction output model capped fetch result

swagger:model ErrorTransactionOutputModelCappedFetchResult

func (*ErrorTransactionOutputModelCappedFetchResult) ContextValidate ¶ 

func (m *ErrorTransactionOutputModelCappedFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error transaction output model capped fetch result based on the context it is used

func (*ErrorTransactionOutputModelCappedFetchResult) MarshalBinary ¶ 

func (m *ErrorTransactionOutputModelCappedFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorTransactionOutputModelCappedFetchResult) UnmarshalBinary ¶ 

func (m *ErrorTransactionOutputModelCappedFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorTransactionOutputModelCappedFetchResult) Validate ¶ 

func (m *ErrorTransactionOutputModelCappedFetchResult) Validate(formats strfmt.Registry) error

Validate validates this error transaction output model capped fetch result

type ExemptionReasonModel ¶ 

type ExemptionReasonModel struct {

	// A unique ID number representing this exemption reason.
	ID int32 `json:"id,omitempty"`

	// A friendly name describing this exemption reason.
	// Example: EXPOSURE
	Name string `json:"name,omitempty"`
}

ExemptionReasonModel An exemption reason defines why a certificate allows a customer to be exempt for purposes of tax calculation. For a full list of defined exemption reasons, please call the `ListCertificateExemptionReasons` API. Example: {"name":"EXPOSURE"}

swagger:model ExemptionReasonModel

func (*ExemptionReasonModel) ContextValidate ¶ 

func (m *ExemptionReasonModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this exemption reason model based on context it is used

func (*ExemptionReasonModel) MarshalBinary ¶ 

func (m *ExemptionReasonModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExemptionReasonModel) UnmarshalBinary ¶ 

func (m *ExemptionReasonModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExemptionReasonModel) Validate ¶ 

func (m *ExemptionReasonModel) Validate(formats strfmt.Registry) error

Validate validates this exemption reason model

type ExemptionReasonModelFetchResult ¶ 

type ExemptionReasonModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ExemptionReasonModel `json:"value"`
}

ExemptionReasonModelFetchResult exemption reason model fetch result

swagger:model ExemptionReasonModelFetchResult

func (*ExemptionReasonModelFetchResult) ContextValidate ¶ 

func (m *ExemptionReasonModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this exemption reason model fetch result based on the context it is used

func (*ExemptionReasonModelFetchResult) MarshalBinary ¶ 

func (m *ExemptionReasonModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExemptionReasonModelFetchResult) UnmarshalBinary ¶ 

func (m *ExemptionReasonModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExemptionReasonModelFetchResult) Validate ¶ 

func (m *ExemptionReasonModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this exemption reason model fetch result

type ExemptionStatusModel ¶ 

type ExemptionStatusModel struct {

	// Certificate if the customer is exempted
	// Example: {"businessNumberType":"Business Services","createdDate":"2021-12-25T17:08:39.0918001Z","customers":[{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"f2ae7d6c-c260-44c3-95a7-e4fae8c931a5","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"},{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"f3f5e266-4052-484b-9d9e-cd7b896c2fbe","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"}],"documentExists":false,"exemptPercentage":0,"exemptionNumber":"Exempt-1234","exemptionReason":{"name":"RESALE"},"expirationDate":"2020-12-31","exposureZone":{"name":"Washington"},"filename":"fddee8bd-59d0-4604-824d-10f813dd536c","id":0,"isSingleCertificate":false,"modifiedDate":"2021-12-25","pageCount":0,"signedDate":"2016-02-01","taxNumberType":"FEIN","valid":true,"verified":false}
	Certificate *CertificateModel `json:"certificate,omitempty"`

	// The exemption status of this customer in this country/region.
	// Example: Exempt
	Status string `json:"status,omitempty"`
}

ExemptionStatusModel Indicates the customer's exemption status in a specific country and region. Example: {"certificate":{"businessNumberType":"Business Services","createdDate":"2021-12-25T17:08:39.0918001Z","customers":[{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"f2ae7d6c-c260-44c3-95a7-e4fae8c931a5","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"},{"alternateId":"987654321","attnName":"Attn: Receiving","city":"Irvine","companyId":0,"contactName":"Alice Smith","country":"US","customerCode":"f3f5e266-4052-484b-9d9e-cd7b896c2fbe","emailAddress":"dr.bob.example@example.org","exposureZones":[{"name":"Washington"}],"faxNumber":"949.555.1213","lastTransaction":"2008-10-08T00:00:00","line1":"645 Main Street","name":"Dr. Bob Example","phoneNumber":"(949) 555-1212","postalCode":"92614","region":"CA"}],"documentExists":false,"exemptPercentage":0,"exemptionNumber":"Exempt-1234","exemptionReason":{"name":"RESALE"},"expirationDate":"2020-12-31","exposureZone":{"name":"Washington"},"filename":"fddee8bd-59d0-4604-824d-10f813dd536c","id":0,"isSingleCertificate":false,"modifiedDate":"2021-12-25","pageCount":0,"signedDate":"2016-02-01","taxNumberType":"FEIN","valid":true,"verified":false},"status":"Exempt"}

swagger:model ExemptionStatusModel

func (*ExemptionStatusModel) ContextValidate ¶ 

func (m *ExemptionStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this exemption status model based on the context it is used

func (*ExemptionStatusModel) MarshalBinary ¶ 

func (m *ExemptionStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExemptionStatusModel) UnmarshalBinary ¶ 

func (m *ExemptionStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExemptionStatusModel) Validate ¶ 

func (m *ExemptionStatusModel) Validate(formats strfmt.Registry) error

Validate validates this exemption status model

type ExportDocumentLineModel ¶ 

type ExportDocumentLineModel struct {

	// The transactions in the country you wish to run a report.
	// Use "ALL" for all countries
	// Use "ALL Non-US" for all international countries
	// Or use a single 2-char ISO country code
	// Example: US
	Country string `json:"country,omitempty"`

	// The currency your report is displayed in.
	// Accepts "USD" or leave this blank to get all the documents with all the currencies
	// Example: USD
	CurrencyCode string `json:"currencyCode,omitempty"`

	// The code your business application uses to identify a customer or vendor
	CustomerVendorCode string `json:"customerVendorCode,omitempty"`

	// The type of date to filter your transactions
	// Example: DocumentDate
	// Enum: [DocumentDate ModifiedDate PaymentDate ReportingDate TaxDate]
	DateFilter string `json:"dateFilter,omitempty"`

	// The transaction type you want to run a report on
	// Example: ConsumerUse
	// Enum: [ConsumerUse Sales]
	DocType string `json:"docType,omitempty"`

	// DocumentStatus
	// For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
	// Example: Temporary
	// Enum: [Temporary Saved Posted Committed Cancelled Adjusted Queued PendingApproval Any]
	DocumentStatus string `json:"documentStatus,omitempty"`

	// The end date filter for report execution. If no date provided, today's date will be used as the endDate.
	// Accepts date in short format yyyy-mm-dd as well as date time stamp
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// The file format.
	// Example: CSV
	// Enum: [CSV]
	Format string `json:"format,omitempty"`

	// If true, include only documents that are locked.
	// If false, include only documents that are not locked.
	// Defaults to false if not specified.
	// Example: true
	IsLocked bool `json:"isLocked,omitempty"`

	// Use this parameter when dateFilter = ModifiedDate.
	// For dateFilter = DocumentDate, PaymentDate, TaxDate or ReportingDate, the isModifiedDateSameAsDocumentDate parameter is ignored.
	// Set this parameter to true when you would like to get Documents which have the Document Date same as Modified Date.
	// Defaults to false if not specified.
	// Example: false
	IsModifiedDateSameAsDocumentDate bool `json:"isModifiedDateSameAsDocumentDate,omitempty"`

	// If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.
	// Example: abc,xyz
	MerchantSellerIdentifier string `json:"merchantSellerIdentifier,omitempty"`

	// Number of partitions (2 - 250) to split the report into.
	// If a value is provided for this property, a value must also be provided for the partition property.
	// Example: 10
	NumberOfPartitions int32 `json:"numberOfPartitions,omitempty"`

	// The zero-based partition number to retrieve in this export request.
	// If a value is provided for this property, a value must also be provided for the numberOfPartitions property.
	// Example: 0
	Partition int32 `json:"partition,omitempty"`

	// The start date filter for report execution. If no date provided, same date of last month will be used as the startDate.
	// Accepts date in short format yyyy-mm-dd as well as date time stamp
	// Example: 2021-11-25T00:00:00+00:00
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

	// The state associated with the transactions you wish to run a report.
	// Use "ALL" for all states or 2-char state code.
	// Example: All
	State string `json:"state,omitempty"`

	// The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
	// Example: 123
	TaxCode string `json:"taxCode,omitempty"`

	// TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output).
	// TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
	// Example: Alcohol
	TaxGroup string `json:"taxGroup,omitempty"`

	// The description of the tax
	// Example: VAT
	TaxName string `json:"taxName,omitempty"`

	// Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
	// Example: Prepared Food and Beverage
	TaxSubType string `json:"taxSubType,omitempty"`
}

ExportDocumentLineModel An input model for executing a report detailed to the document line level Example: {"country":"US","currencyCode":"USD","dateFilter":"DocumentDate","docType":"Sales","documentStatus":"Committed","endDate":"2021-12-25T00:00:00+00:00","format":"CSV","isLocked":true,"isModifiedDateSameAsDocumentDate":false,"merchantSellerIdentifier":"abc,xyz","numberOfPartitions":10,"partition":0,"startDate":"2021-11-25T00:00:00+00:00","state":"All","taxCode":"123","taxGroup":"Alcohol","taxName":"VAT","taxSubType":"Prepared Food and Beverage"}

swagger:model ExportDocumentLineModel

func (*ExportDocumentLineModel) ContextValidate ¶ 

func (m *ExportDocumentLineModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this export document line model based on context it is used

func (*ExportDocumentLineModel) MarshalBinary ¶ 

func (m *ExportDocumentLineModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExportDocumentLineModel) UnmarshalBinary ¶ 

func (m *ExportDocumentLineModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExportDocumentLineModel) Validate ¶ 

func (m *ExportDocumentLineModel) Validate(formats strfmt.Registry) error

Validate validates this export document line model

type ExposureZoneModel ¶ 

type ExposureZoneModel struct {

	// The unique ID number of the AvaTax company that recorded this customer.
	CompanyID int32 `json:"companyId,omitempty"`

	// Two character ISO 3166 county code for the country component of this exposure zone.
	// Read Only: true
	Country string `json:"country,omitempty"`

	// The date when this record was created.
	// Format: date-time
	Created strfmt.DateTime `json:"created,omitempty"`

	// A more complete description of this exposure zone, suitable for use as a tooltip or help text.
	Description string `json:"description,omitempty"`

	// A unique ID number representing this exposure zone.
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Format: date-time
	Modified strfmt.DateTime `json:"modified,omitempty"`

	// The short name of this exposure zone, suitable for use in a drop-down list.
	// Example: Washington
	Name string `json:"name,omitempty"`

	// Two or three character ISO 3166 region, province, or state name of this exposure zone.
	// Read Only: true
	Region string `json:"region,omitempty"`

	// A tag indicating
	Tag string `json:"tag,omitempty"`
}

ExposureZoneModel Information about a physical area or zone in which a certificate can apply. An exposure zone for an exemption certificate will generally be a tax authority such as a state, country, or local government entity. Example: {"name":"Washington"}

swagger:model ExposureZoneModel

func (*ExposureZoneModel) ContextValidate ¶ 

func (m *ExposureZoneModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this exposure zone model based on the context it is used

func (*ExposureZoneModel) MarshalBinary ¶ 

func (m *ExposureZoneModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExposureZoneModel) UnmarshalBinary ¶ 

func (m *ExposureZoneModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExposureZoneModel) Validate ¶ 

func (m *ExposureZoneModel) Validate(formats strfmt.Registry) error

Validate validates this exposure zone model

type ExposureZoneModelFetchResult ¶ 

type ExposureZoneModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ExposureZoneModel `json:"value"`
}

ExposureZoneModelFetchResult exposure zone model fetch result

swagger:model ExposureZoneModelFetchResult

func (*ExposureZoneModelFetchResult) ContextValidate ¶ 

func (m *ExposureZoneModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this exposure zone model fetch result based on the context it is used

func (*ExposureZoneModelFetchResult) MarshalBinary ¶ 

func (m *ExposureZoneModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExposureZoneModelFetchResult) UnmarshalBinary ¶ 

func (m *ExposureZoneModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExposureZoneModelFetchResult) Validate ¶ 

func (m *ExposureZoneModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this exposure zone model fetch result

type FiledReturnModel ¶ 

type FiledReturnModel struct {

	// The unique ID number of the company filing return.
	// Example: 12345
	CompanyID int64 `json:"companyId,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: 1
	EndPeriodMonth int32 `json:"endPeriodMonth,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: 2017
	EndPeriodYear int16 `json:"endPeriodYear,omitempty"`

	// The unique code of the form.
	// Example: USAZTPT2
	TaxformCode string `json:"taxformCode,omitempty"`
}

FiledReturnModel Filing Returns Model Example: {"companyId":12345,"endPeriodMonth":1,"endPeriodYear":2017,"taxformCode":"USAZTPT2"}

swagger:model FiledReturnModel

func (*FiledReturnModel) ContextValidate ¶ 

func (m *FiledReturnModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filed return model based on context it is used

func (*FiledReturnModel) MarshalBinary ¶ 

func (m *FiledReturnModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FiledReturnModel) UnmarshalBinary ¶ 

func (m *FiledReturnModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FiledReturnModel) Validate ¶ 

func (m *FiledReturnModel) Validate(formats strfmt.Registry) error

Validate validates this filed return model

type FiledReturnModelFetchResult ¶ 

type FiledReturnModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FiledReturnModel `json:"value"`
}

FiledReturnModelFetchResult filed return model fetch result

swagger:model FiledReturnModelFetchResult

func (*FiledReturnModelFetchResult) ContextValidate ¶ 

func (m *FiledReturnModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filed return model fetch result based on the context it is used

func (*FiledReturnModelFetchResult) MarshalBinary ¶ 

func (m *FiledReturnModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FiledReturnModelFetchResult) UnmarshalBinary ¶ 

func (m *FiledReturnModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FiledReturnModelFetchResult) Validate ¶ 

func (m *FiledReturnModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this filed return model fetch result

type FilingAdjustmentModel ¶ 

type FilingAdjustmentModel struct {

	// The account type of the adjustment.
	// Example: None
	// Required: true
	// Enum: [None AccountsReceivableAccountsPayable AccountsReceivable AccountsPayable]
	AccountType *string `json:"accountType"`

	// The adjustment amount.
	// Example: 100
	// Required: true
	Amount *float64 `json:"amount"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The filing return id that this applies too
	// Read Only: true
	FilingID int64 `json:"filingId,omitempty"`

	// The unique ID number for the adjustment.
	// Example: 15634
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// Whether or not the adjustment has been calculated.
	// Example: false
	IsCalculated bool `json:"isCalculated,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The filing period the adjustment is applied to.
	// Example: None
	// Required: true
	// Enum: [None CurrentPeriod NextPeriod]
	Period *string `json:"period"`

	// A descriptive reason for creating this adjustment.
	Reason string `json:"reason,omitempty"`

	// The type of the adjustment.
	// Example: Discount
	// Required: true
	Type *string `json:"type"`
}

FilingAdjustmentModel A model for return adjustments. Example: {"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}

swagger:model FilingAdjustmentModel

func (*FilingAdjustmentModel) ContextValidate ¶ 

func (m *FilingAdjustmentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing adjustment model based on the context it is used

func (*FilingAdjustmentModel) MarshalBinary ¶ 

func (m *FilingAdjustmentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingAdjustmentModel) UnmarshalBinary ¶ 

func (m *FilingAdjustmentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingAdjustmentModel) Validate ¶ 

func (m *FilingAdjustmentModel) Validate(formats strfmt.Registry) error

Validate validates this filing adjustment model

type FilingAnswerModel ¶ 

type FilingAnswerModel struct {

	// The value of the answer for the filing question identified by filingQuestionId
	// Example: Answer to question 1
	Answer interface{} `json:"answer,omitempty"`

	// The ID number for a filing question
	// Example: 1
	// Required: true
	FilingQuestionID *int64 `json:"filingQuestionId"`
}

FilingAnswerModel filing answer model Example: {"answer":"Answer to question 1","filingQuestionId":1}

swagger:model FilingAnswerModel

func (*FilingAnswerModel) ContextValidate ¶ 

func (m *FilingAnswerModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filing answer model based on context it is used

func (*FilingAnswerModel) MarshalBinary ¶ 

func (m *FilingAnswerModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingAnswerModel) UnmarshalBinary ¶ 

func (m *FilingAnswerModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingAnswerModel) Validate ¶ 

func (m *FilingAnswerModel) Validate(formats strfmt.Registry) error

Validate validates this filing answer model

type FilingAttachmentModel ¶ 

type FilingAttachmentModel struct {

	// The description of the attachment
	// Example: Form XYZ Confirmation
	Description string `json:"description,omitempty"`

	// The resourceFileId used to retrieve the attachment
	// Example: 71
	ResourceFileID int32 `json:"resourceFileId,omitempty"`
}

FilingAttachmentModel An attachment associated with a filing return Example: {"description":"Form XYZ Confirmation","resourceFileId":71}

swagger:model FilingAttachmentModel

func (*FilingAttachmentModel) ContextValidate ¶ 

func (m *FilingAttachmentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filing attachment model based on context it is used

func (*FilingAttachmentModel) MarshalBinary ¶ 

func (m *FilingAttachmentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingAttachmentModel) UnmarshalBinary ¶ 

func (m *FilingAttachmentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingAttachmentModel) Validate ¶ 

func (m *FilingAttachmentModel) Validate(formats strfmt.Registry) error

Validate validates this filing attachment model

type FilingAugmentationModel ¶ 

type FilingAugmentationModel struct {

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The field amount.
	// Example: 10
	// Required: true
	FieldAmount *float64 `json:"fieldAmount"`

	// The field name.
	// Example: Credit from the State
	// Required: true
	FieldName *string `json:"fieldName"`

	// The filing return id that this applies too
	// Read Only: true
	FilingID int64 `json:"filingId,omitempty"`

	// The unique ID number for the augmentation.
	// Example: 103230
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`
}

FilingAugmentationModel A model for return augmentations. Example: {"fieldAmount":10,"fieldName":"Credit from the State","id":103230}

swagger:model FilingAugmentationModel

func (*FilingAugmentationModel) ContextValidate ¶ 

func (m *FilingAugmentationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing augmentation model based on the context it is used

func (*FilingAugmentationModel) MarshalBinary ¶ 

func (m *FilingAugmentationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingAugmentationModel) UnmarshalBinary ¶ 

func (m *FilingAugmentationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingAugmentationModel) Validate ¶ 

func (m *FilingAugmentationModel) Validate(formats strfmt.Registry) error

Validate validates this filing augmentation model

type FilingCalendarEditModel ¶ 

type FilingCalendarEditModel struct {

	// The name of the field to be modified.
	// Example: Ein
	// Required: true
	FieldName *string `json:"fieldName"`

	// The new/proposed value of the field.
	// Example: 002094005
	// Required: true
	NewValue interface{} `json:"newValue"`

	// The current value of the field.
	// Example: 002094004
	// Required: true
	OldValue interface{} `json:"oldValue"`

	// The unique ID of the filing calendar question. "Filing calendar question" is the wording displayed to users for a given field.
	// Example: 36
	// Required: true
	QuestionID *int32 `json:"questionId"`
}

FilingCalendarEditModel An edit to be made on a filing calendar. Example: {"fieldName":"Ein","newValue":"002094005","oldValue":"002094004","questionId":36}

swagger:model FilingCalendarEditModel

func (*FilingCalendarEditModel) ContextValidate ¶ 

func (m *FilingCalendarEditModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filing calendar edit model based on context it is used

func (*FilingCalendarEditModel) MarshalBinary ¶ 

func (m *FilingCalendarEditModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingCalendarEditModel) UnmarshalBinary ¶ 

func (m *FilingCalendarEditModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingCalendarEditModel) Validate ¶ 

func (m *FilingCalendarEditModel) Validate(formats strfmt.Registry) error

Validate validates this filing calendar edit model

type FilingCalendarModel ¶ 

type FilingCalendarModel struct {

	// Custom filing information field for Alabama.
	// Max Length: 25
	// Min Length: 0
	AlAccessCode *string `json:"alAccessCode,omitempty"`

	// Custom filing information field for Alabama.
	// Max Length: 25
	// Min Length: 0
	AlSignOn *string `json:"alSignOn,omitempty"`

	// User name of bulk account.
	// Read Only: true
	BulkAccountID string `json:"bulkAccountId,omitempty"`

	// The status of the bulk account's validation.
	// Example: New
	// Read Only: true
	// Enum: [New Added Failed]
	BulkAccountValidationStatus string `json:"bulkAccountValidationStatus,omitempty"`

	// DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
	// The city name of the mailing address that will be used when filling out this tax return.
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// The unique ID number of the company to which this filing calendar belongs.
	// Example: 12345
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
	// The two character ISO-3166 country code of the mailing address that will be used when filling out this tax return.
	// Example: US
	// Max Length: 2
	// Min Length: 0
	Country *string `json:"country,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Custom filing information field for Connecticut.
	// Max Length: 50
	// Min Length: 0
	CtReg *string `json:"ctReg,omitempty"`

	// DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
	// Special filing instructions to be used when filing this return.
	// Please note that requesting special filing instructions may incur additional costs.
	// Max Length: 1000
	// Min Length: 0
	CustomerFilingInstructions *string `json:"customerFilingInstructions,omitempty"`

	// If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
	// Max Length: 40
	// Min Length: 0
	EFilePassword *string `json:"eFilePassword,omitempty"`

	// If you file electronically, this is the username you use to log in to the tax authority's website.
	// Max Length: 254
	// Min Length: 0
	EFileUsername *string `json:"eFileUsername,omitempty"`

	// The earliest date for the tax period when this return should be filed.
	// This date specifies the earliest date for tax transactions that should be reported on this filing calendar.
	// Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February.
	// Example: 2015-01-01T00:00:00
	// Required: true
	// Format: date
	EffectiveDate *strfmt.Date `json:"effectiveDate"`

	// The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
	// Example: 12-3456789
	// Max Length: 50
	// Min Length: 0
	EmployerIdentificationNumber *string `json:"employerIdentificationNumber,omitempty"`

	// The last date for the tax period when this return should be filed.
	// This date specifies the last date for tax transactions that should be reported on this filing calendar.
	// Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The frequency on which this tax form is filed.
	// Example: Monthly
	// Required: true
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequencyID *string `json:"filingFrequencyId"`

	// The method to be used when filing this return.
	// Example: PaperReturn
	// Enum: [PaperReturn ElectronicReturn SER EFTPaper PhonePaper SignatureReady EfileCheck]
	FilingTypeID string `json:"filingTypeId,omitempty"`

	// The start period of a fiscal year for this form/company
	FiscalYearStartMonth int32 `json:"fiscalYearStartMonth,omitempty"`

	// If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.
	FixedPrepaymentAmount float64 `json:"fixedPrepaymentAmount,omitempty"`

	// Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	FormCountry string `json:"formCountry,omitempty"`

	// Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	FormRegion string `json:"formRegion,omitempty"`

	// Custom filing information field for Iowa.
	// Max Length: 50
	// Min Length: 0
	IaBen *string `json:"iaBen,omitempty"`

	// The unique ID number of this filing calendar.
	// Example: 56789
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
	// Internal filing notes.
	// Max Length: 1000
	// Min Length: 0
	InternalNotes *string `json:"internalNotes,omitempty"`

	// The legal entity name to be used when filing this return.
	// Example: Bob's Artisan Pottery
	// Max Length: 75
	// Min Length: 0
	LegalEntityName *string `json:"legalEntityName,omitempty"`

	// DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
	// The first line of the mailing address that will be used when filling out this tax return.
	// Example: 2000 Main Street
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
	// The second line of the mailing address that will be used when filling out this tax return.
	// Please note that some tax forms do not support multiple address lines.
	// Max Length: 50
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Tax Registration ID for the local jurisdiction, if any.
	// Max Length: 50
	// Min Length: 0
	LocalRegistrationID *string `json:"localRegistrationId,omitempty"`

	// If this calendar is for a location-specific tax return, specify the location code here.  To file for all locations, leave this value NULL.
	// Max Length: 50
	// Min Length: 0
	LocationCode *string `json:"locationCode,omitempty"`

	// The city name of the mailing address that will be used when filling out this tax return.
	// Max Length: 50
	// Min Length: 0
	MailingAddressCity *string `json:"mailingAddressCity,omitempty"`

	// Name or ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	MailingAddressCountry string `json:"mailingAddressCountry,omitempty"`

	// The first line of the mailing address that will be used when filling out this tax return.
	// Max Length: 50
	// Min Length: 0
	MailingAddressLine1 *string `json:"mailingAddressLine1,omitempty"`

	// The second line of the mailing address that will be used when filling out this tax return.
	// Please note that some tax forms do not support multiple address lines.
	// Max Length: 50
	// Min Length: 0
	MailingAddressLine2 *string `json:"mailingAddressLine2,omitempty"`

	// The postal code or zip code of the mailing address that will be used when filling out this tax return.
	// Max Length: 25
	// Min Length: 0
	MailingAddressPostalCode *string `json:"mailingAddressPostalCode,omitempty"`

	// Name or ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	MailingAddressRegion string `json:"mailingAddressRegion,omitempty"`

	// Custom filing information field for Maine.
	// Max Length: 50
	// Min Length: 0
	MeBusinessCode *string `json:"meBusinessCode,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// A 16-bit bitmap containing a 1 for each month when the return should be filed.
	// Example: 2340
	Months int16 `json:"months,omitempty"`

	// Custom filing information field.  Leave blank.
	// Max Length: 50
	// Min Length: 0
	Other1Name *string `json:"other1Name,omitempty"`

	// Custom filing information field.  Leave blank.
	// Max Length: 50
	// Min Length: 0
	Other1Value *string `json:"other1Value,omitempty"`

	// Custom filing information field.  Leave blank.
	// Max Length: 50
	// Min Length: 0
	Other2Name *string `json:"other2Name,omitempty"`

	// Custom filing information field.  Leave blank.
	// Max Length: 50
	// Min Length: 0
	Other2Value *string `json:"other2Value,omitempty"`

	// Custom filing information field.  Leave blank.
	// Max Length: 50
	// Min Length: 0
	Other3Name *string `json:"other3Name,omitempty"`

	// Custom filing information field.  Leave blank.
	// Max Length: 50
	// Min Length: 0
	Other3Value *string `json:"other3Value,omitempty"`

	// DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release.
	// If this calendar is for a location-specific tax return, specify the location-specific behavior here.
	// Example: None
	// Enum: [None Schedule Duplicate Consolidated]
	OutletTypeID string `json:"outletTypeId,omitempty"`

	// Specify the ISO 4217 currency code for the currency to remit for this tax return.  For all tax returns in the United States, specify "USD".
	// Max Length: 3
	// Min Length: 0
	PaymentCurrency *string `json:"paymentCurrency,omitempty"`

	// The phone number to be used when filing this return.
	// Example: 714 555-1212
	// Max Length: 50
	// Min Length: 0
	Phone *string `json:"phone,omitempty"`

	// DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
	// The postal code or zip code of the mailing address that will be used when filling out this tax return.
	// Example: 92614
	// Max Length: 25
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Determines if a prepayment is required for this filing calendar
	// Example: false
	PrePaymentRequired bool `json:"prePaymentRequired,omitempty"`

	// If you are required to prepay a percentage of taxes for future periods, please specify the percentage in whole numbers;
	// for example, the value 90 would indicate 90%.
	// Example: 90
	PrepayPercentage int32 `json:"prepayPercentage,omitempty"`

	// DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release.
	// The state, region, or province of the mailing address that will be used when filling out this tax return.
	// Example: CA
	// Max Length: 3
	// Min Length: 0
	Region *string `json:"region,omitempty"`

	// DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
	// The legacy return name of the tax form to file.
	// Example: CABOE401A2
	// Max Length: 50
	// Min Length: 0
	ReturnName *string `json:"returnName,omitempty"`

	// CompanyReturn settings for complext filing calendar
	// Example: [{"companyReturnId":123,"filingQuestionCode":"EfileUsername","filingQuestionId":26,"id":0,"value":"bobExample"}]
	Settings []*CompanyReturnSettingModel `json:"settings"`

	// The bulk account site code.
	// Read Only: true
	SiteCode string `json:"siteCode,omitempty"`

	// Tax Registration ID for this Region - in the U.S., this is for your state.
	// Example: 101-123456
	// Max Length: 50
	// Min Length: 0
	StateRegistrationID *string `json:"stateRegistrationId,omitempty"`

	// The unique ID of the tax authority of this return.
	// Read Only: true
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The name of the tax authority of this return.
	// Read Only: true
	TaxAuthorityName string `json:"taxAuthorityName,omitempty"`

	// The type description of the tax authority of this return.
	// Read Only: true
	TaxAuthorityType string `json:"taxAuthorityType,omitempty"`

	// The Avalara standard tax form code of the tax form for this filing calendar.  The first two characters of the tax form code
	// are the ISO 3166 country code of the country that issued this form.
	TaxFormCode string `json:"taxFormCode,omitempty"`

	// DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward.
	// The type of tax to report on this return.
	// Example: E
	// Required: true
	// Enum: [E Lodging Bottle RentToOwn BikeTax LandedCost CheckoutBag Alcohol Amusement Hospitality RentalLeasing GrossReceipts Mattress Lumber Paint Tires EI All BothSalesAndUseTax ConsumerUseTax ConsumersUseAndSellersUseTax ConsumerUseAndSalesTax Fee VATInputTax LightBulbs Meals VATNonrecoverableInputTax VATOutputTax PIF Rental SalesTax UseTax EWaste Batteries]
	TaxTypeID *string `json:"taxTypeId"`

	// The list of tax types to report on this return.
	TaxTypes []string `json:"taxTypes"`
}

FilingCalendarModel Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns. Example: {"city":"Irvine","companyId":12345,"country":"US","effectiveDate":"2015-01-01","employerIdentificationNumber":"12-3456789","filingFrequencyId":"Quarterly","filingTypeId":"ElectronicReturn","id":56789,"legalEntityName":"Bob's Artisan Pottery","line1":"2000 Main Street","months":2340,"outletTypeId":"None","phone":"714 555-1212","postalCode":"92614","prePaymentRequired":false,"prepayPercentage":90,"region":"CA","returnName":"CABOE401A2","settings":[{"companyReturnId":123,"filingQuestionCode":"EfileUsername","filingQuestionId":26,"id":0,"value":"bobExample"}],"stateRegistrationId":"101-123456","taxTypeId":"All"}

swagger:model FilingCalendarModel

func (*FilingCalendarModel) ContextValidate ¶ 

func (m *FilingCalendarModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing calendar model based on the context it is used

func (*FilingCalendarModel) MarshalBinary ¶ 

func (m *FilingCalendarModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingCalendarModel) UnmarshalBinary ¶ 

func (m *FilingCalendarModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingCalendarModel) Validate ¶ 

func (m *FilingCalendarModel) Validate(formats strfmt.Registry) error

Validate validates this filing calendar model

type FilingCalendarModelFetchResult ¶ 

type FilingCalendarModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FilingCalendarModel `json:"value"`
}

FilingCalendarModelFetchResult filing calendar model fetch result

swagger:model FilingCalendarModelFetchResult

func (*FilingCalendarModelFetchResult) ContextValidate ¶ 

func (m *FilingCalendarModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing calendar model fetch result based on the context it is used

func (*FilingCalendarModelFetchResult) MarshalBinary ¶ 

func (m *FilingCalendarModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingCalendarModelFetchResult) UnmarshalBinary ¶ 

func (m *FilingCalendarModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingCalendarModelFetchResult) Validate ¶ 

func (m *FilingCalendarModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this filing calendar model fetch result

type FilingFrequencyModel ¶ 

type FilingFrequencyModel struct {

	// The description name of this filing frequency
	// Example: Monthly
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this filing frequency.
	// Example: 1
	// Required: true
	ID *int32 `json:"id"`
}

FilingFrequencyModel FilingFrequency Model Example: {"description":"Monthly","id":1}

swagger:model FilingFrequencyModel

func (*FilingFrequencyModel) ContextValidate ¶ 

func (m *FilingFrequencyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filing frequency model based on context it is used

func (*FilingFrequencyModel) MarshalBinary ¶ 

func (m *FilingFrequencyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingFrequencyModel) UnmarshalBinary ¶ 

func (m *FilingFrequencyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingFrequencyModel) Validate ¶ 

func (m *FilingFrequencyModel) Validate(formats strfmt.Registry) error

Validate validates this filing frequency model

type FilingFrequencyModelFetchResult ¶ 

type FilingFrequencyModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FilingFrequencyModel `json:"value"`
}

FilingFrequencyModelFetchResult filing frequency model fetch result

swagger:model FilingFrequencyModelFetchResult

func (*FilingFrequencyModelFetchResult) ContextValidate ¶ 

func (m *FilingFrequencyModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing frequency model fetch result based on the context it is used

func (*FilingFrequencyModelFetchResult) MarshalBinary ¶ 

func (m *FilingFrequencyModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingFrequencyModelFetchResult) UnmarshalBinary ¶ 

func (m *FilingFrequencyModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingFrequencyModelFetchResult) Validate ¶ 

func (m *FilingFrequencyModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this filing frequency model fetch result

type FilingModel ¶ 

type FilingModel struct {

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

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A listing of regional tax filings within this time period.
	// Example: [{"collectAmount":1.1,"consumerUseNonTaxableAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxableAmount":0,"country":"US","endDate":"2016-10-31T00:00:00","filingId":0,"hasNexus":true,"id":2892824,"nonTaxableAmount":55.99,"region":"AZ","returns":[{"accrualType":0,"adjustments":[{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}],"augmentations":[{"fieldAmount":10,"fieldName":"Credit from the State","id":103230}],"carryOverConsumerUseTaxAmount":0,"carryOverNonTaxableAmount":0,"carryOverSalesAmount":0,"carryOverTaxAmount":0,"collectAmount":1,"consumerUseNonTaxableAccrualAmount":0,"consumerUseNonTaxableAmount":0,"consumerUseTaxAccrualAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxDueAmount":0,"consumerUseTaxableAccrualAmount":0,"consumerUseTaxableAmount":0,"description":"Sales Tax Return","excludedNonTaxableAmount":0,"excludedSalesAmount":0,"excludedTaxAmount":0,"filingCalendarId":513256,"filingFrequency":"Monthly","filingRegionId":0,"filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"nonTaxableAccrualAmount":0,"nonTaxableAmount":0,"nonTaxableDueAmount":0,"remitAmount":0,"salesAccrualAmount":0,"salesAmount":0,"salesTaxAccrualAmount":0,"sellersUseTaxAccrualAmount":0,"status":"PendingApproval","taxAccrualAmount":0,"taxAmount":0,"taxDueAmount":0,"taxableAccrualAmount":0,"taxableAmount":0,"totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}],"salesAmount":80.48,"startDate":"2016-10-01T00:00:00","status":"PendingApproval","taxAmount":2.2,"taxDueAmount":0,"taxableAmount":24.49,"totalRemittanceAmount":0}]
	FilingRegions []*FilingRegionModel `json:"filingRegions"`

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

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,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"`

	// 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"`
}

FilingModel Represents a listing of all tax calculation data for filings and for accruing to future filings. Example: {"companyId":62593,"filingRegions":[{"collectAmount":1.1,"consumerUseNonTaxableAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxableAmount":0,"country":"US","endDate":"2016-10-31T00:00:00","filingId":0,"hasNexus":true,"id":2892824,"nonTaxableAmount":55.99,"region":"AZ","returns":[{"accrualType":0,"adjustments":[{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}],"augmentations":[{"fieldAmount":10,"fieldName":"Credit from the State","id":103230}],"carryOverConsumerUseTaxAmount":0,"carryOverNonTaxableAmount":0,"carryOverSalesAmount":0,"carryOverTaxAmount":0,"collectAmount":1,"consumerUseNonTaxableAccrualAmount":0,"consumerUseNonTaxableAmount":0,"consumerUseTaxAccrualAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxDueAmount":0,"consumerUseTaxableAccrualAmount":0,"consumerUseTaxableAmount":0,"description":"Sales Tax Return","excludedNonTaxableAmount":0,"excludedSalesAmount":0,"excludedTaxAmount":0,"filingCalendarId":513256,"filingFrequency":"Monthly","filingRegionId":0,"filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"nonTaxableAccrualAmount":0,"nonTaxableAmount":0,"nonTaxableDueAmount":0,"remitAmount":0,"salesAccrualAmount":0,"salesAmount":0,"salesTaxAccrualAmount":0,"sellersUseTaxAccrualAmount":0,"status":"PendingApproval","taxAccrualAmount":0,"taxAmount":0,"taxDueAmount":0,"taxableAccrualAmount":0,"taxableAmount":0,"totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}],"salesAmount":80.48,"startDate":"2016-10-01T00:00:00","status":"PendingApproval","taxAmount":2.2,"taxDueAmount":0,"taxableAmount":24.49,"totalRemittanceAmount":0}],"id":326529,"month":10,"type":"Original","year":2016}

swagger:model FilingModel

func (*FilingModel) ContextValidate ¶ 

func (m *FilingModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing model based on the context it is used

func (*FilingModel) MarshalBinary ¶ 

func (m *FilingModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingModel) UnmarshalBinary ¶ 

func (m *FilingModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingModel) Validate ¶ 

func (m *FilingModel) Validate(formats strfmt.Registry) error

Validate validates this filing model

type FilingModelFetchResult ¶ 

type FilingModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FilingModel `json:"value"`
}

FilingModelFetchResult filing model fetch result

swagger:model FilingModelFetchResult

func (*FilingModelFetchResult) ContextValidate ¶ 

func (m *FilingModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing model fetch result based on the context it is used

func (*FilingModelFetchResult) MarshalBinary ¶ 

func (m *FilingModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingModelFetchResult) UnmarshalBinary ¶ 

func (m *FilingModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingModelFetchResult) Validate ¶ 

func (m *FilingModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this filing model fetch result

type FilingPaymentModel ¶ 

type FilingPaymentModel struct {

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The filing return id that this applies too
	// Example: 1234
	// Required: true
	FilingID *int64 `json:"filingId"`

	// The unique ID number for the payment.
	// Example: 15634
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// Whether or not the payment has been calculated.
	// Example: false
	IsCalculated bool `json:"isCalculated,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The payment amount.
	// Example: 100
	// Required: true
	PaymentAmount *float64 `json:"paymentAmount"`

	// The type of the payment.
	// Example: CurrentPeriod
	// Required: true
	// Enum: [CurrentPeriod Prepayment PriorPayment PriorCspFee]
	Type *string `json:"type"`
}

FilingPaymentModel A model for return payments. Example: {"filingId":1234,"id":15634,"isCalculated":false,"paymentAmount":100,"type":"CurrentPeriod"}

swagger:model FilingPaymentModel

func (*FilingPaymentModel) ContextValidate ¶ 

func (m *FilingPaymentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing payment model based on the context it is used

func (*FilingPaymentModel) MarshalBinary ¶ 

func (m *FilingPaymentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingPaymentModel) UnmarshalBinary ¶ 

func (m *FilingPaymentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingPaymentModel) Validate ¶ 

func (m *FilingPaymentModel) Validate(formats strfmt.Registry) error

Validate validates this filing payment model

type FilingRegionModel ¶ 

type FilingRegionModel struct {

	// The date the filing region was approved.
	// Format: date-time
	ApproveDate strfmt.DateTime `json:"approveDate,omitempty"`

	// The amount collected by Avalara for this region
	// Example: 1.1
	CollectAmount float64 `json:"collectAmount,omitempty"`

	// Consumer use non-taxable amount.
	// Example: 0
	ConsumerUseNonTaxableAmount float64 `json:"consumerUseNonTaxableAmount,omitempty"`

	// Consumer use tax liability.
	// Example: 0
	ConsumerUseTaxAmount float64 `json:"consumerUseTaxAmount,omitempty"`

	// Consumer use taxable amount.
	// Example: 0
	ConsumerUseTaxableAmount float64 `json:"consumerUseTaxableAmount,omitempty"`

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

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The end date for the filing cycle.
	// Example: 2016-10-31T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// The filing id that this region belongs too
	// Example: 0
	FilingID int64 `json:"filingId,omitempty"`

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

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

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The non-taxable amount.
	// Example: 55.99
	NonTaxableAmount float64 `json:"nonTaxableAmount,omitempty"`

	// The two or three character region code for the region.
	// Example: AZ
	Region string `json:"region,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"}],"augmentations":[{"fieldAmount":10,"fieldName":"Credit from the State","id":103230}],"carryOverConsumerUseTaxAmount":0,"carryOverNonTaxableAmount":0,"carryOverSalesAmount":0,"carryOverTaxAmount":0,"collectAmount":1,"consumerUseNonTaxableAccrualAmount":0,"consumerUseNonTaxableAmount":0,"consumerUseTaxAccrualAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxDueAmount":0,"consumerUseTaxableAccrualAmount":0,"consumerUseTaxableAmount":0,"description":"Sales Tax Return","excludedNonTaxableAmount":0,"excludedSalesAmount":0,"excludedTaxAmount":0,"filingCalendarId":513256,"filingFrequency":"Monthly","filingRegionId":0,"filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"nonTaxableAccrualAmount":0,"nonTaxableAmount":0,"nonTaxableDueAmount":0,"remitAmount":0,"salesAccrualAmount":0,"salesAmount":0,"salesTaxAccrualAmount":0,"sellersUseTaxAccrualAmount":0,"status":"PendingApproval","taxAccrualAmount":0,"taxAmount":0,"taxDueAmount":0,"taxableAccrualAmount":0,"taxableAmount":0,"totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}]
	Returns []*FilingReturnModel `json:"returns"`

	// The sales amount.
	// Example: 80.48
	SalesAmount float64 `json:"salesAmount,omitempty"`

	// The start date for the filing cycle.
	// Example: 2016-10-01T00:00:00
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

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

	// The tax amount.
	// Example: 2.2
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// The tax amount due.
	// Example: 0
	TaxDueAmount float64 `json:"taxDueAmount,omitempty"`

	// The taxable amount.
	// Example: 24.49
	TaxableAmount float64 `json:"taxableAmount,omitempty"`

	// Total remittance amount of all returns in region
	// Example: 0
	TotalRemittanceAmount float64 `json:"totalRemittanceAmount,omitempty"`
}

FilingRegionModel Regions Example: {"collectAmount":1.1,"consumerUseNonTaxableAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxableAmount":0,"country":"US","endDate":"2016-10-31T00:00:00","filingId":0,"hasNexus":true,"id":2892824,"nonTaxableAmount":55.99,"region":"AZ","returns":[{"accrualType":0,"adjustments":[{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}],"augmentations":[{"fieldAmount":10,"fieldName":"Credit from the State","id":103230}],"carryOverConsumerUseTaxAmount":0,"carryOverNonTaxableAmount":0,"carryOverSalesAmount":0,"carryOverTaxAmount":0,"collectAmount":1,"consumerUseNonTaxableAccrualAmount":0,"consumerUseNonTaxableAmount":0,"consumerUseTaxAccrualAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxDueAmount":0,"consumerUseTaxableAccrualAmount":0,"consumerUseTaxableAmount":0,"description":"Sales Tax Return","excludedNonTaxableAmount":0,"excludedSalesAmount":0,"excludedTaxAmount":0,"filingCalendarId":513256,"filingFrequency":"Monthly","filingRegionId":0,"filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"nonTaxableAccrualAmount":0,"nonTaxableAmount":0,"nonTaxableDueAmount":0,"remitAmount":0,"salesAccrualAmount":0,"salesAmount":0,"salesTaxAccrualAmount":0,"sellersUseTaxAccrualAmount":0,"status":"PendingApproval","taxAccrualAmount":0,"taxAmount":0,"taxDueAmount":0,"taxableAccrualAmount":0,"taxableAmount":0,"totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}],"salesAmount":80.48,"startDate":"2016-10-01T00:00:00","status":"PendingApproval","taxAmount":2.2,"taxDueAmount":0,"taxableAmount":24.49,"totalRemittanceAmount":0}

swagger:model FilingRegionModel

func (*FilingRegionModel) ContextValidate ¶ 

func (m *FilingRegionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing region model based on the context it is used

func (*FilingRegionModel) MarshalBinary ¶ 

func (m *FilingRegionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingRegionModel) UnmarshalBinary ¶ 

func (m *FilingRegionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingRegionModel) Validate ¶ 

func (m *FilingRegionModel) Validate(formats strfmt.Registry) error

Validate validates this filing region model

type FilingRequestDataModel ¶ 

type FilingRequestDataModel struct {

	// Filing question answers
	// Example: [{"answer":"Answer to question 1","filingQuestionId":1},{"answer":"Answer to question 2","filingQuestionId":2}]
	Answers []*FilingAnswerModel `json:"answers"`

	// The company return ID if requesting an update.
	// Example: 1
	CompanyReturnID int64 `json:"companyReturnId,omitempty"`

	// The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// Filing cycle effective date of the request
	// Example: 2017-01-01T00:00:00
	// Required: true
	// Format: date
	EffDate *strfmt.Date `json:"effDate"`

	// Filing cycle end date of the request
	// Example: 2020-01-01T00:00:00
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The filing frequency of the request
	// Example: Monthly
	// Required: true
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequencyID *string `json:"filingFrequencyId"`

	// The start period of a fiscal year for this form/company
	FiscalYearStartMonth int32 `json:"fiscalYearStartMonth,omitempty"`

	// Flag if the request is a clone of a current filing calendar
	// Example: false
	IsClone bool `json:"isClone,omitempty"`

	// Location code of the request
	// Example: LOC-1
	LocationCode string `json:"locationCode,omitempty"`

	// The months of the request
	// Example: 2
	// Required: true
	Months *int16 `json:"months"`

	// The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.
	// Example: WI
	// Read Only: true
	Region string `json:"region,omitempty"`

	// State registration ID of the company requesting the filing calendar.
	// Example: 1234
	RegistrationID string `json:"registrationId,omitempty"`

	// DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
	// The legacy return name of the requested calendar.
	// Example: WIST12CT
	ReturnName string `json:"returnName,omitempty"`

	// The tax authority id of the return
	// Example: 121
	// Read Only: true
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The tax authority name on the return
	// Example: WISCONSIN
	// Read Only: true
	TaxAuthorityName string `json:"taxAuthorityName,omitempty"`

	// The Avalara standard tax form code of the tax form for this filing calendar.  The first two characters of the tax form code
	// are the ISO 3166 country code of the country that issued this form.
	// Example: US00194
	TaxFormCode string `json:"taxFormCode,omitempty"`

	// The type of tax to report on this return.
	// Example: E
	// Enum: [E Lodging Bottle RentToOwn BikeTax LandedCost CheckoutBag Alcohol Amusement Hospitality RentalLeasing GrossReceipts Mattress Lumber Paint Tires EI All BothSalesAndUseTax ConsumerUseTax ConsumersUseAndSellersUseTax ConsumerUseAndSalesTax Fee VATInputTax LightBulbs Meals VATNonrecoverableInputTax VATOutputTax PIF Rental SalesTax UseTax EWaste Batteries]
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

FilingRequestDataModel Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns. Example: {"answers":[{"answer":"Answer to question 1","filingQuestionId":1},{"answer":"Answer to question 2","filingQuestionId":2}],"companyReturnId":1,"country":"US","effDate":"2017-01-01","endDate":"2020-01-01","filingFrequencyId":"Monthly","isClone":false,"locationCode":"LOC-1","months":2,"region":"WI","registrationId":"1234","returnName":"WIST12CT","taxAuthorityId":121,"taxAuthorityName":"WISCONSIN","taxFormCode":"US00194","taxTypeId":"SalesTax"}

swagger:model FilingRequestDataModel

func (*FilingRequestDataModel) ContextValidate ¶ 

func (m *FilingRequestDataModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing request data model based on the context it is used

func (*FilingRequestDataModel) MarshalBinary ¶ 

func (m *FilingRequestDataModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingRequestDataModel) UnmarshalBinary ¶ 

func (m *FilingRequestDataModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingRequestDataModel) Validate ¶ 

func (m *FilingRequestDataModel) Validate(formats strfmt.Registry) error

Validate validates this filing request data model

type FilingRequestModel ¶ 

type FilingRequestModel struct {

	// The unique ID number of the company to which this filing request belongs.
	// Example: 12345
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The data model object of the request
	// Example: {"answers":[{"answer":"Answer to question 1","filingQuestionId":1},{"answer":"Answer to question 2","filingQuestionId":2}],"companyReturnId":1,"effDate":"2017-01-01","endDate":"2017-01-01","filingFrequencyId":"Monthly","isClone":false,"locationCode":"LOC-1","months":2,"region":"WI","registrationId":"1234","returnName":"WIST12CT","taxAuthorityId":121,"taxAuthorityName":"WISCONSIN","taxTypeId":"SalesTax"}
	// Required: true
	Data *FilingRequestDataModel `json:"data"`

	// The current status of this request
	// Example: New
	// Read Only: true
	// Enum: [New Validated Pending Active PendingStop Inactive ChangeRequest RequestApproved RequestDenied]
	FilingRequestStatusID string `json:"filingRequestStatusId,omitempty"`

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

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`
}

FilingRequestModel Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns. Example: {"companyId":12345,"data":{"answers":[{"answer":"Answer to question 1","filingQuestionId":1},{"answer":"Answer to question 2","filingQuestionId":2}],"companyReturnId":1,"effDate":"2017-01-01","endDate":"2017-01-01","filingFrequencyId":"Monthly","isClone":false,"locationCode":"LOC-1","months":2,"region":"WI","registrationId":"1234","returnName":"WIST12CT","taxAuthorityId":121,"taxAuthorityName":"WISCONSIN","taxTypeId":"SalesTax"},"filingRequestStatusId":"New","id":12345}

swagger:model FilingRequestModel

func (*FilingRequestModel) ContextValidate ¶ 

func (m *FilingRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing request model based on the context it is used

func (*FilingRequestModel) MarshalBinary ¶ 

func (m *FilingRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingRequestModel) UnmarshalBinary ¶ 

func (m *FilingRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingRequestModel) Validate ¶ 

func (m *FilingRequestModel) Validate(formats strfmt.Registry) error

Validate validates this filing request model

type FilingRequestModelFetchResult ¶ 

type FilingRequestModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FilingRequestModel `json:"value"`
}

FilingRequestModelFetchResult filing request model fetch result

swagger:model FilingRequestModelFetchResult

func (*FilingRequestModelFetchResult) ContextValidate ¶ 

func (m *FilingRequestModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing request model fetch result based on the context it is used

func (*FilingRequestModelFetchResult) MarshalBinary ¶ 

func (m *FilingRequestModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingRequestModelFetchResult) UnmarshalBinary ¶ 

func (m *FilingRequestModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingRequestModelFetchResult) Validate ¶ 

func (m *FilingRequestModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this filing request model fetch result

type FilingReturnCreditModel ¶ 

type FilingReturnCreditModel struct {

	// The resourceFileId used to retrieve the attachment
	// Example: 0
	TotalExempt float64 `json:"totalExempt,omitempty"`

	// The resourceFileId used to retrieve the attachment
	// Example: 0
	TotalSales float64 `json:"totalSales,omitempty"`

	// The resourceFileId used to retrieve the attachment
	// Example: 0
	TotalTax float64 `json:"totalTax,omitempty"`

	// The resourceFileId used to retrieve the attachment
	// Example: 0
	TotalTaxable float64 `json:"totalTaxable,omitempty"`

	// The excluded carry over credit documents
	TransactionDetails []*WorksheetDocument `json:"transactionDetails"`
}

FilingReturnCreditModel An attachment associated with a filing return Example: {"totalExempt":0,"totalSales":0,"totalTax":0,"totalTaxable":0}

swagger:model FilingReturnCreditModel

func (*FilingReturnCreditModel) ContextValidate ¶ 

func (m *FilingReturnCreditModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing return credit model based on the context it is used

func (*FilingReturnCreditModel) MarshalBinary ¶ 

func (m *FilingReturnCreditModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingReturnCreditModel) UnmarshalBinary ¶ 

func (m *FilingReturnCreditModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingReturnCreditModel) Validate ¶ 

func (m *FilingReturnCreditModel) Validate(formats strfmt.Registry) error

Validate validates this filing return credit model

type FilingReturnModel ¶ 

type FilingReturnModel struct {

	// Accrual type of the return
	// Example: Filing
	// Enum: [Filing Accrual]
	AccrualType string `json:"accrualType,omitempty"`

	// The Adjustments for this return.
	// Example: [{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}]
	Adjustments []*FilingAdjustmentModel `json:"adjustments"`

	// The applied carry over credit documents
	// Example: {"totalExempt":0,"totalSales":0,"totalTax":0,"totalTaxable":0}
	AppliedCarryOverCredits *FilingReturnCreditModel `json:"appliedCarryOverCredits,omitempty"`

	// The attachments for this return.
	Attachments []*FilingAttachmentModel `json:"attachments"`

	// The Augmentations for this return.
	// Example: [{"fieldAmount":10,"fieldName":"Credit from the State","id":103230}]
	Augmentations []*FilingAugmentationModel `json:"augmentations"`

	// The amount of carry over consumer use tax applied to the liability calculation
	// Example: 0
	CarryOverConsumerUseTaxAmount float64 `json:"carryOverConsumerUseTaxAmount,omitempty"`

	// The amount of carry over non taxable sales applied to the liability calculation
	// Example: 0
	CarryOverNonTaxableAmount float64 `json:"carryOverNonTaxableAmount,omitempty"`

	// The amount of carry over sales applied to the liability calculation
	// Example: 0
	CarryOverSalesAmount float64 `json:"carryOverSalesAmount,omitempty"`

	// The amount of carry over sales tax applied to the liability calculation
	// Example: 0
	CarryOverTaxAmount float64 `json:"carryOverTaxAmount,omitempty"`

	// The amount collected by avalara for this return
	// Example: 1
	CollectAmount float64 `json:"collectAmount,omitempty"`

	// The total amount of consumer use non taxable sales accrued in the current active period
	// Example: 0
	ConsumerUseNonTaxableAccrualAmount float64 `json:"consumerUseNonTaxableAccrualAmount,omitempty"`

	// Consumer use non-taxable amount.
	// Example: 0
	ConsumerUseNonTaxableAmount float64 `json:"consumerUseNonTaxableAmount,omitempty"`

	// The total amount of consumer use tax accrued in the current active period
	// Example: 0
	ConsumerUseTaxAccrualAmount float64 `json:"consumerUseTaxAccrualAmount,omitempty"`

	// Consumer use tax liability during the period.
	// Example: 0
	ConsumerUseTaxAmount float64 `json:"consumerUseTaxAmount,omitempty"`

	// Consumer use tax liability accrued during the period.
	// Example: 0
	ConsumerUseTaxDueAmount float64 `json:"consumerUseTaxDueAmount,omitempty"`

	// The total amount of consumer use taxable sales accrued in the current active period
	// Example: 0
	ConsumerUseTaxableAccrualAmount float64 `json:"consumerUseTaxableAccrualAmount,omitempty"`

	// Consumer use taxable amount.
	// Example: 0
	ConsumerUseTaxableAmount float64 `json:"consumerUseTaxableAmount,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A description for the return.
	// Example: Sales Tax Return
	Description string `json:"description,omitempty"`

	// The end date of this return
	// Format: date-time
	EndPeriod strfmt.DateTime `json:"endPeriod,omitempty"`

	// The excluded carry over credit documents
	// Example: {"totalExempt":0,"totalSales":0,"totalTax":0,"totalTaxable":0}
	ExcludedCarryOverCredits *FilingReturnCreditModel `json:"excludedCarryOverCredits,omitempty"`

	// The amount of non-taxable sales excluded from the liability calculation
	// Example: 0
	ExcludedNonTaxableAmount float64 `json:"excludedNonTaxableAmount,omitempty"`

	// The amount of sales excluded from the liability calculation
	// Example: 0
	ExcludedSalesAmount float64 `json:"excludedSalesAmount,omitempty"`

	// The amount of tax excluded from the liability calculation
	// Example: 0
	ExcludedTaxAmount float64 `json:"excludedTaxAmount,omitempty"`

	// The date the return was filed by Avalara.
	// Format: date-time
	FiledDate strfmt.DateTime `json:"filedDate,omitempty"`

	// The unique ID number of the filing calendar associated with this return.
	// Example: 513256
	FilingCalendarID int64 `json:"filingCalendarId,omitempty"`

	// The filing frequency of the return.
	// Example: Monthly
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequency string `json:"filingFrequency,omitempty"`

	// The region id that this return belongs too
	// Example: 0
	FilingRegionID int64 `json:"filingRegionId,omitempty"`

	// The filing type of the return.
	// Example: PaperReturn
	// Enum: [PaperReturn ElectronicReturn SER EFTPaper PhonePaper SignatureReady EfileCheck]
	FilingType string `json:"filingType,omitempty"`

	// The unique code of the form.
	// Example: AL2100
	FormCode string `json:"formCode,omitempty"`

	// The name of the form.
	// Example: AL 2100
	FormName string `json:"formName,omitempty"`

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

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,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.
	Month int32 `json:"month,omitempty"`

	// The total amount of nontaxable sales accrued in the current active period
	// Example: 0
	NonTaxableAccrualAmount float64 `json:"nonTaxableAccrualAmount,omitempty"`

	// The non-taxable amount.
	// Example: 0
	NonTaxableAmount float64 `json:"nonTaxableAmount,omitempty"`

	// The non-taxable due amount.
	// Example: 0
	NonTaxableDueAmount float64 `json:"nonTaxableDueAmount,omitempty"`

	// The payments for this return.
	Payments []*FilingPaymentModel `json:"payments"`

	// The remittance amount of the return.
	// Example: 0
	RemitAmount float64 `json:"remitAmount,omitempty"`

	// The resourceFileId of the return.  Will be null if not available.
	ResourceFileID int64 `json:"resourceFileId,omitempty"`

	// The total amount of sales accrued in the current active period
	// Example: 0
	SalesAccrualAmount float64 `json:"salesAccrualAmount,omitempty"`

	// The sales amount.
	// Example: 0
	SalesAmount float64 `json:"salesAmount,omitempty"`

	// The total amount of sales tax accrued in the current active period
	// Example: 0
	SalesTaxAccrualAmount float64 `json:"salesTaxAccrualAmount,omitempty"`

	// The total amount of sellers use tax accrued in the current active period
	// Example: 0
	SellersUseTaxAccrualAmount float64 `json:"sellersUseTaxAccrualAmount,omitempty"`

	// The start date of this return
	// Format: date-time
	StartPeriod strfmt.DateTime `json:"startPeriod,omitempty"`

	// The current status of the filing return.
	// 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"`

	// The total amount of total tax accrued in the current active period
	// Example: 0
	TaxAccrualAmount float64 `json:"taxAccrualAmount,omitempty"`

	// The tax amount.
	// Example: 0
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// Tax Authority ID of this return
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The tax due amount.
	// Example: 0
	TaxDueAmount float64 `json:"taxDueAmount,omitempty"`

	// The total amount of taxable sales accrued in the current active period
	// Example: 0
	TaxableAccrualAmount float64 `json:"taxableAccrualAmount,omitempty"`

	// The taxable amount.
	// Example: 0
	TaxableAmount float64 `json:"taxableAmount,omitempty"`

	// Total amount of adjustments on this return
	// Example: 0
	TotalAdjustments float64 `json:"totalAdjustments,omitempty"`

	// Total amount of augmentations on this return
	// Example: 0
	TotalAugmentations float64 `json:"totalAugmentations,omitempty"`

	// Total amount of payments on this return
	// Example: 0
	TotalPayments float64 `json:"totalPayments,omitempty"`

	// The FilingTaskType for this return.
	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.
	Year int32 `json:"year,omitempty"`
}

FilingReturnModel Filing Returns Model Example: {"accrualType":0,"adjustments":[{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}],"augmentations":[{"fieldAmount":10,"fieldName":"Credit from the State","id":103230}],"carryOverConsumerUseTaxAmount":0,"carryOverNonTaxableAmount":0,"carryOverSalesAmount":0,"carryOverTaxAmount":0,"collectAmount":1,"consumerUseNonTaxableAccrualAmount":0,"consumerUseNonTaxableAmount":0,"consumerUseTaxAccrualAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxDueAmount":0,"consumerUseTaxableAccrualAmount":0,"consumerUseTaxableAmount":0,"description":"Sales Tax Return","excludedNonTaxableAmount":0,"excludedSalesAmount":0,"excludedTaxAmount":0,"filingCalendarId":513256,"filingFrequency":"Monthly","filingRegionId":0,"filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"nonTaxableAccrualAmount":0,"nonTaxableAmount":0,"nonTaxableDueAmount":0,"remitAmount":0,"salesAccrualAmount":0,"salesAmount":0,"salesTaxAccrualAmount":0,"sellersUseTaxAccrualAmount":0,"status":"PendingApproval","taxAccrualAmount":0,"taxAmount":0,"taxDueAmount":0,"taxableAccrualAmount":0,"taxableAmount":0,"totalAdjustments":0,"totalAugmentations":0,"totalPayments":0}

swagger:model FilingReturnModel

func (*FilingReturnModel) ContextValidate ¶ 

func (m *FilingReturnModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing return model based on the context it is used

func (*FilingReturnModel) MarshalBinary ¶ 

func (m *FilingReturnModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingReturnModel) UnmarshalBinary ¶ 

func (m *FilingReturnModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingReturnModel) Validate ¶ 

func (m *FilingReturnModel) Validate(formats strfmt.Registry) error

Validate validates this filing return model

type FilingReturnModelBasic ¶ 

type FilingReturnModelBasic struct {

	// Accrual type of the return
	// Example: Filing
	// Enum: [Filing Accrual]
	AccrualType string `json:"accrualType,omitempty"`

	// The attachments for this return.
	Attachments []*FilingAttachmentModel `json:"attachments"`

	// The amount collected by avalara for this return
	// Example: 1
	CollectAmount float64 `json:"collectAmount,omitempty"`

	// The unique ID number of the company filing return.
	// Example: 0
	CompanyID int64 `json:"companyId,omitempty"`

	// Consumer use non-taxable amount.
	// Example: 0
	ConsumerUseNonTaxableAmount float64 `json:"consumerUseNonTaxableAmount,omitempty"`

	// Consumer use tax liability.
	// Example: 0
	ConsumerUseTaxAmount float64 `json:"consumerUseTaxAmount,omitempty"`

	// Consumer use taxable amount.
	// Example: 0
	ConsumerUseTaxableAmount float64 `json:"consumerUseTaxableAmount,omitempty"`

	// The country of the form.
	Country string `json:"country,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A description for the return.
	// Example: Sales Tax Return
	Description string `json:"description,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: 1
	EndPeriodMonth int32 `json:"endPeriodMonth,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: 2017
	EndPeriodYear int16 `json:"endPeriodYear,omitempty"`

	// The amount of non-taxable sales excluded from the liability calculation
	// Example: 0
	ExcludedNonTaxableAmount float64 `json:"excludedNonTaxableAmount,omitempty"`

	// The amount of sales excluded from the liability calculation
	// Example: 0
	ExcludedSalesAmount float64 `json:"excludedSalesAmount,omitempty"`

	// The amount of tax excluded from the liability calculation
	// Example: 0
	ExcludedTaxAmount float64 `json:"excludedTaxAmount,omitempty"`

	// The date the return was filed by Avalara.
	// Format: date-time
	FiledDate strfmt.DateTime `json:"filedDate,omitempty"`

	// The unique ID number of the filing calendar associated with this return.
	// Example: 513256
	FilingCalendarID int64 `json:"filingCalendarId,omitempty"`

	// The filing frequency of the return.
	// Example: Monthly
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequency string `json:"filingFrequency,omitempty"`

	// The filing id that this return belongs too
	// Example: 0
	FilingID int64 `json:"filingId,omitempty"`

	// The region id that this return belongs too
	// Example: 0
	FilingRegionID int64 `json:"filingRegionId,omitempty"`

	// The filing type of the return.
	// Example: PaperReturn
	// Enum: [PaperReturn ElectronicReturn SER EFTPaper PhonePaper SignatureReady EfileCheck]
	FilingType string `json:"filingType,omitempty"`

	// The unique code of the form.
	// Example: AL2100
	FormCode string `json:"formCode,omitempty"`

	// The name of the form.
	// Example: AL 2100
	FormName string `json:"formName,omitempty"`

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

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The non-taxable amount.
	// Example: 0
	NonTaxableAmount float64 `json:"nonTaxableAmount,omitempty"`

	// The non-taxable due amount.
	// Example: 0
	NonTaxableDueAmount float64 `json:"nonTaxableDueAmount,omitempty"`

	// The region of the form.
	Region string `json:"region,omitempty"`

	// The remittance amount of the return.
	// Example: 0
	RemitAmount float64 `json:"remitAmount,omitempty"`

	// The resourceFileId of the return
	// Example: 0
	ResourceFileID int64 `json:"resourceFileId,omitempty"`

	// The sales amount.
	// Example: 0
	SalesAmount float64 `json:"salesAmount,omitempty"`

	// The current status of the filing return.
	// 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"`

	// The tax amount.
	// Example: 0
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// The tax due amount.
	// Example: 0
	TaxDueAmount float64 `json:"taxDueAmount,omitempty"`

	// The taxable amount.
	// Example: 0
	TaxableAmount float64 `json:"taxableAmount,omitempty"`
}

FilingReturnModelBasic Filing Returns Model Example: {"accrualType":0,"collectAmount":1,"companyId":0,"consumerUseNonTaxableAmount":0,"consumerUseTaxAmount":0,"consumerUseTaxableAmount":0,"description":"Sales Tax Return","endPeriodMonth":1,"endPeriodYear":2017,"excludedNonTaxableAmount":0,"excludedSalesAmount":0,"excludedTaxAmount":0,"filingCalendarId":513256,"filingFrequency":"Monthly","filingId":0,"filingRegionId":0,"filingType":"ElectronicReturn","formCode":"AL2100","formName":"AL 2100","id":5233103,"nonTaxableAmount":0,"nonTaxableDueAmount":0,"remitAmount":0,"resourceFileId":0,"salesAmount":0,"status":"PendingApproval","taxAmount":0,"taxDueAmount":0,"taxableAmount":0}

swagger:model FilingReturnModelBasic

func (*FilingReturnModelBasic) ContextValidate ¶ 

func (m *FilingReturnModelBasic) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing return model basic based on the context it is used

func (*FilingReturnModelBasic) MarshalBinary ¶ 

func (m *FilingReturnModelBasic) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingReturnModelBasic) UnmarshalBinary ¶ 

func (m *FilingReturnModelBasic) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingReturnModelBasic) Validate ¶ 

func (m *FilingReturnModelBasic) Validate(formats strfmt.Registry) error

Validate validates this filing return model basic

type FilingReturnModelBasicFetchResult ¶ 

type FilingReturnModelBasicFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FilingReturnModelBasic `json:"value"`
}

FilingReturnModelBasicFetchResult filing return model basic fetch result

swagger:model FilingReturnModelBasicFetchResult

func (*FilingReturnModelBasicFetchResult) ContextValidate ¶ 

func (m *FilingReturnModelBasicFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filing return model basic fetch result based on the context it is used

func (*FilingReturnModelBasicFetchResult) MarshalBinary ¶ 

func (m *FilingReturnModelBasicFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingReturnModelBasicFetchResult) UnmarshalBinary ¶ 

func (m *FilingReturnModelBasicFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingReturnModelBasicFetchResult) Validate ¶ 

func (m *FilingReturnModelBasicFetchResult) Validate(formats strfmt.Registry) error

Validate validates this filing return model basic fetch result

type FilingStatusChangeModel ¶ 

type FilingStatusChangeModel struct {

	// Indicates the filing status you are requesting for this company
	// Example: NotConfiguredForCompliance
	// Enum: [NotConfiguredForCompliance NotYetFiling FilingRequested FirstFiling Active NoReporting Inactive]
	RequestedStatus string `json:"requestedStatus,omitempty"`
}

FilingStatusChangeModel Represents a change request for filing status for a company Example: {"requestedStatus":"FirstFiling"}

swagger:model FilingStatusChangeModel

func (*FilingStatusChangeModel) ContextValidate ¶ 

func (m *FilingStatusChangeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filing status change model based on context it is used

func (*FilingStatusChangeModel) MarshalBinary ¶ 

func (m *FilingStatusChangeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingStatusChangeModel) UnmarshalBinary ¶ 

func (m *FilingStatusChangeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingStatusChangeModel) Validate ¶ 

func (m *FilingStatusChangeModel) Validate(formats strfmt.Registry) error

Validate validates this filing status change model

type FilingsCheckupAuthorityModel ¶ 

type FilingsCheckupAuthorityModel struct {

	// Jurisdiction Id of the tax authority
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// Location Code of the tax authority
	LocationCode string `json:"locationCode,omitempty"`

	// Suggested forms to file due to tax collected
	SuggestedForms []*FilingsCheckupSuggestedFormModel `json:"suggestedForms"`

	// Amount of tax collected in this tax authority
	Tax float64 `json:"tax,omitempty"`

	// Unique ID of the tax authority
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// Name of the tax authority
	TaxAuthorityName string `json:"taxAuthorityName,omitempty"`

	// Type Id of the tax authority
	TaxAuthorityTypeID int32 `json:"taxAuthorityTypeId,omitempty"`

	// Tax Type collected in the tax authority
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

FilingsCheckupAuthorityModel Cycle Safe Expiration results. Example: {"jurisdictionId":42,"suggestedForms":[{"country":"US","region":"NY","taxAuthorityId":71,"taxFormCode":"NYAU11"}],"tax":0,"taxAuthorityId":71,"taxAuthorityName":"NEW YORK","taxAuthorityTypeId":45,"taxTypeId":"U"}

swagger:model FilingsCheckupAuthorityModel

func (*FilingsCheckupAuthorityModel) ContextValidate ¶ 

func (m *FilingsCheckupAuthorityModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filings checkup authority model based on the context it is used

func (*FilingsCheckupAuthorityModel) MarshalBinary ¶ 

func (m *FilingsCheckupAuthorityModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingsCheckupAuthorityModel) UnmarshalBinary ¶ 

func (m *FilingsCheckupAuthorityModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingsCheckupAuthorityModel) Validate ¶ 

func (m *FilingsCheckupAuthorityModel) Validate(formats strfmt.Registry) error

Validate validates this filings checkup authority model

type FilingsCheckupModel ¶ 

type FilingsCheckupModel struct {

	// A collection of authorities in the report
	Authorities []*FilingsCheckupAuthorityModel `json:"authorities"`
}

FilingsCheckupModel Results of the Worksheet Checkup report Example: {"authorities":[{"jurisdictionId":42,"suggestedForms":[{"country":"US","region":"NY","taxAuthorityId":71,"taxFormCode":"NYAU11"}],"tax":0,"taxAuthorityId":71,"taxAuthorityName":"NEW YORK","taxAuthorityTypeId":45,"taxTypeId":"U"}]}

swagger:model FilingsCheckupModel

func (*FilingsCheckupModel) ContextValidate ¶ 

func (m *FilingsCheckupModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this filings checkup model based on the context it is used

func (*FilingsCheckupModel) MarshalBinary ¶ 

func (m *FilingsCheckupModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingsCheckupModel) UnmarshalBinary ¶ 

func (m *FilingsCheckupModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingsCheckupModel) Validate ¶ 

func (m *FilingsCheckupModel) Validate(formats strfmt.Registry) error

Validate validates this filings checkup model

type FilingsCheckupSuggestedFormModel ¶ 

type FilingsCheckupSuggestedFormModel struct {

	// Country of the suggested form returned
	// Example: US
	Country string `json:"country,omitempty"`

	// Region of the suggested form returned
	// Example: NY
	Region string `json:"region,omitempty"`

	// Legacy Name of the suggested form returned
	ReturnName string `json:"returnName,omitempty"`

	// Tax Authority ID of the suggested form returned
	// Example: 71
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// Name of the suggested form returned
	// Example: NYAU11
	TaxFormCode string `json:"taxFormCode,omitempty"`
}

FilingsCheckupSuggestedFormModel Worksheet Checkup Report Suggested Form Model Example: {"country":"US","region":"NY","taxAuthorityId":71,"taxFormCode":"NYAU11"}

swagger:model FilingsCheckupSuggestedFormModel

func (*FilingsCheckupSuggestedFormModel) ContextValidate ¶ 

func (m *FilingsCheckupSuggestedFormModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filings checkup suggested form model based on context it is used

func (*FilingsCheckupSuggestedFormModel) MarshalBinary ¶ 

func (m *FilingsCheckupSuggestedFormModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingsCheckupSuggestedFormModel) UnmarshalBinary ¶ 

func (m *FilingsCheckupSuggestedFormModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingsCheckupSuggestedFormModel) Validate ¶ 

func (m *FilingsCheckupSuggestedFormModel) Validate(formats strfmt.Registry) error

Validate validates this filings checkup suggested form model

type FilingsTaxDetailsModel ¶ 

type FilingsTaxDetailsModel struct {

	// The nontaxable amount
	// Example: 100
	NonTaxableAmount float64 `json:"nonTaxableAmount,omitempty"`

	// The number of nights
	// Example: 1
	NumberOfNights int64 `json:"numberOfNights,omitempty"`

	// The total sales amount
	// Example: 200
	SalesAmount float64 `json:"salesAmount,omitempty"`

	// The tax amount
	// Example: 10
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// The tax type associated with the summary
	// Example: S
	TaxType string `json:"taxType,omitempty"`
}

FilingsTaxDetailsModel Represents a listing of all tax calculation data for filings and for accruing to future filings. Example: {"nonTaxableAmount":100,"numberOfNights":1,"salesAmount":200,"taxAmount":10,"taxType":"S"}

swagger:model FilingsTaxDetailsModel

func (*FilingsTaxDetailsModel) ContextValidate ¶ 

func (m *FilingsTaxDetailsModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filings tax details model based on context it is used

func (*FilingsTaxDetailsModel) MarshalBinary ¶ 

func (m *FilingsTaxDetailsModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingsTaxDetailsModel) UnmarshalBinary ¶ 

func (m *FilingsTaxDetailsModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingsTaxDetailsModel) Validate ¶ 

func (m *FilingsTaxDetailsModel) Validate(formats strfmt.Registry) error

Validate validates this filings tax details model

type FilingsTaxSummaryModel ¶ 

type FilingsTaxSummaryModel struct {

	// The collect amount
	// Example: 10
	CollectAmount float64 `json:"collectAmount,omitempty"`

	// The nontaxable accrual amount
	// Example: 100
	NonTaxableAccrualAmount float64 `json:"nonTaxableAccrualAmount,omitempty"`

	// The nontaxable amount
	// Example: 100
	NonTaxableAmount float64 `json:"nonTaxableAmount,omitempty"`

	// The remittance amount
	// Example: 10
	RemittanceAmount float64 `json:"remittanceAmount,omitempty"`

	// reportableNonTaxableAmount
	// Example: 50
	ReportableNonTaxableAmount float64 `json:"reportableNonTaxableAmount,omitempty"`

	// reportableSalesAmount
	// Example: 100
	ReportableSalesAmount float64 `json:"reportableSalesAmount,omitempty"`

	// reportableTaxAmount
	// Example: 5
	ReportableTaxAmount float64 `json:"reportableTaxAmount,omitempty"`

	// reportableTaxableAmount
	// Example: 5
	ReportableTaxableAmount float64 `json:"reportableTaxableAmount,omitempty"`

	// The sales accrual amount
	// Example: 100
	SalesAccrualAmount float64 `json:"salesAccrualAmount,omitempty"`

	// The total sales amount
	// Example: 200
	SalesAmount float64 `json:"salesAmount,omitempty"`

	// The tax accrual amount
	// Example: 10
	TaxAccrualAmount float64 `json:"taxAccrualAmount,omitempty"`

	// The tax amount
	// Example: 10
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// The taxable sales accrual amount
	// Example: 0
	TaxableAccrualAmount float64 `json:"taxableAccrualAmount,omitempty"`

	// The taxable amount
	// Example: 0
	TaxableAmount float64 `json:"taxableAmount,omitempty"`
}

FilingsTaxSummaryModel Represents a listing of all tax calculation data for filings and for accruing to future filings. 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}

swagger:model FilingsTaxSummaryModel

func (*FilingsTaxSummaryModel) ContextValidate ¶ 

func (m *FilingsTaxSummaryModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this filings tax summary model based on context it is used

func (*FilingsTaxSummaryModel) MarshalBinary ¶ 

func (m *FilingsTaxSummaryModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FilingsTaxSummaryModel) UnmarshalBinary ¶ 

func (m *FilingsTaxSummaryModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FilingsTaxSummaryModel) Validate ¶ 

func (m *FilingsTaxSummaryModel) Validate(formats strfmt.Registry) error

Validate validates this filings tax summary model

type FirmClientLinkageInputModel ¶ 

type FirmClientLinkageInputModel struct {

	// Client AccountId that needs to be linked to the firm
	// Example: 24958289
	// Required: true
	ClientAccountID *int32 `json:"clientAccountId"`

	// Client AccountName that needs to be linked to the firm
	// Example: client account
	// Required: true
	ClientAccountName *string `json:"clientAccountName"`
}

FirmClientLinkageInputModel Account Linkage Input model Example: {"clientAccountId":24958289,"clientAccountName":"client account"}

swagger:model FirmClientLinkageInputModel

func (*FirmClientLinkageInputModel) ContextValidate ¶ 

func (m *FirmClientLinkageInputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this firm client linkage input model based on context it is used

func (*FirmClientLinkageInputModel) MarshalBinary ¶ 

func (m *FirmClientLinkageInputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FirmClientLinkageInputModel) UnmarshalBinary ¶ 

func (m *FirmClientLinkageInputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FirmClientLinkageInputModel) Validate ¶ 

func (m *FirmClientLinkageInputModel) Validate(formats strfmt.Registry) error

Validate validates this firm client linkage input model

type FirmClientLinkageOutputModel ¶ 

type FirmClientLinkageOutputModel struct {

	// Client Account to be linked with the firm
	// Example: 24958289
	ClientAccountID int32 `json:"clientAccountId,omitempty"`

	// Client Account name
	// Example: Client Account
	ClientAccountName string `json:"clientAccountName,omitempty"`

	// Created date of the linkage
	// Example: 2021-12-25T17:08:43.9820973+00:00
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// User who created the linkage
	// Example: 213
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Firm Account to be linked with the firm
	// Example: 23982571
	FirmAccountID int32 `json:"firmAccountId,omitempty"`

	// FIrm Account name
	// Example: Firm Account
	FirmAccountName string `json:"firmAccountName,omitempty"`

	// Email of the firm's point of contact person for the client
	FirmContactEmail string `json:"firmContactEmail,omitempty"`

	// Name of the firm's point of contact person for the client
	FirmContactName string `json:"firmContactName,omitempty"`

	// The unique ID number of firm-client linkage.
	// Example: 123456
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// This is set to 1 if the linkage is deleted.
	// Example: false
	IsDeleted bool `json:"isDeleted,omitempty"`

	// Modified date of the linkage
	// Example: 2021-12-25T17:08:43.9821473+00:00
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// User who modified the linkage
	// Example: 213
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The status of the account linkage. The following are the available statuses
	// * Requested - When a linkage is requested
	// * Approved - When the linkage is approved
	// * Rejected - When the linkage is rejected
	// * Revoked - When the linkage is revoked.
	// Example: Requested
	// Enum: [Requested Approved Rejected Revoked]
	Status string `json:"status,omitempty"`
}

FirmClientLinkageOutputModel Account Linkage output model Example: {"clientAccountId":24958289,"clientAccountName":"Client Account","createdDate":"2021-12-25T17:08:43.9820973+00:00","createdUserId":213,"firmAccountId":23982571,"firmAccountName":"Firm Account","id":123456,"isDeleted":false,"modifiedDate":"2021-12-25T17:08:43.9821473+00:00","modifiedUserId":213,"status":"Requested"}

swagger:model FirmClientLinkageOutputModel

func (*FirmClientLinkageOutputModel) ContextValidate ¶ 

func (m *FirmClientLinkageOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this firm client linkage output model based on the context it is used

func (*FirmClientLinkageOutputModel) MarshalBinary ¶ 

func (m *FirmClientLinkageOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FirmClientLinkageOutputModel) UnmarshalBinary ¶ 

func (m *FirmClientLinkageOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FirmClientLinkageOutputModel) Validate ¶ 

func (m *FirmClientLinkageOutputModel) Validate(formats strfmt.Registry) error

Validate validates this firm client linkage output model

type FirmClientLinkageOutputModelFetchResult ¶ 

type FirmClientLinkageOutputModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FirmClientLinkageOutputModel `json:"value"`
}

FirmClientLinkageOutputModelFetchResult firm client linkage output model fetch result

swagger:model FirmClientLinkageOutputModelFetchResult

func (*FirmClientLinkageOutputModelFetchResult) ContextValidate ¶ 

func (m *FirmClientLinkageOutputModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this firm client linkage output model fetch result based on the context it is used

func (*FirmClientLinkageOutputModelFetchResult) MarshalBinary ¶ 

func (m *FirmClientLinkageOutputModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FirmClientLinkageOutputModelFetchResult) UnmarshalBinary ¶ 

func (m *FirmClientLinkageOutputModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FirmClientLinkageOutputModelFetchResult) Validate ¶ 

func (m *FirmClientLinkageOutputModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this firm client linkage output model fetch result

type FormMasterModel ¶ 

type FormMasterModel struct {

	// True if this state permits payment by ACH Credit
	// Example: false
	AchCreditAllowed bool `json:"achCreditAllowed,omitempty"`

	// Unused
	AliasForFormMasterID string `json:"aliasForFormMasterId,omitempty"`

	// True if the form overall can go negative
	// Example: false
	AllowNegativeOverallTax bool `json:"allowNegativeOverallTax,omitempty"`

	// Unused
	// Example: false
	AllowsBulkFilingAccounts bool `json:"allowsBulkFilingAccounts,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddress1 string `json:"amendedAddress1,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddress2 string `json:"amendedAddress2,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddressCity string `json:"amendedAddressCity,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddressCountry string `json:"amendedAddressCountry,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddressMailTo string `json:"amendedAddressMailTo,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddressPostalCode string `json:"amendedAddressPostalCode,omitempty"`

	// Mailing address to use when filing an amended return
	AmendedAddressRegion string `json:"amendedAddressRegion,omitempty"`

	// Tax authority that issued the form
	AuthorityName string `json:"authorityName,omitempty"`

	// Unused
	AverageCheckClearDays string `json:"averageCheckClearDays,omitempty"`

	// Unused
	BulkAccountInstructionLink string `json:"bulkAccountInstructionLink,omitempty"`

	// Unused
	ContentReviewFrequencyID int32 `json:"contentReviewFrequencyId,omitempty"`

	// ISO 3166 code of the country that issued this tax form
	// Example: US
	Country string `json:"country,omitempty"`

	// Date when form was created
	// Example: 0001-01-01T00:00:00
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// ID of the Avalara user who created the form
	// Example: 0
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Day of the month on which the form is considered delinquent. Almost always the same as DueDay
	DelinquentDay int32 `json:"delinquentDay,omitempty"`

	// Description of this tax form
	// Example: State, Local, and District Sales and Use Tax Return
	Description string `json:"description,omitempty"`

	// Mailing address of the department of revenue
	DorAddress1 string `json:"dorAddress1,omitempty"`

	// Mailing address of the department of revenue
	DorAddress2 string `json:"dorAddress2,omitempty"`

	// Mailing address of the department of revenue
	DorAddressCity string `json:"dorAddressCity,omitempty"`

	// Mailing address of the department of revenue
	DorAddressCountry string `json:"dorAddressCountry,omitempty"`

	// Mailing address of the department of revenue
	DorAddressMailTo string `json:"dorAddressMailTo,omitempty"`

	// Mailing address of the department of revenue
	DorAddressPostalCode string `json:"dorAddressPostalCode,omitempty"`

	// Mailing address of the department of revenue
	DorAddressRegion string `json:"dorAddressRegion,omitempty"`

	// Phone number of the department of revenue
	DorPhoneNumber string `json:"dorPhoneNumber,omitempty"`

	// Link to the state department of revenue website, if available
	DorWebsite string `json:"dorWebsite,omitempty"`

	// Day of the month when the form is due
	// Example: 20
	DueDay int32 `json:"dueDay,omitempty"`

	// Date when this form became effective
	// Example: 2005-04-01T00:00:00
	// Format: date-time
	EffDate strfmt.DateTime `json:"effDate,omitempty"`

	// Date when this form expired
	// Example: 9999-12-31T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// --Need Further Clarification
	// Example: false
	FileForAllOutlets bool `json:"fileForAllOutlets,omitempty"`

	// Unused
	// Example: false
	FilterZeroRatedLineDetails bool `json:"filterZeroRatedLineDetails,omitempty"`

	// Month of the year the state considers as the first fiscal month
	FiscalYearStartMonth int32 `json:"fiscalYearStartMonth,omitempty"`

	// The type of the form being submitted
	// Example: 0
	FormTypeID int32 `json:"formTypeId,omitempty"`

	// Unused
	// Example: false
	GrossIncludesInterstateSales bool `json:"grossIncludesInterstateSales,omitempty"`

	// Unused
	GrossIncludesTax string `json:"grossIncludesTax,omitempty"`

	// Unused
	// Example: false
	HasDependencies bool `json:"hasDependencies,omitempty"`

	// Unused
	// Example: false
	HasEfileFee bool `json:"hasEfileFee,omitempty"`

	// Unused
	// Example: false
	HasEpayFee bool `json:"hasEpayFee,omitempty"`

	// Unused
	// Example: false
	HasMultiFilingMethods bool `json:"hasMultiFilingMethods,omitempty"`

	// Can form support multi frequencies
	// Example: false
	HasMultiFrequencies bool `json:"hasMultiFrequencies,omitempty"`

	// Unused
	// Example: false
	HasMultiPayMethods bool `json:"hasMultiPayMethods,omitempty"`

	// Unused
	// Example: false
	HasMultiRegistrationMethods bool `json:"hasMultiRegistrationMethods,omitempty"`

	// Not sure if used
	// Example: false
	HasPrepayments bool `json:"hasPrepayments,omitempty"`

	// Unused
	// Example: false
	HasReportingCodes bool `json:"hasReportingCodes,omitempty"`

	// Unused
	// Example: false
	HasSchedules bool `json:"hasSchedules,omitempty"`

	// Unique ID number of this form master object
	// Example: 2415
	ID int32 `json:"id,omitempty"`

	// --Need Further Clarification
	InconsistencyTolerance string `json:"inconsistencyTolerance,omitempty"`

	// Unused
	IsEFTRequired bool `json:"isEFTRequired,omitempty"`

	// True if this form is available for use
	// Example: true
	IsEffective bool `json:"isEffective,omitempty"`

	// Unused
	// Example: false
	IsFilePayMethodLinked bool `json:"isFilePayMethodLinked,omitempty"`

	// True if you can report a negative amount in a single jurisdiction on the form
	IsNegAmountAllowed bool `json:"isNegAmountAllowed,omitempty"`

	// Unused
	// Example: false
	IsNettingRequired bool `json:"isNettingRequired,omitempty"`

	// Does this tax authority require a power of attorney in order to speak to Avalara
	// Example: false
	IsPOARequired bool `json:"isPOARequired,omitempty"`

	// True if this form requires that the customer register with the authority
	// Example: false
	IsRegistrationRequired bool `json:"isRegistrationRequired,omitempty"`

	// Legacy return name as known in the AvaFileForm table
	// Example: CABOE401A2
	LegacyReturnName string `json:"legacyReturnName,omitempty"`

	// --Need Further Clarification
	ListingSortOrder string `json:"listingSortOrder,omitempty"`

	// Unused
	// Example: 0
	MailingReceivedRuleID int32 `json:"mailingReceivedRuleId,omitempty"`

	// Date when form was modified
	// Example: 0001-01-01T00:00:00
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// ID of the Avalara user who modified the form
	// Example: 0
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// Internal Avalara flag
	NonSstBehavior string `json:"nonSstBehavior,omitempty"`

	// Unused
	// Example: false
	OnlineAmendedReturns bool `json:"onlineAmendedReturns,omitempty"`

	// Unused
	// Example: false
	OnlineBackFiling bool `json:"onlineBackFiling,omitempty"`

	// Unused
	OutletLocationIdentifiersRequired bool `json:"outletLocationIdentifiersRequired,omitempty"`

	// Type of outlet reporting for this form
	// Example: 0
	OutletReportingMethodID int32 `json:"outletReportingMethodId,omitempty"`

	// --Need Further Clarification
	// Example: false
	PaperFormsDoNotHaveDiscounts bool `json:"paperFormsDoNotHaveDiscounts,omitempty"`

	// Unused
	PeerReviewed string `json:"peerReviewed,omitempty"`

	// Unused
	PeerReviewedDate string `json:"peerReviewedDate,omitempty"`

	// Unused
	PeerReviewedID string `json:"peerReviewedId,omitempty"`

	// True if this form is verified filed via email
	// Example: false
	PostOfficeValidated bool `json:"postOfficeValidated,omitempty"`

	// --Need Further Clarification
	PrepaymentFrequency string `json:"prepaymentFrequency,omitempty"`

	// Unused
	// Example: 0
	ProofOfMailingID int32 `json:"proofOfMailingId,omitempty"`

	// The region within which this form was issued
	// Example: CA
	Region string `json:"region,omitempty"`

	// Unused
	RegistrationIDFormat string `json:"registrationIdFormat,omitempty"`

	// Jurisdiction level of the state
	ReportLevel string `json:"reportLevel,omitempty"`

	// Unused
	RequiredEfileTrigger string `json:"requiredEfileTrigger,omitempty"`

	// Unused
	RequiredEftTrigger string `json:"requiredEftTrigger,omitempty"`

	// True if this form requires that you set up outlets in the state
	// Example: false
	RequiresOutletSetup bool `json:"requiresOutletSetup,omitempty"`

	// Unused
	// Example: 0
	RoundingMethodID int32 `json:"roundingMethodId,omitempty"`

	// --Need Further Clarification
	RoundingPrecision string `json:"roundingPrecision,omitempty"`

	// DEPRECATED
	ShortCode string `json:"shortCode,omitempty"`

	// Internal Avalara flag
	SstBehavior string `json:"sstBehavior,omitempty"`

	// Internal behavior
	// Example: false
	StackAggregation bool `json:"stackAggregation,omitempty"`

	// Internal Avalara flag
	StackAggregationOption string `json:"stackAggregationOption,omitempty"`

	// Unique tax form code representing this tax form
	TaxFormCode string `json:"taxFormCode,omitempty"`

	// Human readable form summary name
	// Example: CA BOE 401 A2
	TaxFormName string `json:"taxFormName,omitempty"`

	// Unused
	ThresholdTrigger string `json:"thresholdTrigger,omitempty"`

	// Unused
	TransactionSortingOption string `json:"transactionSortingOption,omitempty"`

	// Total amount of discounts that can be received by a vendor each year
	// Example: 0
	VendorDiscountAnnualMax float64 `json:"vendorDiscountAnnualMax,omitempty"`

	// Unused
	// Example: false
	VendorDiscountEfile bool `json:"vendorDiscountEfile,omitempty"`

	// Unused
	// Example: false
	VendorDiscountPaper bool `json:"vendorDiscountPaper,omitempty"`

	// Unused
	// Example: false
	VersionsRequireAuthorityApproval bool `json:"versionsRequireAuthorityApproval,omitempty"`

	// True if this form can be shown to customers
	// Example: false
	VisibleToCustomers bool `json:"visibleToCustomers,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddress1 string `json:"zeroAddress1,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddress2 string `json:"zeroAddress2,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddressCity string `json:"zeroAddressCity,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddressCountry string `json:"zeroAddressCountry,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddressMailTo string `json:"zeroAddressMailTo,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddressPostalCode string `json:"zeroAddressPostalCode,omitempty"`

	// Mailing address to use when a zero dollar form is filed
	ZeroAddressRegion string `json:"zeroAddressRegion,omitempty"`
}

FormMasterModel Represents information about a tax form known to Avalara Example: {"achCreditAllowed":false,"allowNegativeOverallTax":false,"allowsBulkFilingAccounts":false,"country":"US","createdDate":"0001-01-01T00:00:00","createdUserId":0,"description":"State, Local, and District Sales and Use Tax Return","dueDay":20,"effDate":"2005-04-01T00:00:00","endDate":"9999-12-31T00:00:00","fileForAllOutlets":false,"filterZeroRatedLineDetails":false,"formTypeId":0,"grossIncludesInterstateSales":false,"hasDependencies":false,"hasEfileFee":false,"hasEpayFee":false,"hasMultiFilingMethods":false,"hasMultiFrequencies":false,"hasMultiPayMethods":false,"hasMultiRegistrationMethods":false,"hasPrepayments":false,"hasReportingCodes":false,"hasSchedules":false,"id":2415,"isEFTRequired":false,"isEffective":true,"isFilePayMethodLinked":false,"isNegAmountAllowed":false,"isNettingRequired":false,"isPOARequired":false,"isRegistrationRequired":false,"legacyReturnName":"CABOE401A2","mailingReceivedRuleId":0,"modifiedDate":"0001-01-01T00:00:00","modifiedUserId":0,"onlineAmendedReturns":false,"onlineBackFiling":false,"outletReportingMethodId":0,"paperFormsDoNotHaveDiscounts":false,"postOfficeValidated":false,"proofOfMailingId":0,"region":"CA","requiresOutletSetup":false,"roundingMethodId":0,"stackAggregation":false,"taxFormName":"CA BOE 401 A2","vendorDiscountAnnualMax":0,"vendorDiscountEfile":false,"vendorDiscountPaper":false,"versionsRequireAuthorityApproval":false,"visibleToCustomers":false}

swagger:model FormMasterModel

func (*FormMasterModel) ContextValidate ¶ 

func (m *FormMasterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this form master model based on context it is used

func (*FormMasterModel) MarshalBinary ¶ 

func (m *FormMasterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FormMasterModel) UnmarshalBinary ¶ 

func (m *FormMasterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FormMasterModel) Validate ¶ 

func (m *FormMasterModel) Validate(formats strfmt.Registry) error

Validate validates this form master model

type FormMasterModelFetchResult ¶ 

type FormMasterModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*FormMasterModel `json:"value"`
}

FormMasterModelFetchResult form master model fetch result

swagger:model FormMasterModelFetchResult

func (*FormMasterModelFetchResult) ContextValidate ¶ 

func (m *FormMasterModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this form master model fetch result based on the context it is used

func (*FormMasterModelFetchResult) MarshalBinary ¶ 

func (m *FormMasterModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FormMasterModelFetchResult) UnmarshalBinary ¶ 

func (m *FormMasterModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FormMasterModelFetchResult) Validate ¶ 

func (m *FormMasterModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this form master model fetch result

type FreeTrialRequestModel ¶ 

type FreeTrialRequestModel struct {

	// Accept Avalara's terms and conditions is necessary for a free trial
	// Example: true
	// Required: true
	AcceptAvalaraTermsAndConditions *bool `json:"acceptAvalaraTermsAndConditions"`

	// Campaign identifier for Notification purpose
	// Example: 70140000000TsVb
	Campaign string `json:"campaign,omitempty"`

	// The company or organizational name for this free trial.  If this account is for personal use, it is acceptable
	// to use your full name here.
	// Example: Bob's Artisan Pottery
	// Required: true
	Company *string `json:"company"`

	// The Address information of the account
	// Example: {"country":"US","line":"100 Ravine Ln","postalCode":"98010","region":"WA"}
	// Required: true
	CompanyAddress *CompanyAddress `json:"companyAddress"`

	// The email address of the user requesting a free trial.
	// Example: bob@example.org
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email"`

	// The first or given name of the user requesting a free trial.
	// Example: Bob
	// Required: true
	// Max Length: 50
	// Min Length: 0
	FirstName *string `json:"firstName"`

	// Read Avalara's terms and conditions is necessary for a free trial account
	// Example: true
	// Required: true
	HaveReadAvalaraTermsAndConditions *bool `json:"haveReadAvalaraTermsAndConditions"`

	// The last or family name of the user requesting a free trial.
	// Example: McExample
	// Required: true
	// Max Length: 50
	// Min Length: 0
	LastName *string `json:"lastName"`

	// The phone number of the person requesting the free trial.
	// Example: +1 (714) 555-1212
	// Required: true
	Phone *string `json:"phone"`

	// Website of the company or user requesting a free trial
	// Example: www.bobartisanpottery.com
	// Max Length: 50
	// Min Length: 0
	Website *string `json:"website,omitempty"`
}

FreeTrialRequestModel Represents a request for a free trial account for AvaTax. Free trial accounts are only available on the Sandbox environment. Example: {"acceptAvalaraTermsAndConditions":true,"campaign":"70140000000TsVb","company":"Bob's Artisan Pottery","companyAddress":{"country":"US","line":"100 Ravine Ln","postalCode":"98010","region":"WA"},"email":"bob@example.org","firstName":"Bob","haveReadAvalaraTermsAndConditions":true,"lastName":"McExample","phone":"+1 (714) 555-1212","website":"www.bobartisanpottery.com"}

swagger:model FreeTrialRequestModel

func (*FreeTrialRequestModel) ContextValidate ¶ 

func (m *FreeTrialRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this free trial request model based on the context it is used

func (*FreeTrialRequestModel) MarshalBinary ¶ 

func (m *FreeTrialRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FreeTrialRequestModel) UnmarshalBinary ¶ 

func (m *FreeTrialRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FreeTrialRequestModel) Validate ¶ 

func (m *FreeTrialRequestModel) Validate(formats strfmt.Registry) error

Validate validates this free trial request model

type FrequencyAvailableModel ¶ 

type FrequencyAvailableModel struct {

	// Expired Calendar End Date
	AvailableCycles []*AvailableCycleModel `json:"availableCycles"`

	// Frequency Code
	FrequencyCode string `json:"frequencyCode,omitempty"`

	// Frequency Name
	FrequencyName string `json:"frequencyName,omitempty"`

	// Reason
	Reason string `json:"reason,omitempty"`
}

FrequencyAvailableModel Frequency Available object Example: {"availableCycles":[{"cycleName":"","filingDueDate":"2021-12-25T17:08:42.5250831+00:00","transactionalPeriodEnd":"2022-01-24T17:08:42.5250841+00:00","transactionalPeriodStart":"2021-12-25T17:08:42.5250844+00:00"}],"frequencyCode":"","frequencyName":"","reason":""}

swagger:model FrequencyAvailableModel

func (*FrequencyAvailableModel) ContextValidate ¶ 

func (m *FrequencyAvailableModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this frequency available model based on the context it is used

func (*FrequencyAvailableModel) MarshalBinary ¶ 

func (m *FrequencyAvailableModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FrequencyAvailableModel) UnmarshalBinary ¶ 

func (m *FrequencyAvailableModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FrequencyAvailableModel) Validate ¶ 

func (m *FrequencyAvailableModel) Validate(formats strfmt.Registry) error

Validate validates this frequency available model

type FundingConfigurationModel ¶ 

type FundingConfigurationModel struct {

	// CompanyID
	// Example: 2793
	CompanyID int32 `json:"companyId,omitempty"`

	// Recipient
	// Example: USD
	Currency string `json:"currency,omitempty"`

	// DocumentKey
	// Example: ACH Pull
	FundingMethod string `json:"fundingMethod,omitempty"`

	// Sender
	// Example: true
	IsFundingSetup bool `json:"isFundingSetup,omitempty"`

	// LastPolled
	// Example: 2021-12-25T17:08:38.2766791Z
	// Format: date-time
	LastUpdated strfmt.DateTime `json:"lastUpdated,omitempty"`

	// Domain
	// Example: AvaTax15
	SystemType string `json:"systemType,omitempty"`
}

FundingConfigurationModel Status of an Avalara Managed Returns funding configuration for a company Example: {"companyId":2793,"currency":"USD","fundingMethod":"ACH Pull","isFundingSetup":true,"lastUpdated":"2021-12-25T17:08:38.2766791Z","systemType":"AvaTax15"}

swagger:model FundingConfigurationModel

func (*FundingConfigurationModel) ContextValidate ¶ 

func (m *FundingConfigurationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this funding configuration model based on context it is used

func (*FundingConfigurationModel) MarshalBinary ¶ 

func (m *FundingConfigurationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FundingConfigurationModel) UnmarshalBinary ¶ 

func (m *FundingConfigurationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FundingConfigurationModel) Validate ¶ 

func (m *FundingConfigurationModel) Validate(formats strfmt.Registry) error

Validate validates this funding configuration model

type FundingESignMethodReturn ¶ 

type FundingESignMethodReturn struct {

	// The actual javascript to use to render this object
	JavaScript string `json:"javaScript,omitempty"`

	// JavaScriptReady
	JavaScriptReady bool `json:"javaScriptReady,omitempty"`

	// Method
	Method string `json:"method,omitempty"`
}

FundingESignMethodReturn Represents the current status of a funding ESign method Example: {"javaScriptReady":false,"method":""}

swagger:model FundingESignMethodReturn

func (*FundingESignMethodReturn) ContextValidate ¶ 

func (m *FundingESignMethodReturn) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this funding e sign method return based on context it is used

func (*FundingESignMethodReturn) MarshalBinary ¶ 

func (m *FundingESignMethodReturn) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FundingESignMethodReturn) UnmarshalBinary ¶ 

func (m *FundingESignMethodReturn) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FundingESignMethodReturn) Validate ¶ 

func (m *FundingESignMethodReturn) Validate(formats strfmt.Registry) error

Validate validates this funding e sign method return

type FundingInitiateModel ¶ 

type FundingInitiateModel struct {

	// If you have requested an email for funding setup, this is the recipient who will receive an
	// email inviting them to setup funding configuration for Avalara Managed Returns.  The recipient can
	// then click on a link in the email and setup funding configuration for this company.
	// Example: user@example.org
	// Required: true
	FundingEmailRecipient *string `json:"fundingEmailRecipient"`

	// Set this value to true to request an email to the recipient
	// Example: true
	RequestEmail bool `json:"requestEmail,omitempty"`

	// Set this value to true to request an HTML-based funding widget that can be embedded within an
	// existing user interface.  A user can then interact with the HTML-based funding widget to set up
	// funding information for the company.
	RequestWidget bool `json:"requestWidget,omitempty"`
}

FundingInitiateModel funding initiate model Example: {"fundingEmailRecipient":"user@example.org","requestEmail":true}

swagger:model FundingInitiateModel

func (*FundingInitiateModel) ContextValidate ¶ 

func (m *FundingInitiateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this funding initiate model based on context it is used

func (*FundingInitiateModel) MarshalBinary ¶ 

func (m *FundingInitiateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FundingInitiateModel) UnmarshalBinary ¶ 

func (m *FundingInitiateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FundingInitiateModel) Validate ¶ 

func (m *FundingInitiateModel) Validate(formats strfmt.Registry) error

Validate validates this funding initiate model

type FundingStatusModel ¶ 

type FundingStatusModel struct {

	// CompanyID
	CompanyID string `json:"companyID,omitempty"`

	// DocumentKey
	DocumentKey string `json:"documentKey,omitempty"`

	// DocumentName
	DocumentName string `json:"documentName,omitempty"`

	// DocumentType
	DocumentType string `json:"documentType,omitempty"`

	// Domain
	Domain string `json:"domain,omitempty"`

	// ErrorMessage
	ErrorMessage string `json:"errorMessage,omitempty"`

	// LastActivated
	// Format: date-time
	LastActivated strfmt.DateTime `json:"lastActivated,omitempty"`

	// LastPolled
	// Format: date-time
	LastPolled strfmt.DateTime `json:"lastPolled,omitempty"`

	// LastSigned
	// Format: date-time
	LastSigned strfmt.DateTime `json:"lastSigned,omitempty"`

	// MethodReturn
	// Example: {"javaScriptReady":false,"method":""}
	MethodReturn *FundingESignMethodReturn `json:"methodReturn,omitempty"`

	// Recipient
	Recipient string `json:"recipient,omitempty"`

	// The unique ID number of this funding request
	RequestID int64 `json:"requestId,omitempty"`

	// Sender
	Sender string `json:"sender,omitempty"`

	// Status
	Status string `json:"status,omitempty"`

	// SubledgerProfileID
	SubledgerProfileID int32 `json:"subledgerProfileID,omitempty"`

	// TemplateRequestId
	TemplateRequestID int64 `json:"templateRequestId,omitempty"`
}

FundingStatusModel Status of an Avalara Managed Returns funding configuration for a company Example: {"companyID":"123456","documentKey":"RTdIy3AAABLblqZhBCV9kul4F1qC -","documentName":"New Customer - Avalara Returns Funding Power of Attorney","documentType":"ACH","domain":"AvaTax15","lastActivated":"2016-01-01T19:16:17","lastPolled":"2016-01-01T20:16:17","methodReturn":{"javaScriptReady":false},"recipient":"bob@example.org","requestId":12345,"sender":"treasury@avalara.com","status":"Expired","subledgerProfileID":12345}

swagger:model FundingStatusModel

func (*FundingStatusModel) ContextValidate ¶ 

func (m *FundingStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this funding status model based on the context it is used

func (*FundingStatusModel) MarshalBinary ¶ 

func (m *FundingStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FundingStatusModel) UnmarshalBinary ¶ 

func (m *FundingStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FundingStatusModel) Validate ¶ 

func (m *FundingStatusModel) Validate(formats strfmt.Registry) error

Validate validates this funding status model

type HsCodeModel ¶ 

type HsCodeModel struct {

	// A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading.
	// Example: HSCode
	// Required: true
	Description *string `json:"description"`

	// The destination country identified with this HS Code.  This value applies when certain products are classified in specific ways by
	// bilateral trade agreements.
	// Example: US
	DestinationCountry string `json:"destinationCountry,omitempty"`

	// For codes that have been expired or defined on specific dates, this value indicates the earliest
	// date for which this code is considered valid.
	//
	// If this value is null, this code can be used for any valid date earlier than its end date.
	// Format: date
	EffDate strfmt.Date `json:"effDate,omitempty"`

	// For codes that have been expired or defined on specific dates, this value indicates the latest
	// date for which this code is considered valid.
	//
	// If this value is null, this code can be used for any valid date later than its effective date.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The harmonized tariff system code for this section and chapter.
	//
	// A full HS code contains more than six characters.  Partial HS codes with two, four, or six characters may have child codes underneath them.
	// A child code is one that contains greater specificity than a parent code.  It is recommended that when you identify a product you use
	// the most detailed code available to identify it.
	//
	// Top level sections do not have HS Codes.
	// Example: hsCode
	// Max Length: 25
	// Min Length: 0
	HsCode *string `json:"hsCode,omitempty"`

	// A unique identifier for this harmonized tariff system code.
	//
	// To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value.
	// Example: 12345
	// Required: true
	ID *int64 `json:"id"`

	// The unique ID number of the parent HS code or HS code prefix.
	//
	// To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value.
	// Example: 0
	ParentHsCodeID int64 `json:"parentHsCodeId,omitempty"`

	// The system to which this HS code belongs.
	// Example: system
	// Read Only: true
	System string `json:"system,omitempty"`
}

HsCodeModel Describes an element in the harmonized tariff system.

According to the [United States International Trade Commission](https://www.usitc.gov), the harmonized tariff schedule is defined as follows:

The HTS is a U.S. nomenclature system used to classify traded goods based on their material composition, product name, and/or intended function. The HTS is designed so that each article falls into only one category. It is divided into chapters, each of which has a 2-digit number. Each product category within the various chapters is designated by 4, 6, 8, or 10 digits. The 4-digit categories are called "headings." The 6-, 8- and 10-digit classifications are called "subheadings."

Within AvaTax, the `HsCodeModel` object can refer to sections, chapters, headings, subheadings, or articles. Each object represents one classification. Many of these objects have child objects underneath them; these child objects are more specific than their parent objects. Example: {"description":"HSCode","destinationCountry":"US","hsCode":"hsCode","id":12345,"parentHsCodeId":0,"system":"system"}

swagger:model HsCodeModel

func (*HsCodeModel) ContextValidate ¶ 

func (m *HsCodeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this hs code model based on the context it is used

func (*HsCodeModel) MarshalBinary ¶ 

func (m *HsCodeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*HsCodeModel) UnmarshalBinary ¶ 

func (m *HsCodeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*HsCodeModel) Validate ¶ 

func (m *HsCodeModel) Validate(formats strfmt.Registry) error

Validate validates this hs code model

type HsCodeModelFetchResult ¶ 

type HsCodeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*HsCodeModel `json:"value"`
}

HsCodeModelFetchResult hs code model fetch result

swagger:model HsCodeModelFetchResult

func (*HsCodeModelFetchResult) ContextValidate ¶ 

func (m *HsCodeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this hs code model fetch result based on the context it is used

func (*HsCodeModelFetchResult) MarshalBinary ¶ 

func (m *HsCodeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*HsCodeModelFetchResult) UnmarshalBinary ¶ 

func (m *HsCodeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*HsCodeModelFetchResult) Validate ¶ 

func (m *HsCodeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this hs code model fetch result

type InspectResponseModel ¶ 

type InspectResponseModel struct {

	// A list of determination factors for a line that is being inspected through the InspectLine API.
	// Example: [{"code":"NoNexus","description":"No tax was calculated because no nexus was declared in XYZ."}]
	DeterminationFactors []*DeterminationFactorModel `json:"determinationFactors"`
}

InspectResponseModel Response model used as output for InspectLine API. Example: {"determinationFactors":[{"code":"NoNexus","description":"No tax was calculated because no nexus was declared in XYZ."}]}

swagger:model InspectResponseModel

func (*InspectResponseModel) ContextValidate ¶ 

func (m *InspectResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this inspect response model based on the context it is used

func (*InspectResponseModel) MarshalBinary ¶ 

func (m *InspectResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InspectResponseModel) UnmarshalBinary ¶ 

func (m *InspectResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InspectResponseModel) Validate ¶ 

func (m *InspectResponseModel) Validate(formats strfmt.Registry) error

Validate validates this inspect response model

type InvoiceMessageModel ¶ 

type InvoiceMessageModel struct {

	// The content of the invoice message.
	// Example: Intra-EU Supply of Goods as per Art. 138 EU VAT Directive 2006/112
	Content string `json:"content,omitempty"`

	// The applicable tax line numbers and codes.
	// Example: ["1","2"]
	LineNumbers []string `json:"lineNumbers"`
}

InvoiceMessageModel Represents a message to be displayed on an invoice. Example: {"content":"Intra-EU Supply of Goods as per Art. 138 EU VAT Directive 2006/112","lineNumbers":["1","2"]}

swagger:model InvoiceMessageModel

func (*InvoiceMessageModel) ContextValidate ¶ 

func (m *InvoiceMessageModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this invoice message model based on context it is used

func (*InvoiceMessageModel) MarshalBinary ¶ 

func (m *InvoiceMessageModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InvoiceMessageModel) UnmarshalBinary ¶ 

func (m *InvoiceMessageModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InvoiceMessageModel) Validate ¶ 

func (m *InvoiceMessageModel) Validate(formats strfmt.Registry) error

Validate validates this invoice message model

type IsoCountryModel ¶ 

type IsoCountryModel struct {

	// Whether or not this country requires a region in postal addresses.
	// Example: false
	AddressesRequireRegion bool `json:"addressesRequireRegion,omitempty"`

	// The three character ISO 3166 country code
	Alpha3Code string `json:"alpha3Code,omitempty"`

	// The two character ISO 3166 country code
	// Example: FR
	Code string `json:"code,omitempty"`

	// True if this country is a member of the European Union
	// Example: true
	IsEuropeanUnion bool `json:"isEuropeanUnion,omitempty"`

	// A list of localized names in a variety of languages.
	//
	// This list is maintained by the International Standards Organization.
	LocalizedNames []*IsoLocalizedName `json:"localizedNames"`

	// The full name of this country in uppercase.
	//
	// For names in proper or formal case, or for names in other languages, please examine the `localizedNames` element for an appropriate name.
	// Example: France
	Name string `json:"name,omitempty"`
}

IsoCountryModel Represents an ISO 3166 recognized country Example: {"addressesRequireRegion":false,"code":"FR","isEuropeanUnion":true,"name":"France"}

swagger:model IsoCountryModel

func (*IsoCountryModel) ContextValidate ¶ 

func (m *IsoCountryModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this iso country model based on the context it is used

func (*IsoCountryModel) MarshalBinary ¶ 

func (m *IsoCountryModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IsoCountryModel) UnmarshalBinary ¶ 

func (m *IsoCountryModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IsoCountryModel) Validate ¶ 

func (m *IsoCountryModel) Validate(formats strfmt.Registry) error

Validate validates this iso country model

type IsoCountryModelFetchResult ¶ 

type IsoCountryModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*IsoCountryModel `json:"value"`
}

IsoCountryModelFetchResult iso country model fetch result

swagger:model IsoCountryModelFetchResult

func (*IsoCountryModelFetchResult) ContextValidate ¶ 

func (m *IsoCountryModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this iso country model fetch result based on the context it is used

func (*IsoCountryModelFetchResult) MarshalBinary ¶ 

func (m *IsoCountryModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IsoCountryModelFetchResult) UnmarshalBinary ¶ 

func (m *IsoCountryModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IsoCountryModelFetchResult) Validate ¶ 

func (m *IsoCountryModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this iso country model fetch result

type IsoLocalizedName ¶ 

type IsoLocalizedName struct {

	// The two-character alphanumeric code identifying the language in which this name is used.
	//
	// Note that languageAlpha2Code and language3AlphaCode refer to the same language.
	// Example: en
	LanguageAlpha2Code string `json:"languageAlpha2Code,omitempty"`

	// The three-character alphanumeric code identifying the language in which this name is used.
	//
	// Note that languageAlpha2Code and language3AlphaCode refer to the same language.
	// Example: eng
	LanguageAlpha3Code string `json:"languageAlpha3Code,omitempty"`

	// The name of this geographic entity as known in this language.
	// Example: United States
	Name string `json:"name,omitempty"`
}

IsoLocalizedName Represents a language-specific localized name of a particular geographic entity such as a country or a region. Example: {"languageAlpha2Code":"en","languageAlpha3Code":"eng","name":"United States"}

swagger:model IsoLocalizedName

func (*IsoLocalizedName) ContextValidate ¶ 

func (m *IsoLocalizedName) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this iso localized name based on context it is used

func (*IsoLocalizedName) MarshalBinary ¶ 

func (m *IsoLocalizedName) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IsoLocalizedName) UnmarshalBinary ¶ 

func (m *IsoLocalizedName) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IsoLocalizedName) Validate ¶ 

func (m *IsoLocalizedName) Validate(formats strfmt.Registry) error

Validate validates this iso localized name

type IsoRegionModel ¶ 

type IsoRegionModel struct {

	// The word in the local language that classifies what type of a region this represents
	// Example: State
	Classification string `json:"classification,omitempty"`

	// The three character ISO 3166 region code
	// Example: CA
	Code string `json:"code,omitempty"`

	// The two-character ISO 3166 country code this region belongs to
	// Example: US
	CountryCode string `json:"countryCode,omitempty"`

	// Whether the region collects tax or not. This field will be populated for US country only and will be null for all the other countries.
	IsRegionTaxable bool `json:"isRegionTaxable,omitempty"`

	// A list of localized names in a variety of languages.
	//
	// This list is maintained by the International Standards Organization.
	LocalizedNames []*IsoLocalizedName `json:"localizedNames"`

	// The full name, using localized characters, for this region, in uppercase.
	//
	// For names in proper or formal case, or for names in other languages, please examine the `localizedNames` element for an appropriate name.
	// Example: California
	Name string `json:"name,omitempty"`

	// For the United States, this flag indicates whether a U.S. State participates in the Streamlined
	// Sales Tax program.  For countries other than the US, this flag is null.
	StreamlinedSalesTax bool `json:"streamlinedSalesTax,omitempty"`
}

IsoRegionModel Represents a region, province, or state within a country Example: {"classification":"State","code":"CA","countryCode":"US","name":"California"}

swagger:model IsoRegionModel

func (*IsoRegionModel) ContextValidate ¶ 

func (m *IsoRegionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this iso region model based on the context it is used

func (*IsoRegionModel) MarshalBinary ¶ 

func (m *IsoRegionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IsoRegionModel) UnmarshalBinary ¶ 

func (m *IsoRegionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IsoRegionModel) Validate ¶ 

func (m *IsoRegionModel) Validate(formats strfmt.Registry) error

Validate validates this iso region model

type IsoRegionModelFetchResult ¶ 

type IsoRegionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*IsoRegionModel `json:"value"`
}

IsoRegionModelFetchResult iso region model fetch result

swagger:model IsoRegionModelFetchResult

func (*IsoRegionModelFetchResult) ContextValidate ¶ 

func (m *IsoRegionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this iso region model fetch result based on the context it is used

func (*IsoRegionModelFetchResult) MarshalBinary ¶ 

func (m *IsoRegionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*IsoRegionModelFetchResult) UnmarshalBinary ¶ 

func (m *IsoRegionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*IsoRegionModelFetchResult) Validate ¶ 

func (m *IsoRegionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this iso region model fetch result

type ItemBulkUploadInputModel ¶ 

type ItemBulkUploadInputModel struct {

	// List of items
	// Example: [{"companyId":0,"description":"Potato Chips","id":0,"itemCode":"CHIP1041","itemGroup":"Packaged Food","parameters":[{"id":0,"name":"ScreenSize","unit":"inch","value":"24"}],"taxCode":"PF051578"}]
	Items []*ItemModel `json:"items"`
}

ItemBulkUploadInputModel Represents a bulk upload input model. Example: {"items":[{"companyId":0,"description":"Potato Chips","id":0,"itemCode":"CHIP1041","itemGroup":"Packaged Food","parameters":[{"id":0,"name":"ScreenSize","unit":"inch","value":"24"}],"taxCode":"PF051578"}]}

swagger:model ItemBulkUploadInputModel

func (*ItemBulkUploadInputModel) ContextValidate ¶ 

func (m *ItemBulkUploadInputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item bulk upload input model based on the context it is used

func (*ItemBulkUploadInputModel) MarshalBinary ¶ 

func (m *ItemBulkUploadInputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemBulkUploadInputModel) UnmarshalBinary ¶ 

func (m *ItemBulkUploadInputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemBulkUploadInputModel) Validate ¶ 

func (m *ItemBulkUploadInputModel) Validate(formats strfmt.Registry) error

Validate validates this item bulk upload input model

type ItemBulkUploadOutputModel ¶ 

type ItemBulkUploadOutputModel struct {

	// Dictionary of object and respective list of errors
	// Example: [{"errors":["Please provide a value for field description."],"itemCode":"Item 4","rowIndex":5}]
	Failed []*ItemUploadErrorModel `json:"failed"`

	// Count of processed objects
	// Example: 35
	Total int32 `json:"total,omitempty"`
}

ItemBulkUploadOutputModel Represents a bulk upload response model. Example: {"failed":[{"errors":["Please provide a value for field description."],"itemCode":"Item 4","rowIndex":5}],"total":35}

swagger:model ItemBulkUploadOutputModel

func (*ItemBulkUploadOutputModel) ContextValidate ¶ 

func (m *ItemBulkUploadOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item bulk upload output model based on the context it is used

func (*ItemBulkUploadOutputModel) MarshalBinary ¶ 

func (m *ItemBulkUploadOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemBulkUploadOutputModel) UnmarshalBinary ¶ 

func (m *ItemBulkUploadOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemBulkUploadOutputModel) Validate ¶ 

func (m *ItemBulkUploadOutputModel) Validate(formats strfmt.Registry) error

Validate validates this item bulk upload output model

type ItemClassificationInputModel ¶ 

type ItemClassificationInputModel struct {

	// The product code of an item in a given system.
	// Example: 9011900000
	// Required: true
	// Max Length: 50
	// Min Length: 0
	ProductCode *string `json:"productCode"`

	// The system code in which the product belongs.
	// Example: TARIC
	// Max Length: 50
	// Min Length: 0
	SystemCode *string `json:"systemCode,omitempty"`
}

ItemClassificationInputModel Product classification input model. Example: {"productCode":"9011900000","systemCode":"TARIC"}

swagger:model ItemClassificationInputModel

func (*ItemClassificationInputModel) ContextValidate ¶ 

func (m *ItemClassificationInputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this item classification input model based on context it is used

func (*ItemClassificationInputModel) MarshalBinary ¶ 

func (m *ItemClassificationInputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemClassificationInputModel) UnmarshalBinary ¶ 

func (m *ItemClassificationInputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemClassificationInputModel) Validate ¶ 

func (m *ItemClassificationInputModel) Validate(formats strfmt.Registry) error

Validate validates this item classification input model

type ItemClassificationOutputModel ¶ 

type ItemClassificationOutputModel struct {

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

	// The unique ID number of the item this product belongs to.
	// Example: 891267
	ItemID int64 `json:"itemId,omitempty"`

	// A unique code representing this item.
	// Example: 001048015838
	ProductCode string `json:"productCode,omitempty"`

	// A unique code representing this item.
	// Example: HTS
	SystemCode string `json:"systemCode,omitempty"`

	// The system id which the product belongs.
	// Example: 1
	SystemID int32 `json:"systemId,omitempty"`
}

ItemClassificationOutputModel Product classification output model. Example: {"id":791,"itemId":891267,"productCode":"001048015838","systemCode":"HTS","systemId":1}

swagger:model ItemClassificationOutputModel

func (*ItemClassificationOutputModel) ContextValidate ¶ 

func (m *ItemClassificationOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this item classification output model based on context it is used

func (*ItemClassificationOutputModel) MarshalBinary ¶ 

func (m *ItemClassificationOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemClassificationOutputModel) UnmarshalBinary ¶ 

func (m *ItemClassificationOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemClassificationOutputModel) Validate ¶ 

func (m *ItemClassificationOutputModel) Validate(formats strfmt.Registry) error

Validate validates this item classification output model

type ItemClassificationOutputModelFetchResult ¶ 

type ItemClassificationOutputModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ItemClassificationOutputModel `json:"value"`
}

ItemClassificationOutputModelFetchResult item classification output model fetch result

swagger:model ItemClassificationOutputModelFetchResult

func (*ItemClassificationOutputModelFetchResult) ContextValidate ¶ 

func (m *ItemClassificationOutputModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item classification output model fetch result based on the context it is used

func (*ItemClassificationOutputModelFetchResult) MarshalBinary ¶ 

func (m *ItemClassificationOutputModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemClassificationOutputModelFetchResult) UnmarshalBinary ¶ 

func (m *ItemClassificationOutputModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemClassificationOutputModelFetchResult) Validate ¶ 

func (m *ItemClassificationOutputModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this item classification output model fetch result

type ItemModel ¶ 

type ItemModel struct {

	// A category of product
	// Example: Home \u003e Kitchen \u003e Mugs
	// Max Length: 4000
	// Min Length: 0
	Category *string `json:"category,omitempty"`

	// List of classifications that belong to this item.
	// A single classification consits of a productCode and a systemCode for a particular item.
	// Example: [{"productCode":"9011900000","systemCode":"TARIC"}]
	Classifications []*ClassificationModel `json:"classifications"`

	// The unique ID number of the company that owns this item.
	// Example: 12345
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A friendly description of this item in your product catalog.
	// Example: Ceramic Mug
	// Required: true
	// Max Length: 255
	// Min Length: 0
	Description *string `json:"description"`

	// The unique ID number of this item.
	// Example: 56789
	// Required: true
	ID *int64 `json:"id"`

	// A unique code representing this item.
	// Example: CERMUG
	// Required: true
	// Max Length: 50
	// Min Length: 0
	ItemCode *string `json:"itemCode"`

	// A way to group similar items.
	// Example: Mugs
	// Max Length: 50
	// Min Length: 0
	ItemGroup *string `json:"itemGroup,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// List of item parameters.
	Parameters []*ItemParameterModel `json:"parameters"`

	// List of item tags.
	Tags []*ItemTagDetailModel `json:"tags"`

	// DEPRECATED - Date: 11/13/2018, Version: 18.12, Message: For identifying an `Item` with `Avalara TaxCode`, please call the [CreateItemClassification API] with your ItemCode and the Avalara TaxCode.
	// The unique code string of the Tax Code that is applied when selling this item.
	// When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values.
	// Example: P0000000
	// Max Length: 25
	// Min Length: 0
	TaxCode *string `json:"taxCode,omitempty"`

	// DEPRECATED - Date: 11/13/2018, Version: 18.12, Message: For identifying an `Item` with `Avalara TaxCode`, please call the [CreateItemClassification API] with your ItemCode and the Avalara TaxCode.
	// The unique ID number of the tax code that is applied when selling this item.
	// When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values.
	TaxCodeID int32 `json:"taxCodeId,omitempty"`
}

ItemModel Represents an item in your company's product catalog. Example: {"category":"Home \u003e Kitchen \u003e Mugs","classifications":[{"productCode":"9011900000","systemCode":"TARIC"}],"companyId":12345,"description":"Ceramic Mug","id":56789,"itemCode":"CERMUG","itemGroup":"Mugs","taxCode":"P0000000"}

swagger:model ItemModel

func (*ItemModel) ContextValidate ¶ 

func (m *ItemModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item model based on the context it is used

func (*ItemModel) MarshalBinary ¶ 

func (m *ItemModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemModel) UnmarshalBinary ¶ 

func (m *ItemModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemModel) Validate ¶ 

func (m *ItemModel) Validate(formats strfmt.Registry) error

Validate validates this item model

type ItemModelFetchResult ¶ 

type ItemModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ItemModel `json:"value"`
}

ItemModelFetchResult item model fetch result

swagger:model ItemModelFetchResult

func (*ItemModelFetchResult) ContextValidate ¶ 

func (m *ItemModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item model fetch result based on the context it is used

func (*ItemModelFetchResult) MarshalBinary ¶ 

func (m *ItemModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemModelFetchResult) UnmarshalBinary ¶ 

func (m *ItemModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemModelFetchResult) Validate ¶ 

func (m *ItemModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this item model fetch result

type ItemParameterModel ¶ 

type ItemParameterModel struct {

	// The id of the parameter.
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// This field identifies if parameter is needed for calculation
	// Read Only: true
	IsNeededForCalculation *bool `json:"isNeededForCalculation,omitempty"`

	// This field identifies if parameter is needed for classification
	// Read Only: true
	IsNeededForClassification *bool `json:"isNeededForClassification,omitempty"`

	// This field identifies if parameter is needed for returns
	// Read Only: true
	IsNeededForReturns *bool `json:"isNeededForReturns,omitempty"`

	// The item id
	ItemID int64 `json:"itemId,omitempty"`

	// The parameter's name.
	// Example: ScreenSize
	// Required: true
	Name *string `json:"name"`

	// The unit of measurement code for the parameter.
	// Example: inch
	Unit string `json:"unit,omitempty"`

	// The value for the parameter.
	// Example: 24
	// Required: true
	Value *string `json:"value"`
}

ItemParameterModel Represents a parameter associated with an item. Example: {"id":0,"name":"ScreenSize","unit":"inch","value":"24"}

swagger:model ItemParameterModel

func (*ItemParameterModel) ContextValidate ¶ 

func (m *ItemParameterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item parameter model based on the context it is used

func (*ItemParameterModel) MarshalBinary ¶ 

func (m *ItemParameterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemParameterModel) UnmarshalBinary ¶ 

func (m *ItemParameterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemParameterModel) Validate ¶ 

func (m *ItemParameterModel) Validate(formats strfmt.Registry) error

Validate validates this item parameter model

type ItemParameterModelFetchResult ¶ 

type ItemParameterModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ItemParameterModel `json:"value"`
}

ItemParameterModelFetchResult item parameter model fetch result

swagger:model ItemParameterModelFetchResult

func (*ItemParameterModelFetchResult) ContextValidate ¶ 

func (m *ItemParameterModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item parameter model fetch result based on the context it is used

func (*ItemParameterModelFetchResult) MarshalBinary ¶ 

func (m *ItemParameterModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemParameterModelFetchResult) UnmarshalBinary ¶ 

func (m *ItemParameterModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemParameterModelFetchResult) Validate ¶ 

func (m *ItemParameterModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this item parameter model fetch result

type ItemSyncModel ¶ 

type ItemSyncModel struct {

	// A friendly description of the item. If your company has enrolled in Streamlined Sales Tax, this description must be auditable.
	// Example: Potato Chips
	// Required: true
	Description *string `json:"description"`

	// A unique code representing this item.
	// Example: CHIP1041
	// Required: true
	ItemCode *string `json:"itemCode"`

	// A group to which the item belongs.
	// Example: Packaged Food
	ItemGroup string `json:"itemGroup,omitempty"`

	// The tax code of the item (optional)
	// Example: PF051578
	TaxCode string `json:"taxCode,omitempty"`
}

ItemSyncModel An abridged item model used for syncing product catalogs with AvaTax. Example: {"description":"Potato Chips","itemCode":"CHIP1041","itemGroup":"Packaged Food","taxCode":"PF051578"}

swagger:model ItemSyncModel

func (*ItemSyncModel) ContextValidate ¶ 

func (m *ItemSyncModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this item sync model based on context it is used

func (*ItemSyncModel) MarshalBinary ¶ 

func (m *ItemSyncModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemSyncModel) UnmarshalBinary ¶ 

func (m *ItemSyncModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemSyncModel) Validate ¶ 

func (m *ItemSyncModel) Validate(formats strfmt.Registry) error

Validate validates this item sync model

type ItemTagDetailModel ¶ 

type ItemTagDetailModel struct {

	// The unique ID number of the company that owns this item.
	// Example: 8010687
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Example: 0001-01-01T00:00:00
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The unique ID number of this item.
	// Example: 151284220
	ItemID int64 `json:"itemId,omitempty"`

	// The unique ID number of the item-tag relation.
	// Example: 51
	// Read Only: true
	ItemTagDetailID int32 `json:"itemTagDetailId,omitempty"`

	// The unique tag Id for the tags.
	// Read Only: true
	TagID int32 `json:"tagId,omitempty"`

	// The tag name.
	// Example: CLASSIFICATION_INITIATIONERROR
	// Required: true
	TagName *string `json:"tagName"`
}

ItemTagDetailModel Represents a tag for an item in your company's product catalog. Example: {"companyId":8010687,"createdDate":"0001-01-01T00:00:00","itemId":151284220,"itemTagDetailId":51,"tagName":"CLASSIFICATION_INITIATIONERROR"}

swagger:model ItemTagDetailModel

func (*ItemTagDetailModel) ContextValidate ¶ 

func (m *ItemTagDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item tag detail model based on the context it is used

func (*ItemTagDetailModel) MarshalBinary ¶ 

func (m *ItemTagDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemTagDetailModel) UnmarshalBinary ¶ 

func (m *ItemTagDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemTagDetailModel) Validate ¶ 

func (m *ItemTagDetailModel) Validate(formats strfmt.Registry) error

Validate validates this item tag detail model

type ItemTagDetailModelFetchResult ¶ 

type ItemTagDetailModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ItemTagDetailModel `json:"value"`
}

ItemTagDetailModelFetchResult item tag detail model fetch result

swagger:model ItemTagDetailModelFetchResult

func (*ItemTagDetailModelFetchResult) ContextValidate ¶ 

func (m *ItemTagDetailModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this item tag detail model fetch result based on the context it is used

func (*ItemTagDetailModelFetchResult) MarshalBinary ¶ 

func (m *ItemTagDetailModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemTagDetailModelFetchResult) UnmarshalBinary ¶ 

func (m *ItemTagDetailModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemTagDetailModelFetchResult) Validate ¶ 

func (m *ItemTagDetailModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this item tag detail model fetch result

type ItemUploadErrorModel ¶ 

type ItemUploadErrorModel struct {

	// List of errors for against given item code
	Errors []string `json:"errors"`

	// Item code
	ItemCode string `json:"itemCode,omitempty"`

	// Row index of an item
	RowIndex int32 `json:"rowIndex,omitempty"`
}

ItemUploadErrorModel Represents a item upload error model.

swagger:model ItemUploadErrorModel

func (*ItemUploadErrorModel) ContextValidate ¶ 

func (m *ItemUploadErrorModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this item upload error model based on context it is used

func (*ItemUploadErrorModel) MarshalBinary ¶ 

func (m *ItemUploadErrorModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ItemUploadErrorModel) UnmarshalBinary ¶ 

func (m *ItemUploadErrorModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ItemUploadErrorModel) Validate ¶ 

func (m *ItemUploadErrorModel) Validate(formats strfmt.Registry) error

Validate validates this item upload error model

type JurisdictionModel ¶ 

type JurisdictionModel struct {

	// The city name of this jurisdiction
	City string `json:"city,omitempty"`

	// The code that is used to identify this jurisdiction
	// Example: 53
	// Required: true
	Code *string `json:"code"`

	// Name or ISO 3166 code identifying the country of this jurisdiction.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	Country string `json:"country,omitempty"`

	// The county name of this jurisdiction
	County string `json:"county,omitempty"`

	// County FIPS code
	CountyFips string `json:"countyFips,omitempty"`

	// The date this jurisdiction starts to take effect on tax calculations
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// The date this jurisdiction stops to take effect on tax calculations
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Unique AvaTax Id of this Jurisdiction
	ID int32 `json:"id,omitempty"`

	// The name of this jurisdiction
	// Example: WASHINGTON
	// Required: true
	Name *string `json:"name"`

	// City FIPS code
	PlaceFips string `json:"placeFips,omitempty"`

	// The base rate of tax specific to this jurisdiction.
	// Example: 0.06
	Rate float64 `json:"rate,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: WA
	Region string `json:"region,omitempty"`

	// The "Sales" tax rate specific to this jurisdiction.
	// Example: 0.06
	SalesRate float64 `json:"salesRate,omitempty"`

	// A short name of the jurisidiction
	ShortName string `json:"shortName,omitempty"`

	// The Avalara-supplied signature code for this jurisdiction.
	// Required: true
	SignatureCode *string `json:"signatureCode"`

	// State FIPS code
	StateFips string `json:"stateFips,omitempty"`

	// The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
	// Example: Country
	// Required: true
	// Enum: [Country State County City Special]
	Type *string `json:"type"`

	// The "Seller's Use" tax rate specific to this jurisdiction.
	// Example: 0.06
	UseRate float64 `json:"useRate,omitempty"`
}

JurisdictionModel Represents information about a single legal taxing jurisdiction Example: {"code":"53","name":"WASHINGTON","rate":0.06,"region":"WA","salesRate":0.06,"signatureCode":"","type":"State","useRate":0.06}

swagger:model JurisdictionModel

func (*JurisdictionModel) ContextValidate ¶ 

func (m *JurisdictionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this jurisdiction model based on context it is used

func (*JurisdictionModel) MarshalBinary ¶ 

func (m *JurisdictionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JurisdictionModel) UnmarshalBinary ¶ 

func (m *JurisdictionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JurisdictionModel) Validate ¶ 

func (m *JurisdictionModel) Validate(formats strfmt.Registry) error

Validate validates this jurisdiction model

type JurisdictionModelFetchResult ¶ 

type JurisdictionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*JurisdictionModel `json:"value"`
}

JurisdictionModelFetchResult jurisdiction model fetch result

swagger:model JurisdictionModelFetchResult

func (*JurisdictionModelFetchResult) ContextValidate ¶ 

func (m *JurisdictionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this jurisdiction model fetch result based on the context it is used

func (*JurisdictionModelFetchResult) MarshalBinary ¶ 

func (m *JurisdictionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JurisdictionModelFetchResult) UnmarshalBinary ¶ 

func (m *JurisdictionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JurisdictionModelFetchResult) Validate ¶ 

func (m *JurisdictionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this jurisdiction model fetch result

type JurisdictionOverrideModel ¶ 

type JurisdictionOverrideModel struct {

	// The unique ID number assigned to this account.
	// Example: 0
	AccountID int32 `json:"accountId,omitempty"`

	// The boundary level of this override
	// Example: Address
	// Read Only: true
	// Enum: [Address Zip9 Zip5]
	BoundaryLevel string `json:"boundaryLevel,omitempty"`

	// The city address of the physical location affected by this override.
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// The two character ISO-3166 country code of the country affected by this override.
	//
	// Note that only United States addresses are affected by the jurisdiction override system.
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Example: 0
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A description of why this jurisdiction override was created.
	// Example: a test JO
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Description *string `json:"description"`

	// The date when this override first takes effect.  Set this value to null to affect all dates up to the end date.
	// Example: 2006-08-01T00:00:00
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The date when this override will cease to take effect.  Set this value to null to never expire.
	// Example: 2099-01-12T00:00:00
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The unique ID number of this override.
	// Example: 0
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// True if this is a default boundary
	IsDefault bool `json:"isDefault,omitempty"`

	// A list of the tax jurisdictions that will be assigned to this overridden address.
	// Required: true
	Jurisdictions []*JurisdictionModel `json:"jurisdictions"`

	// The street address of the physical location affected by this override.
	// Example: 5500 Irvine Center Dr
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Example: 0
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The postal code of the physical location affected by this override.
	// Example: 92618
	// Required: true
	// Max Length: 11
	// Min Length: 0
	PostalCode *string `json:"postalCode"`

	// Name or ISO 3166 code identifying the region within the country to be affected by this override.
	//
	// Note that only United States addresses are affected by the jurisdiction override system.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	// Required: true
	Region *string `json:"region"`

	// The TaxRegionId of the new location affected by this jurisdiction override.
	// Example: 0
	// Required: true
	TaxRegionID *int32 `json:"taxRegionId"`
}

JurisdictionOverrideModel Represents an override of tax jurisdictions for a specific address.

During the time period represented by EffDate through EndDate, all tax decisions for addresses matching this override object will be assigned to the list of jurisdictions designated in this object. Example: {"accountId":0,"boundaryLevel":"Address","city":"Irvine","country":"US","description":"a test JO","effectiveDate":"2006-08-01","endDate":"2099-01-12","id":0,"isDefault":false,"jurisdictions":[{"code":"53","name":"WASHINGTON","rate":0.06,"region":"WA","salesRate":0.06,"signatureCode":"","type":"State","useRate":0.06}],"line1":"5500 Irvine Center Dr","postalCode":"92618","region":"CA","taxRegionId":0}

swagger:model JurisdictionOverrideModel

func (*JurisdictionOverrideModel) ContextValidate ¶ 

func (m *JurisdictionOverrideModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this jurisdiction override model based on the context it is used

func (*JurisdictionOverrideModel) MarshalBinary ¶ 

func (m *JurisdictionOverrideModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JurisdictionOverrideModel) UnmarshalBinary ¶ 

func (m *JurisdictionOverrideModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JurisdictionOverrideModel) Validate ¶ 

func (m *JurisdictionOverrideModel) Validate(formats strfmt.Registry) error

Validate validates this jurisdiction override model

type JurisdictionOverrideModelFetchResult ¶ 

type JurisdictionOverrideModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*JurisdictionOverrideModel `json:"value"`
}

JurisdictionOverrideModelFetchResult jurisdiction override model fetch result

swagger:model JurisdictionOverrideModelFetchResult

func (*JurisdictionOverrideModelFetchResult) ContextValidate ¶ 

func (m *JurisdictionOverrideModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this jurisdiction override model fetch result based on the context it is used

func (*JurisdictionOverrideModelFetchResult) MarshalBinary ¶ 

func (m *JurisdictionOverrideModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JurisdictionOverrideModelFetchResult) UnmarshalBinary ¶ 

func (m *JurisdictionOverrideModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JurisdictionOverrideModelFetchResult) Validate ¶ 

func (m *JurisdictionOverrideModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this jurisdiction override model fetch result

type JurisdictionRateTypeTaxTypeMappingModel ¶ 

type JurisdictionRateTypeTaxTypeMappingModel struct {

	// Name or ISO 3166 code identifying the country of this jurisdiction.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// The date this jurisdiction starts to take effect on tax calculations
	// Example: 2021-12-25T17:08:40.6925111+00:00
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// The date this jurisdiction stops to take effect on tax calculations
	// Example: 2022-12-25T17:08:40.692535+00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// The unique ID number of this Jurisdiction RateType TaxType Mapping.
	// Example: 0
	ID int32 `json:"id,omitempty"`

	// Jurisdiction Code
	// Example: 01
	JurisdictionCode string `json:"jurisdictionCode,omitempty"`

	// Jurisdiction TypeId
	// Example: STA
	JurisdictionType string `json:"jurisdictionType,omitempty"`

	// Jurisdiction long name
	// Example: ALABAMA
	LongName string `json:"longName,omitempty"`

	// Rate Type to which this jurisdiction is applicable
	// Example: G
	RateTypeID string `json:"rateTypeId,omitempty"`

	// Name or ISO 3166 code identifying the region of this jurisdiction.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: AL
	State string `json:"state,omitempty"`

	// Tax Type to which this jurisdiction is applicable
	// Example: S
	TaxSubTypeID string `json:"taxSubTypeId,omitempty"`

	// Tax Type Group to which this jurisdiction is applicable
	// Example: SalesAndUse
	TaxTypeGroupID string `json:"taxTypeGroupId,omitempty"`

	// Tax Type to which this jurisdiction is applicable
	// Example: S
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

JurisdictionRateTypeTaxTypeMappingModel Represents a Jurisdiction with applicable TaxType, TaxSubType and RateType. Example: {"country":"US","effectiveDate":"2021-12-25T17:08:40.6925111+00:00","endDate":"2022-12-25T17:08:40.692535+00:00","id":0,"jurisdictionCode":"01","jurisdictionType":"STA","longName":"ALABAMA","rateTypeId":"G","state":"AL","taxSubTypeId":"S","taxTypeGroupId":"SalesAndUse","taxTypeId":"S"}

swagger:model JurisdictionRateTypeTaxTypeMappingModel

func (*JurisdictionRateTypeTaxTypeMappingModel) ContextValidate ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this jurisdiction rate type tax type mapping model based on context it is used

func (*JurisdictionRateTypeTaxTypeMappingModel) MarshalBinary ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JurisdictionRateTypeTaxTypeMappingModel) UnmarshalBinary ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JurisdictionRateTypeTaxTypeMappingModel) Validate ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModel) Validate(formats strfmt.Registry) error

Validate validates this jurisdiction rate type tax type mapping model

type JurisdictionRateTypeTaxTypeMappingModelFetchResult ¶ 

type JurisdictionRateTypeTaxTypeMappingModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*JurisdictionRateTypeTaxTypeMappingModel `json:"value"`
}

JurisdictionRateTypeTaxTypeMappingModelFetchResult jurisdiction rate type tax type mapping model fetch result

swagger:model JurisdictionRateTypeTaxTypeMappingModelFetchResult

func (*JurisdictionRateTypeTaxTypeMappingModelFetchResult) ContextValidate ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this jurisdiction rate type tax type mapping model fetch result based on the context it is used

func (*JurisdictionRateTypeTaxTypeMappingModelFetchResult) MarshalBinary ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JurisdictionRateTypeTaxTypeMappingModelFetchResult) UnmarshalBinary ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JurisdictionRateTypeTaxTypeMappingModelFetchResult) Validate ¶ 

func (m *JurisdictionRateTypeTaxTypeMappingModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this jurisdiction rate type tax type mapping model fetch result

type LicenseKeyModel ¶ 

type LicenseKeyModel struct {

	// The primary key of the account
	// Example: 123456789
	AccountID int32 `json:"accountId,omitempty"`

	// If your software allows you to specify the HTTP Authorization header directly, this is the header string you
	// should use when contacting Avalara to make API calls with this license key.
	// Example: Basic MTIzNDU2Nzg5Ojc0MkEwMkFBNDYzQ0RFNzQxRTkzMkVDMzY1MzYwQ0EzQ0YzNzhCRDk=
	HTTPRequestHeader string `json:"httpRequestHeader,omitempty"`

	// This is your private license key.  You must record this license key for safekeeping.
	// If you lose this key, you must contact the ResetLicenseKey API in order to request a new one.
	// Each account can only have one license key at a time.
	// Example: 742A02AA463CDE741E932EC365360CA3CF378BD9
	PrivateLicenseKey string `json:"privateLicenseKey,omitempty"`
}

LicenseKeyModel Represents a license key for this account. Example: {"accountId":123456789,"httpRequestHeader":"Basic MTIzNDU2Nzg5Ojc0MkEwMkFBNDYzQ0RFNzQxRTkzMkVDMzY1MzYwQ0EzQ0YzNzhCRDk=","privateLicenseKey":"742A02AA463CDE741E932EC365360CA3CF378BD9"}

swagger:model LicenseKeyModel

func (*LicenseKeyModel) ContextValidate ¶ 

func (m *LicenseKeyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this license key model based on context it is used

func (*LicenseKeyModel) MarshalBinary ¶ 

func (m *LicenseKeyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LicenseKeyModel) UnmarshalBinary ¶ 

func (m *LicenseKeyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LicenseKeyModel) Validate ¶ 

func (m *LicenseKeyModel) Validate(formats strfmt.Registry) error

Validate validates this license key model

type LineItemModel ¶ 

type LineItemModel struct {

	// The addresses to use for this transaction line.
	//
	// If you set this value to `null`, or if you omit this element from your API call, then instead the transaction
	// will use the `addresses` from the document level.
	//
	// If you specify any other value besides `null`, only addresses specified for this line will be used for this line.
	// Example: {"shipFrom":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"},"shipTo":{"city":"Seattle","country":"US","line1":"1100 2nd Ave","postalCode":"98101","region":"WA"}}
	Addresses *AddressesModel `json:"addresses,omitempty"`

	// Total amount for this line.  The amount represents the net currency value that changed hands from the customer (represented by the `customerCode` field) to the company (represented by the `companyCode`) field.
	//
	// For sale transactions, this value must be positive.  It indicates the amount of money paid by the customer to the company.
	//
	// For refund or return transactions, this value must be negative.
	// Example: 100
	// Required: true
	Amount *float64 `json:"amount"`

	// VAT business identification number for the customer for this line item.  If you leave this field empty,
	// this line item will use whatever business identification number you provided at the transaction level.
	//
	// If you specify a VAT business identification number for the customer in this transaction and you have also set up
	// a business identification number for your company during company setup, this transaction will be treated as a
	// business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
	// Max Length: 25
	// Min Length: 0
	BusinessIdentificationNo *string `json:"businessIdentificationNo,omitempty"`

	// Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “.  Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.
	// Max Length: 4000
	// Min Length: 0
	Category *string `json:"category,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
	//
	// Max Length: 25
	// Min Length: 0
	CustomerUsageType *string `json:"customerUsageType,omitempty"`

	// Item description.
	//
	// For Streamlined Sales Tax (SST) customers, this field is required if an unmapped `itemCode` is used.
	// Example: Yarn
	// Max Length: 2096
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// True if the document discount should be applied to this line.  If this value is false, or not provided, discounts will not be
	// applied to this line even if they are specified on the root `discount` element.
	Discounted bool `json:"discounted,omitempty"`

	// Entity Use Code - The client application customer or usage type.  This field allows you to designate a type of usage that
	// may make this transaction considered exempt by reason of exempt usage.
	//
	// For a list of entity use codes, see the Definitions API `ListEntityUseCodes`.
	// Max Length: 25
	// Min Length: 0
	EntityUseCode *string `json:"entityUseCode,omitempty"`

	// The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable
	// ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service
	// will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request,
	// and will perform exemption processing using either of those two options.
	// Note: This is same as 'exemptNo' in TransactionModel.
	ExemptionCode string `json:"exemptionCode,omitempty"`

	// The Item code for Custom Duty / Global Import tax determination
	// Harmonized Tariff System code for this transaction.
	//
	// For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.
	// Max Length: 25
	// Min Length: 0
	HsCode *string `json:"hsCode,omitempty"`

	// Item Code (SKU).  If you provide an `itemCode` field, the AvaTax API will look up the item you created with the `CreateItems` API call
	// and use all the information available about that item for this transaction.
	// Example: Y0001
	// Max Length: 50
	// Min Length: 0
	ItemCode *string `json:"itemCode,omitempty"`

	// This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.
	// Example: Marketplace
	// Enum: [Marketplace Seller]
	MarketplaceLiabilityType string `json:"marketplaceLiabilityType,omitempty"`

	// DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead.
	// ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
	MerchantSellerID int64 `json:"merchantSellerId,omitempty"`

	// ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
	// Max Length: 100
	// Min Length: 0
	MerchantSellerIdentifier *string `json:"merchantSellerIdentifier,omitempty"`

	// The line number of this line within the document.  This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.
	// Example: 1
	// Max Length: 50
	// Min Length: 0
	Number *string `json:"number,omitempty"`

	// The transaction's original ID in its origination system
	// Max Length: 50
	// Min Length: 0
	OriginationDocumentID *string `json:"originationDocumentId,omitempty"`

	// Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.
	// Max Length: 60
	// Min Length: 0
	OriginationSite *string `json:"originationSite,omitempty"`

	// Special parameters that apply to this line within this transaction.
	//
	// To get a full list of available parameters, please use the `ListParameters` API.
	Parameters []*TransactionLineParameterModel `json:"parameters"`

	// Quantity of items in this line.  This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds.
	//
	// If not provided, or if set to zero, the quantity value is assumed to be one (1).
	// Example: 1
	Quantity float64 `json:"quantity,omitempty"`

	// Ref1 (Customer Defined Field)
	//
	// This field is available for you to use to provide whatever information your implementation requires.  It does not affect tax calculation.
	// Max Length: 250
	// Min Length: 0
	Ref1 *string `json:"ref1,omitempty"`

	// Ref2 (Customer Defined Field)
	//
	// This field is available for you to use to provide whatever information your implementation requires.  It does not affect tax calculation.
	// Max Length: 250
	// Min Length: 0
	Ref2 *string `json:"ref2,omitempty"`

	// Revenue Account (Customer Defined Field).
	//
	// This field is available for you to use to provide whatever information your implementation requires.  It does not affect tax calculation.
	// Max Length: 50
	// Min Length: 0
	RevenueAccount *string `json:"revenueAccount,omitempty"`

	// A long description of the product.
	// Max Length: 4000
	// Min Length: 0
	Summary *string `json:"summary,omitempty"`

	// Tax Code - System or Custom Tax Code.
	//
	// You can use your own tax code mapping or standard Avalara tax codes.  For a full list of tax codes, see `ListTaxCodes`.
	// Example: PS081282
	// Max Length: 25
	// Min Length: 0
	TaxCode *string `json:"taxCode,omitempty"`

	// Indicates whether the `amount` for this line already includes tax.
	//
	// If this value is `true`, the final price of this line including tax will equal the value in `amount`.
	//
	// If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line.
	TaxIncluded bool `json:"taxIncluded,omitempty"`

	// Specifies a tax override for this line.
	// Example: {"reason":"Precalculated Tax","taxAmount":6.25,"taxDate":"2021-12-25","type":"TaxAmount"}
	TaxOverride *TaxOverrideModel `json:"taxOverride,omitempty"`

	// Custom user fields/flex fields for this line.
	UserDefinedFields []*TransactionLineUserDefinedFieldModel `json:"userDefinedFields"`
}

LineItemModel Represents one line item in a transaction Example: {"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}

swagger:model LineItemModel

func (*LineItemModel) ContextValidate ¶ 

func (m *LineItemModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this line item model based on the context it is used

func (*LineItemModel) MarshalBinary ¶ 

func (m *LineItemModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LineItemModel) UnmarshalBinary ¶ 

func (m *LineItemModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LineItemModel) Validate ¶ 

func (m *LineItemModel) Validate(formats strfmt.Registry) error

Validate validates this line item model

type LinkCertificatesModel ¶ 

type LinkCertificatesModel struct {

	// An array of certificate ID numbers to link
	// Example: [1,3]
	// Required: true
	Certificates []int32 `json:"certificates"`
}

LinkCertificatesModel Represents a customer to whom you sell products and/or services. Example: {"certificates":[1,3]}

swagger:model LinkCertificatesModel

func (*LinkCertificatesModel) ContextValidate ¶ 

func (m *LinkCertificatesModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this link certificates model based on context it is used

func (*LinkCertificatesModel) MarshalBinary ¶ 

func (m *LinkCertificatesModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LinkCertificatesModel) UnmarshalBinary ¶ 

func (m *LinkCertificatesModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LinkCertificatesModel) Validate ¶ 

func (m *LinkCertificatesModel) Validate(formats strfmt.Registry) error

Validate validates this link certificates model

type LinkCustomersModel ¶ 

type LinkCustomersModel struct {

	// An array of customerCodes that are exempted by this certificate
	// Example: ["123456789"]
	Customers []string `json:"customers"`
}

LinkCustomersModel Represents a customer to whom you sell products and/or services. Example: {"customers":["123456789"]}

swagger:model LinkCustomersModel

func (*LinkCustomersModel) ContextValidate ¶ 

func (m *LinkCustomersModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this link customers model based on context it is used

func (*LinkCustomersModel) MarshalBinary ¶ 

func (m *LinkCustomersModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LinkCustomersModel) UnmarshalBinary ¶ 

func (m *LinkCustomersModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LinkCustomersModel) Validate ¶ 

func (m *LinkCustomersModel) Validate(formats strfmt.Registry) error

Validate validates this link customers model

type LocationModel ¶ 

type LocationModel struct {

	// Indicates the type of place of business represented by this location.
	// Example: Storefront
	// Required: true
	// Enum: [Storefront MainOffice Warehouse Salesperson Other SellerRemitsTax MarketplaceRemitsTax NonPhysical]
	AddressCategoryID *string `json:"addressCategoryId"`

	// Indicates whether this location is a physical place of business or a temporary salesperson location.
	// Example: Location
	// Required: true
	// Enum: [Location Salesperson Marketplace]
	AddressTypeID *string `json:"addressTypeId"`

	// The city of the physical address of this location.
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// The unique ID number of the company that operates at this location.
	// Example: 12345
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// Name or ISO 3166 code identifying the country of the physical address of this location.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// The county name of the physical address of this location.  Not required.
	// Example: Orange
	// Max Length: 50
	// Min Length: 0
	County *string `json:"county,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.
	// Example: Bob's Artisan Pottery
	// Max Length: 100
	// Min Length: 0
	DbaName *string `json:"dbaName,omitempty"`

	// A friendly name for this location.
	// Example: Bob's Artisan Pottery
	// Max Length: 255
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// The date when this location was opened for business, or null if not known.
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// If this place of business has closed, the date when this location closed business.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The unique ID number of this location.
	// Example: 56789
	// Required: true
	ID *int32 `json:"id"`

	// Set this flag to true to indicate that this is the default location for this company.
	// Example: true
	IsDefault bool `json:"isDefault,omitempty"`

	// Indicates whether the Marketplace is outside or in USA
	// Example: false
	IsMarketplaceOutsideUsa bool `json:"isMarketplaceOutsideUsa,omitempty"`

	// Set this flag to true to indicate that this location has been registered with a tax authority.
	// Example: true
	IsRegistered bool `json:"isRegistered,omitempty"`

	// The most recent date when a transaction was processed for this location.  Set by AvaTax.
	// Read Only: true
	// Format: date-time
	LastTransactionDate strfmt.DateTime `json:"lastTransactionDate,omitempty"`

	// The first line of the physical address of this location.
	// Example: 2000 Main Street
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1"`

	// The second line of the physical address of this location.
	// Max Length: 50
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// The third line of the physical address of this location.
	// Max Length: 50
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// A code that identifies this location.  Must be unique within your company.
	// Example: DEFAULT
	// Required: true
	// Max Length: 50
	// Min Length: 0
	LocationCode *string `json:"locationCode"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// A friendly name for this location.
	// Example: Main Office
	// Max Length: 100
	// Min Length: 0
	OutletName *string `json:"outletName,omitempty"`

	// List of location parameters.
	// Read Only: true
	Parameters []*LocationParameterModel `json:"parameters"`

	// The postal code or zip code of the physical address of this location.
	// Example: 92614
	// Required: true
	// Max Length: 10
	// Min Length: 0
	PostalCode *string `json:"postalCode"`

	// Name or ISO 3166 code identifying the region within the country of the physical address of this location.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`

	// The date when this location was registered with a tax authority.  Not required.
	// Example: 2015-01-01T00:00:00
	// Format: date-time
	RegisteredDate strfmt.DateTime `json:"registeredDate,omitempty"`

	// Extra information required by certain jurisdictions for filing.
	// For a list of settings recognized by Avalara, query the endpoint "/api/v2/definitions/locationquestions".
	// To determine the list of settings required for this location, query the endpoint "/api/v2/companies/(id)/locations/(id)/validate".
	// Example: [{"questionId":17,"value":"abcdefghij"}]
	Settings []*LocationSettingModel `json:"settings"`
}

LocationModel A location where this company does business. Some jurisdictions may require you to list all locations where your company does business. Example: {"addressCategoryId":"MainOffice","addressTypeId":"Location","city":"Irvine","companyId":12345,"country":"US","county":"Orange","dbaName":"Bob's Artisan Pottery","description":"Bob's Artisan Pottery","id":56789,"isDefault":true,"isMarketplaceOutsideUsa":false,"isRegistered":true,"line1":"2000 Main Street","locationCode":"DEFAULT","outletName":"Main Office","postalCode":"92614","region":"CA","registeredDate":"2015-01-01T00:00:00","settings":[{"questionId":17,"value":"abcdefghij"}]}

swagger:model LocationModel

func (*LocationModel) ContextValidate ¶ 

func (m *LocationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location model based on the context it is used

func (*LocationModel) MarshalBinary ¶ 

func (m *LocationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationModel) UnmarshalBinary ¶ 

func (m *LocationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationModel) Validate ¶ 

func (m *LocationModel) Validate(formats strfmt.Registry) error

Validate validates this location model

type LocationModelFetchResult ¶ 

type LocationModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*LocationModel `json:"value"`
}

LocationModelFetchResult location model fetch result

swagger:model LocationModelFetchResult

func (*LocationModelFetchResult) ContextValidate ¶ 

func (m *LocationModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location model fetch result based on the context it is used

func (*LocationModelFetchResult) MarshalBinary ¶ 

func (m *LocationModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationModelFetchResult) UnmarshalBinary ¶ 

func (m *LocationModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationModelFetchResult) Validate ¶ 

func (m *LocationModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this location model fetch result

type LocationParameterModel ¶ 

type LocationParameterModel struct {

	// The ID number of the parameter.
	// Example: 0
	ID int64 `json:"id,omitempty"`

	// The ID of the company location the parameter associated with.
	// Example: 12345
	// Read Only: true
	LocationID int32 `json:"locationId,omitempty"`

	// The parameter's name.
	// Example: NumberOfUnitsForRent
	// Required: true
	Name *string `json:"name"`

	// The parameter's value.
	// Example: Count
	Unit string `json:"unit,omitempty"`

	// The value of the parameter.
	// Example: 10
	// Required: true
	Value *string `json:"value"`
}

LocationParameterModel The parameter associated with a company location. Example: {"id":0,"locationId":12345,"name":"NumberOfUnitsForRent","unit":"Count","value":"10"}

swagger:model LocationParameterModel

func (*LocationParameterModel) ContextValidate ¶ 

func (m *LocationParameterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location parameter model based on the context it is used

func (*LocationParameterModel) MarshalBinary ¶ 

func (m *LocationParameterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationParameterModel) UnmarshalBinary ¶ 

func (m *LocationParameterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationParameterModel) Validate ¶ 

func (m *LocationParameterModel) Validate(formats strfmt.Registry) error

Validate validates this location parameter model

type LocationParameterModelFetchResult ¶ 

type LocationParameterModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*LocationParameterModel `json:"value"`
}

LocationParameterModelFetchResult location parameter model fetch result

swagger:model LocationParameterModelFetchResult

func (*LocationParameterModelFetchResult) ContextValidate ¶ 

func (m *LocationParameterModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location parameter model fetch result based on the context it is used

func (*LocationParameterModelFetchResult) MarshalBinary ¶ 

func (m *LocationParameterModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationParameterModelFetchResult) UnmarshalBinary ¶ 

func (m *LocationParameterModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationParameterModelFetchResult) Validate ¶ 

func (m *LocationParameterModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this location parameter model fetch result

type LocationQuestionModel ¶ 

type LocationQuestionModel struct {

	// Data type of the answer
	DataType string `json:"dataType,omitempty"`

	// If additional information is available about the location setting, this contains descriptive text to help
	// you identify the correct value to provide in this setting.
	// Required: true
	Description *string `json:"description"`

	// If available, this is an example value that you can demonstrate to the user to show what is expected.
	ExampleValue string `json:"exampleValue,omitempty"`

	// Help and guidance for this specific question
	HelpText string `json:"helpText,omitempty"`

	// The unique ID number of this location setting type
	// Example: 1
	// Required: true
	ID *int32 `json:"id"`

	// Indicates the country that this jurisdiction belongs to
	JurisdictionCountry string `json:"jurisdictionCountry,omitempty"`

	// Indicates which jurisdiction requires this question
	JurisdictionName string `json:"jurisdictionName,omitempty"`

	// Indicates the state, region, or province that this jurisdiction belongs to
	JurisdictionRegion string `json:"jurisdictionRegion,omitempty"`

	// Indicates which type of jurisdiction requires this question
	// Example: Country
	// Enum: [Country State County City Special]
	JurisdictionType string `json:"jurisdictionType,omitempty"`

	// Maximum length of the answer string
	MaxLength int32 `json:"maxLength,omitempty"`

	// This is the prompt for this question
	// Example: State Assigned Code
	// Required: true
	Question *string `json:"question"`

	// If available, this regular expression will verify that the input from the user is in the expected format.
	RegularExpression string `json:"regularExpression,omitempty"`

	// True if this question must be answered for this filing calendar
	// Example: false
	Required bool `json:"required,omitempty"`

	// static options
	StaticOptions string `json:"staticOptions,omitempty"`

	// unique
	// Example: false
	Unique bool `json:"unique,omitempty"`
}

LocationQuestionModel Information about questions that the local jurisdictions require for each location Example: {"description":"","id":1,"jurisdictionType":"Country","question":"State Assigned Code","required":false,"unique":false}

swagger:model LocationQuestionModel

func (*LocationQuestionModel) ContextValidate ¶ 

func (m *LocationQuestionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this location question model based on context it is used

func (*LocationQuestionModel) MarshalBinary ¶ 

func (m *LocationQuestionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationQuestionModel) UnmarshalBinary ¶ 

func (m *LocationQuestionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationQuestionModel) Validate ¶ 

func (m *LocationQuestionModel) Validate(formats strfmt.Registry) error

Validate validates this location question model

type LocationQuestionModelFetchResult ¶ 

type LocationQuestionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*LocationQuestionModel `json:"value"`
}

LocationQuestionModelFetchResult location question model fetch result

swagger:model LocationQuestionModelFetchResult

func (*LocationQuestionModelFetchResult) ContextValidate ¶ 

func (m *LocationQuestionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location question model fetch result based on the context it is used

func (*LocationQuestionModelFetchResult) MarshalBinary ¶ 

func (m *LocationQuestionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationQuestionModelFetchResult) UnmarshalBinary ¶ 

func (m *LocationQuestionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationQuestionModelFetchResult) Validate ¶ 

func (m *LocationQuestionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this location question model fetch result

type LocationSettingModel ¶ 

type LocationSettingModel struct {

	// The unique ID number of the location question answered.
	// Example: 17
	QuestionID int32 `json:"questionId,omitempty"`

	// The name of the question
	QuestionName string `json:"questionName,omitempty"`

	// The answer the user provided.
	// Example: abcdefghij
	// Max Length: 50
	// Min Length: 0
	Value *string `json:"value,omitempty"`
}

LocationSettingModel Represents the answer to one local jurisdiction question for a location. Example: {"questionId":17,"value":"abcdefghij"}

swagger:model LocationSettingModel

func (*LocationSettingModel) ContextValidate ¶ 

func (m *LocationSettingModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this location setting model based on context it is used

func (*LocationSettingModel) MarshalBinary ¶ 

func (m *LocationSettingModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationSettingModel) UnmarshalBinary ¶ 

func (m *LocationSettingModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationSettingModel) Validate ¶ 

func (m *LocationSettingModel) Validate(formats strfmt.Registry) error

Validate validates this location setting model

type LocationValidationModel ¶ 

type LocationValidationModel struct {

	// A list of settings that must be defined for this location
	// Example: [{"description":"","id":1,"jurisdictionType":"Country","question":"State Assigned Code","required":false,"unique":false}]
	RequiredSettings []*LocationQuestionModel `json:"requiredSettings"`

	// True if the location has a value for each jurisdiction-required setting.
	// The user is required to ensure that the values are correct according to the jurisdiction; this flag
	// does not indicate whether the taxing jurisdiction has accepted the data you have provided.
	// Example: true
	SettingsValidated bool `json:"settingsValidated,omitempty"`
}

LocationValidationModel Tells you whether this location object has been correctly set up to the local jurisdiction's standards Example: {"requiredSettings":[{"description":"","id":1,"jurisdictionType":"Country","question":"State Assigned Code","required":false,"unique":false}],"settingsValidated":true}

swagger:model LocationValidationModel

func (*LocationValidationModel) ContextValidate ¶ 

func (m *LocationValidationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this location validation model based on the context it is used

func (*LocationValidationModel) MarshalBinary ¶ 

func (m *LocationValidationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocationValidationModel) UnmarshalBinary ¶ 

func (m *LocationValidationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocationValidationModel) Validate ¶ 

func (m *LocationValidationModel) Validate(formats strfmt.Registry) error

Validate validates this location validation model

type LockTransactionModel ¶ 

type LockTransactionModel struct {

	// Set this value to be true to commit this transaction.
	// Committing a transaction allows it to be reported on a tax return.  Uncommitted transactions will not be reported.
	// Example: true
	// Required: true
	IsLocked *bool `json:"isLocked"`
}

LockTransactionModel Commit this transaction as permanent Example: {"isLocked":true}

swagger:model LockTransactionModel

func (*LockTransactionModel) ContextValidate ¶ 

func (m *LockTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this lock transaction model based on context it is used

func (*LockTransactionModel) MarshalBinary ¶ 

func (m *LockTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LockTransactionModel) UnmarshalBinary ¶ 

func (m *LockTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LockTransactionModel) Validate ¶ 

func (m *LockTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this lock transaction model

type LoginVerificationInputModel ¶ 

type LoginVerificationInputModel struct {

	// AccountId of the login verification
	// Example: 1987654323
	// Required: true
	AccountID *int32 `json:"accountId"`

	// Additional options of the verification
	// Example: {"key":"4133|AR-2131232-13"}
	AdditionalOptions map[string]string `json:"additionalOptions,omitempty"`

	// Bulk Request Id of the verification
	// Example: 1
	BulkRequestID int32 `json:"bulkRequestId,omitempty"`

	// CompanyId that we are verifying the login information for
	// Example: 12345
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// Password we are using for verification
	// Example: Test
	// Required: true
	Password *string `json:"password"`

	// Priority of the verification request
	// Example: 2
	Priority int32 `json:"priority,omitempty"`

	// Region of the verification request
	// Example: AR
	// Required: true
	Region *string `json:"region"`

	// TaxFormCode for the verification request
	// Example: USARET1
	TaxFormCode string `json:"taxFormCode,omitempty"`

	// Username that we are using for verification
	// Example: Test
	// Required: true
	Username *string `json:"username"`
}

LoginVerificationInputModel Represents a verification request using Skyscraper for a company Example: {"accountId":1987654323,"additionalOptions":{"key":"4133|AR-2131232-13"},"bulkRequestId":1,"companyId":12345,"password":"Test","priority":2,"region":"AR","taxFormCode":"USARET1","username":"Test"}

swagger:model LoginVerificationInputModel

func (*LoginVerificationInputModel) ContextValidate ¶ 

func (m *LoginVerificationInputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this login verification input model based on context it is used

func (*LoginVerificationInputModel) MarshalBinary ¶ 

func (m *LoginVerificationInputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LoginVerificationInputModel) UnmarshalBinary ¶ 

func (m *LoginVerificationInputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LoginVerificationInputModel) Validate ¶ 

func (m *LoginVerificationInputModel) Validate(formats strfmt.Registry) error

Validate validates this login verification input model

type LoginVerificationOutputModel ¶ 

type LoginVerificationOutputModel struct {

	// The job Id returned from skyscraper
	// Example: 8366
	// Required: true
	JobID *int32 `json:"jobId"`

	// Indicates if the login was successful
	// Example: true
	LoginSuccess bool `json:"loginSuccess,omitempty"`

	// The message returned from the job
	Message string `json:"message,omitempty"`

	// The operation status of the job
	// Example: Pending
	OperationStatus string `json:"operationStatus,omitempty"`
}

LoginVerificationOutputModel This is the output model coming from skyscraper services Example: {"jobId":8366,"loginSuccess":true,"message":"","operationStatus":"Pending"}

swagger:model LoginVerificationOutputModel

func (*LoginVerificationOutputModel) ContextValidate ¶ 

func (m *LoginVerificationOutputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this login verification output model based on context it is used

func (*LoginVerificationOutputModel) MarshalBinary ¶ 

func (m *LoginVerificationOutputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LoginVerificationOutputModel) UnmarshalBinary ¶ 

func (m *LoginVerificationOutputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LoginVerificationOutputModel) Validate ¶ 

func (m *LoginVerificationOutputModel) Validate(formats strfmt.Registry) error

Validate validates this login verification output model

type MarketplaceLocationModel ¶ 

type MarketplaceLocationModel struct {

	// Marketplace Location Country
	// Example: US
	Country string `json:"country,omitempty"`

	// Marketplace Location Created Date
	// Example: 2019-11-21T00:00:00
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// Marketplace Location Enforcement Date
	// Example: 2019-10-01T00:00:00
	// Format: date-time
	EnforcementDate strfmt.DateTime `json:"enforcementDate,omitempty"`

	// Marketplace Location Legislative Effective Date
	// Format: date-time
	LegislativeEffectiveDate strfmt.DateTime `json:"legislativeEffectiveDate,omitempty"`

	// Marketplace Location
	// Example: Amazon
	Marketplace string `json:"marketplace,omitempty"`

	// Marketplace Location Adoption Date
	// Example: 2019-01-01T00:00:00
	// Format: date-time
	MarketplaceAdoptionDate strfmt.DateTime `json:"marketplaceAdoptionDate,omitempty"`

	// Marketplace Location End Date
	// Example: 9999-12-31T00:00:00
	// Format: date-time
	MarketplaceEndDate strfmt.DateTime `json:"marketplaceEndDate,omitempty"`

	// Marketplace Location Id
	// Example: a0n0b00000ODPh2AAH
	MarketplaceID string `json:"marketplaceId,omitempty"`

	// Marketplace Location Modified Date
	// Example: 2019-11-21T00:00:00
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// Marketplace Location State
	// Example: AL
	Region string `json:"region,omitempty"`
}

MarketplaceLocationModel Marketplace Location Output model Example: {"country":"US","createdDate":"2019-11-21T00:00:00","enforcementDate":"2019-10-01T00:00:00","marketplace":"Amazon","marketplaceAdoptionDate":"2019-01-01T00:00:00","marketplaceEndDate":"9999-12-31T00:00:00","marketplaceId":"a0n0b00000ODPh2AAH","modifiedDate":"2019-11-21T00:00:00","region":"AL"}

swagger:model MarketplaceLocationModel

func (*MarketplaceLocationModel) ContextValidate ¶ 

func (m *MarketplaceLocationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this marketplace location model based on context it is used

func (*MarketplaceLocationModel) MarshalBinary ¶ 

func (m *MarketplaceLocationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MarketplaceLocationModel) UnmarshalBinary ¶ 

func (m *MarketplaceLocationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MarketplaceLocationModel) Validate ¶ 

func (m *MarketplaceLocationModel) Validate(formats strfmt.Registry) error

Validate validates this marketplace location model

type MarketplaceLocationModelFetchResult ¶ 

type MarketplaceLocationModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*MarketplaceLocationModel `json:"value"`
}

MarketplaceLocationModelFetchResult marketplace location model fetch result

swagger:model MarketplaceLocationModelFetchResult

func (*MarketplaceLocationModelFetchResult) ContextValidate ¶ 

func (m *MarketplaceLocationModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this marketplace location model fetch result based on the context it is used

func (*MarketplaceLocationModelFetchResult) MarshalBinary ¶ 

func (m *MarketplaceLocationModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MarketplaceLocationModelFetchResult) UnmarshalBinary ¶ 

func (m *MarketplaceLocationModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MarketplaceLocationModelFetchResult) Validate ¶ 

func (m *MarketplaceLocationModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this marketplace location model fetch result

type MarketplaceModel ¶ 

type MarketplaceModel struct {

	// Marketplace Location
	// Example: Amazon
	Marketplace string `json:"marketplace,omitempty"`

	// Marketplace Location Id
	// Example: a0n0b00000ODPh2AAH
	MarketplaceID string `json:"marketplaceId,omitempty"`
}

MarketplaceModel Marketplace Location Output model Example: {"marketplace":"Amazon","marketplaceId":"a0n0b00000ODPh2AAH"}

swagger:model MarketplaceModel

func (*MarketplaceModel) ContextValidate ¶ 

func (m *MarketplaceModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this marketplace model based on context it is used

func (*MarketplaceModel) MarshalBinary ¶ 

func (m *MarketplaceModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MarketplaceModel) UnmarshalBinary ¶ 

func (m *MarketplaceModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MarketplaceModel) Validate ¶ 

func (m *MarketplaceModel) Validate(formats strfmt.Registry) error

Validate validates this marketplace model

type MarketplaceModelFetchResult ¶ 

type MarketplaceModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*MarketplaceModel `json:"value"`
}

MarketplaceModelFetchResult marketplace model fetch result

swagger:model MarketplaceModelFetchResult

func (*MarketplaceModelFetchResult) ContextValidate ¶ 

func (m *MarketplaceModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this marketplace model fetch result based on the context it is used

func (*MarketplaceModelFetchResult) MarshalBinary ¶ 

func (m *MarketplaceModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MarketplaceModelFetchResult) UnmarshalBinary ¶ 

func (m *MarketplaceModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MarketplaceModelFetchResult) Validate ¶ 

func (m *MarketplaceModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this marketplace model fetch result

type Message ¶ 

type Message struct {

	// details
	Details string `json:"details,omitempty"`

	// help link
	HelpLink string `json:"helpLink,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// refers to
	RefersTo string `json:"refersTo,omitempty"`

	// severity
	// Example: Success
	// Enum: [Success Warning Error Exception]
	Severity string `json:"severity,omitempty"`

	// source
	Source string `json:"source,omitempty"`

	// summary
	Summary string `json:"summary,omitempty"`
}

Message message

swagger:model Message

func (*Message) ContextValidate ¶ 

func (m *Message) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this message based on context it is used

func (*Message) MarshalBinary ¶ 

func (m *Message) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Message) UnmarshalBinary ¶ 

func (m *Message) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Message) Validate ¶ 

func (m *Message) Validate(formats strfmt.Registry) error

Validate validates this message

type MrsCompanyModel ¶ 

type MrsCompanyModel struct {

	// The unique ID number of the account this company belongs to.
	// Example: 123456789
	AccountID int32 `json:"accountId,omitempty"`

	// The name of this account, as shown to customers.
	// Example: Default Account
	AccountName string `json:"accountName,omitempty"`

	// The company code for the company
	CompanyCode string `json:"companyCode,omitempty"`

	// The unique ID number of this company.
	// Example: 12345
	CompanyID int32 `json:"companyId,omitempty"`

	// The name of this company, as shown to customers.
	// Example: Default Company
	CompanyName string `json:"companyName,omitempty"`

	// The date when this record was created.
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date/time when this record was last modified.
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The taxpayer identification number for the company
	Tin string `json:"tin,omitempty"`
}

MrsCompanyModel A company and account Example: {"accountId":123456789,"accountName":"Default Account","companyId":12345,"companyName":"Default Company"}

swagger:model MrsCompanyModel

func (*MrsCompanyModel) ContextValidate ¶ 

func (m *MrsCompanyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this mrs company model based on context it is used

func (*MrsCompanyModel) MarshalBinary ¶ 

func (m *MrsCompanyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MrsCompanyModel) UnmarshalBinary ¶ 

func (m *MrsCompanyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MrsCompanyModel) Validate ¶ 

func (m *MrsCompanyModel) Validate(formats strfmt.Registry) error

Validate validates this mrs company model

type MrsCompanyModelFetchResult ¶ 

type MrsCompanyModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*MrsCompanyModel `json:"value"`
}

MrsCompanyModelFetchResult mrs company model fetch result

swagger:model MrsCompanyModelFetchResult

func (*MrsCompanyModelFetchResult) ContextValidate ¶ 

func (m *MrsCompanyModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this mrs company model fetch result based on the context it is used

func (*MrsCompanyModelFetchResult) MarshalBinary ¶ 

func (m *MrsCompanyModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MrsCompanyModelFetchResult) UnmarshalBinary ¶ 

func (m *MrsCompanyModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MrsCompanyModelFetchResult) Validate ¶ 

func (m *MrsCompanyModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this mrs company model fetch result

type MultiDocumentLineItemModel ¶ 

type MultiDocumentLineItemModel struct {

	// The addresses to use for this transaction line.
	//
	// If you set this value to `null`, or if you omit this element from your API call, then instead the transaction
	// will use the `addresses` from the document level.
	//
	// If you specify any other value besides `null`, only addresses specified for this line will be used for this line.
	// Example: {"shipFrom":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"},"shipTo":{"city":"Seattle","country":"US","line1":"1100 2nd Ave","postalCode":"98101","region":"WA"}}
	Addresses *AddressesModel `json:"addresses,omitempty"`

	// Total amount for this line.  The amount represents the net currency value that changed hands from the customer (represented by the `customerCode` field) to the company (represented by the `companyCode`) field.
	//
	// For sale transactions, this value must be positive.  It indicates the amount of money paid by the customer to the company.
	//
	// For refund or return transactions, this value must be negative.
	// Example: 100
	// Required: true
	Amount *float64 `json:"amount"`

	// VAT business identification number for the customer for this line item.  If you leave this field empty,
	// this line item will use whatever business identification number you provided at the transaction level.
	//
	// If you specify a VAT business identification number for the customer in this transaction and you have also set up
	// a business identification number for your company during company setup, this transaction will be treated as a
	// business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
	// Max Length: 25
	// Min Length: 0
	BusinessIdentificationNo *string `json:"businessIdentificationNo,omitempty"`

	// Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “.  Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.
	// Max Length: 4000
	// Min Length: 0
	Category *string `json:"category,omitempty"`

	// Specify the code of the company for this line of transaction.
	//
	// If you leave this value null, the `companyCode` at the root level will be used instead.
	// Example: DEFAULT
	CompanyCode string `json:"companyCode,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
	//
	// Max Length: 25
	// Min Length: 0
	CustomerUsageType *string `json:"customerUsageType,omitempty"`

	// Item description.
	//
	// For Streamlined Sales Tax (SST) customers, this field is required if an unmapped `itemCode` is used.
	// Example: Yarn
	// Max Length: 2096
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// True if the document discount should be applied to this line.  If this value is false, or not provided, discounts will not be
	// applied to this line even if they are specified on the root `discount` element.
	Discounted bool `json:"discounted,omitempty"`

	// Entity Use Code - The client application customer or usage type.  This field allows you to designate a type of usage that
	// may make this transaction considered exempt by reason of exempt usage.
	//
	// For a list of entity use codes, see the Definitions API `ListEntityUseCodes`.
	// Max Length: 25
	// Min Length: 0
	EntityUseCode *string `json:"entityUseCode,omitempty"`

	// The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable
	// ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service
	// will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request,
	// and will perform exemption processing using either of those two options.
	// Note: This is same as 'exemptNo' in TransactionModel.
	ExemptionCode string `json:"exemptionCode,omitempty"`

	// The Item code for Custom Duty / Global Import tax determination
	// Harmonized Tariff System code for this transaction.
	//
	// For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.
	// Max Length: 25
	// Min Length: 0
	HsCode *string `json:"hsCode,omitempty"`

	// Item Code (SKU).  If you provide an `itemCode` field, the AvaTax API will look up the item you created with the `CreateItems` API call
	// and use all the information available about that item for this transaction.
	// Example: Y0001
	// Max Length: 50
	// Min Length: 0
	ItemCode *string `json:"itemCode,omitempty"`

	// This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.
	// Example: Marketplace
	// Enum: [Marketplace Seller]
	MarketplaceLiabilityType string `json:"marketplaceLiabilityType,omitempty"`

	// DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead.
	// ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
	MerchantSellerID int64 `json:"merchantSellerId,omitempty"`

	// ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
	// Max Length: 100
	// Min Length: 0
	MerchantSellerIdentifier *string `json:"merchantSellerIdentifier,omitempty"`

	// The line number of this line within the document.  This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.
	// Example: 1
	// Max Length: 50
	// Min Length: 0
	Number *string `json:"number,omitempty"`

	// The transaction's original ID in its origination system
	// Max Length: 50
	// Min Length: 0
	OriginationDocumentID *string `json:"originationDocumentId,omitempty"`

	// Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.
	// Max Length: 60
	// Min Length: 0
	OriginationSite *string `json:"originationSite,omitempty"`

	// Special parameters that apply to this line within this transaction.
	//
	// To get a full list of available parameters, please use the `ListParameters` API.
	Parameters []*TransactionLineParameterModel `json:"parameters"`

	// Quantity of items in this line.  This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds.
	//
	// If not provided, or if set to zero, the quantity value is assumed to be one (1).
	// Example: 1
	Quantity float64 `json:"quantity,omitempty"`

	// Ref1 (Customer Defined Field)
	//
	// This field is available for you to use to provide whatever information your implementation requires.  It does not affect tax calculation.
	// Max Length: 250
	// Min Length: 0
	Ref1 *string `json:"ref1,omitempty"`

	// Ref2 (Customer Defined Field)
	//
	// This field is available for you to use to provide whatever information your implementation requires.  It does not affect tax calculation.
	// Max Length: 250
	// Min Length: 0
	Ref2 *string `json:"ref2,omitempty"`

	// Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
	//
	// If you leave this value `null`, the `reportingLocationCode` at the root level will be used instead.
	// Example: ReportLocation111
	ReportingLocationCode string `json:"reportingLocationCode,omitempty"`

	// Revenue Account (Customer Defined Field).
	//
	// This field is available for you to use to provide whatever information your implementation requires.  It does not affect tax calculation.
	// Max Length: 50
	// Min Length: 0
	RevenueAccount *string `json:"revenueAccount,omitempty"`

	// A long description of the product.
	// Max Length: 4000
	// Min Length: 0
	Summary *string `json:"summary,omitempty"`

	// Tax Code - System or Custom Tax Code.
	//
	// You can use your own tax code mapping or standard Avalara tax codes.  For a full list of tax codes, see `ListTaxCodes`.
	// Example: PS081282
	// Max Length: 25
	// Min Length: 0
	TaxCode *string `json:"taxCode,omitempty"`

	// Indicates whether the `amount` for this line already includes tax.
	//
	// If this value is `true`, the final price of this line including tax will equal the value in `amount`.
	//
	// If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line.
	TaxIncluded bool `json:"taxIncluded,omitempty"`

	// Specifies a tax override for this line.
	// Example: {"reason":"Precalculated Tax","taxAmount":6.25,"taxDate":"2021-12-25","type":"TaxAmount"}
	TaxOverride *TaxOverrideModel `json:"taxOverride,omitempty"`

	// Custom user fields/flex fields for this line.
	UserDefinedFields []*TransactionLineUserDefinedFieldModel `json:"userDefinedFields"`
}

MultiDocumentLineItemModel Represents one line item in a MultiDocument transaction Example: {"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}

swagger:model MultiDocumentLineItemModel

func (*MultiDocumentLineItemModel) ContextValidate ¶ 

func (m *MultiDocumentLineItemModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this multi document line item model based on the context it is used

func (*MultiDocumentLineItemModel) MarshalBinary ¶ 

func (m *MultiDocumentLineItemModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiDocumentLineItemModel) UnmarshalBinary ¶ 

func (m *MultiDocumentLineItemModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiDocumentLineItemModel) Validate ¶ 

func (m *MultiDocumentLineItemModel) Validate(formats strfmt.Registry) error

Validate validates this multi document line item model

type MultiDocumentModel ¶ 

type MultiDocumentModel struct {

	// The unique ID number of the AvaTax customer account that created this MultiDocument object.
	// Example: 123456
	AccountID int32 `json:"accountId,omitempty"`

	// The transaction code of the MultiDocument transaction.
	//
	// All individual transactions within this MultiDocument object will have this code as a prefix.
	// Example: 13a8d514-b44c-4a98-9764-7fc90f180765
	Code string `json:"code,omitempty"`

	// The date/time when this record was created.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The user ID of the user who created this record.
	// Example: 87954
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A separate document will exist for each unique combination of buyer and seller in this MultiDocument transaction.
	// Example: [{"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"73377039-ca73-4b96-8429-fd2b5b23d745","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}]
	// Read Only: true
	Documents []*TransactionModel `json:"documents"`

	// The unique ID number of this MultiDocument object.
	// Example: 12
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Example: 2021-12-25T00:00:00+00:00
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Example: 66783
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// Indicates the type of MultiDocument transaction.  Common values are:
	//
	// * SalesOrder - An estimate that is not permanently recorded
	// * SalesInvoice - An invoice that can be reported on a tax return
	//
	// For more information about document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/)
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type string `json:"type,omitempty"`
}

MultiDocumentModel A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.

A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately. Example: {"accountId":123456,"code":"13a8d514-b44c-4a98-9764-7fc90f180765","createdDate":"2021-12-25T00:00:00+00:00","createdUserId":87954,"documents":[{"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"73377039-ca73-4b96-8429-fd2b5b23d745","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}],"id":12,"modifiedDate":"2021-12-25T00:00:00+00:00","modifiedUserId":66783,"type":"SalesInvoice"}

swagger:model MultiDocumentModel

func (*MultiDocumentModel) ContextValidate ¶ 

func (m *MultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this multi document model based on the context it is used

func (*MultiDocumentModel) MarshalBinary ¶ 

func (m *MultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiDocumentModel) UnmarshalBinary ¶ 

func (m *MultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiDocumentModel) Validate ¶ 

func (m *MultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this multi document model

type MultiDocumentModelFetchResult ¶ 

type MultiDocumentModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*MultiDocumentModel `json:"value"`
}

MultiDocumentModelFetchResult multi document model fetch result

swagger:model MultiDocumentModelFetchResult

func (*MultiDocumentModelFetchResult) ContextValidate ¶ 

func (m *MultiDocumentModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this multi document model fetch result based on the context it is used

func (*MultiDocumentModelFetchResult) MarshalBinary ¶ 

func (m *MultiDocumentModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiDocumentModelFetchResult) UnmarshalBinary ¶ 

func (m *MultiDocumentModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiDocumentModelFetchResult) Validate ¶ 

func (m *MultiDocumentModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this multi document model fetch result

type 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"`
}

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

func (*MultiTaxFilingModel) ContextValidate ¶ 

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

ContextValidate validate this multi tax filing model based on the context it is used

func (*MultiTaxFilingModel) MarshalBinary ¶ 

func (m *MultiTaxFilingModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiTaxFilingModel) UnmarshalBinary ¶ 

func (m *MultiTaxFilingModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiTaxFilingModel) Validate ¶ 

func (m *MultiTaxFilingModel) Validate(formats strfmt.Registry) error

Validate validates this multi tax filing model

type MultiTaxFilingModelFetchResult ¶ 

type MultiTaxFilingModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*MultiTaxFilingModel `json:"value"`
}

MultiTaxFilingModelFetchResult multi tax filing model fetch result

swagger:model MultiTaxFilingModelFetchResult

func (*MultiTaxFilingModelFetchResult) ContextValidate ¶ 

func (m *MultiTaxFilingModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this multi tax filing model fetch result based on the context it is used

func (*MultiTaxFilingModelFetchResult) MarshalBinary ¶ 

func (m *MultiTaxFilingModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiTaxFilingModelFetchResult) UnmarshalBinary ¶ 

func (m *MultiTaxFilingModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiTaxFilingModelFetchResult) Validate ¶ 

func (m *MultiTaxFilingModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this multi tax filing model fetch result

type 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"`
}

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

func (*MultiTaxFilingRegionModel) ContextValidate ¶ 

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

ContextValidate validate this multi tax filing region model based on the context it is used

func (*MultiTaxFilingRegionModel) MarshalBinary ¶ 

func (m *MultiTaxFilingRegionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiTaxFilingRegionModel) UnmarshalBinary ¶ 

func (m *MultiTaxFilingRegionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiTaxFilingRegionModel) Validate ¶ 

func (m *MultiTaxFilingRegionModel) Validate(formats strfmt.Registry) error

Validate validates this multi tax filing region model

type MultiTaxFilingReturnModel ¶ 

type MultiTaxFilingReturnModel struct {

	// Accrual type of the return
	// Example: Filing
	// Enum: [Filing Accrual]
	AccrualType string `json:"accrualType,omitempty"`

	// The Adjustments for this return.
	// Example: [{"accountType":"AccountsReceivableAccountsPayable","amount":100,"id":15634,"isCalculated":false,"period":"CurrentPeriod","type":"Discount"}]
	Adjustments []*FilingAdjustmentModel `json:"adjustments"`

	// The applied carry over credit documents
	// Example: {"totalExempt":0,"totalSales":0,"totalTax":0,"totalTaxable":0}
	AppliedCarryOverCredits *FilingReturnCreditModel `json:"appliedCarryOverCredits,omitempty"`

	// The attachments for this return.
	Attachments []*FilingAttachmentModel `json:"attachments"`

	// The Augmentations for this return.
	Augmentations []*FilingAugmentationModel `json:"augmentations"`

	// A description for the return.
	// Example: Sales Tax Return
	Description string `json:"description,omitempty"`

	// The end date of this return
	// Format: date-time
	EndPeriod strfmt.DateTime `json:"endPeriod,omitempty"`

	// The excluded carry over credit documents
	// Example: {"totalExempt":0,"totalSales":0,"totalTax":0,"totalTaxable":0}
	ExcludedCarryOverCredits *FilingReturnCreditModel `json:"excludedCarryOverCredits,omitempty"`

	// The date the return was filed by Avalara.
	// Format: date-time
	FiledDate strfmt.DateTime `json:"filedDate,omitempty"`

	// The unique ID number of the filing calendar associated with this return.
	// Example: 513256
	FilingCalendarID int64 `json:"filingCalendarId,omitempty"`

	// The filing frequency of the return.
	// Example: Monthly
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequency string `json:"filingFrequency,omitempty"`

	// The filing type of the return.
	// Example: PaperReturn
	// Enum: [PaperReturn ElectronicReturn SER EFTPaper PhonePaper SignatureReady EfileCheck]
	FilingType string `json:"filingType,omitempty"`

	// The unique code of the form.
	// Example: AL2100
	FormCode string `json:"formCode,omitempty"`

	// The name of the form.
	// Example: AL 2100
	FormName string `json:"formName,omitempty"`

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

	// The payments for this return.
	Payments []*FilingPaymentModel `json:"payments"`

	// A detailed breakdown of the taxes in this filing
	// Example: [{"nonTaxableAmount":100,"numberOfNights":1,"salesAmount":200,"taxAmount":10,"taxType":"S"}]
	ReturnTaxDetails []*FilingsTaxDetailsModel `json:"returnTaxDetails"`

	// 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}
	ReturnTaxSummary *FilingsTaxSummaryModel `json:"returnTaxSummary,omitempty"`

	// The start date of this return
	// Format: date-time
	StartPeriod strfmt.DateTime `json:"startPeriod,omitempty"`

	// The current status of the filing return.
	// 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"`

	// Tax Authority ID of this return
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// Total amount of adjustments on this return
	// Example: 0
	TotalAdjustments float64 `json:"totalAdjustments,omitempty"`

	// Total amount of augmentations on this return
	// Example: 0
	TotalAugmentations float64 `json:"totalAugmentations,omitempty"`

	// Total amount of payments on this return
	// Example: 0
	TotalPayments float64 `json:"totalPayments,omitempty"`

	// The FilingTaskType for this return.
	Type string `json:"type,omitempty"`
}

MultiTaxFilingReturnModel Filing Returns Model 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}

swagger:model MultiTaxFilingReturnModel

func (*MultiTaxFilingReturnModel) ContextValidate ¶ 

func (m *MultiTaxFilingReturnModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this multi tax filing return model based on the context it is used

func (*MultiTaxFilingReturnModel) MarshalBinary ¶ 

func (m *MultiTaxFilingReturnModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiTaxFilingReturnModel) UnmarshalBinary ¶ 

func (m *MultiTaxFilingReturnModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiTaxFilingReturnModel) Validate ¶ 

func (m *MultiTaxFilingReturnModel) Validate(formats strfmt.Registry) error

Validate validates this multi tax filing return model

type NewAccountModel ¶ 

type NewAccountModel struct {

	// This is the email address to which credentials were mailed
	// Example: bob@example.org
	AccountDetailsEmailedTo string `json:"accountDetailsEmailedTo,omitempty"`

	// This is the ID number of the account that was created
	// Example: 123456789
	AccountID int32 `json:"accountId,omitempty"`

	// The date and time when this account was created
	// Example: 0001-01-01T00:00:00
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The date and time when account information was emailed to the user
	// Example: 0001-01-01T00:00:00
	// Format: date-time
	EmailedDate strfmt.DateTime `json:"emailedDate,omitempty"`

	// The license key of the account that was created
	LicenseKey string `json:"licenseKey,omitempty"`

	// If this account includes any limitations, specify them here
	Limitations string `json:"limitations,omitempty"`

	// The payment url where the payment method can be set up
	PaymentURL string `json:"paymentUrl,omitempty"`
}

NewAccountModel Represents information about a newly created account Example: {"accountDetailsEmailedTo":"bob@example.org","accountId":123456789,"createdDate":"0001-01-01T00:00:00","emailedDate":"0001-01-01T00:00:00"}

swagger:model NewAccountModel

func (*NewAccountModel) ContextValidate ¶ 

func (m *NewAccountModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this new account model based on context it is used

func (*NewAccountModel) MarshalBinary ¶ 

func (m *NewAccountModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NewAccountModel) UnmarshalBinary ¶ 

func (m *NewAccountModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NewAccountModel) Validate ¶ 

func (m *NewAccountModel) Validate(formats strfmt.Registry) error

Validate validates this new account model

type NewAccountRequestModel ¶ 

type NewAccountRequestModel struct {

	// Set this to true if and only if the owner of the newly created account accepts Avalara's terms and conditions for your account.
	//
	// Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key.
	// Example: true
	AcceptAvalaraTermsAndConditions bool `json:"acceptAvalaraTermsAndConditions,omitempty"`

	// The name of the account to create
	// Example: BizTech Company Inc.
	// Required: true
	// Max Length: 50
	// Min Length: 0
	AccountName *string `json:"accountName"`

	// Type of the account to be created. Regular, Firm or FirmClient
	// Example: Regular
	// Enum: [Regular Firm FirmClient]
	AccountType string `json:"accountType,omitempty"`

	// If your Avalara business development representative requests, please provide the campaign ID associated with your
	// signup process.  This campaign identifier helps Avalara match users to the context in which they learned about the product
	// to help improve the accuracy of our messaging.
	//
	// The `campaign` field must be either null or a value provided to you by an Avalara business development representative.
	// If you provide an unexpected value in this field, your API call will fail.
	// Example: 70140000000TsVb
	Campaign string `json:"campaign,omitempty"`

	// Address information of the account being created.
	// Example: {"country":"US","line":"100 Ravine Ln","postalCode":"98010","region":"WA"}
	// Required: true
	CompanyAddress *CompanyAddress `json:"companyAddress"`

	// Company code to be assigned to the company created for this account.
	//
	// If no company code is provided, this will be defaulted to "DEFAULT" company code.
	// Max Length: 50
	// Min Length: 0
	CompanyCode *string `json:"companyCode,omitempty"`

	// The id associated with the connector
	// Example: a0n4000000ChMwPAAV
	ConnectorID string `json:"connectorId,omitempty"`

	// The date on which the account should take effect.  If null, defaults to today.
	//
	// You should leave this value `null` unless specifically requested by your Avalara business development manager.
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// Email of the primary contact person for this account
	// Example: bob@example.org
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email"`

	// The date on which the account should expire.
	//
	// You should leave this value `null` unless specifically requested by your Avalara business development manager.
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// First name of the primary contact person for this account
	// Example: Bob
	// Required: true
	// Max Length: 50
	// Min Length: 0
	FirstName *string `json:"firstName"`

	// Set this to true if and only if the owner of the newly created account has fully read Avalara's terms and conditions for your account.
	//
	// Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key.
	// Example: true
	HaveReadAvalaraTermsAndConditions bool `json:"haveReadAvalaraTermsAndConditions,omitempty"`

	// Last name of the primary contact person for this account
	// Example: Example
	// Required: true
	// Max Length: 50
	// Min Length: 0
	LastName *string `json:"lastName"`

	// If your Avalara business development representative requests, please provide the lead source value associated with your
	// signup process.  This lead source identifier helps Avalara match users to the context in which they learned about the product
	// to help improve the accuracy of our messaging.
	//
	// The `leadSource` field must be either null or a value provided to you by an Avalara business development representative.
	// If you provide an unexpected value in this field, your API call will fail.
	// Example: Direct Visitor
	LeadSource string `json:"leadSource,omitempty"`

	// A dynamic key-value pair for the marketing context information
	// Example: {"campaignId":"70140000000TsVb","leadSource":"Direct Visitor"}
	MarketingContext map[string]string `json:"marketingContext,omitempty"`

	// The offer code provided to you by your Avalara business development contact.
	//
	// This code controls what services and rates the customer will be provisioned with upon creation.
	//
	// If you do not know your offer code, please contact your Avalara business development representative.
	// Example: DeveloperDotAvalaraFreeTrial
	// Required: true
	Offer *string `json:"offer"`

	// Payment Method to be associated with the account.
	//
	// This is strictly to be used internally unless your Avalara business development manager specifically asks you to provide this value
	// while attempting to create an account.
	// Example: 701abc-def
	PaymentMethodID string `json:"paymentMethodId,omitempty"`

	// Phone number of the primary contact person for this account
	// Max Length: 50
	// Min Length: 0
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// Properties of the primary contact person for this account
	Properties []string `json:"properties"`

	// United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your
	// Social Security Number if you are an individual.
	// This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
	// Max Length: 11
	// Min Length: 0
	TaxPayerIDNumber *string `json:"taxPayerIdNumber,omitempty"`

	// Title of the primary contact person for this account
	// Max Length: 50
	// Min Length: 0
	Title *string `json:"title,omitempty"`

	// If instructed by your Avalara business development manager, set this value to a temporary password to permit the user to continue their onboarding process.
	//
	// If this value is null, a temporary password is generated by the system and emailed to the user.
	//
	// The user will then be asked to choose a permanent password when they first log on to the AvaTax website.
	UserPassword string `json:"userPassword,omitempty"`

	// The username to be associated with the user created.
	// If this is not provided, email address will be used as the username.
	// Example: bob
	// Max Length: 50
	// Min Length: 0
	Username *string `json:"username,omitempty"`

	// Website of the new customer whose account is being created.
	//
	// It is strongly recommended to provide the customer's website URL, as this will help our support representatives better
	// assist customers.
	// Example: https://biztech.com
	// Max Length: 255
	// Min Length: 0
	Website *string `json:"website,omitempty"`

	// This option controls what type of a welcome email is sent when the account is created.
	//
	// * `Normal` - A standard welcome email will be sent.
	// * `Suppressed` - No email will be sent.
	// * `Custom` - If your Avalara business development representative provides you with a customized welcome email for your customers, please select this option.
	// Example: Normal
	WelcomeEmail string `json:"welcomeEmail,omitempty"`
}

NewAccountRequestModel Represents a request for a new account with Avalara for a new subscriber. Contains information about the account requested and the rate plan selected. Example: {"acceptAvalaraTermsAndConditions":true,"accountName":"BizTech Company Inc.","accountType":"Regular","campaign":"70140000000TsVb","companyAddress":{"country":"US","line":"100 Ravine Ln","postalCode":"98010","region":"WA"},"connectorId":"a0n4000000ChMwPAAV","email":"bob@example.org","firstName":"Bob","haveReadAvalaraTermsAndConditions":true,"lastName":"Example","leadSource":"Direct Visitor","marketingContext":{"campaignId":"70140000000TsVb","leadSource":"Direct Visitor"},"offer":"DeveloperDotAvalaraFreeTrial","paymentMethodId":"701abc-def","username":"bob","website":"https://biztech.com","welcomeEmail":"Normal"}

swagger:model NewAccountRequestModel

func (*NewAccountRequestModel) ContextValidate ¶ 

func (m *NewAccountRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this new account request model based on the context it is used

func (*NewAccountRequestModel) MarshalBinary ¶ 

func (m *NewAccountRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NewAccountRequestModel) UnmarshalBinary ¶ 

func (m *NewAccountRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NewAccountRequestModel) Validate ¶ 

func (m *NewAccountRequestModel) Validate(formats strfmt.Registry) error

Validate validates this new account request model

type NewFirmClientAccountRequestModel ¶ 

type NewFirmClientAccountRequestModel struct {

	// The name of the account to create
	// Example: BizTech Company Inc.
	// Required: true
	// Max Length: 50
	// Min Length: 0
	AccountName *string `json:"accountName"`

	// Address information of the account being created.
	// Example: {"country":"US","line":"100 Ravine Ln","postalCode":"98010","region":"WA"}
	// Required: true
	CompanyAddress *CompanyAddress `json:"companyAddress"`

	// Company code to be assigned to the company created for this account.
	//
	// If no company code is provided, this will be defaulted to "DEFAULT" company code.
	// Example: DEFAULT
	// Max Length: 50
	// Min Length: 0
	CompanyCode *string `json:"companyCode,omitempty"`

	// Email of the primary contact person for this account
	// Example: bob@example.org
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email"`

	// First name of the primary contact person for this account
	// Example: Bob
	// Required: true
	// Max Length: 50
	// Min Length: 0
	FirstName *string `json:"firstName"`

	// Last name of the primary contact person for this account
	// Example: Example
	// Required: true
	// Max Length: 50
	// Min Length: 0
	LastName *string `json:"lastName"`

	// Phone number of the primary contact person for this account
	// Max Length: 50
	// Min Length: 0
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// Properties of the primary contact person for this account
	Properties []string `json:"properties"`

	// United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your
	// Social Security Number if you are an individual.
	// This value is required if the address provided is inside the US. Otherwise it is optional.
	// Max Length: 11
	// Min Length: 0
	TaxPayerIDNumber *string `json:"taxPayerIdNumber,omitempty"`

	// Title of the primary contact person for this account
	// Max Length: 50
	// Min Length: 0
	Title *string `json:"title,omitempty"`
}

NewFirmClientAccountRequestModel Represents a request for a new account with Avalara for a new Firm client. Example: {"accountName":"BizTech Company Inc.","companyAddress":{"country":"US","line":"100 Ravine Ln","postalCode":"98010","region":"WA"},"companyCode":"DEFAULT","email":"bob@example.org","firstName":"Bob","lastName":"Example"}

swagger:model NewFirmClientAccountRequestModel

func (*NewFirmClientAccountRequestModel) ContextValidate ¶ 

func (m *NewFirmClientAccountRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this new firm client account request model based on the context it is used

func (*NewFirmClientAccountRequestModel) MarshalBinary ¶ 

func (m *NewFirmClientAccountRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NewFirmClientAccountRequestModel) UnmarshalBinary ¶ 

func (m *NewFirmClientAccountRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NewFirmClientAccountRequestModel) Validate ¶ 

func (m *NewFirmClientAccountRequestModel) Validate(formats strfmt.Registry) error

Validate validates this new firm client account request model

type NexusByAddressModel ¶ 

type NexusByAddressModel struct {

	// The address that was provided by the user in the call to `DeclareNexusByAddress`
	// Example: {"city":"Irvine","country":"US","effectiveDate":"2018-01-01T00:00:00","endDate":"2020-12-31T00:00:00","line1":"2000 Main Street","postalCode":"92614","region":"CA"}
	Address *DeclareNexusByAddressModel `json:"address,omitempty"`

	// List of all nexus objects that were affected by declaring nexus at the address specified
	// by `address`.
	// Example: [{"companyId":0,"country":"US","createdDate":"2017-06-30T05:14:06.003","createdUserId":0,"effectiveDate":"2017-04-01","hasLocalNexus":false,"hasPermanentEstablishment":true,"id":0,"isSSTActive":false,"isSellerImporterOfRecord":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisTypeId":"STA","jurisdictionTypeId":"State","modifiedDate":"2021-12-06T09:14:53.693","modifiedUserId":0,"nexusTaxTypeGroup":"SalesAndUse","nexusTypeId":"SalesOrSellersUseTax","region":"CA","shortName":"CALIFORNIA","signatureCode":"","sourcing":"Destination","stateAssignedNo":"","streamlinedSalesTax":false,"taxName":"Tire Fee","taxTypeGroup":"EWaste","taxableNexus":true}]
	DeclaredNexus []*NexusModel `json:"declaredNexus"`
}

NexusByAddressModel Contains information about nexus jurisdictions that were declared as a result of a call to `DeclareNexusByAddress`. For each address, this object model contains a list of the nexus objects that were declared according to the geocoding that corresponds to this address. Example: {"address":{"city":"Irvine","country":"US","effectiveDate":"2018-01-01T00:00:00","endDate":"2020-12-31T00:00:00","line1":"2000 Main Street","postalCode":"92614","region":"CA"},"declaredNexus":[{"companyId":0,"country":"US","createdDate":"2017-06-30T05:14:06.003","createdUserId":0,"effectiveDate":"2017-04-01","hasLocalNexus":false,"hasPermanentEstablishment":true,"id":0,"isSSTActive":false,"isSellerImporterOfRecord":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisTypeId":"STA","jurisdictionTypeId":"State","modifiedDate":"2021-12-06T09:14:53.693","modifiedUserId":0,"nexusTaxTypeGroup":"SalesAndUse","nexusTypeId":"SalesOrSellersUseTax","region":"CA","shortName":"CALIFORNIA","signatureCode":"","sourcing":"Destination","stateAssignedNo":"","streamlinedSalesTax":false,"taxName":"Tire Fee","taxTypeGroup":"EWaste","taxableNexus":true}]}

swagger:model NexusByAddressModel

func (*NexusByAddressModel) ContextValidate ¶ 

func (m *NexusByAddressModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus by address model based on the context it is used

func (*NexusByAddressModel) MarshalBinary ¶ 

func (m *NexusByAddressModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusByAddressModel) UnmarshalBinary ¶ 

func (m *NexusByAddressModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusByAddressModel) Validate ¶ 

func (m *NexusByAddressModel) Validate(formats strfmt.Registry) error

Validate validates this nexus by address model

type NexusByTaxFormModel ¶ 

type NexusByTaxFormModel struct {

	// The company ID of the company that was used to load the companyNexus array.  If this value is null, no company data was loaded.
	// Example: 12345
	CompanyID int32 `json:"companyId,omitempty"`

	// A list of all currently-defined company nexus that are related to this tax form
	// Example: []
	CompanyNexus []*NexusModel `json:"companyNexus"`

	// The code of the tax form that was requested
	// Example: UNKNOWNFORM
	FormCode string `json:"formCode,omitempty"`

	// A list of all Avalara-defined nexus that are relevant to this tax form
	// Example: []
	NexusDefinitions []*NexusModel `json:"nexusDefinitions"`
}

NexusByTaxFormModel Identifies all nexus that match a particular tax form Example: {"companyId":12345,"companyNexus":[],"formCode":"UNKNOWNFORM","nexusDefinitions":[]}

swagger:model NexusByTaxFormModel

func (*NexusByTaxFormModel) ContextValidate ¶ 

func (m *NexusByTaxFormModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus by tax form model based on the context it is used

func (*NexusByTaxFormModel) MarshalBinary ¶ 

func (m *NexusByTaxFormModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusByTaxFormModel) UnmarshalBinary ¶ 

func (m *NexusByTaxFormModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusByTaxFormModel) Validate ¶ 

func (m *NexusByTaxFormModel) Validate(formats strfmt.Registry) error

Validate validates this nexus by tax form model

type NexusModel ¶ 

type NexusModel struct {

	// The unique ID number of the company that declared nexus.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Example: 0
	CompanyID int32 `json:"companyId,omitempty"`

	// Name or ISO 3166 code identifying the country in which this company declared nexus.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// The date when this record was created.
	//
	// This field is defined automatically when you declare nexus.  You do not need to provide a value for this field.
	// Example: 2017-06-30T05:14:06.003
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	//
	// This field is defined automatically when you declare nexus.  You do not need to provide a value for this field.
	// Example: 0
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date when this nexus began.  If not known, set to null.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Example: 2017-04-01T00:00:00
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// If this nexus will end or has ended on a specific date, set this to the date when this nexus ends.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// True if you are also declaring local nexus within this jurisdiction.
	// Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: false
	HasLocalNexus bool `json:"hasLocalNexus,omitempty"`

	// Set this value to true if your company has a permanent establishment within this jurisdiction.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Example: true
	HasPermanentEstablishment bool `json:"hasPermanentEstablishment,omitempty"`

	// The unique ID number of this declaration of nexus.
	//
	// This field is defined automatically when you declare nexus.  You do not need to provide a value for this field.
	// Example: 0
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates
	// in the Streamlined Sales Tax program and if the account associated with the Nexus has an active AvaTaxCsp subscription.
	// For countries other than the US, this flag is null.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: false
	// Read Only: true
	IsSSTActive *bool `json:"isSSTActive,omitempty"`

	// For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region.
	//
	// Some taxes only apply if the seller is the importer of record for a product.  In cases where companies are working together to
	// ship products, there may be mutual agreement as to which company is the entity designated as importer of record.  The importer
	// of record will then be the company designated to pay taxes marked as being obligated to the importer of record.
	//
	// Set this value to `true` to consider your company as the importer of record and collect these taxes.  Leave this value as false
	// or null and taxes will be calculated as if your company is not the importer of record.
	//
	// This value may also be set during each transaction API call.  See `CreateTransaction()` for more information.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Example: false
	IsSellerImporterOfRecord bool `json:"isSellerImporterOfRecord,omitempty"`

	// The code identifying the jurisdiction in which this company declared nexus.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: 06
	// Required: true
	// Max Length: 10
	// Min Length: 0
	JurisCode *string `json:"jurisCode"`

	// The common name of the jurisdiction in which this company declared nexus.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: CALIFORNIA
	// Required: true
	// Max Length: 200
	// Min Length: 0
	JurisName *string `json:"jurisName"`

	// DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead.
	// The jurisdiction type of the jurisdiction in which this company declared nexus.
	// Example: STA
	// Enum: [STA CTY CIT STJ CNT]
	JurisTypeID string `json:"jurisTypeId,omitempty"`

	// The type of the jurisdiction in which this company declared nexus.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: Country
	// Enum: [Country State County City Special]
	JurisdictionTypeID string `json:"jurisdictionTypeId,omitempty"`

	// If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only
	// a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Example: Selected
	// Enum: [Selected StateAdministered All]
	LocalNexusTypeID string `json:"localNexusTypeId,omitempty"`

	// The date/time when this record was last modified.
	//
	// This field is defined automatically when you declare nexus.  You do not need to provide a value for this field.
	// Example: 2021-12-06T09:14:53.693
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	//
	// This field is defined automatically when you declare nexus.  You do not need to provide a value for this field.
	// Example: 0
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The type of nexus that this company is declaring.Replaces NexusTypeId.
	// Use [ListNexusTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListNexusTaxTypeGroups/) API for a list of nexus tax type groups.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: SalesAndUse
	NexusTaxTypeGroup string `json:"nexusTaxTypeGroup,omitempty"`

	// The type of nexus that this company is declaring.
	//
	// If you are voluntarily declaring nexus in a jurisdiction, you should select `SalesOrSellersUseTax` for your
	// nexus type option.  This option allows you to calculate tax correctly whether you are selling in-state or
	// shipping from an out-of-state location.
	//
	// If you are legally obligated to declare nexus due to physical presence or other sufficient nexus, you
	// should select `SalesTax`.  This indicates that, as a legal requirement, your company must always collect
	// and remit full sales tax in this jurisdiction.
	//
	// If you are participating in the Streamlined Sales Tax program, your SST administrator will select nexus
	// settings for you in all SST jurisdictions.  Do not select any SST options by yourself.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Example: None
	// Enum: [None SalesOrSellersUseTax SalesTax SSTVolunteer SSTNonVolunteer]
	NexusTypeID string `json:"nexusTypeId,omitempty"`

	// List of nexus parameters.
	// Read Only: true
	Parameters []*NexusParameterDetailModel `json:"parameters"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: CA
	// Required: true
	Region *string `json:"region"`

	// The short name of the jurisdiction.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: CALIFORNIA
	// Read Only: true
	// Max Length: 15
	// Min Length: 0
	ShortName string `json:"shortName,omitempty"`

	// The signature code of the boundary region as defined by Avalara.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Read Only: true
	// Max Length: 4
	// Min Length: 0
	SignatureCode string `json:"signatureCode,omitempty"`

	// Indicates whether this nexus is defined as origin or destination nexus.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: Mixed
	// Enum: [Mixed Destination Origin]
	Sourcing string `json:"sourcing,omitempty"`

	// The state assigned number of this jurisdiction.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Read Only: true
	// Max Length: 50
	// Min Length: 0
	StateAssignedNo string `json:"stateAssignedNo,omitempty"`

	// DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead.
	// For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates
	// in the Streamlined Sales Tax program.  For countries other than the US, this flag is null.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// Example: false
	// Read Only: true
	StreamlinedSalesTax *bool `json:"streamlinedSalesTax,omitempty"`

	// A unique ID number of the tax authority that is associated with this nexus.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	TaxAuthorityID int64 `json:"taxAuthorityId,omitempty"`

	// Optional - the tax identification number under which you declared nexus.
	//
	// This field is user-selectable and should be provided when creating or updating a nexus object.
	// Max Length: 25
	// Min Length: 0
	TaxID *string `json:"taxId,omitempty"`

	// A description of corresponding tax type applied to the nexus.
	//
	// When a custom nexus is created, it'll have to be matched to a system nexus to be validated successfully. The matched system nexus has a
	// field to describe the tax type applied to it, that field will be copied over to the nexus that is being created.
	//
	// This field is defined by Avalara. Its main purpose is to give a simple description of the tax type associated with the nexus so
	// users have a better understanding of the nexus when it is displayed.
	// Example: Tire Fee
	// Read Only: true
	TaxName string `json:"taxName,omitempty"`

	// The type group of nexus that this company is declaring
	// Use [ListTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListTaxTypeGroups/) API for a list of nexus tax type groups.
	//
	// This field is defined by Avalara.  All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.
	// NOTE: This optional field will trigger nexus subtype lookup when populated. When using make sure TaxTypeGroup matches corresponding NexusTaxTypeGroup
	// Example: EWaste
	TaxTypeGroup string `json:"taxTypeGroup,omitempty"`

	// Shows if system nexus records are associated with tax collection
	// Example: true
	// Read Only: true
	TaxableNexus *bool `json:"taxableNexus,omitempty"`
}

NexusModel Represents a declaration of nexus within a particular taxing jurisdiction.

To create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a list of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object.

The user selectable fields for the nexus object are `companyId`, `effectiveDate`, `endDate`, `localNexusTypeId`, `taxId`, `nexusTypeId`, `hasPermanentEstablishment`, and `isSellerImporterOfRecord`.

When calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects by calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration. Example: {"companyId":0,"country":"US","createdDate":"2017-06-30T05:14:06.003","createdUserId":0,"effectiveDate":"2017-04-01","hasLocalNexus":false,"hasPermanentEstablishment":true,"id":0,"isSSTActive":false,"isSellerImporterOfRecord":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisTypeId":"STA","jurisdictionTypeId":"State","modifiedDate":"2021-12-06T09:14:53.693","modifiedUserId":0,"nexusTaxTypeGroup":"SalesAndUse","nexusTypeId":"SalesOrSellersUseTax","region":"CA","shortName":"CALIFORNIA","signatureCode":"","sourcing":"Destination","stateAssignedNo":"","streamlinedSalesTax":false,"taxName":"Tire Fee","taxTypeGroup":"EWaste","taxableNexus":true}

swagger:model NexusModel

func (*NexusModel) ContextValidate ¶ 

func (m *NexusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus model based on the context it is used

func (*NexusModel) MarshalBinary ¶ 

func (m *NexusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusModel) UnmarshalBinary ¶ 

func (m *NexusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusModel) Validate ¶ 

func (m *NexusModel) Validate(formats strfmt.Registry) error

Validate validates this nexus model

type NexusModelFetchResult ¶ 

type NexusModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NexusModel `json:"value"`
}

NexusModelFetchResult nexus model fetch result

swagger:model NexusModelFetchResult

func (*NexusModelFetchResult) ContextValidate ¶ 

func (m *NexusModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus model fetch result based on the context it is used

func (*NexusModelFetchResult) MarshalBinary ¶ 

func (m *NexusModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusModelFetchResult) UnmarshalBinary ¶ 

func (m *NexusModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusModelFetchResult) Validate ¶ 

func (m *NexusModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this nexus model fetch result

type NexusParameterDetailModel ¶ 

type NexusParameterDetailModel struct {

	// The id of the parameter.
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The parameter's name.
	// Example: IsRemoteSeller
	// Required: true
	Name *string `json:"name"`

	// The nexus id
	NexusID int32 `json:"nexusId,omitempty"`

	// The unit of measurement code for the parameter.
	Unit string `json:"unit,omitempty"`

	// The value for the parameter.
	// Example: true
	// Required: true
	Value *string `json:"value"`
}

NexusParameterDetailModel Represents a parameter associated with a nexus. Example: {"id":0,"name":"IsRemoteSeller","value":"true"}

swagger:model NexusParameterDetailModel

func (*NexusParameterDetailModel) ContextValidate ¶ 

func (m *NexusParameterDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus parameter detail model based on the context it is used

func (*NexusParameterDetailModel) MarshalBinary ¶ 

func (m *NexusParameterDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusParameterDetailModel) UnmarshalBinary ¶ 

func (m *NexusParameterDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusParameterDetailModel) Validate ¶ 

func (m *NexusParameterDetailModel) Validate(formats strfmt.Registry) error

Validate validates this nexus parameter detail model

type NexusParameterDetailModelFetchResult ¶ 

type NexusParameterDetailModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NexusParameterDetailModel `json:"value"`
}

NexusParameterDetailModelFetchResult nexus parameter detail model fetch result

swagger:model NexusParameterDetailModelFetchResult

func (*NexusParameterDetailModelFetchResult) ContextValidate ¶ 

func (m *NexusParameterDetailModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus parameter detail model fetch result based on the context it is used

func (*NexusParameterDetailModelFetchResult) MarshalBinary ¶ 

func (m *NexusParameterDetailModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusParameterDetailModelFetchResult) UnmarshalBinary ¶ 

func (m *NexusParameterDetailModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusParameterDetailModelFetchResult) Validate ¶ 

func (m *NexusParameterDetailModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this nexus parameter detail model fetch result

type NexusSummaryModel ¶ 

type NexusSummaryModel struct {

	// Company Id
	// Example: 1234
	CompanyID int32 `json:"companyId,omitempty"`

	// Nexus summary for this company
	// Example: [{"count":8,"nexusTaxTypeGroup":"SalesAndUse"},{"count":5,"nexusTaxTypeGroup":"InputOutput"}]
	NexusSummary []*NexusTaxTypeGroupCountModel `json:"nexusSummary"`
}

NexusSummaryModel Nexus summary model Example: {"companyId":1234,"nexusSummary":[{"count":8,"nexusTaxTypeGroup":"SalesAndUse"},{"count":5,"nexusTaxTypeGroup":"InputOutput"}]}

swagger:model NexusSummaryModel

func (*NexusSummaryModel) ContextValidate ¶ 

func (m *NexusSummaryModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus summary model based on the context it is used

func (*NexusSummaryModel) MarshalBinary ¶ 

func (m *NexusSummaryModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusSummaryModel) UnmarshalBinary ¶ 

func (m *NexusSummaryModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusSummaryModel) Validate ¶ 

func (m *NexusSummaryModel) Validate(formats strfmt.Registry) error

Validate validates this nexus summary model

type NexusTaxTypeGroupCountModel ¶ 

type NexusTaxTypeGroupCountModel struct {

	// How many nexus in the group
	Count int32 `json:"count,omitempty"`

	// Which nexus tax type group
	NexusTaxTypeGroup string `json:"nexusTaxTypeGroup,omitempty"`
}

NexusTaxTypeGroupCountModel Nexus tax type groupe with count

swagger:model NexusTaxTypeGroupCountModel

func (*NexusTaxTypeGroupCountModel) ContextValidate ¶ 

func (m *NexusTaxTypeGroupCountModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this nexus tax type group count model based on context it is used

func (*NexusTaxTypeGroupCountModel) MarshalBinary ¶ 

func (m *NexusTaxTypeGroupCountModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusTaxTypeGroupCountModel) UnmarshalBinary ¶ 

func (m *NexusTaxTypeGroupCountModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusTaxTypeGroupCountModel) Validate ¶ 

func (m *NexusTaxTypeGroupCountModel) Validate(formats strfmt.Registry) error

Validate validates this nexus tax type group count model

type NexusTaxTypeGroupModel ¶ 

type NexusTaxTypeGroupModel struct {

	// The description of this nexus tax type group.
	// Example: Sales and Use
	Description string `json:"description,omitempty"`

	// The unique ID number of this nexus tax type group.
	// Example: 1
	ID int32 `json:"id,omitempty"`

	// The unique human readable Id of this nexus tax type group.
	// Example: SalesAndUse
	NexusTaxTypeGroupID string `json:"nexusTaxTypeGroupId,omitempty"`

	// True if this tax type group is displayed in the user interface of the AvaTax website.
	ShowColumn bool `json:"showColumn,omitempty"`

	// If this tax type group requires a subscription, this contains the friendly name of the subscription type required to use it.
	SubscriptionDescription string `json:"subscriptionDescription,omitempty"`

	// If this tax type group requires a subscription, this contains the ID number of the subscription type required to use it.
	SubscriptionTypeID int32 `json:"subscriptionTypeId,omitempty"`

	// The name of the tab in the AvaTax website corresponding to this tax type group.
	TabName string `json:"tabName,omitempty"`
}

NexusTaxTypeGroupModel Represents a group of tax types Example: {"description":"Sales and Use","id":1,"nexusTaxTypeGroupId":"SalesAndUse"}

swagger:model NexusTaxTypeGroupModel

func (*NexusTaxTypeGroupModel) ContextValidate ¶ 

func (m *NexusTaxTypeGroupModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this nexus tax type group model based on context it is used

func (*NexusTaxTypeGroupModel) MarshalBinary ¶ 

func (m *NexusTaxTypeGroupModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusTaxTypeGroupModel) UnmarshalBinary ¶ 

func (m *NexusTaxTypeGroupModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusTaxTypeGroupModel) Validate ¶ 

func (m *NexusTaxTypeGroupModel) Validate(formats strfmt.Registry) error

Validate validates this nexus tax type group model

type NexusTaxTypeGroupModelFetchResult ¶ 

type NexusTaxTypeGroupModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NexusTaxTypeGroupModel `json:"value"`
}

NexusTaxTypeGroupModelFetchResult nexus tax type group model fetch result

swagger:model NexusTaxTypeGroupModelFetchResult

func (*NexusTaxTypeGroupModelFetchResult) ContextValidate ¶ 

func (m *NexusTaxTypeGroupModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nexus tax type group model fetch result based on the context it is used

func (*NexusTaxTypeGroupModelFetchResult) MarshalBinary ¶ 

func (m *NexusTaxTypeGroupModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NexusTaxTypeGroupModelFetchResult) UnmarshalBinary ¶ 

func (m *NexusTaxTypeGroupModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NexusTaxTypeGroupModelFetchResult) Validate ¶ 

func (m *NexusTaxTypeGroupModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this nexus tax type group model fetch result

type NoticeCommentModel ¶ 

type NoticeCommentModel struct {

	// An attachment to the detail
	// Example: {"accountId":5555,"companyId":66666,"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","length":333,"name":"nameoffile.txt","resourceFileTypeId":0,"username":"test.user"}
	AttachmentUploadRequest *ResourceFileUploadRequestModel `json:"attachmentUploadRequest,omitempty"`

	// TaxNoticeComment
	// Example: comment
	Comment string `json:"comment,omitempty"`

	// TaxNoticeCommentLink
	// Example: www.avalara.com
	CommentLink string `json:"commentLink,omitempty"`

	// taxNoticeCommentType
	// Example: Internal
	// Required: true
	// Enum: [Internal Customer POAAttachment NoticeVoucher]
	CommentType *string `json:"commentType"`

	// taxNoticeCommentTypeId
	// Example: 0
	CommentTypeID int32 `json:"commentTypeId,omitempty"`

	// TaxNoticeCommentUserId
	// Example: 0
	CommentUserID int32 `json:"commentUserId,omitempty"`

	// TaxNoticeCommentUserName
	// Example: complianceUser
	// Read Only: true
	CommentUserName string `json:"commentUserName,omitempty"`

	// The date this comment was entered
	// Example: 2021-12-25T17:08:45.9679334Z
	// Format: date-time
	Date strfmt.DateTime `json:"date,omitempty"`

	// The unique ID number of this notice.
	// Example: 1123
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The ID of the notice this comment is attached too
	// Example: 12345
	// Required: true
	NoticeID *int32 `json:"noticeId"`

	// resourceFileId
	ResourceFileID int64 `json:"resourceFileId,omitempty"`

	// TaxNoticeFileName
	// Example: xyz.txt
	// Max Length: 300
	// Min Length: 0
	TaxNoticeFileName *string `json:"taxNoticeFileName,omitempty"`
}

NoticeCommentModel Represents communication between Avalara and the company regarding the processing of a tax notice. Example: {"attachmentUploadRequest":{"accountId":5555,"companyId":66666,"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","length":333,"name":"nameoffile.txt","resourceFileTypeId":0,"username":"test.user"},"comment":"comment","commentLink":"www.avalara.com","commentType":"Internal","commentTypeId":0,"commentUserId":0,"commentUserName":"complianceUser","date":"2021-12-25T17:08:45.9679334Z","id":1123,"noticeId":12345,"taxNoticeFileName":"xyz.txt"}

swagger:model NoticeCommentModel

func (*NoticeCommentModel) ContextValidate ¶ 

func (m *NoticeCommentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice comment model based on the context it is used

func (*NoticeCommentModel) MarshalBinary ¶ 

func (m *NoticeCommentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeCommentModel) UnmarshalBinary ¶ 

func (m *NoticeCommentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeCommentModel) Validate ¶ 

func (m *NoticeCommentModel) Validate(formats strfmt.Registry) error

Validate validates this notice comment model

type NoticeCommentModelFetchResult ¶ 

type NoticeCommentModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeCommentModel `json:"value"`
}

NoticeCommentModelFetchResult notice comment model fetch result

swagger:model NoticeCommentModelFetchResult

func (*NoticeCommentModelFetchResult) ContextValidate ¶ 

func (m *NoticeCommentModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice comment model fetch result based on the context it is used

func (*NoticeCommentModelFetchResult) MarshalBinary ¶ 

func (m *NoticeCommentModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeCommentModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeCommentModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeCommentModelFetchResult) Validate ¶ 

func (m *NoticeCommentModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice comment model fetch result

type NoticeCustomerFundingOptionModel ¶ 

type NoticeCustomerFundingOptionModel struct {

	// A flag if the FundingOption is active
	// Example: true
	ActiveFlag bool `json:"activeFlag,omitempty"`

	// The description name of this tax authority FundingOption.
	// Example: Pull
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax notice customer FundingOption.
	// Example: 1
	// Required: true
	ID *int32 `json:"id"`

	// sort order of the FundingOptions
	// Example: 5
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeCustomerFundingOptionModel Tax Authority Model Example: {"activeFlag":true,"description":"Pull","id":1,"sortOrder":5}

swagger:model NoticeCustomerFundingOptionModel

func (*NoticeCustomerFundingOptionModel) ContextValidate ¶ 

func (m *NoticeCustomerFundingOptionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice customer funding option model based on context it is used

func (*NoticeCustomerFundingOptionModel) MarshalBinary ¶ 

func (m *NoticeCustomerFundingOptionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeCustomerFundingOptionModel) UnmarshalBinary ¶ 

func (m *NoticeCustomerFundingOptionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeCustomerFundingOptionModel) Validate ¶ 

func (m *NoticeCustomerFundingOptionModel) Validate(formats strfmt.Registry) error

Validate validates this notice customer funding option model

type NoticeCustomerFundingOptionModelFetchResult ¶ 

type NoticeCustomerFundingOptionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeCustomerFundingOptionModel `json:"value"`
}

NoticeCustomerFundingOptionModelFetchResult notice customer funding option model fetch result

swagger:model NoticeCustomerFundingOptionModelFetchResult

func (*NoticeCustomerFundingOptionModelFetchResult) ContextValidate ¶ 

func (m *NoticeCustomerFundingOptionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice customer funding option model fetch result based on the context it is used

func (*NoticeCustomerFundingOptionModelFetchResult) MarshalBinary ¶ 

func (m *NoticeCustomerFundingOptionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeCustomerFundingOptionModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeCustomerFundingOptionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeCustomerFundingOptionModelFetchResult) Validate ¶ 

func (m *NoticeCustomerFundingOptionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice customer funding option model fetch result

type NoticeCustomerTypeModel ¶ 

type NoticeCustomerTypeModel struct {

	// A flag if the type is active
	// Example: true
	ActiveFlag bool `json:"activeFlag,omitempty"`

	// The description name of this tax authority type.
	// Example: City
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax notice customer type.
	// Example: 12345
	// Required: true
	ID *int32 `json:"id"`

	// sort order of the types
	// Example: 5
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeCustomerTypeModel Tax Authority Model Example: {"activeFlag":true,"description":"City","id":12345,"sortOrder":5}

swagger:model NoticeCustomerTypeModel

func (*NoticeCustomerTypeModel) ContextValidate ¶ 

func (m *NoticeCustomerTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice customer type model based on context it is used

func (*NoticeCustomerTypeModel) MarshalBinary ¶ 

func (m *NoticeCustomerTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeCustomerTypeModel) UnmarshalBinary ¶ 

func (m *NoticeCustomerTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeCustomerTypeModel) Validate ¶ 

func (m *NoticeCustomerTypeModel) Validate(formats strfmt.Registry) error

Validate validates this notice customer type model

type NoticeCustomerTypeModelFetchResult ¶ 

type NoticeCustomerTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeCustomerTypeModel `json:"value"`
}

NoticeCustomerTypeModelFetchResult notice customer type model fetch result

swagger:model NoticeCustomerTypeModelFetchResult

func (*NoticeCustomerTypeModelFetchResult) ContextValidate ¶ 

func (m *NoticeCustomerTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice customer type model fetch result based on the context it is used

func (*NoticeCustomerTypeModelFetchResult) MarshalBinary ¶ 

func (m *NoticeCustomerTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeCustomerTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeCustomerTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeCustomerTypeModelFetchResult) Validate ¶ 

func (m *NoticeCustomerTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice customer type model fetch result

type NoticeFilingTypeModel ¶ 

type NoticeFilingTypeModel struct {

	// A flag if the type is active
	// Example: true
	ActiveFlag bool `json:"activeFlag,omitempty"`

	// The description name of this tax authority type.
	// Example: Electronic Return
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax notice customer type.
	// Example: 1
	// Required: true
	ID *int32 `json:"id"`

	// sort order of the types
	// Example: 5
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeFilingTypeModel Tax Notice FilingType Model Example: {"activeFlag":true,"description":"Electronic Return ","id":1,"sortOrder":5}

swagger:model NoticeFilingTypeModel

func (*NoticeFilingTypeModel) ContextValidate ¶ 

func (m *NoticeFilingTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice filing type model based on context it is used

func (*NoticeFilingTypeModel) MarshalBinary ¶ 

func (m *NoticeFilingTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeFilingTypeModel) UnmarshalBinary ¶ 

func (m *NoticeFilingTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeFilingTypeModel) Validate ¶ 

func (m *NoticeFilingTypeModel) Validate(formats strfmt.Registry) error

Validate validates this notice filing type model

type NoticeFilingTypeModelFetchResult ¶ 

type NoticeFilingTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeFilingTypeModel `json:"value"`
}

NoticeFilingTypeModelFetchResult notice filing type model fetch result

swagger:model NoticeFilingTypeModelFetchResult

func (*NoticeFilingTypeModelFetchResult) ContextValidate ¶ 

func (m *NoticeFilingTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice filing type model fetch result based on the context it is used

func (*NoticeFilingTypeModelFetchResult) MarshalBinary ¶ 

func (m *NoticeFilingTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeFilingTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeFilingTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeFilingTypeModelFetchResult) Validate ¶ 

func (m *NoticeFilingTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice filing type model fetch result

type NoticeFinanceModel ¶ 

type NoticeFinanceModel struct {

	// An attachment to the finance detail
	// Example: {"accountId":5555,"companyId":66666,"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","length":333,"name":"nameoffile.txt","resourceFileTypeId":0,"username":"test.user"}
	AttachmentUploadRequest *ResourceFileUploadRequestModel `json:"attachmentUploadRequest,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The amount of credits listed on the notice
	// Example: 85.98
	Credits float64 `json:"credits,omitempty"`

	// The amount of CSP Fee Refund on the notice
	// Example: 10.98
	CspFeeRefund float64 `json:"cspFeeRefund,omitempty"`

	// The amount of customer interest on the notice
	// Example: 13.98
	CustomerInterest float64 `json:"customerInterest,omitempty"`

	// The amount of customer penalty on the notice
	// Example: 23.98
	CustomerPenalty float64 `json:"customerPenalty,omitempty"`

	// The due date of the notice
	// Example: 2022-01-08T17:08:46.017393Z
	// Format: date-time
	DueDate strfmt.DateTime `json:"dueDate,omitempty"`

	// The name of the file attached to the finance detail
	FileName string `json:"fileName,omitempty"`

	// The Unique Id of the Finance Model
	// Example: 0
	ID int32 `json:"id,omitempty"`

	// The amount of interest listed on the notice
	// Example: 88.98
	Interest float64 `json:"interest,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The date of the notice
	// Example: 2021-12-25T17:08:46.0173736Z
	// Format: date-time
	NoticeDate strfmt.DateTime `json:"noticeDate,omitempty"`

	// The unique ID of the the tax notice associated with the the finance detail
	// Example: 12345
	NoticeID int32 `json:"noticeId,omitempty"`

	// The sequential number of the notice
	// Example: 3x3215
	NoticeNumber string `json:"noticeNumber,omitempty"`

	// The amound of penalty listed on the notice
	// Example: 56.98
	Penalty float64 `json:"penalty,omitempty"`

	// The ResourceFileId of the finance detail attachment
	ResourceFileID int64 `json:"resourceFileId,omitempty"`

	// The amount of tax abated on the notice
	// Example: 45.98
	TaxAbated float64 `json:"taxAbated,omitempty"`

	// The amount of tax due on the notice
	// Example: 99.98
	TaxDue float64 `json:"taxDue,omitempty"`
}

NoticeFinanceModel Represents estimated financial results from responding to a tax notice. Example: {"attachmentUploadRequest":{"accountId":5555,"companyId":66666,"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","length":333,"name":"nameoffile.txt","resourceFileTypeId":0,"username":"test.user"},"credits":85.98,"cspFeeRefund":10.98,"customerInterest":13.98,"customerPenalty":23.98,"dueDate":"2022-01-08T17:08:46.017393Z","id":0,"interest":88.98,"noticeDate":"2021-12-25T17:08:46.0173736Z","noticeId":12345,"noticeNumber":"3x3215","penalty":56.98,"taxAbated":45.98,"taxDue":99.98}

swagger:model NoticeFinanceModel

func (*NoticeFinanceModel) ContextValidate ¶ 

func (m *NoticeFinanceModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice finance model based on the context it is used

func (*NoticeFinanceModel) MarshalBinary ¶ 

func (m *NoticeFinanceModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeFinanceModel) UnmarshalBinary ¶ 

func (m *NoticeFinanceModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeFinanceModel) Validate ¶ 

func (m *NoticeFinanceModel) Validate(formats strfmt.Registry) error

Validate validates this notice finance model

type NoticeFinanceModelFetchResult ¶ 

type NoticeFinanceModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeFinanceModel `json:"value"`
}

NoticeFinanceModelFetchResult notice finance model fetch result

swagger:model NoticeFinanceModelFetchResult

func (*NoticeFinanceModelFetchResult) ContextValidate ¶ 

func (m *NoticeFinanceModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice finance model fetch result based on the context it is used

func (*NoticeFinanceModelFetchResult) MarshalBinary ¶ 

func (m *NoticeFinanceModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeFinanceModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeFinanceModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeFinanceModelFetchResult) Validate ¶ 

func (m *NoticeFinanceModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice finance model fetch result

type NoticeModel ¶ 

type NoticeModel struct {

	// The ava file form id of the notice
	// Example: 333
	AvaFileFormID int32 `json:"avaFileFormId,omitempty"`

	// The unique ID number of the user that closed the notice
	// Example: 1
	ClosedByUserID int32 `json:"closedByUserId,omitempty"`

	// The closed date of the notice
	// Example: 2022-01-14T17:08:46.0568477Z
	// Format: date-time
	ClosedDate strfmt.DateTime `json:"closedDate,omitempty"`

	// Additional comments on the notice
	// Example: [{"comment":"spoke to Chris payment not received need copy of check.VW","commentType":"Internal","commentTypeId":0,"commentUserId":1,"commentUserName":"user@compliance.com","date":"2021-12-25T17:08:46.056639Z","id":3,"noticeId":3878}]
	Comments []*NoticeCommentModel `json:"comments"`

	// The unique ID number of the company to which this notice belongs.
	// Example: 5714
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// The id of the compliance contact
	// Example: 555
	ComplianceContactID int32 `json:"complianceContactId,omitempty"`

	// Name or ISO 3166 code identifying the country that sent this notice.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// The user who created the notice
	// Example: user@compliance.com
	// Read Only: true
	CreatedByUserName string `json:"createdByUserName,omitempty"`

	// The date when this record was created.
	// Example: 2021-12-20T17:08:46.0572475Z
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Example: 1
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Comments from the customer on this notice
	// Example: comments
	CustomerComment string `json:"customerComment,omitempty"`

	// The notice customer funding options
	// Example: Pull
	// Enum: [Pull Wire]
	CustomerFundingOptionID string `json:"customerFundingOptionId,omitempty"`

	// NoticeCustomerTypeID can be retrieved from the definitions API
	// Example: AvaTaxReturns
	// Required: true
	// Enum: [AvaTaxReturns StandAlone Strategic SST TrustFile PWC HudsonGroup MRA None]
	CustomerTypeID *string `json:"customerTypeId"`

	// The description of the notice
	// Example: description
	Description string `json:"description,omitempty"`

	// The document reference of the notice
	DocumentReference string `json:"documentReference,omitempty"`

	// Expected resolution date of the notice
	// Example: 2022-01-09T17:08:46.0571825Z
	// Format: date-time
	ExpectedResolutionDate strfmt.DateTime `json:"expectedResolutionDate,omitempty"`

	// The filing frequency of the notice
	// Example: Monthly
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequency string `json:"filingFrequency,omitempty"`

	// The filing type of the notice
	// Example: ElectronicReturn
	// Enum: [ElectronicReturn PaperReturn ReturnNotFiled EFTPaper SER TrustfileEdi UploadFile PaperManual CertCapture SignatureReady]
	FilingTypeID string `json:"filingTypeId,omitempty"`

	// Finance details of the notice
	// Example: [{"credits":0.06,"id":3,"interest":0.19,"noticeDate":"2021-12-25T17:08:46.0566833Z","noticeId":0,"penalty":0.67,"taxAbated":0,"taxDue":6.66}]
	Finances []*NoticeFinanceModel `json:"finances"`

	// Indicator to hide from customer
	// Example: false
	// Required: true
	HideFromCustomer *bool `json:"hideFromCustomer"`

	// The unique ID number of this notice.
	// Example: 3878
	// Required: true
	ID *int32 `json:"id"`

	// The jurisdiction name of the notice
	// Example: CHANDLER
	// Read Only: true
	JurisdictionName string `json:"jurisdictionName,omitempty"`

	// The jurisdiction type of the notice
	// Example: City
	// Read Only: true
	JurisdictionType string `json:"jurisdictionType,omitempty"`

	// The date/time when this record was last modified.
	// Example: 2021-12-25T17:08:46.0572745Z
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Example: 222
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The unique ID number of the user that owns the notice
	// Example: 23
	OwnedByUserID int32 `json:"ownedByUserId,omitempty"`

	// The priority of the notice
	// Example: ImmediateAttentionRequired
	// Required: true
	// Enum: [ImmediateAttentionRequired High Normal Low]
	PriorityID *string `json:"priorityId"`

	// The notice reason
	// Example: Unsupported Credit
	// Read Only: true
	Reason string `json:"reason,omitempty"`

	// The notice reason id
	// Example: 10
	// Required: true
	ReasonID *int32 `json:"reasonId"`

	// The received date of the notice
	// Example: 2021-12-25T17:08:46.0568247Z
	// Required: true
	// Format: date-time
	ReceivedDate *strfmt.DateTime `json:"receivedDate"`

	// Name or ISO 3166 code identifying the region within the country that sent this notice.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: AZ
	Region string `json:"region,omitempty"`

	// Notice Responsibility Details
	Responsibility []*NoticeResponsibilityDetailModel `json:"responsibility"`

	// The id of the revenue contact
	// Example: 444
	RevenueContactID int32 `json:"revenueContactId,omitempty"`

	// Notice Root Cause Details
	RootCause []*NoticeRootCauseDetailModel `json:"rootCause"`

	// The sales force case of the notice
	// Example: 3333
	SalesForceCase string `json:"salesForceCase,omitempty"`

	// The URL to the sales force case
	// Example: http://www.salesforcecaseurl.com
	SalesForceCaseURL string `json:"salesForceCaseUrl,omitempty"`

	// Indicator to show customer this resolution date
	// Example: false
	// Required: true
	ShowResolutionDateToCustomer *bool `json:"showResolutionDateToCustomer"`

	// The status of the notice
	// Example: Closed - Paid
	// Read Only: true
	Status string `json:"status,omitempty"`

	// The status id of the notice
	// Example: 4
	// Required: true
	StatusID *int32 `json:"statusId"`

	// The tax authority id of the notice
	// Example: 208
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The tax form code of the notice
	TaxFormCode string `json:"taxFormCode,omitempty"`

	// The tax period of the notice
	// Example: 200710
	TaxPeriod string `json:"taxPeriod,omitempty"`

	// The ticket reference number of the notice
	// Example: 1235
	TicketReferenceNo string `json:"ticketReferenceNo,omitempty"`

	// The ticket reference url of the notice
	// Example: http://www.ticketurl.com
	TicketReferenceURL string `json:"ticketReferenceUrl,omitempty"`

	// The total remmitance amount for the notice
	// Example: 0
	// Read Only: true
	TotalRemit float64 `json:"totalRemit,omitempty"`

	// The tax notice type description
	Type string `json:"type,omitempty"`

	// The tax notice type id
	// Example: 3
	TypeID int32 `json:"typeId,omitempty"`
}

NoticeModel Represents a letter received from a tax authority regarding tax filing. These letters often have the warning "Notice" printed at the top, which is why they are called "Notices". Example: {"avaFileFormId":333,"closedByUserId":1,"closedDate":"2022-01-14T17:08:46.0568477Z","comments":[{"comment":"spoke to Chris payment not received need copy of check.VW","commentType":"Internal","commentTypeId":0,"commentUserId":1,"commentUserName":"user@compliance.com","date":"2021-12-25T17:08:46.056639Z","id":3,"noticeId":3878}],"companyId":5714,"complianceContactId":555,"country":"US","createdByUserName":"user@compliance.com","createdDate":"2021-12-20T17:08:46.0572475Z","createdUserId":1,"customerComment":"comments","customerFundingOptionId":"Pull","customerTypeId":"AvaTaxReturns","description":"description","expectedResolutionDate":"2022-01-09T17:08:46.0571825Z","filingFrequency":"Quarterly","filingTypeId":"ElectronicReturn","finances":[{"credits":0.06,"id":3,"interest":0.19,"noticeDate":"2021-12-25T17:08:46.0566833Z","noticeId":0,"penalty":0.67,"taxAbated":0,"taxDue":6.66}],"hideFromCustomer":false,"id":3878,"jurisdictionName":"CHANDLER","jurisdictionType":"City","modifiedDate":"2021-12-25T17:08:46.0572745Z","modifiedUserId":222,"ownedByUserId":23,"priorityId":"ImmediateAttentionRequired","reason":"Unsupported Credit","reasonId":10,"receivedDate":"2021-12-25T17:08:46.0568247Z","region":"AZ","revenueContactId":444,"salesForceCase":"3333","salesForceCaseUrl":"http://www.salesforcecaseurl.com","showResolutionDateToCustomer":false,"status":"Closed - Paid","statusId":4,"taxAuthorityId":208,"taxPeriod":"200710","ticketReferenceNo":"1235","ticketReferenceUrl":"http://www.ticketurl.com","totalRemit":0,"typeId":3}

swagger:model NoticeModel

func (*NoticeModel) ContextValidate ¶ 

func (m *NoticeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice model based on the context it is used

func (*NoticeModel) MarshalBinary ¶ 

func (m *NoticeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeModel) UnmarshalBinary ¶ 

func (m *NoticeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeModel) Validate ¶ 

func (m *NoticeModel) Validate(formats strfmt.Registry) error

Validate validates this notice model

type NoticeModelFetchResult ¶ 

type NoticeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeModel `json:"value"`
}

NoticeModelFetchResult notice model fetch result

swagger:model NoticeModelFetchResult

func (*NoticeModelFetchResult) ContextValidate ¶ 

func (m *NoticeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice model fetch result based on the context it is used

func (*NoticeModelFetchResult) MarshalBinary ¶ 

func (m *NoticeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeModelFetchResult) Validate ¶ 

func (m *NoticeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice model fetch result

type NoticePriorityModel ¶ 

type NoticePriorityModel struct {

	// A flag if the Priority is active
	// Example: true
	ActiveFlag bool `json:"activeFlag,omitempty"`

	// The description name of this tax authority Priority.
	// Example: High
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax notice customer Priority.
	// Example: 2
	// Required: true
	ID *int32 `json:"id"`

	// sort order of the Prioritys
	// Example: 10
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticePriorityModel Tax Notice Priority Model Example: {"activeFlag":true,"description":"High","id":2,"sortOrder":10}

swagger:model NoticePriorityModel

func (*NoticePriorityModel) ContextValidate ¶ 

func (m *NoticePriorityModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice priority model based on context it is used

func (*NoticePriorityModel) MarshalBinary ¶ 

func (m *NoticePriorityModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticePriorityModel) UnmarshalBinary ¶ 

func (m *NoticePriorityModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticePriorityModel) Validate ¶ 

func (m *NoticePriorityModel) Validate(formats strfmt.Registry) error

Validate validates this notice priority model

type NoticePriorityModelFetchResult ¶ 

type NoticePriorityModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticePriorityModel `json:"value"`
}

NoticePriorityModelFetchResult notice priority model fetch result

swagger:model NoticePriorityModelFetchResult

func (*NoticePriorityModelFetchResult) ContextValidate ¶ 

func (m *NoticePriorityModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice priority model fetch result based on the context it is used

func (*NoticePriorityModelFetchResult) MarshalBinary ¶ 

func (m *NoticePriorityModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticePriorityModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticePriorityModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticePriorityModelFetchResult) Validate ¶ 

func (m *NoticePriorityModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice priority model fetch result

type NoticeReasonModel ¶ 

type NoticeReasonModel struct {

	// A flag if the type is active
	// Example: true
	ActiveFlag bool `json:"activeFlag,omitempty"`

	// The description name of this tax authority type.
	// Example: AvaTax Returns
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax notice customer type.
	// Example: 1
	// Required: true
	ID *int32 `json:"id"`

	// sort order of the types
	// Example: 5
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeReasonModel Tax Notice Reason Model Example: {"activeFlag":true,"description":"AvaTax Returns","id":1,"sortOrder":5}

swagger:model NoticeReasonModel

func (*NoticeReasonModel) ContextValidate ¶ 

func (m *NoticeReasonModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice reason model based on context it is used

func (*NoticeReasonModel) MarshalBinary ¶ 

func (m *NoticeReasonModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeReasonModel) UnmarshalBinary ¶ 

func (m *NoticeReasonModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeReasonModel) Validate ¶ 

func (m *NoticeReasonModel) Validate(formats strfmt.Registry) error

Validate validates this notice reason model

type NoticeReasonModelFetchResult ¶ 

type NoticeReasonModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeReasonModel `json:"value"`
}

NoticeReasonModelFetchResult notice reason model fetch result

swagger:model NoticeReasonModelFetchResult

func (*NoticeReasonModelFetchResult) ContextValidate ¶ 

func (m *NoticeReasonModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice reason model fetch result based on the context it is used

func (*NoticeReasonModelFetchResult) MarshalBinary ¶ 

func (m *NoticeReasonModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeReasonModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeReasonModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeReasonModelFetchResult) Validate ¶ 

func (m *NoticeReasonModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice reason model fetch result

type NoticeResponsibilityDetailModel ¶ 

type NoticeResponsibilityDetailModel struct {

	// The description name of this filing frequency
	// Example: Avalara-Compliance
	// Read Only: true
	Description string `json:"description,omitempty"`

	// The unique ID number of this filing frequency.
	// Example: 0
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// TaxNoticeId
	// Example: 4
	// Required: true
	NoticeID *int32 `json:"noticeId"`

	// TaxNoticeResponsibilityId
	// Example: 4
	// Required: true
	TaxNoticeResponsibilityID *int32 `json:"taxNoticeResponsibilityId"`
}

NoticeResponsibilityDetailModel NoticeResponsibility Model Example: {"description":"Avalara-Compliance","id":0,"noticeId":4,"taxNoticeResponsibilityId":4}

swagger:model NoticeResponsibilityDetailModel

func (*NoticeResponsibilityDetailModel) ContextValidate ¶ 

func (m *NoticeResponsibilityDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice responsibility detail model based on the context it is used

func (*NoticeResponsibilityDetailModel) MarshalBinary ¶ 

func (m *NoticeResponsibilityDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeResponsibilityDetailModel) UnmarshalBinary ¶ 

func (m *NoticeResponsibilityDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeResponsibilityDetailModel) Validate ¶ 

func (m *NoticeResponsibilityDetailModel) Validate(formats strfmt.Registry) error

Validate validates this notice responsibility detail model

type NoticeResponsibilityDetailModelFetchResult ¶ 

type NoticeResponsibilityDetailModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeResponsibilityDetailModel `json:"value"`
}

NoticeResponsibilityDetailModelFetchResult notice responsibility detail model fetch result

swagger:model NoticeResponsibilityDetailModelFetchResult

func (*NoticeResponsibilityDetailModelFetchResult) ContextValidate ¶ 

func (m *NoticeResponsibilityDetailModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice responsibility detail model fetch result based on the context it is used

func (*NoticeResponsibilityDetailModelFetchResult) MarshalBinary ¶ 

func (m *NoticeResponsibilityDetailModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeResponsibilityDetailModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeResponsibilityDetailModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeResponsibilityDetailModelFetchResult) Validate ¶ 

func (m *NoticeResponsibilityDetailModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice responsibility detail model fetch result

type NoticeResponsibilityModel ¶ 

type NoticeResponsibilityModel struct {

	// The description name of this notice responsibility
	// Example: Customer-Invalid login (Return filed manual)
	Description string `json:"description,omitempty"`

	// The unique ID number of this notice responsibility.
	// Example: 11
	ID int32 `json:"id,omitempty"`

	// Defines if the responsibility is active
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// The sort order of this responsibility
	// Example: 55
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeResponsibilityModel NoticeResponsibility Model Example: {"description":"Customer-Invalid login (Return filed manual)","id":11,"isActive":true,"sortOrder":55}

swagger:model NoticeResponsibilityModel

func (*NoticeResponsibilityModel) ContextValidate ¶ 

func (m *NoticeResponsibilityModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice responsibility model based on context it is used

func (*NoticeResponsibilityModel) MarshalBinary ¶ 

func (m *NoticeResponsibilityModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeResponsibilityModel) UnmarshalBinary ¶ 

func (m *NoticeResponsibilityModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeResponsibilityModel) Validate ¶ 

func (m *NoticeResponsibilityModel) Validate(formats strfmt.Registry) error

Validate validates this notice responsibility model

type NoticeResponsibilityModelFetchResult ¶ 

type NoticeResponsibilityModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeResponsibilityModel `json:"value"`
}

NoticeResponsibilityModelFetchResult notice responsibility model fetch result

swagger:model NoticeResponsibilityModelFetchResult

func (*NoticeResponsibilityModelFetchResult) ContextValidate ¶ 

func (m *NoticeResponsibilityModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice responsibility model fetch result based on the context it is used

func (*NoticeResponsibilityModelFetchResult) MarshalBinary ¶ 

func (m *NoticeResponsibilityModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeResponsibilityModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeResponsibilityModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeResponsibilityModelFetchResult) Validate ¶ 

func (m *NoticeResponsibilityModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice responsibility model fetch result

type NoticeRootCauseDetailModel ¶ 

type NoticeRootCauseDetailModel struct {

	// The description name of this root cause
	// Example: Processor error-Return not submitted
	// Read Only: true
	Description string `json:"description,omitempty"`

	// The unique ID number of this filing frequency.
	// Example: 0
	// Required: true
	ID *int32 `json:"id"`

	// TaxNoticeId
	// Example: 4
	// Required: true
	NoticeID *int32 `json:"noticeId"`

	// TaxNoticeRootCauseId
	// Example: 4
	// Required: true
	TaxNoticeRootCauseID *int32 `json:"taxNoticeRootCauseId"`
}

NoticeRootCauseDetailModel NoticeRootCause Model Example: {"description":"Processor error-Return not submitted","id":0,"noticeId":4,"taxNoticeRootCauseId":4}

swagger:model NoticeRootCauseDetailModel

func (*NoticeRootCauseDetailModel) ContextValidate ¶ 

func (m *NoticeRootCauseDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice root cause detail model based on the context it is used

func (*NoticeRootCauseDetailModel) MarshalBinary ¶ 

func (m *NoticeRootCauseDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeRootCauseDetailModel) UnmarshalBinary ¶ 

func (m *NoticeRootCauseDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeRootCauseDetailModel) Validate ¶ 

func (m *NoticeRootCauseDetailModel) Validate(formats strfmt.Registry) error

Validate validates this notice root cause detail model

type NoticeRootCauseDetailModelFetchResult ¶ 

type NoticeRootCauseDetailModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeRootCauseDetailModel `json:"value"`
}

NoticeRootCauseDetailModelFetchResult notice root cause detail model fetch result

swagger:model NoticeRootCauseDetailModelFetchResult

func (*NoticeRootCauseDetailModelFetchResult) ContextValidate ¶ 

func (m *NoticeRootCauseDetailModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice root cause detail model fetch result based on the context it is used

func (*NoticeRootCauseDetailModelFetchResult) MarshalBinary ¶ 

func (m *NoticeRootCauseDetailModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeRootCauseDetailModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeRootCauseDetailModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeRootCauseDetailModelFetchResult) Validate ¶ 

func (m *NoticeRootCauseDetailModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice root cause detail model fetch result

type NoticeRootCauseModel ¶ 

type NoticeRootCauseModel struct {

	// The description name of this notice RootCause
	// Example: Customer-Invalid login (Return filed manual)
	Description string `json:"description,omitempty"`

	// The unique ID number of this notice RootCause.
	// Example: 11
	ID int32 `json:"id,omitempty"`

	// Defines if the RootCause is active
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// The sort order of this RootCause
	// Example: 55
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeRootCauseModel NoticeRootCause Model Example: {"description":"Customer-Invalid login (Return filed manual)","id":11,"isActive":true,"sortOrder":55}

swagger:model NoticeRootCauseModel

func (*NoticeRootCauseModel) ContextValidate ¶ 

func (m *NoticeRootCauseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice root cause model based on context it is used

func (*NoticeRootCauseModel) MarshalBinary ¶ 

func (m *NoticeRootCauseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeRootCauseModel) UnmarshalBinary ¶ 

func (m *NoticeRootCauseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeRootCauseModel) Validate ¶ 

func (m *NoticeRootCauseModel) Validate(formats strfmt.Registry) error

Validate validates this notice root cause model

type NoticeRootCauseModelFetchResult ¶ 

type NoticeRootCauseModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeRootCauseModel `json:"value"`
}

NoticeRootCauseModelFetchResult notice root cause model fetch result

swagger:model NoticeRootCauseModelFetchResult

func (*NoticeRootCauseModelFetchResult) ContextValidate ¶ 

func (m *NoticeRootCauseModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice root cause model fetch result based on the context it is used

func (*NoticeRootCauseModelFetchResult) MarshalBinary ¶ 

func (m *NoticeRootCauseModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeRootCauseModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeRootCauseModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeRootCauseModelFetchResult) Validate ¶ 

func (m *NoticeRootCauseModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice root cause model fetch result

type NoticeStatusModel ¶ 

type NoticeStatusModel struct {

	// The description name of this tax authority type.
	// Example: City
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax authority type.
	// Example: 12345
	// Required: true
	ID *int32 `json:"id"`

	// True if a tax notice in this status is considered 'open' and has more work expected to be done before it is closed.
	// Example: false
	IsOpen bool `json:"isOpen,omitempty"`

	// If a list of status values is to be displayed in a dropdown, they should be displayed in this numeric order.
	// Example: 0
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeStatusModel Tax Notice Status Model Example: {"description":"City","id":12345,"isOpen":false,"sortOrder":0}

swagger:model NoticeStatusModel

func (*NoticeStatusModel) ContextValidate ¶ 

func (m *NoticeStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice status model based on context it is used

func (*NoticeStatusModel) MarshalBinary ¶ 

func (m *NoticeStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeStatusModel) UnmarshalBinary ¶ 

func (m *NoticeStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeStatusModel) Validate ¶ 

func (m *NoticeStatusModel) Validate(formats strfmt.Registry) error

Validate validates this notice status model

type NoticeStatusModelFetchResult ¶ 

type NoticeStatusModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeStatusModel `json:"value"`
}

NoticeStatusModelFetchResult notice status model fetch result

swagger:model NoticeStatusModelFetchResult

func (*NoticeStatusModelFetchResult) ContextValidate ¶ 

func (m *NoticeStatusModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice status model fetch result based on the context it is used

func (*NoticeStatusModelFetchResult) MarshalBinary ¶ 

func (m *NoticeStatusModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeStatusModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeStatusModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeStatusModelFetchResult) Validate ¶ 

func (m *NoticeStatusModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice status model fetch result

type NoticeTypeModel ¶ 

type NoticeTypeModel struct {

	// A flag if the type is active
	// Example: true
	ActiveFlag bool `json:"activeFlag,omitempty"`

	// The description name of this tax authority type.
	// Example: Notices
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax notice customer type.
	// Example: 2
	// Required: true
	ID *int32 `json:"id"`

	// sort order of the types
	// Example: 10
	SortOrder int32 `json:"sortOrder,omitempty"`
}

NoticeTypeModel Tax Notice Type Model Example: {"activeFlag":true,"description":"Notices","id":2,"sortOrder":10}

swagger:model NoticeTypeModel

func (*NoticeTypeModel) ContextValidate ¶ 

func (m *NoticeTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notice type model based on context it is used

func (*NoticeTypeModel) MarshalBinary ¶ 

func (m *NoticeTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeTypeModel) UnmarshalBinary ¶ 

func (m *NoticeTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeTypeModel) Validate ¶ 

func (m *NoticeTypeModel) Validate(formats strfmt.Registry) error

Validate validates this notice type model

type NoticeTypeModelFetchResult ¶ 

type NoticeTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NoticeTypeModel `json:"value"`
}

NoticeTypeModelFetchResult notice type model fetch result

swagger:model NoticeTypeModelFetchResult

func (*NoticeTypeModelFetchResult) ContextValidate ¶ 

func (m *NoticeTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notice type model fetch result based on the context it is used

func (*NoticeTypeModelFetchResult) MarshalBinary ¶ 

func (m *NoticeTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NoticeTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *NoticeTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NoticeTypeModelFetchResult) Validate ¶ 

func (m *NoticeTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notice type model fetch result

type NotificationModel ¶ 

type NotificationModel struct {

	// The unique ID number of the account that received this notification.
	// Example: 202011901
	AccountID int32 `json:"accountId,omitempty"`

	// If there is a specific action suggested by this notification, and if this action is requested
	// by a specific due date, this value will be the due date for the action.
	//
	// An action is a suggested next step such as "Review Your Tax Profile."  If an action is suggested,
	// you should give the viewer a hyperlink to the location referred to by `actionLink` and give the
	// hyperlink the name `actionName`.
	//
	// For actions that have deadlines, such as "Confirm your tax registration before filing", this value
	// will be set to the deadline date for the action.  Otherwise, this value will be null.
	// Format: date-time
	ActionDueDate strfmt.DateTime `json:"actionDueDate,omitempty"`

	// If there is a specific action suggested by this notification, this is the URL of the action.
	//
	// An action is a suggested next step such as "Review Your Tax Profile."  If an action is suggested,
	// you should give the viewer a hyperlink to the location referred to by `actionLink` and give the
	// hyperlink the name `actionName`.
	// Example: www.xyz.com
	// Max Length: 250
	// Min Length: 0
	ActionLink *string `json:"actionLink,omitempty"`

	// If there is a specific action suggested by this notification, this is the name of the action.
	//
	// An action is a suggested next step such as "Review Your Tax Profile."  If an action is suggested,
	// you should give the viewer a hyperlink to the location referred to by `actionLink` and give the
	// hyperlink the name `actionName`.
	// Example: Certificate Renewal
	// Max Length: 250
	// Min Length: 0
	ActionName *string `json:"actionName,omitempty"`

	// The category of this notification.
	//
	// Notification categories are a useful way to group related notifications together. Category names may change
	// over time.
	//
	// For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".
	// Example: Certificate Expiration
	// Max Length: 50
	// Min Length: 0
	Category *string `json:"category,omitempty"`

	// If this notification was tied to a specific company, this will be the
	// unique ID number of the company that received the notification.  Notifications that
	// are tied to accounts will have a `NULL` value for `companyId`.
	// Example: 34345
	CompanyID int32 `json:"companyId,omitempty"`

	// The UTC timestamp of the time when this notification was created.
	// Example: 2018-05-05T00:00:00
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The unique ID number of the user who created the notification.
	// Example: 442323
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// When a user has finished reviewing a notification, they may opt to dismiss it by calling the
	// `DismissNotification` API.  This API marks the notification as dismissed, and dismissed notifications
	// will generally not appear in most user interfaces.
	// Example: false
	Dismissed bool `json:"dismissed,omitempty"`

	// If this notification has been dismissed, this indicates the unique ID number of the user that
	// dismissed the notification.
	DismissedByUserID int32 `json:"dismissedByUserId,omitempty"`

	// If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user
	// dismissed the notification.
	// Format: date-time
	DismissedDate strfmt.DateTime `json:"dismissedDate,omitempty"`

	// If this notification is time sensitive, this is the latest date when the notification should be
	// displayed to the user.
	// Example: 2021-12-25T00:00:00+00:00
	// Required: true
	// Format: date-time
	ExpireDate *strfmt.DateTime `json:"expireDate"`

	// The unique id of the notification.
	// Example: 123
	ID int64 `json:"id,omitempty"`

	// The message for this notification.  This is a friendly description of the notification and any relevant
	// information that can help you decide what kind of action, if any, to take in response.
	// Example: The certificate of your company is nearing its expiration, please consider renewing it.
	// Required: true
	Message *string `json:"message"`

	// The UTC timestamp of the time when this notification was last modified.
	// Example: 2018-05-07T00:00:00
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The unique ID number of the user who most recently modified this notification.
	// Example: 442323
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// If this notification object requires user action to resolve, this value will be set to true.
	// Example: true
	NeedsAction bool `json:"needsAction,omitempty"`

	// The unique reference Id number of the object referred to by this notification, if any.
	//
	// Some notifications may include information about a related data object.
	//
	// For example, if this notification was related to a nexus declaration, the `referenceObject` field would
	// be  `Nexus` and the `referenceId` field would be the unique ID number of that nexus.
	// Example: 692
	ReferenceID int64 `json:"referenceId,omitempty"`

	// The type name of object referred to by this notification, if any.
	//
	// Some notifications may include information about a related data object.
	//
	// For example, if this notification was related to a nexus declaration, the `referenceObject` field would
	// be  `Nexus` and the `referenceId` field would be the unique ID number of that nexus.
	// Example: Company Return
	// Max Length: 20
	// Min Length: 0
	ReferenceObject *string `json:"referenceObject,omitempty"`

	// The severity level of the notification.
	// Example: Neutral
	// Required: true
	// Enum: [Neutral Advisory Blocking Complete]
	SeverityLevelID *string `json:"severityLevelId"`

	// The topic of this notification.
	//
	// Notification topics contain information about the notification.  They are a summary of the issue and can
	// help you decide what type of action to take.
	//
	// For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".
	// Max Length: 250
	// Min Length: 0
	Topic *string `json:"topic,omitempty"`
}

NotificationModel Represents a single notification.

A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed any relevant concerns raised by this notification.

An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile. Example: {"accountId":202011901,"actionLink":"www.xyz.com","actionName":"Certificate Renewal","category":"Certificate Expiration","companyId":34345,"createdDate":"2018-05-05T00:00:00","createdUserId":442323,"dismissed":false,"expireDate":"2021-12-25T00:00:00+00:00","id":123,"message":"The certificate of your company is nearing its expiration, please consider renewing it.","modifiedDate":"2018-05-07T00:00:00","modifiedUserId":442323,"needsAction":true,"referenceId":692,"referenceObject":"Company Return","severityLevelId":"Neutral"}

swagger:model NotificationModel

func (*NotificationModel) ContextValidate ¶ 

func (m *NotificationModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this notification model based on context it is used

func (*NotificationModel) MarshalBinary ¶ 

func (m *NotificationModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NotificationModel) UnmarshalBinary ¶ 

func (m *NotificationModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NotificationModel) Validate ¶ 

func (m *NotificationModel) Validate(formats strfmt.Registry) error

Validate validates this notification model

type NotificationModelFetchResult ¶ 

type NotificationModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*NotificationModel `json:"value"`
}

NotificationModelFetchResult notification model fetch result

swagger:model NotificationModelFetchResult

func (*NotificationModelFetchResult) ContextValidate ¶ 

func (m *NotificationModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this notification model fetch result based on the context it is used

func (*NotificationModelFetchResult) MarshalBinary ¶ 

func (m *NotificationModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NotificationModelFetchResult) UnmarshalBinary ¶ 

func (m *NotificationModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NotificationModelFetchResult) Validate ¶ 

func (m *NotificationModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this notification model fetch result

type OfferModel ¶ 

type OfferModel struct {

	// Id of the transaction
	// Example: 1234567989
	ID string `json:"id,omitempty"`

	// Message indicating what action took place
	// Example: The offer abc has been added to the account 123456789 at 2018-07-08
	OfferMessage string `json:"offerMessage,omitempty"`
}

OfferModel Gets the response for the offer request Example: {"id":"1234567989","offerMessage":"The offer abc has been added to the account 123456789 at 2018-07-08"}

swagger:model OfferModel

func (*OfferModel) ContextValidate ¶ 

func (m *OfferModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this offer model based on context it is used

func (*OfferModel) MarshalBinary ¶ 

func (m *OfferModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OfferModel) UnmarshalBinary ¶ 

func (m *OfferModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OfferModel) Validate ¶ 

func (m *OfferModel) Validate(formats strfmt.Registry) error

Validate validates this offer model

type OriginalAPIRequestResponseModel ¶ 

type OriginalAPIRequestResponseModel struct {

	// API request
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	Request *CreateTransactionModel `json:"request,omitempty"`

	// API response
	// Example: {"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"4e00a491-842b-4bba-8c03-fd4bb9eecddc","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}
	Response *TransactionModel `json:"response,omitempty"`
}

OriginalAPIRequestResponseModel Represents the exact API request and response from the original transaction API call, if available Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"},"response":{"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"4e00a491-842b-4bba-8c03-fd4bb9eecddc","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}}

swagger:model OriginalApiRequestResponseModel

func (*OriginalAPIRequestResponseModel) ContextValidate ¶ 

func (m *OriginalAPIRequestResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this original Api request response model based on the context it is used

func (*OriginalAPIRequestResponseModel) MarshalBinary ¶ 

func (m *OriginalAPIRequestResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OriginalAPIRequestResponseModel) UnmarshalBinary ¶ 

func (m *OriginalAPIRequestResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OriginalAPIRequestResponseModel) Validate ¶ 

func (m *OriginalAPIRequestResponseModel) Validate(formats strfmt.Registry) error

Validate validates this original Api request response model

type ParameterModel ¶ 

type ParameterModel struct {

	// The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
	AttributeType string `json:"attributeType,omitempty"`

	// DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
	// The category grouping of this parameter.  When your user interface displays a large number of parameters, they should
	// be grouped by their category value.
	// Example: Lodging
	Category string `json:"category,omitempty"`

	// The data type of the property.
	// Example: NumericMeasured
	DataType string `json:"dataType,omitempty"`

	// Help text to be shown to the user when they are filling out this parameter.  Help text may include HTML links to additional
	// content with more information about a parameter.
	// Example: Please enter the number of nights the customer stayed in your lodging; whole numbers only.
	HelpText string `json:"helpText,omitempty"`

	// A help url that provides more information about the parameter
	// Example: www.example.com/lodging
	HelpURL string `json:"helpUrl,omitempty"`

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

	// This field identifies if parameter is needed for calculation
	// Example: true
	IsNeededForCalculation bool `json:"isNeededForCalculation,omitempty"`

	// This field identifies if parameter is needed for classification
	// Example: false
	IsNeededForClassification bool `json:"isNeededForClassification,omitempty"`

	// This field identifies if parameter is needed for returns
	// Example: false
	IsNeededForReturns bool `json:"isNeededForReturns,omitempty"`

	// Label that helps the user to identify a parameter
	// Example: lodging
	Label string `json:"label,omitempty"`

	// The unit of measurement type of the parameter
	MeasurementType string `json:"measurementType,omitempty"`

	// The name of the property.  To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call.
	// Example: NumberOfNights
	Name string `json:"name,omitempty"`

	// DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
	// The prompt you should use when displaying this parameter to a user.  For example, if your user interface displays a
	// parameter in a text box, this is the label you should use to identify that text box.
	// Example: Lodging Number of Nights
	Prompt string `json:"prompt,omitempty"`

	// DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
	// If your user interface permits client-side validation of parameters, this string is a regular expression you can use
	// to validate the user's data entry prior to submitting a tax request.
	// Example: \\d*
	RegularExpression string `json:"regularExpression,omitempty"`

	// A list of service types to which this parameter applies.
	// Example: ["AvaLodging"]
	ServiceTypes []string `json:"serviceTypes"`

	// If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
	Values []string `json:"values"`
}

ParameterModel An extra property that can change the behavior of tax transactions. Example: {"category":"Lodging","dataType":"NumericMeasured","helpText":"Please enter the number of nights the customer stayed in your lodging; whole numbers only.","helpUrl":"www.example.com/lodging","id":12345,"isNeededForCalculation":true,"isNeededForClassification":false,"isNeededForReturns":false,"label":"lodging","name":"NumberOfNights","prompt":"Lodging Number of Nights","regularExpression":"\\d*","serviceTypes":["AvaLodging"]}

swagger:model ParameterModel

func (*ParameterModel) ContextValidate ¶ 

func (m *ParameterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this parameter model based on context it is used

func (*ParameterModel) MarshalBinary ¶ 

func (m *ParameterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ParameterModel) UnmarshalBinary ¶ 

func (m *ParameterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ParameterModel) Validate ¶ 

func (m *ParameterModel) Validate(formats strfmt.Registry) error

Validate validates this parameter model

type ParameterModelFetchResult ¶ 

type ParameterModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ParameterModel `json:"value"`
}

ParameterModelFetchResult parameter model fetch result

swagger:model ParameterModelFetchResult

func (*ParameterModelFetchResult) ContextValidate ¶ 

func (m *ParameterModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this parameter model fetch result based on the context it is used

func (*ParameterModelFetchResult) MarshalBinary ¶ 

func (m *ParameterModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ParameterModelFetchResult) UnmarshalBinary ¶ 

func (m *ParameterModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ParameterModelFetchResult) Validate ¶ 

func (m *ParameterModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this parameter model fetch result

type ParameterUsageModel ¶ 

type ParameterUsageModel struct {

	// The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
	// Example: Product
	AttributeType string `json:"attributeType,omitempty"`

	// The country for the parameter usage item.
	// Example: US
	Country string `json:"country,omitempty"`

	// The data type of the property.
	// Example: NumericMeasured
	DataType string `json:"dataType,omitempty"`

	// Help text to be shown to the user when they are filling out this parameter.  Help text may include HTML links to additional
	// content with more information about a parameter.
	// Example: A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.
	HelpText string `json:"helpText,omitempty"`

	// A help url that provides more information about the parameter
	HelpURL string `json:"helpUrl,omitempty"`

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

	// Label that helps the user to identify a parameter
	// Example: Screen Size
	Label string `json:"label,omitempty"`

	// The unit of measurement type of the parameter
	// Example: Length
	MeasurementType string `json:"measurementType,omitempty"`

	// The name of the property.  To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call.
	// Example: ScreenSize
	Name string `json:"name,omitempty"`

	// The id of the parameter.
	// Example: 12345
	ParameterID int64 `json:"parameterId,omitempty"`

	// Product code for the parameter usage item.
	// Example: PC080100
	ProductCode string `json:"productCode,omitempty"`

	// The state for the parameter usage item.
	// Example: CA
	Region string `json:"region,omitempty"`

	// System Id for the parameter usage item
	// Example: 0
	SystemID int32 `json:"systemId,omitempty"`

	// tax type for the parameter usage item.
	// Example: EWaste
	TaxTypeID string `json:"taxTypeId,omitempty"`

	// If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
	Values []string `json:"values"`
}

ParameterUsageModel usage of system defined parameters. Example: {"attributeType":"Product","country":"US","dataType":"NumericMeasured","helpText":"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.","id":12345,"label":"Screen Size","measurementType":"Length","name":"ScreenSize","parameterId":12345,"productCode":"PC080100","region":"CA","systemId":0,"taxTypeId":"EWaste"}

swagger:model ParameterUsageModel

func (*ParameterUsageModel) ContextValidate ¶ 

func (m *ParameterUsageModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this parameter usage model based on context it is used

func (*ParameterUsageModel) MarshalBinary ¶ 

func (m *ParameterUsageModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ParameterUsageModel) UnmarshalBinary ¶ 

func (m *ParameterUsageModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ParameterUsageModel) Validate ¶ 

func (m *ParameterUsageModel) Validate(formats strfmt.Registry) error

Validate validates this parameter usage model

type ParameterUsageModelFetchResult ¶ 

type ParameterUsageModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ParameterUsageModel `json:"value"`
}

ParameterUsageModelFetchResult parameter usage model fetch result

swagger:model ParameterUsageModelFetchResult

func (*ParameterUsageModelFetchResult) ContextValidate ¶ 

func (m *ParameterUsageModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this parameter usage model fetch result based on the context it is used

func (*ParameterUsageModelFetchResult) MarshalBinary ¶ 

func (m *ParameterUsageModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ParameterUsageModelFetchResult) UnmarshalBinary ¶ 

func (m *ParameterUsageModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ParameterUsageModelFetchResult) Validate ¶ 

func (m *ParameterUsageModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this parameter usage model fetch result

type PasswordChangeModel ¶ 

type PasswordChangeModel struct {

	// New Password
	// Example: ANewPassword567:)
	// Required: true
	NewPassword *string `json:"newPassword"`

	// Old Password
	// Example: MyOldPassword123!
	// Required: true
	// Max Length: 50
	// Min Length: 0
	OldPassword *string `json:"oldPassword"`
}

PasswordChangeModel Password Change Model Example: {"newPassword":"ANewPassword567:)","oldPassword":"MyOldPassword123!"}

swagger:model PasswordChangeModel

func (*PasswordChangeModel) ContextValidate ¶ 

func (m *PasswordChangeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this password change model based on context it is used

func (*PasswordChangeModel) MarshalBinary ¶ 

func (m *PasswordChangeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PasswordChangeModel) UnmarshalBinary ¶ 

func (m *PasswordChangeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PasswordChangeModel) Validate ¶ 

func (m *PasswordChangeModel) Validate(formats strfmt.Registry) error

Validate validates this password change model

type PingResultModel ¶ 

type PingResultModel struct {

	// Returns true if you provided authentication for this API call; false if you did not.
	// Example: true
	Authenticated bool `json:"authenticated,omitempty"`

	// The ID number of the currently authenticated user's account, if any.
	// Example: 123456789
	AuthenticatedAccountID int32 `json:"authenticatedAccountId,omitempty"`

	// The ID number of the currently authenticated user's company, if any.
	// Example: 123456789
	AuthenticatedCompanyID int32 `json:"authenticatedCompanyId,omitempty"`

	// The ID number of the currently authenticated user, if any.
	// Example: 98765
	AuthenticatedUserID int32 `json:"authenticatedUserId,omitempty"`

	// The username of the currently authenticated user, if any.
	// Example: TestUser
	AuthenticatedUserName string `json:"authenticatedUserName,omitempty"`

	// Returns the type of authentication you provided, if authenticated
	// Example: None
	// Enum: [None UsernamePassword AccountIdLicenseKey OpenIdBearerToken]
	AuthenticationType string `json:"authenticationType,omitempty"`

	// The connected Salesforce account.
	// Example: 1111
	Crmid string `json:"crmid,omitempty"`

	// Version number
	// Example: 1.0.0.0
	Version string `json:"version,omitempty"`
}

PingResultModel Ping Result Model Example: {"authenticated":true,"authenticatedAccountId":123456789,"authenticatedCompanyId":123456789,"authenticatedUserId":98765,"authenticatedUserName":"TestUser","authenticationType":"UsernamePassword","crmid":"1111","version":"1.0.0.0"}

swagger:model PingResultModel

func (*PingResultModel) ContextValidate ¶ 

func (m *PingResultModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this ping result model based on context it is used

func (*PingResultModel) MarshalBinary ¶ 

func (m *PingResultModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PingResultModel) UnmarshalBinary ¶ 

func (m *PingResultModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PingResultModel) Validate ¶ 

func (m *PingResultModel) Validate(formats strfmt.Registry) error

Validate validates this ping result model

type PoNumberModel ¶ 

type PoNumberModel struct {

	// Unique ID number
	// Example: 1234
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// Purchase order number.
	// Example: test
	PoNumber string `json:"poNumber,omitempty"`
}

PoNumberModel Represents a purchase order number for a transaction Example: {"id":1234,"poNumber":"test"}

swagger:model PoNumberModel

func (*PoNumberModel) ContextValidate ¶ 

func (m *PoNumberModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this po number model based on the context it is used

func (*PoNumberModel) MarshalBinary ¶ 

func (m *PoNumberModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PoNumberModel) UnmarshalBinary ¶ 

func (m *PoNumberModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PoNumberModel) Validate ¶ 

func (m *PoNumberModel) Validate(formats strfmt.Registry) error

Validate validates this po number model

type PointOfSaleDataRequestModel ¶ 

type PointOfSaleDataRequestModel struct {

	// A unique code that references a company within your account.
	// Example: DEFAULT
	// Required: true
	CompanyCode *string `json:"companyCode"`

	// The date associated with the response content. Default is current date. This field can be used to backdate or postdate the response content.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date
	DocumentDate strfmt.Date `json:"documentDate,omitempty"`

	// Set this value to true to include Juris Code in the response.
	// Example: true
	IncludeJurisCodes bool `json:"includeJurisCodes,omitempty"`

	// A list of item codes to include in this point-of-sale file. If no item codes are specified, responese will include all distinct item codes associated with the Items within your company.
	// Example: ["TXINCL"]
	ItemCodes []string `json:"itemCodes"`

	// A list of location codes to include in this point-of-sale file. If no location codes are specified, response will include all locations within your company.
	// Example: ["DEFAULT"]
	LocationCodes []string `json:"locationCodes"`

	// A unique code assoicated with the Partner you may be working with. If you are not working with a Partner or your Partner has not provided you an ID, leave null.
	// Example: DMA
	// Enum: [DMA AX7]
	PartnerID string `json:"partnerId,omitempty"`

	// The format of your response. Formats include JSON, CSV, and XML.
	// Example: Json
	// Enum: [Json Csv Xml]
	ResponseType string `json:"responseType,omitempty"`

	// A list of tax codes to include in this point-of-sale file. If no tax codes are specified, response will include all distinct tax codes associated with the Items within your company.
	// Example: ["P0000000"]
	TaxCodes []string `json:"taxCodes"`
}

PointOfSaleDataRequestModel Point-of-Sale Data Request Model Example: {"companyCode":"DEFAULT","documentDate":"2021-12-25","includeJurisCodes":true,"itemCodes":["TXINCL"],"locationCodes":["DEFAULT"],"responseType":"Json","taxCodes":["P0000000"]}

swagger:model PointOfSaleDataRequestModel

func (*PointOfSaleDataRequestModel) ContextValidate ¶ 

func (m *PointOfSaleDataRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this point of sale data request model based on context it is used

func (*PointOfSaleDataRequestModel) MarshalBinary ¶ 

func (m *PointOfSaleDataRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PointOfSaleDataRequestModel) UnmarshalBinary ¶ 

func (m *PointOfSaleDataRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PointOfSaleDataRequestModel) Validate ¶ 

func (m *PointOfSaleDataRequestModel) Validate(formats strfmt.Registry) error

Validate validates this point of sale data request model

type PostalCodeModel ¶ 

type PostalCodeModel struct {

	// Country this PostalCode locates in
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// The date when the PostalCode becomes effective
	// Example: 2005-04-01T00:00:00
	// Read Only: true
	// Format: date-time
	EffDate strfmt.DateTime `json:"effDate,omitempty"`

	// The date when the PostalCode becomes expired
	// Example: 9999-12-31T00:00:00
	// Read Only: true
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// The postalCode
	// Example: 98104
	// Read Only: true
	PostalCode string `json:"postalCode,omitempty"`

	// The Region/State/Province this PostalCode locates in
	// Example: WA
	// Read Only: true
	Region string `json:"region,omitempty"`

	// An Avalara assigned TaxRegion Id associated to the PostalCode
	// Example: 0
	// Read Only: true
	TaxRegionID int32 `json:"taxRegionId,omitempty"`
}

PostalCodeModel Represents a PostalCode and its associated data like: country, region, effective dates, etc. Example: {"country":"US","effDate":"2005-04-01T00:00:00","endDate":"9999-12-31T00:00:00","postalCode":"98104","region":"WA","taxRegionId":0}

swagger:model PostalCodeModel

func (*PostalCodeModel) ContextValidate ¶ 

func (m *PostalCodeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this postal code model based on the context it is used

func (*PostalCodeModel) MarshalBinary ¶ 

func (m *PostalCodeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostalCodeModel) UnmarshalBinary ¶ 

func (m *PostalCodeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostalCodeModel) Validate ¶ 

func (m *PostalCodeModel) Validate(formats strfmt.Registry) error

Validate validates this postal code model

type PostalCodeModelFetchResult ¶ 

type PostalCodeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*PostalCodeModel `json:"value"`
}

PostalCodeModelFetchResult postal code model fetch result

swagger:model PostalCodeModelFetchResult

func (*PostalCodeModelFetchResult) ContextValidate ¶ 

func (m *PostalCodeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this postal code model fetch result based on the context it is used

func (*PostalCodeModelFetchResult) MarshalBinary ¶ 

func (m *PostalCodeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostalCodeModelFetchResult) UnmarshalBinary ¶ 

func (m *PostalCodeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostalCodeModelFetchResult) Validate ¶ 

func (m *PostalCodeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this postal code model fetch result

type PowerOfAttorneyCheckModel ¶ 

type PowerOfAttorneyCheckModel struct {

	// Notes if there is an actice POA
	// Example: true
	ActivePoa bool `json:"activePoa,omitempty"`

	// POA download
	AvailablePoa *ResourceFileDownloadResult `json:"availablePoa,omitempty"`

	// companyId of the request
	// Example: 12345
	CompanyID int32 `json:"companyId,omitempty"`

	// Country POA is for
	// Example: US
	Country string `json:"country,omitempty"`

	// Effective Date of the POA
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// End Date of POA
	// Format: date-time
	ExpirationDate strfmt.DateTime `json:"expirationDate,omitempty"`

	// Region POA is for
	// Example: WI
	Region string `json:"region,omitempty"`
}

PowerOfAttorneyCheckModel Response when checking if a company has a POA on file with Avalara Example: {"activePoa":true,"companyId":12345,"country":"US","region":"WI"}

swagger:model PowerOfAttorneyCheckModel

func (*PowerOfAttorneyCheckModel) ContextValidate ¶ 

func (m *PowerOfAttorneyCheckModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this power of attorney check model based on the context it is used

func (*PowerOfAttorneyCheckModel) MarshalBinary ¶ 

func (m *PowerOfAttorneyCheckModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PowerOfAttorneyCheckModel) UnmarshalBinary ¶ 

func (m *PowerOfAttorneyCheckModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PowerOfAttorneyCheckModel) Validate ¶ 

func (m *PowerOfAttorneyCheckModel) Validate(formats strfmt.Registry) error

Validate validates this power of attorney check model

type PreferredProgramModel ¶ 

type PreferredProgramModel struct {

	// A code that identifies this preferred program.  To select this program, specify this code
	// value in the `AvaTax.LC.PreferredProgram` parameter.
	// Example: NAFTA
	Code string `json:"code,omitempty"`

	// The ISO 3166 country code for the destination permitted by this program
	// Example: MX
	DestinationCountry string `json:"destinationCountry,omitempty"`

	// The earliest date for which this preferred program can be used in AvaTax.  If `null`, this preferred program
	// is valid for all dates earlier than `endDate`.
	// Example: 2018-01-01T00:00:00
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The latest date for which this preferred program can be used in AvaTax.  If `null`, this preferred program
	// is valid for all dates later than `effectiveDate`.
	// Example: 9999-12-31T00:00:00
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The unique ID number representing this preferred program.
	// Example: 99
	ID int32 `json:"id,omitempty"`

	// The ISO 3166 country code for the origin permitted by this program
	// Example: US
	OriginCountry string `json:"originCountry,omitempty"`
}

PreferredProgramModel A preferred program is a customs and/or duty program that can be used to handle cross-border transactions. Customers who sign up for a preferred program may obtain better terms for their customs and duty payments.

To indicate that your company has signed up for a preferred program, specify the `code` value from this object as the value for the `AvaTax.LC.PreferredProgram` parameter in your transaction. Example: {"code":"NAFTA","destinationCountry":"MX","effectiveDate":"2018-01-01","endDate":"9999-12-31","id":99,"originCountry":"US"}

swagger:model PreferredProgramModel

func (*PreferredProgramModel) ContextValidate ¶ 

func (m *PreferredProgramModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this preferred program model based on context it is used

func (*PreferredProgramModel) MarshalBinary ¶ 

func (m *PreferredProgramModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PreferredProgramModel) UnmarshalBinary ¶ 

func (m *PreferredProgramModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PreferredProgramModel) Validate ¶ 

func (m *PreferredProgramModel) Validate(formats strfmt.Registry) error

Validate validates this preferred program model

type PreferredProgramModelFetchResult ¶ 

type PreferredProgramModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*PreferredProgramModel `json:"value"`
}

PreferredProgramModelFetchResult preferred program model fetch result

swagger:model PreferredProgramModelFetchResult

func (*PreferredProgramModelFetchResult) ContextValidate ¶ 

func (m *PreferredProgramModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this preferred program model fetch result based on the context it is used

func (*PreferredProgramModelFetchResult) MarshalBinary ¶ 

func (m *PreferredProgramModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PreferredProgramModelFetchResult) UnmarshalBinary ¶ 

func (m *PreferredProgramModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PreferredProgramModelFetchResult) Validate ¶ 

func (m *PreferredProgramModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this preferred program model fetch result

type ProductClassificationSystemModel ¶ 

type ProductClassificationSystemModel struct {

	// List of all countries that belong to the system including
	Countries []*ProductSystemCountryModel `json:"countries"`

	// custom value set for the system
	// Example: pqr
	CustomsValue string `json:"customsValue,omitempty"`

	// A friendly human-readable name representing this System.
	// Example: xyz
	Description string `json:"description,omitempty"`

	// The System code for this System.
	// Example: abc
	SystemCode string `json:"systemCode,omitempty"`

	// Its Integer SystemId value for System
	// Example: 1
	SystemID int32 `json:"systemId,omitempty"`
}

ProductClassificationSystemModel Represents a product classification system. Example: {"customsValue":"pqr","description":"xyz","systemCode":"abc","systemId":1}

swagger:model ProductClassificationSystemModel

func (*ProductClassificationSystemModel) ContextValidate ¶ 

func (m *ProductClassificationSystemModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this product classification system model based on the context it is used

func (*ProductClassificationSystemModel) MarshalBinary ¶ 

func (m *ProductClassificationSystemModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProductClassificationSystemModel) UnmarshalBinary ¶ 

func (m *ProductClassificationSystemModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProductClassificationSystemModel) Validate ¶ 

func (m *ProductClassificationSystemModel) Validate(formats strfmt.Registry) error

Validate validates this product classification system model

type ProductClassificationSystemModelFetchResult ¶ 

type ProductClassificationSystemModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ProductClassificationSystemModel `json:"value"`
}

ProductClassificationSystemModelFetchResult product classification system model fetch result

swagger:model ProductClassificationSystemModelFetchResult

func (*ProductClassificationSystemModelFetchResult) ContextValidate ¶ 

func (m *ProductClassificationSystemModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this product classification system model fetch result based on the context it is used

func (*ProductClassificationSystemModelFetchResult) MarshalBinary ¶ 

func (m *ProductClassificationSystemModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProductClassificationSystemModelFetchResult) UnmarshalBinary ¶ 

func (m *ProductClassificationSystemModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProductClassificationSystemModelFetchResult) Validate ¶ 

func (m *ProductClassificationSystemModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this product classification system model fetch result

type ProductSystemCountryModel ¶ 

type ProductSystemCountryModel struct {

	// string value of country code for SystemCountry
	// Example: US
	Country string `json:"country,omitempty"`

	// DateTime as EffDate for SystemCountry
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	EffDate strfmt.DateTime `json:"effDate,omitempty"`

	// DateTime as EffDate for SystemCountry
	// Example: 9999-12-31T00:00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Its Integer SystemCountryId value for SystemCountry
	// Example: 1
	SystemCountryID int32 `json:"systemCountryId,omitempty"`

	// Its Integer SystemId value for SystemCountry
	// Example: 1
	SystemID int32 `json:"systemId,omitempty"`
}

ProductSystemCountryModel Represents a System Country. Example: {"country":"US","effDate":"2021-12-25T00:00:00+00:00","endDate":"9999-12-31T00:00:00","systemCountryId":1,"systemId":1}

swagger:model ProductSystemCountryModel

func (*ProductSystemCountryModel) ContextValidate ¶ 

func (m *ProductSystemCountryModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this product system country model based on context it is used

func (*ProductSystemCountryModel) MarshalBinary ¶ 

func (m *ProductSystemCountryModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProductSystemCountryModel) UnmarshalBinary ¶ 

func (m *ProductSystemCountryModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProductSystemCountryModel) Validate ¶ 

func (m *ProductSystemCountryModel) Validate(formats strfmt.Registry) error

Validate validates this product system country model

type ProvisionStatusModel ¶ 

type ProvisionStatusModel struct {

	// The accountId of the company represented by this status
	// Example: 12345
	AccountID int32 `json:"accountId,omitempty"`

	// The AvaTax company represented by this status
	// Example: 6789
	CompanyID int32 `json:"companyId,omitempty"`

	// The status of exemption certificate setup for this company.
	//
	// If this value is `Finished`, this company will then be able to use the Customers, Certificates, and
	// CertExpressInvites APIs within AvaTax.
	// Example: Provisioned
	// Enum: [Provisioned InProgress NotProvisioned]
	Status string `json:"status,omitempty"`
}

ProvisionStatusModel Contains information about a company's exemption certificate status.

This model can be used to determine if your company is able to use the Customers, Certificates, and CertExpressInvites APIs within AvaTax. Example: {"accountId":12345,"companyId":6789,"status":"Provisioned"}

swagger:model ProvisionStatusModel

func (*ProvisionStatusModel) ContextValidate ¶ 

func (m *ProvisionStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this provision status model based on context it is used

func (*ProvisionStatusModel) MarshalBinary ¶ 

func (m *ProvisionStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProvisionStatusModel) UnmarshalBinary ¶ 

func (m *ProvisionStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProvisionStatusModel) Validate ¶ 

func (m *ProvisionStatusModel) Validate(formats strfmt.Registry) error

Validate validates this provision status model

type QueryRequestModel ¶ 

type QueryRequestModel struct {

	// A list of conditions to filter objects.
	Filter string `json:"filter,omitempty"`

	// A list of included commands for this fetch operation.
	Include string `json:"include,omitempty"`

	// For pagination: This is the maximum number of results to return.
	MaxResults int32 `json:"maxResults,omitempty"`

	// Sorts the resulting objects in a specific manner.
	SortBy string `json:"sortBy,omitempty"`

	// For pagination: This is the index of the first result.
	StartIndex int32 `json:"startIndex,omitempty"`
}

QueryRequestModel Represents a complex query request to parse using query filter guidelines from Microsoft REST standards Example: {"filter":"id = 1","maxResults":10,"sortBy":"id asc","startIndex":0}

swagger:model QueryRequestModel

func (*QueryRequestModel) ContextValidate ¶ 

func (m *QueryRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this query request model based on context it is used

func (*QueryRequestModel) MarshalBinary ¶ 

func (m *QueryRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QueryRequestModel) UnmarshalBinary ¶ 

func (m *QueryRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QueryRequestModel) Validate ¶ 

func (m *QueryRequestModel) Validate(formats strfmt.Registry) error

Validate validates this query request model

type RateModel ¶ 

type RateModel struct {

	// A readable name of the tax or taxing jurisdiction related to this tax rate.
	// Example: CALIFORNIA
	Name string `json:"name,omitempty"`

	// The sales tax rate for general tangible personal property in this jurisdiction.
	// Example: 0.0625
	Rate float64 `json:"rate,omitempty"`

	// The type of jurisdiction associated with this tax rate.
	// Example: Country
	// Enum: [Country State County City Special]
	Type string `json:"type,omitempty"`
}

RateModel Indicates one element of a sales tax rate. Example: {"name":"CALIFORNIA","rate":0.0625,"type":"State"}

swagger:model RateModel

func (*RateModel) ContextValidate ¶ 

func (m *RateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this rate model based on context it is used

func (*RateModel) MarshalBinary ¶ 

func (m *RateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RateModel) UnmarshalBinary ¶ 

func (m *RateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RateModel) Validate ¶ 

func (m *RateModel) Validate(formats strfmt.Registry) error

Validate validates this rate model

type RateTypeModel ¶ 

type RateTypeModel struct {

	// Country code for this rate type
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// Description of this rate type.
	// Example: test
	// Read Only: true
	Description string `json:"description,omitempty"`

	// The unique ID number of this rate type.
	// Example: 1
	// Read Only: true
	ID string `json:"id,omitempty"`
}

RateTypeModel Rate type Model Example: {"country":"US","description":"test","id":"1"}

swagger:model RateTypeModel

func (*RateTypeModel) ContextValidate ¶ 

func (m *RateTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this rate type model based on the context it is used

func (*RateTypeModel) MarshalBinary ¶ 

func (m *RateTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RateTypeModel) UnmarshalBinary ¶ 

func (m *RateTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RateTypeModel) Validate ¶ 

func (m *RateTypeModel) Validate(formats strfmt.Registry) error

Validate validates this rate type model

type RateTypeModelFetchResult ¶ 

type RateTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*RateTypeModel `json:"value"`
}

RateTypeModelFetchResult rate type model fetch result

swagger:model RateTypeModelFetchResult

func (*RateTypeModelFetchResult) ContextValidate ¶ 

func (m *RateTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this rate type model fetch result based on the context it is used

func (*RateTypeModelFetchResult) MarshalBinary ¶ 

func (m *RateTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RateTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *RateTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RateTypeModelFetchResult) Validate ¶ 

func (m *RateTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this rate type model fetch result

type RateTypesModel ¶ 

type RateTypesModel struct {

	// The description of this rate type.
	// Example: Alcohol
	Description string `json:"description,omitempty"`

	// The unique ID number of this rate type.
	// Example: 503
	ID int32 `json:"id,omitempty"`

	// The name of this rateType
	// Example: Alcohol
	RateType string `json:"rateType,omitempty"`
}

RateTypesModel Rate types Model Example: {"description":"Alcohol","id":503,"rateType":"Alcohol"}

swagger:model RateTypesModel

func (*RateTypesModel) ContextValidate ¶ 

func (m *RateTypesModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this rate types model based on context it is used

func (*RateTypesModel) MarshalBinary ¶ 

func (m *RateTypesModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RateTypesModel) UnmarshalBinary ¶ 

func (m *RateTypesModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RateTypesModel) Validate ¶ 

func (m *RateTypesModel) Validate(formats strfmt.Registry) error

Validate validates this rate types model

type RateTypesModelFetchResult ¶ 

type RateTypesModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*RateTypesModel `json:"value"`
}

RateTypesModelFetchResult rate types model fetch result

swagger:model RateTypesModelFetchResult

func (*RateTypesModelFetchResult) ContextValidate ¶ 

func (m *RateTypesModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this rate types model fetch result based on the context it is used

func (*RateTypesModelFetchResult) MarshalBinary ¶ 

func (m *RateTypesModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RateTypesModelFetchResult) UnmarshalBinary ¶ 

func (m *RateTypesModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RateTypesModelFetchResult) Validate ¶ 

func (m *RateTypesModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this rate types model fetch result

type RebuildFilingsModel ¶ 

type RebuildFilingsModel struct {

	// Set this value to true in order to rebuild the filings.
	// Example: true
	// Required: true
	Rebuild *bool `json:"rebuild"`
}

RebuildFilingsModel Rebuild a set of filings. Example: {"rebuild":true}

swagger:model RebuildFilingsModel

func (*RebuildFilingsModel) ContextValidate ¶ 

func (m *RebuildFilingsModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this rebuild filings model based on context it is used

func (*RebuildFilingsModel) MarshalBinary ¶ 

func (m *RebuildFilingsModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RebuildFilingsModel) UnmarshalBinary ¶ 

func (m *RebuildFilingsModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RebuildFilingsModel) Validate ¶ 

func (m *RebuildFilingsModel) Validate(formats strfmt.Registry) error

Validate validates this rebuild filings model

type ReconstructedAPIRequestResponseModel ¶ 

type ReconstructedAPIRequestResponseModel struct {

	// API request
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2017-10-12","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2017 - 10 - 12 - 001","type":"SalesInvoice"}
	Request *CreateTransactionModel `json:"request,omitempty"`
}

ReconstructedAPIRequestResponseModel This model contains a reconstructed CreateTransaction request object that could potentially be used to recreate this transaction.

Note that the API changes over time, and this reconstructed model is likely different from the exact request that was originally used to create this transaction. Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2017-10-12","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2017 - 10 - 12 - 001","type":"SalesInvoice"}}

swagger:model ReconstructedApiRequestResponseModel

func (*ReconstructedAPIRequestResponseModel) ContextValidate ¶ 

func (m *ReconstructedAPIRequestResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this reconstructed Api request response model based on the context it is used

func (*ReconstructedAPIRequestResponseModel) MarshalBinary ¶ 

func (m *ReconstructedAPIRequestResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReconstructedAPIRequestResponseModel) UnmarshalBinary ¶ 

func (m *ReconstructedAPIRequestResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReconstructedAPIRequestResponseModel) Validate ¶ 

func (m *ReconstructedAPIRequestResponseModel) Validate(formats strfmt.Registry) error

Validate validates this reconstructed Api request response model

type ReconstructedMultiDocumentModel ¶ 

type ReconstructedMultiDocumentModel struct {

	// The original request that was used to create a MultiDocument object.
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	Request *CreateMultiDocumentModel `json:"request,omitempty"`
}

ReconstructedMultiDocumentModel Contains information about the original API request and response that created a MultiDocument object. Example: {"request":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"companyCode":"DEFAULT","description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"reportingLocationCode":"ReportLocation111","taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}

swagger:model ReconstructedMultiDocumentModel

func (*ReconstructedMultiDocumentModel) ContextValidate ¶ 

func (m *ReconstructedMultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this reconstructed multi document model based on the context it is used

func (*ReconstructedMultiDocumentModel) MarshalBinary ¶ 

func (m *ReconstructedMultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReconstructedMultiDocumentModel) UnmarshalBinary ¶ 

func (m *ReconstructedMultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReconstructedMultiDocumentModel) Validate ¶ 

func (m *ReconstructedMultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this reconstructed multi document model

type RefreshECommerceTokenInputModel ¶ 

type RefreshECommerceTokenInputModel struct {

	// The token that requires its expiration to be extended.
	// Example: jwt token for gencert utility
	// Required: true
	Token *string `json:"token"`
}

RefreshECommerceTokenInputModel A model used to request the refresh of a CertCapture eCommerce token. Example: {"token":"jwt token for gencert utility"}

swagger:model RefreshECommerceTokenInputModel

func (*RefreshECommerceTokenInputModel) ContextValidate ¶ 

func (m *RefreshECommerceTokenInputModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this refresh e commerce token input model based on context it is used

func (*RefreshECommerceTokenInputModel) MarshalBinary ¶ 

func (m *RefreshECommerceTokenInputModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RefreshECommerceTokenInputModel) UnmarshalBinary ¶ 

func (m *RefreshECommerceTokenInputModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RefreshECommerceTokenInputModel) Validate ¶ 

func (m *RefreshECommerceTokenInputModel) Validate(formats strfmt.Registry) error

Validate validates this refresh e commerce token input model

type RefundTransactionModel ¶ 

type RefundTransactionModel struct {

	// A user-defined reference field containing information about this refund.
	// Example: Refund for a committed transaction
	ReferenceCode string `json:"referenceCode,omitempty"`

	// The date of the refund.  For customers using Avalara's Managed Returns Service, this date controls the month in which the refund
	// transaction will be reported on a tax filing.
	// Example: 2021-12-25T00:00:00+00:00
	// Required: true
	// Format: date
	RefundDate *strfmt.Date `json:"refundDate"`

	// If you chose a refund of type `Partial`, this indicates which lines from the original transaction are being refunded.
	RefundLines []string `json:"refundLines"`

	// The percentage for refund.
	//
	// This value only applies if you choose `refundType = Percentage` or `refundType = Partial`.
	RefundPercentage float64 `json:"refundPercentage,omitempty"`

	// The transaction code for the refund.  This code will be saved to the `ReturnInvoice` transaction, and does not need to match the code of the original sale.
	// Example: 0941711e-bd22-43ac-998d-85616b6fc9d9
	// Max Length: 50
	// Min Length: 0
	RefundTransactionCode *string `json:"refundTransactionCode,omitempty"`

	// Type of this refund.
	//
	// To submit a full refund, specify `Full`.
	//
	// To refund only specific lines from the transaction, specify `Partial` and indicate the lines you wish to apply in the `refundLines` field.
	//
	// To refund the tax that was paid in the previous transaction, specify `TaxOnly`.
	//
	// To issue a percentage-based discount, specify `Percentage`.
	// Example: Full
	// Enum: [Full Partial TaxOnly Percentage]
	RefundType string `json:"refundType,omitempty"`
}

RefundTransactionModel Refund a committed transaction Example: {"referenceCode":"Refund for a committed transaction","refundDate":"2021-12-25","refundTransactionCode":"0941711e-bd22-43ac-998d-85616b6fc9d9","refundType":"Full"}

swagger:model RefundTransactionModel

func (*RefundTransactionModel) ContextValidate ¶ 

func (m *RefundTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this refund transaction model based on context it is used

func (*RefundTransactionModel) MarshalBinary ¶ 

func (m *RefundTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RefundTransactionModel) UnmarshalBinary ¶ 

func (m *RefundTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RefundTransactionModel) Validate ¶ 

func (m *RefundTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this refund transaction model

type RemoveTransactionLineModel ¶ 

type RemoveTransactionLineModel struct {

	// company code
	// Example: DEFAULT
	// Required: true
	CompanyCode *string `json:"companyCode"`

	// document type
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	DocumentType string `json:"documentType,omitempty"`

	// List of line numbers to be removed
	// Example: ["1"]
	// Required: true
	Lines []string `json:"lines"`

	// ption to renumber lines after removal. After renumber, the line number becomes: "1", "2", "3", ...
	// Example: false
	Renumber bool `json:"renumber,omitempty"`

	// document code for the transaction to add lines
	// Example: 1234
	// Required: true
	TransactionCode *string `json:"transactionCode"`
}

RemoveTransactionLineModel Model to specify lines to be removed Example: {"companyCode":"DEFAULT","documentType":"SalesInvoice","lines":["1"],"renumber":false,"transactionCode":"1234"}

swagger:model RemoveTransactionLineModel

func (*RemoveTransactionLineModel) ContextValidate ¶ 

func (m *RemoveTransactionLineModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this remove transaction line model based on context it is used

func (*RemoveTransactionLineModel) MarshalBinary ¶ 

func (m *RemoveTransactionLineModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RemoveTransactionLineModel) UnmarshalBinary ¶ 

func (m *RemoveTransactionLineModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RemoveTransactionLineModel) Validate ¶ 

func (m *RemoveTransactionLineModel) Validate(formats strfmt.Registry) error

Validate validates this remove transaction line model

type ReportModel ¶ 

type ReportModel struct {

	// The ID of the account the reported transactions are from
	// Example: 2087654354
	AccountID int32 `json:"accountId,omitempty"`

	// The ID of the company the reported transactions are from
	// Example: 2087654354
	CompanyID int32 `json:"companyId,omitempty"`

	// The time when the report was finished building, if completed
	// Format: date-time
	CompletedDate strfmt.DateTime `json:"completedDate,omitempty"`

	// The time when the report task was initiated
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The userName of the user who initiated the report task
	CreatedUser string `json:"createdUser,omitempty"`

	// The Id of the user who initiated this task
	// Example: 0
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The name of the report file, if available
	// Example: 2087654354_2087654354_1_ExportDocumentLine.CSV
	File string `json:"file,omitempty"`

	// The format of the report file
	// Example: CSV
	Format string `json:"format,omitempty"`

	// The unique identifier of the report task
	// Example: 1
	ID int64 `json:"id,omitempty"`

	// The parametes used to build the report
	// Example: {"country":"US","currencyCode":"USD","dateFilter":"DD","dateFormat":"MM/dd/yyyy","docType":"S","documentStatus":"Commited","endDate":"2021-12-25T00:00:00+00:00","isLocked":true,"isModifiedDateSameAsDocumentDate":false,"merchantSellerId":"abcd","numberOfPartitions":2,"partition":0,"startDate":"2021-11-25T00:00:00+00:00","state":"All","taxCode":"123","taxGroup":"Alcohol","taxName":"VAT","taxSubType":"Amusement"}
	Parameters *ReportParametersModel `json:"parameters,omitempty"`

	// The type of the report: ExportDocumentLine, etc.
	// Example: ExportDocumentLine
	ReportType string `json:"reportType,omitempty"`

	// The size of the report file, if available
	Size int64 `json:"size,omitempty"`

	// The current status of the report building task
	// Example: InQueue
	Status string `json:"status,omitempty"`
}

ReportModel A model for displaying report task metadata Example: {"accountId":2087654354,"companyId":2087654354,"createdDate":"2021-12-25T00:00:00+00:00","createdUserId":0,"file":"2087654354_2087654354_1_ExportDocumentLine.CSV","format":"CSV","id":1,"parameters":{"country":"US","currencyCode":"USD","dateFilter":"DD","dateFormat":"MM/dd/yyyy","docType":"S","documentStatus":"Commited","endDate":"2021-12-25T00:00:00+00:00","isLocked":true,"isModifiedDateSameAsDocumentDate":false,"merchantSellerId":"abcd","numberOfPartitions":2,"partition":0,"startDate":"2021-11-25T00:00:00+00:00","state":"All","taxCode":"123","taxGroup":"Alcohol","taxName":"VAT","taxSubType":"Amusement"},"reportType":"ExportDocumentLine","status":"InQueue"}

swagger:model ReportModel

func (*ReportModel) ContextValidate ¶ 

func (m *ReportModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this report model based on the context it is used

func (*ReportModel) MarshalBinary ¶ 

func (m *ReportModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReportModel) UnmarshalBinary ¶ 

func (m *ReportModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReportModel) Validate ¶ 

func (m *ReportModel) Validate(formats strfmt.Registry) error

Validate validates this report model

type ReportModelFetchResult ¶ 

type ReportModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ReportModel `json:"value"`
}

ReportModelFetchResult report model fetch result

swagger:model ReportModelFetchResult

func (*ReportModelFetchResult) ContextValidate ¶ 

func (m *ReportModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this report model fetch result based on the context it is used

func (*ReportModelFetchResult) MarshalBinary ¶ 

func (m *ReportModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReportModelFetchResult) UnmarshalBinary ¶ 

func (m *ReportModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReportModelFetchResult) Validate ¶ 

func (m *ReportModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this report model fetch result

type ReportParametersModel ¶ 

type ReportParametersModel struct {

	// The country filter used for your report
	// Example: US
	Country string `json:"country,omitempty"`

	// The currency code used for your report
	// Example: USD
	CurrencyCode string `json:"currencyCode,omitempty"`

	// The code your business application uses to identify a customer or vendor
	CustomerVendorCode string `json:"customerVendorCode,omitempty"`

	// The date type filter used for your report
	// Example: DD
	DateFilter string `json:"dateFilter,omitempty"`

	// The date format used for your report
	// Example: MM/dd/yyyy
	DateFormat string `json:"dateFormat,omitempty"`

	// The doc type filter used for your report
	// Example: S
	DocType string `json:"docType,omitempty"`

	// The Document status filter used for report
	// For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval
	// Example: Commited
	DocumentStatus string `json:"documentStatus,omitempty"`

	// The end date filter used for your report
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// If true, include only documents that are locked.
	// If false, include only documents that are not locked.
	// Defaults to false if not specified.
	// Example: true
	IsLocked bool `json:"isLocked,omitempty"`

	// If true, modified date will be same as document date
	// If false, modified date will not be same as document date
	// Defaults to false if not specified.
	// Example: false
	IsModifiedDateSameAsDocumentDate bool `json:"isModifiedDateSameAsDocumentDate,omitempty"`

	// If set, include only documents associated with this merchantSellerId.
	// Example: abcd
	MerchantSellerID string `json:"merchantSellerId,omitempty"`

	// Number of partitions to split the report into.
	// Example: 2
	NumberOfPartitions int32 `json:"numberOfPartitions,omitempty"`

	// The zero-based partition number to retrieve in this export request.
	// Example: 0
	Partition int32 `json:"partition,omitempty"`

	// The start date filter used for your report
	// Example: 2021-11-25T00:00:00+00:00
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

	// The state filter used for your report
	// Example: All
	State string `json:"state,omitempty"`

	// The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
	// Example: 123
	TaxCode string `json:"taxCode,omitempty"`

	// TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output).
	// TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
	// Example: Alcohol
	TaxGroup string `json:"taxGroup,omitempty"`

	// The description of the tax
	// Example: VAT
	TaxName string `json:"taxName,omitempty"`

	// Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
	// Example: Amusement
	TaxSubType string `json:"taxSubType,omitempty"`
}

ReportParametersModel The output model for report parameter definitions Example: {"country":"US","currencyCode":"USD","dateFilter":"DD","dateFormat":"MM/dd/yyyy","docType":"S","documentStatus":"Commited","endDate":"2021-12-25T00:00:00+00:00","isLocked":true,"isModifiedDateSameAsDocumentDate":false,"merchantSellerId":"abcd","numberOfPartitions":2,"partition":0,"startDate":"2021-11-25T00:00:00+00:00","state":"All","taxCode":"123","taxGroup":"Alcohol","taxName":"VAT","taxSubType":"Amusement"}

swagger:model ReportParametersModel

func (*ReportParametersModel) ContextValidate ¶ 

func (m *ReportParametersModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this report parameters model based on context it is used

func (*ReportParametersModel) MarshalBinary ¶ 

func (m *ReportParametersModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReportParametersModel) UnmarshalBinary ¶ 

func (m *ReportParametersModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReportParametersModel) Validate ¶ 

func (m *ReportParametersModel) Validate(formats strfmt.Registry) error

Validate validates this report parameters model

type RequiredFilingCalendarDataFieldModel ¶ 

type RequiredFilingCalendarDataFieldModel struct {

	// Username that we are using for verification
	// Example: Id Used for Registration
	Description string `json:"description,omitempty"`

	// Region of the verification request
	// Example: RegistrationId
	Name string `json:"name,omitempty"`
}

RequiredFilingCalendarDataFieldModel Represents a verification request using Skyscraper for a company Example: {"description":"Id Used for Registration","name":"RegistrationId"}

swagger:model requiredFilingCalendarDataFieldModel

func (*RequiredFilingCalendarDataFieldModel) ContextValidate ¶ 

func (m *RequiredFilingCalendarDataFieldModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this required filing calendar data field model based on context it is used

func (*RequiredFilingCalendarDataFieldModel) MarshalBinary ¶ 

func (m *RequiredFilingCalendarDataFieldModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RequiredFilingCalendarDataFieldModel) UnmarshalBinary ¶ 

func (m *RequiredFilingCalendarDataFieldModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RequiredFilingCalendarDataFieldModel) Validate ¶ 

func (m *RequiredFilingCalendarDataFieldModel) Validate(formats strfmt.Registry) error

Validate validates this required filing calendar data field model

type ResetLicenseKeyModel ¶ 

type ResetLicenseKeyModel struct {

	// The primary key of the account ID to reset
	// Example: 123456789
	// Required: true
	AccountID *int32 `json:"accountId"`

	// Set this value to true to reset the license key for this account.
	// This license key reset function will only work when called using the credentials of the account administrator of this account.
	// Example: true
	// Required: true
	ConfirmResetLicenseKey *bool `json:"confirmResetLicenseKey"`
}

ResetLicenseKeyModel Represents a license key reset request. Example: {"accountId":123456789,"confirmResetLicenseKey":true}

swagger:model ResetLicenseKeyModel

func (*ResetLicenseKeyModel) ContextValidate ¶ 

func (m *ResetLicenseKeyModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this reset license key model based on context it is used

func (*ResetLicenseKeyModel) MarshalBinary ¶ 

func (m *ResetLicenseKeyModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResetLicenseKeyModel) UnmarshalBinary ¶ 

func (m *ResetLicenseKeyModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResetLicenseKeyModel) Validate ¶ 

func (m *ResetLicenseKeyModel) Validate(formats strfmt.Registry) error

Validate validates this reset license key model

type ResourceFileDownloadResult ¶ 

type ResourceFileDownloadResult struct {

	// Bytes of the file
	// Format: byte
	Bytes strfmt.Base64 `json:"bytes,omitempty"`

	// Mime content type
	ContentType string `json:"contentType,omitempty"`

	// Original filename
	Filename string `json:"filename,omitempty"`

	// True if this download succeeded
	Success bool `json:"success,omitempty"`
}

ResourceFileDownloadResult Represents everything downloaded from resource files

swagger:model ResourceFileDownloadResult

func (*ResourceFileDownloadResult) ContextValidate ¶ 

func (m *ResourceFileDownloadResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this resource file download result based on context it is used

func (*ResourceFileDownloadResult) MarshalBinary ¶ 

func (m *ResourceFileDownloadResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceFileDownloadResult) UnmarshalBinary ¶ 

func (m *ResourceFileDownloadResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceFileDownloadResult) Validate ¶ 

func (m *ResourceFileDownloadResult) Validate(formats strfmt.Registry) error

Validate validates this resource file download result

type ResourceFileTypeModel ¶ 

type ResourceFileTypeModel struct {

	// The name of the file type
	// Example: TaxNoticeAttachment
	Name string `json:"name,omitempty"`

	// The resource file type id
	// Example: 1
	ResourceFileTypeID int32 `json:"resourceFileTypeId,omitempty"`
}

ResourceFileTypeModel Resource File Type Model Example: {"name":"TaxNoticeAttachment","resourceFileTypeId":1}

swagger:model ResourceFileTypeModel

func (*ResourceFileTypeModel) ContextValidate ¶ 

func (m *ResourceFileTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this resource file type model based on context it is used

func (*ResourceFileTypeModel) MarshalBinary ¶ 

func (m *ResourceFileTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceFileTypeModel) UnmarshalBinary ¶ 

func (m *ResourceFileTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceFileTypeModel) Validate ¶ 

func (m *ResourceFileTypeModel) Validate(formats strfmt.Registry) error

Validate validates this resource file type model

type ResourceFileTypeModelFetchResult ¶ 

type ResourceFileTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ResourceFileTypeModel `json:"value"`
}

ResourceFileTypeModelFetchResult resource file type model fetch result

swagger:model ResourceFileTypeModelFetchResult

func (*ResourceFileTypeModelFetchResult) ContextValidate ¶ 

func (m *ResourceFileTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this resource file type model fetch result based on the context it is used

func (*ResourceFileTypeModelFetchResult) MarshalBinary ¶ 

func (m *ResourceFileTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceFileTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *ResourceFileTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceFileTypeModelFetchResult) Validate ¶ 

func (m *ResourceFileTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this resource file type model fetch result

type ResourceFileUploadRequestModel ¶ 

type ResourceFileUploadRequestModel struct {

	// The account ID to which this file will be attached.
	// Example: 5555
	AccountID int32 `json:"accountId,omitempty"`

	// The company ID to which this file will be attached.
	// Example: 66666
	CompanyID int32 `json:"companyId,omitempty"`

	// This stream contains the bytes of the file being uploaded.
	// Example: UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==
	// Required: true
	// Format: byte
	Content *strfmt.Base64 `json:"content"`

	// Length of the file in bytes.
	// Example: 333
	Length int64 `json:"length,omitempty"`

	// The original name of this file.
	// Example: nameoffile.txt
	Name string `json:"name,omitempty"`

	// The resource type ID of this file.
	// Example: 0
	ResourceFileTypeID int32 `json:"resourceFileTypeId,omitempty"`

	// The username adding the file
	// Example: test.user
	Username string `json:"username,omitempty"`
}

ResourceFileUploadRequestModel A request to upload a file to Resource Files Example: {"accountId":5555,"companyId":66666,"content":"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==","length":333,"name":"nameoffile.txt","resourceFileTypeId":0,"username":"test.user"}

swagger:model ResourceFileUploadRequestModel

func (*ResourceFileUploadRequestModel) ContextValidate ¶ 

func (m *ResourceFileUploadRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this resource file upload request model based on context it is used

func (*ResourceFileUploadRequestModel) MarshalBinary ¶ 

func (m *ResourceFileUploadRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceFileUploadRequestModel) UnmarshalBinary ¶ 

func (m *ResourceFileUploadRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceFileUploadRequestModel) Validate ¶ 

func (m *ResourceFileUploadRequestModel) Validate(formats strfmt.Registry) error

Validate validates this resource file upload request model

type ResourceFileUploadResultModel ¶ 

type ResourceFileUploadResultModel struct {

	// True if the upload request succeeded.
	AaaSuccess bool `json:"aaa_success,omitempty"`

	// If the request failed, this contains a description of the error.
	// Example: return message
	Message string `json:"message,omitempty"`

	// If the request succeeded, this is the ID number of the file.
	// Example: 333
	ResourceFileID int64 `json:"resourceFileId,omitempty"`
}

ResourceFileUploadResultModel Encapsulates the result of uploading a file to the resource system Example: {"aaa_success":true,"message":"return message","resourceFileId":333}

swagger:model ResourceFileUploadResultModel

func (*ResourceFileUploadResultModel) ContextValidate ¶ 

func (m *ResourceFileUploadResultModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this resource file upload result model based on context it is used

func (*ResourceFileUploadResultModel) MarshalBinary ¶ 

func (m *ResourceFileUploadResultModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceFileUploadResultModel) UnmarshalBinary ¶ 

func (m *ResourceFileUploadResultModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceFileUploadResultModel) Validate ¶ 

func (m *ResourceFileUploadResultModel) Validate(formats strfmt.Registry) error

Validate validates this resource file upload result model

type ReturnsParameterUsageModel ¶ 

type ReturnsParameterUsageModel struct {

	// The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
	// Example: Product
	AttributeType string `json:"attributeType,omitempty"`

	// The data type of the property.
	// Example: NumericMeasured
	DataType string `json:"dataType,omitempty"`

	// Help text to be shown to the user when they are filling out this parameter.  Help text may include HTML links to additional
	// content with more information about a parameter.
	// Example: A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.
	HelpText string `json:"helpText,omitempty"`

	// A help url that provides more information about the parameter
	HelpURL string `json:"helpUrl,omitempty"`

	// The unique ID number of this property.
	// Example: 12345
	ID int32 `json:"id,omitempty"`

	// Label that helps the user to identify a parameter
	// Example: Screen Size
	Label string `json:"label,omitempty"`

	// The unit of measurement type of the parameter
	// Example: Length
	MeasurementType string `json:"measurementType,omitempty"`

	// The name of the property.  To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call.
	// Example: ScreenSize
	Name string `json:"name,omitempty"`

	// The id of the parameter.
	// Example: 12345
	ParameterID int64 `json:"parameterId,omitempty"`

	// Product code for the return parameter usage item.
	// Example: PC080100
	ProductCode string `json:"productCode,omitempty"`

	// tax type for the returns parameter usage item.
	// Example: LandedCost
	TaxTypeID string `json:"taxTypeId,omitempty"`

	// If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
	Values []string `json:"values"`
}

ReturnsParameterUsageModel usage of system defined parameters for returns. Example: {"attributeType":"Product","dataType":"NumericMeasured","helpText":"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.","id":12345,"label":"Screen Size","measurementType":"Length","name":"ScreenSize","parameterId":12345,"productCode":"PC080100","taxTypeId":"LandedCost"}

swagger:model ReturnsParameterUsageModel

func (*ReturnsParameterUsageModel) ContextValidate ¶ 

func (m *ReturnsParameterUsageModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this returns parameter usage model based on context it is used

func (*ReturnsParameterUsageModel) MarshalBinary ¶ 

func (m *ReturnsParameterUsageModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReturnsParameterUsageModel) UnmarshalBinary ¶ 

func (m *ReturnsParameterUsageModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReturnsParameterUsageModel) Validate ¶ 

func (m *ReturnsParameterUsageModel) Validate(formats strfmt.Registry) error

Validate validates this returns parameter usage model

type ReturnsParameterUsageModelFetchResult ¶ 

type ReturnsParameterUsageModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*ReturnsParameterUsageModel `json:"value"`
}

ReturnsParameterUsageModelFetchResult returns parameter usage model fetch result

swagger:model ReturnsParameterUsageModelFetchResult

func (*ReturnsParameterUsageModelFetchResult) ContextValidate ¶ 

func (m *ReturnsParameterUsageModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this returns parameter usage model fetch result based on the context it is used

func (*ReturnsParameterUsageModelFetchResult) MarshalBinary ¶ 

func (m *ReturnsParameterUsageModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReturnsParameterUsageModelFetchResult) UnmarshalBinary ¶ 

func (m *ReturnsParameterUsageModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReturnsParameterUsageModelFetchResult) Validate ¶ 

func (m *ReturnsParameterUsageModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this returns parameter usage model fetch result

type SecurityRoleModel ¶ 

type SecurityRoleModel struct {

	// A description of this security role
	// Example: AccountAdmin
	// Read Only: true
	Description string `json:"description,omitempty"`

	// The unique ID number of this security role.
	// Example: 3
	// Read Only: true
	ID int32 `json:"id,omitempty"`
}

SecurityRoleModel Represents a single security role. Example: {"description":"AccountAdmin","id":3}

swagger:model SecurityRoleModel

func (*SecurityRoleModel) ContextValidate ¶ 

func (m *SecurityRoleModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this security role model based on the context it is used

func (*SecurityRoleModel) MarshalBinary ¶ 

func (m *SecurityRoleModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SecurityRoleModel) UnmarshalBinary ¶ 

func (m *SecurityRoleModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SecurityRoleModel) Validate ¶ 

func (m *SecurityRoleModel) Validate(formats strfmt.Registry) error

Validate validates this security role model

type SecurityRoleModelFetchResult ¶ 

type SecurityRoleModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*SecurityRoleModel `json:"value"`
}

SecurityRoleModelFetchResult security role model fetch result

swagger:model SecurityRoleModelFetchResult

func (*SecurityRoleModelFetchResult) ContextValidate ¶ 

func (m *SecurityRoleModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this security role model fetch result based on the context it is used

func (*SecurityRoleModelFetchResult) MarshalBinary ¶ 

func (m *SecurityRoleModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SecurityRoleModelFetchResult) UnmarshalBinary ¶ 

func (m *SecurityRoleModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SecurityRoleModelFetchResult) Validate ¶ 

func (m *SecurityRoleModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this security role model fetch result

type SendSalesRequestModel ¶ 

type SendSalesRequestModel struct {

	// The companyId for which the send sales file is being generated.
	// Example: 12345
	// Required: true
	CompanyID *int32 `json:"companyId"`

	// The date for which send sales file is being generated.
	// Example: 2021-12-25T00:00:00+00:00
	// Required: true
	// Format: date-time
	Date *strfmt.DateTime `json:"date"`

	// The send sales file format.
	// Example: STANDARD
	// Enum: [STANDARD DMA DMA_NEW]
	Format string `json:"format,omitempty"`

	// List of taxCodes to be included in send sales file.
	// Example: ["P0000000","PC040100"]
	// Required: true
	TaxCodes []string `json:"taxCodes"`

	// The send sales file type
	// Example: Csv
	// Enum: [Csv Json]
	Type string `json:"type,omitempty"`
}

SendSalesRequestModel SendSales Request Model. Example: {"companyId":12345,"date":"2021-12-25T00:00:00+00:00","format":"STANDARD","taxCodes":["P0000000","PC040100"],"type":"Csv"}

swagger:model SendSalesRequestModel

func (*SendSalesRequestModel) ContextValidate ¶ 

func (m *SendSalesRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this send sales request model based on context it is used

func (*SendSalesRequestModel) MarshalBinary ¶ 

func (m *SendSalesRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SendSalesRequestModel) UnmarshalBinary ¶ 

func (m *SendSalesRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SendSalesRequestModel) Validate ¶ 

func (m *SendSalesRequestModel) Validate(formats strfmt.Registry) error

Validate validates this send sales request model

type SetPasswordModel ¶ 

type SetPasswordModel struct {

	// New Password
	// Example: NewPassword789~~!
	// Required: true
	NewPassword *string `json:"newPassword"`
}

SetPasswordModel Set Password Model Example: {"newPassword":"NewPassword789~~!"}

swagger:model SetPasswordModel

func (*SetPasswordModel) ContextValidate ¶ 

func (m *SetPasswordModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this set password model based on context it is used

func (*SetPasswordModel) MarshalBinary ¶ 

func (m *SetPasswordModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SetPasswordModel) UnmarshalBinary ¶ 

func (m *SetPasswordModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SetPasswordModel) Validate ¶ 

func (m *SetPasswordModel) Validate(formats strfmt.Registry) error

Validate validates this set password model

type SettingModel ¶ 

type SettingModel struct {

	// The unique ID number of the company this setting refers to.
	// Example: 12345
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// The unique ID number of this setting.
	// Example: 56789
	// Required: true
	ID *int32 `json:"id"`

	// The value when the entry was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The value identifying who last modified the entry.
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// A user-defined "name" for this name-value pair.
	// Example: Texas
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Name *string `json:"name"`

	// A user-defined "set" containing this setting.
	//
	// Avalara defines some sets that cannot be changed.  To create your own set, choose a set
	// name that begins with `X-` to indicate that this is an extension value.
	//
	// We recommend that you choose a set name that clearly identifies your application, and then
	// store data within name/value pairs within that set.  For example, if you were creating an
	// application called MyApp, you might choose to create a set named `X-MyCompany-MyApp`.
	// Example: ItemsToRemember
	// Required: true
	// Max Length: 25
	// Min Length: 0
	Set *string `json:"set"`

	// The value of this name-value pair.
	// Example: Alamo
	// Max Length: 200
	// Min Length: 0
	Value *string `json:"value,omitempty"`
}

SettingModel This object is used to keep track of custom information about a company.

The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of preference information, reminders, or any other storage that would need to persist even if the customer uninstalls your application.

A setting can refer to any type of data you need to remember about this company object. When creating this object, you may define your own `set`, `name`, and `value` parameters. To define your own values, please choose a `set` name that begins with `X-` to indicate an extension. Example: {"companyId":12345,"id":56789,"name":"Texas","set":"ItemsToRemember","value":"Alamo"}

swagger:model SettingModel

func (*SettingModel) ContextValidate ¶ 

func (m *SettingModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this setting model based on the context it is used

func (*SettingModel) MarshalBinary ¶ 

func (m *SettingModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SettingModel) UnmarshalBinary ¶ 

func (m *SettingModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SettingModel) Validate ¶ 

func (m *SettingModel) Validate(formats strfmt.Registry) error

Validate validates this setting model

type SettingModelFetchResult ¶ 

type SettingModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*SettingModel `json:"value"`
}

SettingModelFetchResult setting model fetch result

swagger:model SettingModelFetchResult

func (*SettingModelFetchResult) ContextValidate ¶ 

func (m *SettingModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this setting model fetch result based on the context it is used

func (*SettingModelFetchResult) MarshalBinary ¶ 

func (m *SettingModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SettingModelFetchResult) UnmarshalBinary ¶ 

func (m *SettingModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SettingModelFetchResult) Validate ¶ 

func (m *SettingModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this setting model fetch result

type SettleTransactionModel ¶ 

type SettleTransactionModel struct {

	// To change the code for this transaction, you may provide information in this field.
	//
	// If you leave this field null, the transaction's code will not be changed.
	// Example: {"newCode":"f5c5dde4-051a-4b95-a298-9c65cce417e4"}
	ChangeCode *ChangeTransactionCodeModel `json:"changeCode,omitempty"`

	// To commit this transaction so that it can be reported on a tax filing, you may provide information in this field.
	//
	// If you leave this field null, the transaction's commit status will not be changed.
	//
	// If you use Avalara's Managed Returns Service, committing a transaction will allow that transaction to be filed.
	// Example: {"commit":true}
	Commit *CommitTransactionModel `json:"commit,omitempty"`

	// To verify this transaction, you may provide information in this field.
	//
	// If you leave this field null, the transaction will not be verified.
	// Example: {"verifyTotalAmount":100,"verifyTotalTax":6.25,"verifyTransactionDate":"2021-12-25T00:00:00+00:00"}
	Verify *VerifyTransactionModel `json:"verify,omitempty"`
}

SettleTransactionModel Settle this transaction with your ledger by executing one or many actions against that transaction.

You may use this endpoint to verify the transaction, change the transaction's code, and commit the transaction for reporting purposes. This endpoint may be used to execute any or all of these actions at once. Example: {"changeCode":{"newCode":"f5c5dde4-051a-4b95-a298-9c65cce417e4"},"commit":{"commit":true},"verify":{"verifyTotalAmount":100,"verifyTotalTax":6.25,"verifyTransactionDate":"2021-12-25T00:00:00+00:00"}}

swagger:model SettleTransactionModel

func (*SettleTransactionModel) ContextValidate ¶ 

func (m *SettleTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this settle transaction model based on the context it is used

func (*SettleTransactionModel) MarshalBinary ¶ 

func (m *SettleTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SettleTransactionModel) UnmarshalBinary ¶ 

func (m *SettleTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SettleTransactionModel) Validate ¶ 

func (m *SettleTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this settle transaction model

type SkyscraperStatusModel ¶ 

type SkyscraperStatusModel struct {

	// The country of the returns
	// Example: US
	Country string `json:"country,omitempty"`

	// The expected response time of the call
	// Example: 00:30:00
	ExpectedResponseTime string `json:"expectedResponseTime,omitempty"`

	// Indicates if the return is currently available
	// Example: true
	IsAvailable bool `json:"isAvailable,omitempty"`

	// Message on the returns
	// Example: Message
	Message string `json:"message,omitempty"`

	// The specific name of the returns available in skyscraper
	// Example: AL
	Name string `json:"name,omitempty"`

	// A list of required fields to file
	// Example: [{"description":"Id Used for Registration","name":"RegistrationId"}]
	RequiredFilingCalendarDataFields []*RequiredFilingCalendarDataFieldModel `json:"requiredFilingCalendarDataFields"`

	// The Scraper type
	// Example: Login
	// Enum: [Login CustomerDorData]
	ScraperType string `json:"scraperType,omitempty"`

	// The tax form codes available to file through skyscrper
	// Example: ["USAL21009501"]
	TaxFormCodes []string `json:"taxFormCodes"`
}

SkyscraperStatusModel Represents a list of statuses of returns available in skyscraper Example: {"country":"US","expectedResponseTime":"00:30:00","isAvailable":true,"message":"Message","name":"AL","requiredFilingCalendarDataFields":[{"description":"Id Used for Registration","name":"RegistrationId"}],"scraperType":"Login","taxFormCodes":["USAL21009501"]}

swagger:model SkyscraperStatusModel

func (*SkyscraperStatusModel) ContextValidate ¶ 

func (m *SkyscraperStatusModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this skyscraper status model based on the context it is used

func (*SkyscraperStatusModel) MarshalBinary ¶ 

func (m *SkyscraperStatusModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SkyscraperStatusModel) UnmarshalBinary ¶ 

func (m *SkyscraperStatusModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SkyscraperStatusModel) Validate ¶ 

func (m *SkyscraperStatusModel) Validate(formats strfmt.Registry) error

Validate validates this skyscraper status model

type SkyscraperStatusModelFetchResult ¶ 

type SkyscraperStatusModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*SkyscraperStatusModel `json:"value"`
}

SkyscraperStatusModelFetchResult skyscraper status model fetch result

swagger:model SkyscraperStatusModelFetchResult

func (*SkyscraperStatusModelFetchResult) ContextValidate ¶ 

func (m *SkyscraperStatusModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this skyscraper status model fetch result based on the context it is used

func (*SkyscraperStatusModelFetchResult) MarshalBinary ¶ 

func (m *SkyscraperStatusModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SkyscraperStatusModelFetchResult) UnmarshalBinary ¶ 

func (m *SkyscraperStatusModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SkyscraperStatusModelFetchResult) Validate ¶ 

func (m *SkyscraperStatusModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this skyscraper status model fetch result

type StringFetchResult ¶ 

type StringFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []string `json:"value"`
}

StringFetchResult string fetch result

swagger:model StringFetchResult

func (*StringFetchResult) ContextValidate ¶ 

func (m *StringFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this string fetch result based on context it is used

func (*StringFetchResult) MarshalBinary ¶ 

func (m *StringFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StringFetchResult) UnmarshalBinary ¶ 

func (m *StringFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StringFetchResult) Validate ¶ 

func (m *StringFetchResult) Validate(formats strfmt.Registry) error

Validate validates this string fetch result

type SubscriptionModel ¶ 

type SubscriptionModel struct {

	// The unique ID number of the account this subscription belongs to.
	// Example: 123456789
	// Read Only: true
	AccountID int32 `json:"accountId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The date when the subscription began.
	// Example: 2015-01-01T00:00:00
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// If the subscription has ended or will end, this date indicates when the subscription ends.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The unique ID number of this subscription.
	// Example: 12345
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// A friendly description of the service that the account is subscribed to. You can either provide the subscription type Id or this but not both. If
	// subscription type Id is provided, then this information is ignored and this field will be updated with the information from subscription type id.
	// Example: AvaTaxPro
	// Max Length: 25
	// Min Length: 0
	SubscriptionDescription *string `json:"subscriptionDescription,omitempty"`

	// The unique ID number of the service that the account is subscribed to. If this is provided, subscription description is ignored.
	// Example: 2
	SubscriptionTypeID int32 `json:"subscriptionTypeId,omitempty"`
}

SubscriptionModel Represents a service that this account has subscribed to. Example: {"accountId":123456789,"effectiveDate":"2015-01-01","id":12345,"subscriptionDescription":"AvaTaxPro","subscriptionTypeId":2}

swagger:model SubscriptionModel

func (*SubscriptionModel) ContextValidate ¶ 

func (m *SubscriptionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this subscription model based on the context it is used

func (*SubscriptionModel) MarshalBinary ¶ 

func (m *SubscriptionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubscriptionModel) UnmarshalBinary ¶ 

func (m *SubscriptionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubscriptionModel) Validate ¶ 

func (m *SubscriptionModel) Validate(formats strfmt.Registry) error

Validate validates this subscription model

type SubscriptionModelFetchResult ¶ 

type SubscriptionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*SubscriptionModel `json:"value"`
}

SubscriptionModelFetchResult subscription model fetch result

swagger:model SubscriptionModelFetchResult

func (*SubscriptionModelFetchResult) ContextValidate ¶ 

func (m *SubscriptionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this subscription model fetch result based on the context it is used

func (*SubscriptionModelFetchResult) MarshalBinary ¶ 

func (m *SubscriptionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubscriptionModelFetchResult) UnmarshalBinary ¶ 

func (m *SubscriptionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubscriptionModelFetchResult) Validate ¶ 

func (m *SubscriptionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this subscription model fetch result

type SubscriptionTypeModel ¶ 

type SubscriptionTypeModel struct {

	// The friendly name of the service this subscription type represents.
	// Example: AvaTaxPro
	// Required: true
	// Max Length: 255
	// Min Length: 0
	Description *string `json:"description"`

	// The unique ID number of this subscription type.
	// Example: 2
	// Read Only: true
	ID int32 `json:"id,omitempty"`
}

SubscriptionTypeModel Represents a service or a subscription type. Example: {"description":"AvaTaxPro","id":2}

swagger:model SubscriptionTypeModel

func (*SubscriptionTypeModel) ContextValidate ¶ 

func (m *SubscriptionTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this subscription type model based on the context it is used

func (*SubscriptionTypeModel) MarshalBinary ¶ 

func (m *SubscriptionTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubscriptionTypeModel) UnmarshalBinary ¶ 

func (m *SubscriptionTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubscriptionTypeModel) Validate ¶ 

func (m *SubscriptionTypeModel) Validate(formats strfmt.Registry) error

Validate validates this subscription type model

type SubscriptionTypeModelFetchResult ¶ 

type SubscriptionTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*SubscriptionTypeModel `json:"value"`
}

SubscriptionTypeModelFetchResult subscription type model fetch result

swagger:model SubscriptionTypeModelFetchResult

func (*SubscriptionTypeModelFetchResult) ContextValidate ¶ 

func (m *SubscriptionTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this subscription type model fetch result based on the context it is used

func (*SubscriptionTypeModelFetchResult) MarshalBinary ¶ 

func (m *SubscriptionTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubscriptionTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *SubscriptionTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubscriptionTypeModelFetchResult) Validate ¶ 

func (m *SubscriptionTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this subscription type model fetch result

type SyncItemsRequestModel ¶ 

type SyncItemsRequestModel struct {

	// A list of items to sync with AvaTax.
	// Example: [{"description":"Potato Chips","itemCode":"CHIP1041","itemGroup":"Packaged Food","taxCode":"PF051578"}]
	// Required: true
	Items []*ItemSyncModel `json:"items"`
}

SyncItemsRequestModel Represents a request to sync items. Example: {"items":[{"description":"Potato Chips","itemCode":"CHIP1041","itemGroup":"Packaged Food","taxCode":"PF051578"}]}

swagger:model SyncItemsRequestModel

func (*SyncItemsRequestModel) ContextValidate ¶ 

func (m *SyncItemsRequestModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this sync items request model based on the context it is used

func (*SyncItemsRequestModel) MarshalBinary ¶ 

func (m *SyncItemsRequestModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SyncItemsRequestModel) UnmarshalBinary ¶ 

func (m *SyncItemsRequestModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SyncItemsRequestModel) Validate ¶ 

func (m *SyncItemsRequestModel) Validate(formats strfmt.Registry) error

Validate validates this sync items request model

type SyncItemsResponseModel ¶ 

type SyncItemsResponseModel struct {

	// The status of the request
	// Example: Accepted
	Status string `json:"status,omitempty"`
}

SyncItemsResponseModel The response returned after an item sync was requested. Example: {"status":"Accepted"}

swagger:model SyncItemsResponseModel

func (*SyncItemsResponseModel) ContextValidate ¶ 

func (m *SyncItemsResponseModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this sync items response model based on context it is used

func (*SyncItemsResponseModel) MarshalBinary ¶ 

func (m *SyncItemsResponseModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SyncItemsResponseModel) UnmarshalBinary ¶ 

func (m *SyncItemsResponseModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SyncItemsResponseModel) Validate ¶ 

func (m *SyncItemsResponseModel) Validate(formats strfmt.Registry) error

Validate validates this sync items response model

type TagsModel ¶ 

type TagsModel struct {

	// The unique ID number of the tag.
	// Example: 1
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// The tag name.
	// Example: Import_Restricted
	TagName string `json:"tagName,omitempty"`
}

TagsModel Represents a tag for an item in your company's product catalog. Example: {"id":1,"tagName":"Import_Restricted"}

swagger:model TagsModel

func (*TagsModel) ContextValidate ¶ 

func (m *TagsModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tags model based on the context it is used

func (*TagsModel) MarshalBinary ¶ 

func (m *TagsModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TagsModel) UnmarshalBinary ¶ 

func (m *TagsModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TagsModel) Validate ¶ 

func (m *TagsModel) Validate(formats strfmt.Registry) error

Validate validates this tags model

type TagsModelFetchResult ¶ 

type TagsModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TagsModel `json:"value"`
}

TagsModelFetchResult tags model fetch result

swagger:model TagsModelFetchResult

func (*TagsModelFetchResult) ContextValidate ¶ 

func (m *TagsModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tags model fetch result based on the context it is used

func (*TagsModelFetchResult) MarshalBinary ¶ 

func (m *TagsModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TagsModelFetchResult) UnmarshalBinary ¶ 

func (m *TagsModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TagsModelFetchResult) Validate ¶ 

func (m *TagsModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tags model fetch result

type TaxAuthorityFormModel ¶ 

type TaxAuthorityFormModel struct {

	// The form name of the form for this tax authority.
	// Example: CABOE401A2
	// Required: true
	// Max Length: 50
	// Min Length: 0
	FormName *string `json:"formName"`

	// The unique ID number of the tax authority.
	// Example: 69
	// Required: true
	TaxAuthorityID *int32 `json:"taxAuthorityId"`
}

TaxAuthorityFormModel Represents a form that can be filed with a tax authority. Example: {"formName":"CABOE401A2","taxAuthorityId":69}

swagger:model TaxAuthorityFormModel

func (*TaxAuthorityFormModel) ContextValidate ¶ 

func (m *TaxAuthorityFormModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax authority form model based on context it is used

func (*TaxAuthorityFormModel) MarshalBinary ¶ 

func (m *TaxAuthorityFormModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityFormModel) UnmarshalBinary ¶ 

func (m *TaxAuthorityFormModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityFormModel) Validate ¶ 

func (m *TaxAuthorityFormModel) Validate(formats strfmt.Registry) error

Validate validates this tax authority form model

type TaxAuthorityFormModelFetchResult ¶ 

type TaxAuthorityFormModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxAuthorityFormModel `json:"value"`
}

TaxAuthorityFormModelFetchResult tax authority form model fetch result

swagger:model TaxAuthorityFormModelFetchResult

func (*TaxAuthorityFormModelFetchResult) ContextValidate ¶ 

func (m *TaxAuthorityFormModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax authority form model fetch result based on the context it is used

func (*TaxAuthorityFormModelFetchResult) MarshalBinary ¶ 

func (m *TaxAuthorityFormModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityFormModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxAuthorityFormModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityFormModelFetchResult) Validate ¶ 

func (m *TaxAuthorityFormModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax authority form model fetch result

type TaxAuthorityInfo ¶ 

type TaxAuthorityInfo struct {

	// A unique ID number assigned by Avalara to this tax authority.
	// Example: AGAM
	AvalaraID string `json:"avalaraId,omitempty"`

	// The friendly jurisdiction name for this tax authority.
	// Example: CALIFORNIA
	// Required: true
	// Max Length: 128
	// Min Length: 0
	JurisdictionName *string `json:"jurisdictionName"`

	// The type of jurisdiction referenced by this tax authority.
	// Example: Country
	// Enum: [Country State County City Special]
	JurisdictionType string `json:"jurisdictionType,omitempty"`

	// An Avalara-assigned signature code for this tax authority.
	// Example: AGAM
	// Max Length: 4
	// Min Length: 0
	SignatureCode *string `json:"signatureCode,omitempty"`
}

TaxAuthorityInfo Information about a tax authority relevant for an address. Example: {"avalaraId":"AGAM","jurisdictionName":"CALIFORNIA","jurisdictionType":"State","signatureCode":"AGAM"}

swagger:model TaxAuthorityInfo

func (*TaxAuthorityInfo) ContextValidate ¶ 

func (m *TaxAuthorityInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax authority info based on context it is used

func (*TaxAuthorityInfo) MarshalBinary ¶ 

func (m *TaxAuthorityInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityInfo) UnmarshalBinary ¶ 

func (m *TaxAuthorityInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityInfo) Validate ¶ 

func (m *TaxAuthorityInfo) Validate(formats strfmt.Registry) error

Validate validates this tax authority info

type TaxAuthorityModel ¶ 

type TaxAuthorityModel struct {

	// The unique ID number of this tax authority.
	// Example: 12345
	// Required: true
	ID *int32 `json:"id"`

	// The unique ID number of the jurisdiction for this tax authority.
	// Example: 12345
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// The friendly name of this tax authority.
	// Example: COLORADO
	// Required: true
	// Max Length: 128
	// Min Length: 0
	Name *string `json:"name"`

	// The type of this tax authority.
	// Example: 45
	TaxAuthorityTypeID int32 `json:"taxAuthorityTypeId,omitempty"`
}

TaxAuthorityModel Tax Authority Model Example: {"id":12345,"jurisdictionId":12345,"name":"COLORADO","taxAuthorityTypeId":45}

swagger:model TaxAuthorityModel

func (*TaxAuthorityModel) ContextValidate ¶ 

func (m *TaxAuthorityModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax authority model based on context it is used

func (*TaxAuthorityModel) MarshalBinary ¶ 

func (m *TaxAuthorityModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityModel) UnmarshalBinary ¶ 

func (m *TaxAuthorityModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityModel) Validate ¶ 

func (m *TaxAuthorityModel) Validate(formats strfmt.Registry) error

Validate validates this tax authority model

type TaxAuthorityModelFetchResult ¶ 

type TaxAuthorityModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxAuthorityModel `json:"value"`
}

TaxAuthorityModelFetchResult tax authority model fetch result

swagger:model TaxAuthorityModelFetchResult

func (*TaxAuthorityModelFetchResult) ContextValidate ¶ 

func (m *TaxAuthorityModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax authority model fetch result based on the context it is used

func (*TaxAuthorityModelFetchResult) MarshalBinary ¶ 

func (m *TaxAuthorityModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxAuthorityModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityModelFetchResult) Validate ¶ 

func (m *TaxAuthorityModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax authority model fetch result

type TaxAuthorityTypeModel ¶ 

type TaxAuthorityTypeModel struct {

	// The description name of this tax authority type.
	// Example: County
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax Authority customer type.
	// Example: 0
	// Required: true
	ID *int32 `json:"id"`

	// Tax Authority Group
	// Example: LocalCounty
	TaxAuthorityGroup string `json:"taxAuthorityGroup,omitempty"`
}

TaxAuthorityTypeModel Tax Authority Type Model Example: {"description":"County","id":0,"taxAuthorityGroup":"LocalCounty"}

swagger:model TaxAuthorityTypeModel

func (*TaxAuthorityTypeModel) ContextValidate ¶ 

func (m *TaxAuthorityTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax authority type model based on context it is used

func (*TaxAuthorityTypeModel) MarshalBinary ¶ 

func (m *TaxAuthorityTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityTypeModel) UnmarshalBinary ¶ 

func (m *TaxAuthorityTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityTypeModel) Validate ¶ 

func (m *TaxAuthorityTypeModel) Validate(formats strfmt.Registry) error

Validate validates this tax authority type model

type TaxAuthorityTypeModelFetchResult ¶ 

type TaxAuthorityTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxAuthorityTypeModel `json:"value"`
}

TaxAuthorityTypeModelFetchResult tax authority type model fetch result

swagger:model TaxAuthorityTypeModelFetchResult

func (*TaxAuthorityTypeModelFetchResult) ContextValidate ¶ 

func (m *TaxAuthorityTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax authority type model fetch result based on the context it is used

func (*TaxAuthorityTypeModelFetchResult) MarshalBinary ¶ 

func (m *TaxAuthorityTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxAuthorityTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxAuthorityTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxAuthorityTypeModelFetchResult) Validate ¶ 

func (m *TaxAuthorityTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax authority type model fetch result

type TaxCodeModel ¶ 

type TaxCodeModel struct {

	// The unique ID number of the company that owns this tax code.
	// Example: 12345
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// A friendly description of this tax code.
	// Example: Yarn
	// Max Length: 255
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// The Avalara Entity Use Code represented by this tax code.
	// Max Length: 40
	// Min Length: 0
	EntityUseCode *string `json:"entityUseCode,omitempty"`

	// The Avalara Goods and Service Code represented by this tax code.
	// Example: 0
	GoodsServiceCode int64 `json:"goodsServiceCode,omitempty"`

	// The unique ID number of this tax code.
	// Example: 56789
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// True if this tax code is active and can be used in transactions.
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// True if this tax code type refers to a physical object.  Read only field.
	// Example: true
	// Read Only: true
	IsPhysical *bool `json:"isPhysical,omitempty"`

	// True if this tax code has been certified by the Streamlined Sales Tax governing board.
	// By default, you should leave this value empty.
	// Example: false
	IsSSTCertified bool `json:"isSSTCertified,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// If this tax code is a subset of a different tax code, this identifies the parent code.
	// Example: PS080100
	// Max Length: 25
	// Min Length: 0
	ParentTaxCode *string `json:"parentTaxCode,omitempty"`

	// A code string that identifies this tax code.
	// Example: PS081282
	// Required: true
	// Max Length: 25
	// Min Length: 0
	TaxCode *string `json:"taxCode"`

	// The type of this tax code.
	// Example: P
	// Required: true
	// Max Length: 2
	// Min Length: 0
	TaxCodeTypeID *string `json:"taxCodeTypeId"`
}

TaxCodeModel Represents a tax code that can be applied to items on a transaction. A tax code can have specific rules for specific jurisdictions that change the tax calculation behavior. Example: {"companyId":12345,"description":"Yarn","entityUseCode":"","goodsServiceCode":0,"id":56789,"isActive":true,"isPhysical":true,"isSSTCertified":false,"parentTaxCode":"PS080100","taxCode":"PS081282","taxCodeTypeId":"P"}

swagger:model TaxCodeModel

func (*TaxCodeModel) ContextValidate ¶ 

func (m *TaxCodeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax code model based on the context it is used

func (*TaxCodeModel) MarshalBinary ¶ 

func (m *TaxCodeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxCodeModel) UnmarshalBinary ¶ 

func (m *TaxCodeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxCodeModel) Validate ¶ 

func (m *TaxCodeModel) Validate(formats strfmt.Registry) error

Validate validates this tax code model

type TaxCodeModelFetchResult ¶ 

type TaxCodeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxCodeModel `json:"value"`
}

TaxCodeModelFetchResult tax code model fetch result

swagger:model TaxCodeModelFetchResult

func (*TaxCodeModelFetchResult) ContextValidate ¶ 

func (m *TaxCodeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax code model fetch result based on the context it is used

func (*TaxCodeModelFetchResult) MarshalBinary ¶ 

func (m *TaxCodeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxCodeModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxCodeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxCodeModelFetchResult) Validate ¶ 

func (m *TaxCodeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax code model fetch result

type TaxCodeTypesModel ¶ 

type TaxCodeTypesModel struct {

	// The list of Avalara-defined tax code types.
	// Example: {"D":"Digital","F":"Freight","O":"Other","P":"Product","S":"Service","U":"Unknown"}
	Types map[string]string `json:"types,omitempty"`
}

TaxCodeTypesModel Information about Avalara-defined tax code types. This list is used when creating tax codes and tax rules. Example: {"types":{"D":"Digital","F":"Freight","O":"Other","P":"Product","S":"Service","U":"Unknown"}}

swagger:model TaxCodeTypesModel

func (*TaxCodeTypesModel) ContextValidate ¶ 

func (m *TaxCodeTypesModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax code types model based on context it is used

func (*TaxCodeTypesModel) MarshalBinary ¶ 

func (m *TaxCodeTypesModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxCodeTypesModel) UnmarshalBinary ¶ 

func (m *TaxCodeTypesModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxCodeTypesModel) Validate ¶ 

func (m *TaxCodeTypesModel) Validate(formats strfmt.Registry) error

Validate validates this tax code types model

type TaxDetailsByTaxSubType ¶ 

type TaxDetailsByTaxSubType struct {

	// Tax subtype
	// Example: S
	TaxSubType string `json:"taxSubType,omitempty"`

	// Total exempt by tax type
	// Example: 0.05
	TotalExempt float64 `json:"totalExempt,omitempty"`

	// Total non taxable by tax type
	// Example: 0
	TotalNonTaxable float64 `json:"totalNonTaxable,omitempty"`

	// Total tax by tax type
	// Example: 0.625
	TotalTax float64 `json:"totalTax,omitempty"`

	// Total taxable amount by tax type
	// Example: 100
	TotalTaxable float64 `json:"totalTaxable,omitempty"`
}

TaxDetailsByTaxSubType Tax Details by Tax subtype Example: {"taxSubType":"S","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}

swagger:model TaxDetailsByTaxSubType

func (*TaxDetailsByTaxSubType) ContextValidate ¶ 

func (m *TaxDetailsByTaxSubType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax details by tax sub type based on context it is used

func (*TaxDetailsByTaxSubType) MarshalBinary ¶ 

func (m *TaxDetailsByTaxSubType) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxDetailsByTaxSubType) UnmarshalBinary ¶ 

func (m *TaxDetailsByTaxSubType) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxDetailsByTaxSubType) Validate ¶ 

func (m *TaxDetailsByTaxSubType) Validate(formats strfmt.Registry) error

Validate validates this tax details by tax sub type

type TaxDetailsByTaxType ¶ 

type TaxDetailsByTaxType struct {

	// Tax subtype details
	TaxSubTypeDetails []*TaxDetailsByTaxSubType `json:"taxSubTypeDetails"`

	// Tax Type
	// Example: SalesAndUse
	TaxType string `json:"taxType,omitempty"`

	// Total exempt by tax type
	// Example: 0.05
	TotalExempt float64 `json:"totalExempt,omitempty"`

	// Total non taxable by tax type
	// Example: 0
	TotalNonTaxable float64 `json:"totalNonTaxable,omitempty"`

	// Total tax by tax type
	// Example: 0.625
	TotalTax float64 `json:"totalTax,omitempty"`

	// Total taxable amount by tax type
	// Example: 100
	TotalTaxable float64 `json:"totalTaxable,omitempty"`
}

TaxDetailsByTaxType Tax Details by Tax Type Example: {"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}

swagger:model TaxDetailsByTaxType

func (*TaxDetailsByTaxType) ContextValidate ¶ 

func (m *TaxDetailsByTaxType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax details by tax type based on the context it is used

func (*TaxDetailsByTaxType) MarshalBinary ¶ 

func (m *TaxDetailsByTaxType) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxDetailsByTaxType) UnmarshalBinary ¶ 

func (m *TaxDetailsByTaxType) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxDetailsByTaxType) Validate ¶ 

func (m *TaxDetailsByTaxType) Validate(formats strfmt.Registry) error

Validate validates this tax details by tax type

type 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"`
}

TaxOverrideModel Represents a tax override for a transaction Example: {"reason":"Precalculated Tax","taxAmount":6.25,"taxDate":"2021-12-25","type":"TaxAmount"}

swagger:model TaxOverrideModel

func (*TaxOverrideModel) ContextValidate ¶ 

func (m *TaxOverrideModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax override model based on the context it is used

func (*TaxOverrideModel) MarshalBinary ¶ 

func (m *TaxOverrideModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxOverrideModel) UnmarshalBinary ¶ 

func (m *TaxOverrideModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxOverrideModel) Validate ¶ 

func (m *TaxOverrideModel) Validate(formats strfmt.Registry) error

Validate validates this tax override model

type TaxRateModel ¶ 

type TaxRateModel struct {

	// The list of individual rate elements for general tangible personal property sold at a retail
	// point of presence in this jurisdiction on this date.
	// Example: [{"name":"CALIFORNIA","rate":0.0625,"type":"State"}]
	Rates []*RateModel `json:"rates"`

	// The total sales tax rate for general tangible personal property sold at a retail point of presence
	// in this jurisdiction on this date.
	// Example: 0.0625
	TotalRate float64 `json:"totalRate,omitempty"`
}

TaxRateModel Contains information about the general tangible personal property sales tax rates for this jurisdiction.

This rate is calculated by making assumptions about the tax calculation process. It does not account for:

* Sourcing rules, such as origin-and-destination based transactions. * Product taxability rules, such as different tax rates for different product types. * Nexus declarations, where some customers are not obligated to collect tax in specific jurisdictions. * Tax thresholds and rate differences by amounts. * And many more custom use cases.

To upgrade to a fully-featured and accurate tax process that handles these scenarios correctly, please contact Avalara to upgrade to AvaTax! Example: {"rates":[{"name":"CALIFORNIA","rate":0.0625,"type":"State"}],"totalRate":0.0625}

swagger:model TaxRateModel

func (*TaxRateModel) ContextValidate ¶ 

func (m *TaxRateModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax rate model based on the context it is used

func (*TaxRateModel) MarshalBinary ¶ 

func (m *TaxRateModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxRateModel) UnmarshalBinary ¶ 

func (m *TaxRateModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxRateModel) Validate ¶ 

func (m *TaxRateModel) Validate(formats strfmt.Registry) error

Validate validates this tax rate model

type TaxRegionJurisdictionModel ¶ 

type TaxRegionJurisdictionModel struct {

	// The date in which this tax region jurisdiction starts to take effect.
	// Example: 1900-01-01T00:00:00
	// Read Only: true
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The date in which this tax region jurisdiction stops to take effect.
	// Example: 2011-04-30T00:00:00
	// Read Only: true
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The id of the jurisdiction.
	// Example: 1
	// Read Only: true
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// The id of the jurisdiction level.
	// Read Only: true
	JurisdictionLevelID int32 `json:"jurisdictionLevelId,omitempty"`

	// The report level.
	// Example: 1
	// Read Only: true
	ReportLevel int32 `json:"reportLevel,omitempty"`

	// The rock name.
	// Read Only: true
	RockName string `json:"rockName,omitempty"`

	// The signature code.
	// Example: AAKB
	// Read Only: true
	SignatureCode string `json:"signatureCode,omitempty"`

	// The state assigned code.
	// Read Only: true
	StateAssignedCode string `json:"stateAssignedCode,omitempty"`

	// The id of the tax authority.
	// Example: 271
	// Read Only: true
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The id of the tax region.
	// Example: 4556
	// Read Only: true
	TaxRegionID int32 `json:"taxRegionId,omitempty"`
}

TaxRegionJurisdictionModel The tax region jurisdiction model. Example: {"effectiveDate":"1900-01-01","endDate":"2011-04-30","jurisdictionId":1,"reportLevel":1,"signatureCode":"AAKB","taxAuthorityId":271,"taxRegionId":4556}

swagger:model TaxRegionJurisdictionModel

func (*TaxRegionJurisdictionModel) ContextValidate ¶ 

func (m *TaxRegionJurisdictionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax region jurisdiction model based on the context it is used

func (*TaxRegionJurisdictionModel) MarshalBinary ¶ 

func (m *TaxRegionJurisdictionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxRegionJurisdictionModel) UnmarshalBinary ¶ 

func (m *TaxRegionJurisdictionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxRegionJurisdictionModel) Validate ¶ 

func (m *TaxRegionJurisdictionModel) Validate(formats strfmt.Registry) error

Validate validates this tax region jurisdiction model

type TaxRegionModel ¶ 

type TaxRegionModel struct {

	// The name of the city.
	// Read Only: true
	City string `json:"city,omitempty"`

	// The code of the tax region.
	// Example: 2000000000
	// Read Only: true
	Code string `json:"code,omitempty"`

	// Name or ISO 3166 code identifying the country of this jurisdiction.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// The name of the county.
	// Read Only: true
	County string `json:"county,omitempty"`

	// The date this tax region starts to take effect.
	// Example: 1900-01-01T00:00:00
	// Read Only: true
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The date this tax region stops to take effect.
	// Example: 2013-11-30T00:00:00
	// Read Only: true
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The id of the tax region.
	// Example: 120
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// Is Acm flag.
	// Example: false
	// Read Only: true
	IsAcm *bool `json:"isAcm,omitempty"`

	// Is SST flag.
	// Example: false
	// Read Only: true
	IsSst *bool `json:"isSst,omitempty"`

	// List of jurisdictions associated with this tax region.
	// Example: [{"effectiveDate":"1900-01-01T00:00:00","endDate":"2013-11-30T00:00:00","isAcm":true,"isSst":true,"jurisCode":"20","jurisName":"KANSAS","jurisType":"State","jurisdictionId":20,"taxAuthorityId":280}]
	Jurisdictions []*DenormalizedJurisModel `json:"jurisdictions"`

	// The name of the tax region.
	// Example: KANSAS
	// Read Only: true
	Name string `json:"name,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: KS
	// Read Only: true
	Region string `json:"region,omitempty"`

	// The ser code.
	// Read Only: true
	SerCode string `json:"serCode,omitempty"`

	// The tax region signature code.
	// Example: AUIO
	// Read Only: true
	SignatureCode string `json:"signatureCode,omitempty"`
}

TaxRegionModel The tax region model. Example: {"code":"2000000000","country":"US","effectiveDate":"1900-01-01","endDate":"2013-11-30","id":120,"isAcm":false,"isSst":false,"jurisdictions":[{"effectiveDate":"1900-01-01T00:00:00","endDate":"2013-11-30T00:00:00","isAcm":true,"isSst":true,"jurisCode":"20","jurisName":"KANSAS","jurisType":"State","jurisdictionId":20,"taxAuthorityId":280}],"name":"KANSAS","region":"KS","signatureCode":"AUIO"}

swagger:model TaxRegionModel

func (*TaxRegionModel) ContextValidate ¶ 

func (m *TaxRegionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax region model based on the context it is used

func (*TaxRegionModel) MarshalBinary ¶ 

func (m *TaxRegionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxRegionModel) UnmarshalBinary ¶ 

func (m *TaxRegionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxRegionModel) Validate ¶ 

func (m *TaxRegionModel) Validate(formats strfmt.Registry) error

Validate validates this tax region model

type TaxRuleModel ¶ 

type TaxRuleModel struct {

	// The maximum cap for the price of this item according to this rule.  Any amount above this cap will not be subject to this rule.
	//
	// For example, if you must pay 5% of a product's value up to a maximum value of $1000, you would set the `cap` to `1000.00` and the `value` to `0.05`.
	// Example: 0
	Cap float64 `json:"cap,omitempty"`

	// The unique ID number of the company that owns this tax rule.
	// Example: 12345
	CompanyID int32 `json:"companyId,omitempty"`

	// Name or ISO 3166 code identifying the country where this rule will apply.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	// Required: true
	Country *string `json:"country"`

	// For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code.
	//
	// This field is required for rules that apply to specific jurisdictions in the United States.  It is not required
	// if you set the `isAllJuris` flag to true.
	// Example: 013
	// Max Length: 3
	// Min Length: 0
	CountyFIPS *string `json:"countyFIPS,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// The currency code to use for this rule.
	//
	// For a list of currencies supported by AvaTax, use the [ListCurrencies API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCurrencies/).
	// Max Length: 3
	// Min Length: 0
	CurrencyCode *string `json:"currencyCode,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
	//
	// Max Length: 25
	// Min Length: 0
	CustomerUsageType *string `json:"customerUsageType,omitempty"`

	// A friendly name for this tax rule.
	// Example: Freight
	// Max Length: 255
	// Min Length: 0
	Description *string `json:"description,omitempty"`

	// The first date at which this rule applies.  If `null`, this rule will apply to all dates prior to the end date.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// The last date for which this rule applies.  If `null`, this rule will apply to all dates after the effective date.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The entity use code to which this rule applies.
	//
	// You can create custom `entityUseCode` values with specific behavior using this API, or you can change
	// the behavior of Avalara's system-defined entity use codes.
	//
	// For a full list of Avalara-defined entity use codes, see the [ListEntityUseCodes API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/).
	// Max Length: 25
	// Min Length: 0
	EntityUseCode *string `json:"entityUseCode,omitempty"`

	// The unique ID number of this tax rule.
	// Example: 56789
	// Required: true
	ID *int32 `json:"id"`

	// Allows you to make tax rules apply to lower jurisdictions.  This feature is only available in the United States and Canada.
	//
	// * In the United States, this value can be used for rules written at the `State` jurisdictional level.  If set to `true`, this rule will at the state level, county level, city level, and special jurisdiction level.
	// * In Canada, this value can be used for rules written at the `Country` or `State` jurisdictional levels.  If set to `true`, this rule will at all lower jurisdictional levels.
	//
	// For any other use case, this value must be `false`.
	// Example: false
	IsAllJuris bool `json:"isAllJuris,omitempty"`

	// DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: This field is no longer required.
	//
	IsSTPro bool `json:"isSTPro,omitempty"`

	// The code of the jurisdiction to which this tax rule applies.
	//
	// Custom tax rules can apply to a specific jurisdiction or to all jurisdictions.  To select a jurisdiction, use the
	// [ListJurisdictions API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictions/)
	// or the [ListJurisdictionsByAddress API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictionsByAddress/).
	//
	// Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the `jurisName`, `jurisCode`, and
	// `jurisdictionTypeId` fields using the information you retrieved from the API above.
	// Example: 013
	// Required: true
	// Max Length: 10
	// Min Length: 0
	JurisCode *string `json:"jurisCode"`

	// The name of the jurisdiction to which this tax rule applies.
	//
	// Custom tax rules can apply to a specific jurisdiction or to all jurisdictions.  To select a jurisdiction, use the
	// [ListJurisdictions API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictions/)
	// or the [ListJurisdictionsByAddress API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictionsByAddress/).
	// To set a rule that applies to all jurisdictions of a specific type, see `isAllJuris`.
	//
	// Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the `jurisName`, `jurisCode`, and
	// `jurisdictionTypeId` fields using the information you retrieved from the API above.
	// Example: MARICOPA
	// Max Length: 200
	// Min Length: 0
	JurisName *string `json:"jurisName,omitempty"`

	// DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use `jurisdictionTypeId` instead.
	//
	// Example: STA
	// Enum: [STA CTY CIT STJ CNT]
	JurisTypeID string `json:"jurisTypeId,omitempty"`

	// The type of the jurisdiction to which this tax rule applies.
	//
	// Custom tax rules can apply to a specific jurisdiction or to all jurisdictions.  To select a jurisdiction, use the
	// [ListJurisdictions API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictions/)
	// or the [ListJurisdictionsByAddress API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictionsByAddress/).
	//
	// Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the `jurisName`, `jurisCode`, and
	// `jurisdictionTypeId` fields using the information you retrieved from the API above.
	//
	// To make a custom tax rule for US or Canada that applies to all jurisdictions of a specific type, see the `isAllJuris`
	// field for more information.
	// Example: Country
	// Enum: [Country State County City Special]
	JurisdictionTypeID string `json:"jurisdictionTypeId,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// Reserved for Avalara internal usage.  Leave this field null.
	// Max Length: 500
	// Min Length: 0
	NonPassthroughExpression *string `json:"nonPassthroughExpression,omitempty"`

	// Supports custom options for your tax rule.
	//
	// Supported options include:
	// * `TaxAll` - This value indicates that the entire amount of the line becomes taxable when the line amount exceeds the `threshold`.
	// Max Length: 100
	// Min Length: 0
	Options *string `json:"options,omitempty"`

	// Reserved for Avalara internal usage.  Leave this field null.
	PreferredProgramID int32 `json:"preferredProgramId,omitempty"`

	// Indicates the code of the rate type that applies to this rule.  Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes.
	//
	// If you specify a value in the rateTypeCode field, this rule will cause tax lines that are affected by the rule
	// to change to a different rate type code.
	RateTypeCode string `json:"rateTypeCode,omitempty"`

	// DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: Please use `rateTypeCode`, `taxTypeGroup` and `subTaxType` instead.
	//
	// Example: ReducedA
	// Enum: [ReducedA ReducedB Food General IncreasedStandard LinenRental Medical Construction Parking SuperReduced ReducedR Standard Leasing LeasingLow Services Zero]
	RateTypeID string `json:"rateTypeId,omitempty"`

	// Name or ISO 3166 code identifying the region where this rule will apply.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// NOTE: Region is required for US and not required for non-US countries because the user may be either creating a Country-level or Region-level rule.
	// Example: AZ
	Region string `json:"region,omitempty"`

	// The sourcing types to which this rule applies.
	// Example: Mixed
	// Enum: [Mixed Destination Origin]
	Sourcing string `json:"sourcing,omitempty"`

	// For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code.
	//
	// This field is required for rules that apply to specific jurisdictions in the United States.  It is not required
	// if you set the `isAllJuris` flag to true.
	// Example: 04
	// Max Length: 2
	// Min Length: 0
	StateFIPS *string `json:"stateFIPS,omitempty"`

	// For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.
	//
	// You can choose to specify a tax code either by passing its unique ID number in the `taxCodeId` field or
	// by passing its alphanumeric code in the `taxCode` field.  To search for the appropriate tax code for your
	// custom rule, use the `ListTaxCodes` API.
	//
	// The `RateOverrideRule`, `BaseRule`, and `ExemptEntityRule` rule types can be applied to all tax codes.  To
	// make a rule that applies to all tax codes, leave both fields blank.
	//
	// The `ProductTaxabilityRule` rule must be associated with a tax code.  If you attempt to create a product taxability rule
	// without a tax code, you will get an error message.
	// Example: FR020800
	// Max Length: 25
	// Min Length: 0
	TaxCode *string `json:"taxCode,omitempty"`

	// For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.
	//
	// You can choose to specify a tax code either by passing its unique ID number in the `taxCodeId` field or
	// by passing its alphanumeric code in the `taxCode` field.  To search for the appropriate tax code for your
	// custom rule, use the `ListTaxCodes` API.
	//
	// The `RateOverrideRule`, `BaseRule`, and `ExemptEntityRule` rule types can be applied to all tax codes.  To
	// make a rule that applies to all tax codes, leave both fields blank.
	//
	// The `ProductTaxabilityRule` rule must be associated with a tax code.  If you attempt to create a product taxability rule
	// without a tax code, you will get an error message.
	TaxCodeID int32 `json:"taxCodeId,omitempty"`

	// TaxRule Product Detail indicates the HSCode(s) to which the tax rule applies.
	TaxRuleProductDetail []*TaxRuleProductDetailModel `json:"taxRuleProductDetail"`

	// This type value determines the behavior of the tax rule.
	//
	// You can specify that this rule controls the product's taxability or exempt / nontaxable status, the product's rate
	// (for example, if you have been granted an official ruling for your product's rate that differs from the official rate),
	// or other types of behavior.
	// Example: RateRule
	// Required: true
	// Enum: [RateRule RateOverrideRule BaseRule ExemptEntityRule ProductTaxabilityRule NexusRule RateCapRule TaxOverrideRule FeeRule OtherRule]
	TaxRuleTypeID *string `json:"taxRuleTypeId"`

	// This field has different behavior based on the type of rule.
	//
	// * For a product taxability rule, if the rule applies to an item, this value will override the tax sub type of the original product.
	// * For other rules, this value determines what tax sub types will be affected by the rule.
	//
	// Refer to `ListTaxSubtypes` for a list of tax sub types supported by AvaTax.
	// Example: ALL
	TaxSubType string `json:"taxSubType,omitempty"`

	// Indicates the code of the tax type that applies to this rule. Use /api/v2/definitions/taxtypes endpoint to retrieve the list of tax types applicable for your company.
	// Example: ALL
	TaxTypeCode string `json:"taxTypeCode,omitempty"`

	// This field has different behavior based on the type of rule.
	//
	// * For a product taxability rule, if the rule applies to an item, this value will override the tax type group of the original product.
	// * For other rules, this value determines what tax type groups will be affected by the rule.
	//
	// Refer to `ListTaxTypeGroups` for a list of tax type groups supported by AvaTax.
	// Example: SalesAndUse
	TaxTypeGroup string `json:"taxTypeGroup,omitempty"`

	// DEPRECATED - Date: 09/30/2021, Version: 21.9.0, Message: Please use `taxTypeCode` instead.
	// Some tax type groups contain multiple different types of tax.  To create a rule that affects only one
	// type of tax within a tax type group, set this value to the code matching the specific tax type within
	// that group.  The custom tax rule will then only apply to taxes calculated for that specific type.
	//
	// For rules that affect all tax types, use the value `A` to match `All` tax types within that group.
	// Example: E
	// Enum: [E Lodging Bottle RentToOwn BikeTax LandedCost CheckoutBag Alcohol Amusement Hospitality RentalLeasing GrossReceipts Mattress Lumber Paint Tires EI All BothSalesAndUseTax ConsumerUseTax ConsumersUseAndSellersUseTax ConsumerUseAndSalesTax Fee VATInputTax LightBulbs Meals VATNonrecoverableInputTax VATOutputTax PIF Rental SalesTax UseTax EWaste Batteries]
	TaxTypeID string `json:"taxTypeId,omitempty"`

	// The per-unit threshold that must be met before this rule applies.
	//
	// For example, if your product is nontaxable unless it is above $100 per product, you would set the `threshold` value to `100`.  In this case, the rate
	// for the rule would apply to the entire amount above $100.
	//
	// You can also create rules that make the entire product taxable if it exceeds a threshold, but is nontaxable
	// if it is below the threshold.  To choose this, set the `options` field to the value `TaxAll`.
	// Example: 0
	Threshold float64 `json:"threshold,omitempty"`

	// The UnitOfBasis for the TaxRule
	UnitOfBasis string `json:"unitOfBasis,omitempty"`

	// For tax rules that are calculated using units of measurement, this indicates the unit of measurement type
	// used to calculate the amounts for this rule.
	//
	// For a list of units of measurement, use the [ListUnitsOfMeasurement API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListUnitOfMeasurement/).
	UomID int32 `json:"uomId,omitempty"`

	// This field has different behavior based on the type of the tax rule.
	//
	// * For a product taxability rule, this value is either 1 or 0, indicating taxable or non-taxable.
	// * For a rate override rule, this value is the corrected rate stored as a decimal, for example, a rate of 5% would be stored as 0.05 decimal.  If you use the special value of 1.0, only the cap and threshold values will be applied and the rate will be left alone.
	// Example: 0
	Value float64 `json:"value,omitempty"`
}

TaxRuleModel Represents a tax rule that changes the behavior of Avalara's tax engine for certain products and/or entity use codes in certain jurisdictions.

Avalara supports a few different types of tax rules. For information about tax rule types, see [TaxRuleTypeId](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/TaxRuleTypeId/)

Because different types of tax rules have different behavior, some fields may change their behavior based on the type of tax rule selected. Please read the documentation for each field carefully and ensure that the value you send is appropriate for the type of tax rule. Example: {"cap":0,"companyId":12345,"country":"US","countyFIPS":"013","description":"Freight","effectiveDate":"2021-12-25","id":56789,"isAllJuris":false,"jurisCode":"013","jurisName":"MARICOPA","jurisTypeId":0,"jurisdictionTypeId":"County","region":"AZ","stateFIPS":"04","taxCode":"FR020800","taxRuleTypeId":"ProductTaxabilityRule","taxSubType":"ALL","taxTypeCode":"ALL","taxTypeGroup":"SalesAndUse","taxTypeId":"BothSalesAndUseTax","threshold":0,"value":0}

swagger:model TaxRuleModel

func (*TaxRuleModel) ContextValidate ¶ 

func (m *TaxRuleModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax rule model based on the context it is used

func (*TaxRuleModel) MarshalBinary ¶ 

func (m *TaxRuleModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxRuleModel) UnmarshalBinary ¶ 

func (m *TaxRuleModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxRuleModel) Validate ¶ 

func (m *TaxRuleModel) Validate(formats strfmt.Registry) error

Validate validates this tax rule model

type TaxRuleModelFetchResult ¶ 

type TaxRuleModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxRuleModel `json:"value"`
}

TaxRuleModelFetchResult tax rule model fetch result

swagger:model TaxRuleModelFetchResult

func (*TaxRuleModelFetchResult) ContextValidate ¶ 

func (m *TaxRuleModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax rule model fetch result based on the context it is used

func (*TaxRuleModelFetchResult) MarshalBinary ¶ 

func (m *TaxRuleModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxRuleModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxRuleModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxRuleModelFetchResult) Validate ¶ 

func (m *TaxRuleModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax rule model fetch result

type TaxRuleProductDetailModel ¶ 

type TaxRuleProductDetailModel struct {

	// The first date at which this product detail applies.  If `null`, this product detail will apply to all dates prior to the end date.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	EffectiveDate strfmt.DateTime `json:"effectiveDate,omitempty"`

	// The last date for which this product detail applies.  If `null`, this product detail will apply to all dates after the effective date.
	// Example: 2022-12-25T00:00:00+00:00
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// Product Code value
	// Example: 220720
	ProductCode string `json:"productCode,omitempty"`

	// Represents the system Id the detail is applicable for.
	// Example: 28
	SystemID int32 `json:"systemId,omitempty"`

	// TaxRule Id of TaxRule Product Detail entry
	// Example: 123
	TaxRuleID int32 `json:"taxRuleId,omitempty"`

	// The unique ID number of this Tax rule product detail.
	// Example: 1
	TaxRuleProductDetailID int32 `json:"taxRuleProductDetailId,omitempty"`
}

TaxRuleProductDetailModel Represents a tax rule product detail that changes the behavior of Avalara's tax engine for certain tax rules.

Avalara supports a two types of tax product detail. For information about tax rule Product Types HSCode and TaxCode

Because different types of tax rules have different behavior, some fields may change their behavior based on the type of tax rule selected. Please read the documentation for each field carefully and ensure that the value you send is appropriate for the type of tax rule. Example: {"effectiveDate":"2021-12-25T00:00:00+00:00","endDate":"2022-12-25T00:00:00+00:00","productCode":"220720","systemId":28,"taxRuleId":123,"taxRuleProductDetailId":1}

swagger:model TaxRuleProductDetailModel

func (*TaxRuleProductDetailModel) ContextValidate ¶ 

func (m *TaxRuleProductDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax rule product detail model based on context it is used

func (*TaxRuleProductDetailModel) MarshalBinary ¶ 

func (m *TaxRuleProductDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxRuleProductDetailModel) UnmarshalBinary ¶ 

func (m *TaxRuleProductDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxRuleProductDetailModel) Validate ¶ 

func (m *TaxRuleProductDetailModel) Validate(formats strfmt.Registry) error

Validate validates this tax rule product detail model

type TaxSubTypeModel ¶ 

type TaxSubTypeModel struct {

	// The description of this tax sub-type.
	// Example: ALL
	// Required: true
	Description *string `json:"description"`

	// The unique ID number of this tax sub-type.
	// Example: 1
	// Required: true
	ID *int32 `json:"id"`

	// The unique human readable Id of this tax sub-type.
	// Example: *
	// Required: true
	TaxSubType *string `json:"taxSubType"`

	// The upper level group of tax types.
	// Required: true
	TaxTypeGroup *string `json:"taxTypeGroup"`
}

TaxSubTypeModel Represents a tax subtype Example: {"description":"ALL","id":1,"taxSubType":"*"}

swagger:model TaxSubTypeModel

func (*TaxSubTypeModel) ContextValidate ¶ 

func (m *TaxSubTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax sub type model based on context it is used

func (*TaxSubTypeModel) MarshalBinary ¶ 

func (m *TaxSubTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxSubTypeModel) UnmarshalBinary ¶ 

func (m *TaxSubTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxSubTypeModel) Validate ¶ 

func (m *TaxSubTypeModel) Validate(formats strfmt.Registry) error

Validate validates this tax sub type model

type TaxSubTypeModelFetchResult ¶ 

type TaxSubTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxSubTypeModel `json:"value"`
}

TaxSubTypeModelFetchResult tax sub type model fetch result

swagger:model TaxSubTypeModelFetchResult

func (*TaxSubTypeModelFetchResult) ContextValidate ¶ 

func (m *TaxSubTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax sub type model fetch result based on the context it is used

func (*TaxSubTypeModelFetchResult) MarshalBinary ¶ 

func (m *TaxSubTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxSubTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxSubTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxSubTypeModelFetchResult) Validate ¶ 

func (m *TaxSubTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax sub type model fetch result

type TaxTypeGroupModel ¶ 

type TaxTypeGroupModel struct {

	// The description of this tax type group.
	// Example: Sales and Use
	Description string `json:"description,omitempty"`

	// The order this record is being returned in the response
	// Example: 0
	DisplaySequence int32 `json:"displaySequence,omitempty"`

	// The unique ID number of this tax type group.
	// Example: 1
	ID int32 `json:"id,omitempty"`

	// True if this tax type group is displayed in the user interface of the AvaTax website.
	ShowColumn bool `json:"showColumn,omitempty"`

	// If this tax type group requires a subscription, this contains the friendly name of the subscription type required to use it.
	SubscriptionDescription string `json:"subscriptionDescription,omitempty"`

	// If this tax type group requires a subscription, this contains the ID number of the subscription type required to use it.
	SubscriptionTypeID int32 `json:"subscriptionTypeId,omitempty"`

	// The name of the tab in the AvaTax website corresponding to this tax type group.
	TabName string `json:"tabName,omitempty"`

	// The unique human readable Id of this tax type group.
	// Example: SalesAndUse
	TaxTypeGroup string `json:"taxTypeGroup,omitempty"`
}

TaxTypeGroupModel Represents a tax type group Example: {"description":"Sales and Use","displaySequence":0,"id":1,"taxTypeGroup":"SalesAndUse"}

swagger:model TaxTypeGroupModel

func (*TaxTypeGroupModel) ContextValidate ¶ 

func (m *TaxTypeGroupModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax type group model based on context it is used

func (*TaxTypeGroupModel) MarshalBinary ¶ 

func (m *TaxTypeGroupModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxTypeGroupModel) UnmarshalBinary ¶ 

func (m *TaxTypeGroupModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxTypeGroupModel) Validate ¶ 

func (m *TaxTypeGroupModel) Validate(formats strfmt.Registry) error

Validate validates this tax type group model

type TaxTypeGroupModelFetchResult ¶ 

type TaxTypeGroupModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxTypeGroupModel `json:"value"`
}

TaxTypeGroupModelFetchResult tax type group model fetch result

swagger:model TaxTypeGroupModelFetchResult

func (*TaxTypeGroupModelFetchResult) ContextValidate ¶ 

func (m *TaxTypeGroupModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax type group model fetch result based on the context it is used

func (*TaxTypeGroupModelFetchResult) MarshalBinary ¶ 

func (m *TaxTypeGroupModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxTypeGroupModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxTypeGroupModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxTypeGroupModelFetchResult) Validate ¶ 

func (m *TaxTypeGroupModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax type group model fetch result

type TaxTypeModel ¶ 

type TaxTypeModel struct {

	// The description of this tax type.
	// Example: Bottle
	// Read Only: true
	Description string `json:"description,omitempty"`

	// The unique ID number of this tax type.
	// Example: 1
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// The name of this tax type.
	// Example: Bottle
	// Read Only: true
	TaxType string `json:"taxType,omitempty"`
}

TaxTypeModel Represents a tax type Example: {"description":"Bottle","id":1,"taxType":"Bottle"}

swagger:model TaxTypeModel

func (*TaxTypeModel) ContextValidate ¶ 

func (m *TaxTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax type model based on the context it is used

func (*TaxTypeModel) MarshalBinary ¶ 

func (m *TaxTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxTypeModel) UnmarshalBinary ¶ 

func (m *TaxTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxTypeModel) Validate ¶ 

func (m *TaxTypeModel) Validate(formats strfmt.Registry) error

Validate validates this tax type model

type TaxTypeModelFetchResult ¶ 

type TaxTypeModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TaxTypeModel `json:"value"`
}

TaxTypeModelFetchResult tax type model fetch result

swagger:model TaxTypeModelFetchResult

func (*TaxTypeModelFetchResult) ContextValidate ¶ 

func (m *TaxTypeModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax type model fetch result based on the context it is used

func (*TaxTypeModelFetchResult) MarshalBinary ¶ 

func (m *TaxTypeModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxTypeModelFetchResult) UnmarshalBinary ¶ 

func (m *TaxTypeModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxTypeModelFetchResult) Validate ¶ 

func (m *TaxTypeModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this tax type model fetch result

type TransactionAddressModel ¶ 

type TransactionAddressModel struct {

	// The boundary level at which this address was validated.
	// Example: Address
	// Read Only: true
	// Enum: [Address Zip9 Zip5]
	BoundaryLevel string `json:"boundaryLevel,omitempty"`

	// The city for the address.
	// Example: Bainbridge Island
	City string `json:"city,omitempty"`

	// The ISO 3166 country code
	// Example: US
	Country string `json:"country,omitempty"`

	// The unique ID number of this address.
	// Example: 0
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// List of all the qualified jurisdictions for the TaxRegionId.
	Jurisdictions []*JurisdictionModel `json:"jurisdictions"`

	// Latitude for this address
	Latitude string `json:"latitude,omitempty"`

	// The first line of the address.
	// Example: 100 Ravine Lane Northeast #220
	Line1 string `json:"line1,omitempty"`

	// The second line of the address.
	Line2 string `json:"line2,omitempty"`

	// The third line of the address.
	Line3 string `json:"line3,omitempty"`

	// Longitude for this address
	Longitude string `json:"longitude,omitempty"`

	// The postal code or zip code for the address.
	// Example: 98110
	PostalCode string `json:"postalCode,omitempty"`

	// The ISO 3166 region code. E.g., the second part of ISO 3166-2.
	// Example: WA
	Region string `json:"region,omitempty"`

	// The unique ID number of the tax region for this address.
	// Example: 0
	TaxRegionID int32 `json:"taxRegionId,omitempty"`

	// The unique ID number of the document to which this address belongs.
	// Example: 0
	// Read Only: true
	TransactionID int64 `json:"transactionId,omitempty"`
}

TransactionAddressModel An address used within this transaction. Example: {"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}

swagger:model TransactionAddressModel

func (*TransactionAddressModel) ContextValidate ¶ 

func (m *TransactionAddressModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction address model based on the context it is used

func (*TransactionAddressModel) MarshalBinary ¶ 

func (m *TransactionAddressModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionAddressModel) UnmarshalBinary ¶ 

func (m *TransactionAddressModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionAddressModel) Validate ¶ 

func (m *TransactionAddressModel) Validate(formats strfmt.Registry) error

Validate validates this transaction address model

type TransactionBatchItemModel ¶ 

type TransactionBatchItemModel struct {

	// Represents an existing transaction to be adjusted.
	// Example: {"adjustmentDescription":"Price drop before shipping","adjustmentReason":"PriceAdjusted","companyCode":"DEFAULT","documentType":"SalesInvoice","newTransaction":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"},"transactionCode":"6c2877c3-c04e-4c32-adbc-27df5da3d43f"}
	AdjustTransactionModel *BatchAdjustTransactionModel `json:"adjustTransactionModel,omitempty"`

	// Represents a transaction to be created or to be adjusted if exists.
	// Example: {"adjustmentDescription":"Test Description","adjustmentReason":"Other","createTransactionModel":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}
	CreateOrAdjustTransactionModel *CreateOrAdjustTransactionModel `json:"createOrAdjustTransactionModel,omitempty"`

	// Represents a transaction to be created.
	// Example: {"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}
	CreateTransactionModel *CreateTransactionModel `json:"createTransactionModel,omitempty"`

	// Represents a transaction memo.
	// Max Length: 50000
	// Min Length: 0
	Memo *string `json:"memo,omitempty"`

	// Represents an existing transaction to be voided.
	// Example: {"code":"DocVoided","companyCode":"DEFAULT","documentType":"SalesInvoice","transactionCode":"3e76797a-707f-4ffe-b0c6-e84a9d86b0d5"}
	VoidTransactionModel *BatchVoidTransactionModel `json:"voidTransactionModel,omitempty"`
}

TransactionBatchItemModel Represents a transaction batch item. Only one child transaction model should contain data. Example: {"createOrAdjustTransactionModel":{"adjustmentDescription":"Test Description","adjustmentReason":"Other","createTransactionModel":{"addresses":{"singleLocation":{"city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}},"commit":true,"companyCode":"DEFAULT","currencyCode":"USD","customerCode":"ABC","date":"2021-12-25","description":"Yarn","lines":[{"amount":100,"description":"Yarn","itemCode":"Y0001","number":"1","quantity":1,"taxCode":"PS081282"}],"purchaseOrderNo":"2021-12-25-001","type":"SalesInvoice"}}}

swagger:model TransactionBatchItemModel

func (*TransactionBatchItemModel) ContextValidate ¶ 

func (m *TransactionBatchItemModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction batch item model based on the context it is used

func (*TransactionBatchItemModel) MarshalBinary ¶ 

func (m *TransactionBatchItemModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionBatchItemModel) UnmarshalBinary ¶ 

func (m *TransactionBatchItemModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionBatchItemModel) Validate ¶ 

func (m *TransactionBatchItemModel) Validate(formats strfmt.Registry) error

Validate validates this transaction batch item model

type TransactionLineDetailModel ¶ 

type TransactionLineDetailModel struct {

	// The unique ID number of the address used for this tax detail.
	// Example: 12345
	AddressID int64 `json:"addressId,omitempty"`

	// The two character ISO 3166 country code of the country where this tax detail is assigned.
	// Example: US
	// Max Length: 2
	// Min Length: 2
	Country string `json:"country,omitempty"`

	// For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the county where this tax detail is assigned.
	CountyFIPS string `json:"countyFIPS,omitempty"`

	// The amount of this line that was considered exempt in this tax detail.
	// Example: 0
	ExemptAmount float64 `json:"exemptAmount,omitempty"`

	// The unique ID number of the exemption reason for this tax detail.
	// Example: 4
	ExemptReasonID int32 `json:"exemptReasonId,omitempty"`

	// Number of units in this line item that were calculated to be exempt according to this rate detail.
	// Example: 62.5
	ExemptUnits float64 `json:"exemptUnits,omitempty"`

	// The unique ID number of this tax detail.
	// Example: 123456789
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// True if this detail element represented an in-state transaction.
	// Example: false
	InState bool `json:"inState,omitempty"`

	// The Taxes/Fee component. True if the fee is applied.
	IsFee bool `json:"isFee,omitempty"`

	// True if this value is a non-passthrough tax.
	//
	// A non-passthrough tax is a tax that may not be charged to a customer; it must be paid directly by the company.
	IsNonPassThru bool `json:"isNonPassThru,omitempty"`

	// The code of the jurisdiction to which this tax detail applies.
	// Example: 06
	JurisCode string `json:"jurisCode,omitempty"`

	// The name of the jurisdiction to which this tax detail applies.
	// Example: CALIFORNIA
	JurisName string `json:"jurisName,omitempty"`

	// DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Use jurisdictionTypeId instead.
	// The type of the jurisdiction to which this tax detail applies.
	// Example: STA
	// Enum: [STA CTY CIT STJ CNT]
	JurisType string `json:"jurisType,omitempty"`

	// The unique ID number of the jurisdiction to which this tax detail applies.
	// Example: 5000531
	JurisdictionID int32 `json:"jurisdictionId,omitempty"`

	// The type of the jurisdiction in which this tax detail applies.
	// Example: Country
	// Enum: [Country State County City Special]
	JurisdictionType string `json:"jurisdictionType,omitempty"`

	// LiabilityType identifies the party liable to file the tax. This field is used to filter taxes from reports and tax filings as appropriate.
	// Example: Seller
	// Enum: [Seller BuyersAgent]
	LiabilityType string `json:"liabilityType,omitempty"`

	// The amount of this line item that was considered nontaxable in this tax detail.
	// Example: 0
	NonTaxableAmount float64 `json:"nonTaxableAmount,omitempty"`

	// The rule according to which portion of this detail was considered nontaxable.
	// Example: 0
	NonTaxableRuleID int32 `json:"nonTaxableRuleId,omitempty"`

	// The type of nontaxability that was applied to this tax detail.
	// Example: RateRule
	// Enum: [RateRule RateOverrideRule BaseRule ExemptEntityRule ProductTaxabilityRule NexusRule RateCapRule TaxOverrideRule FeeRule OtherRule]
	NonTaxableType string `json:"nonTaxableType,omitempty"`

	// Number of units in this line item that were calculated to be nontaxable according to this rate detail.
	// Example: 1000
	NonTaxableUnits float64 `json:"nonTaxableUnits,omitempty"`

	// The rate at which this tax detail was calculated.
	// Example: 0.0625
	Rate float64 `json:"rate,omitempty"`

	// The unique ID number of the rule according to which this tax detail was calculated.
	// Example: 1321915
	RateRuleID int32 `json:"rateRuleId,omitempty"`

	// The unique ID number of the source of the rate according to which this tax detail was calculated.
	// Example: 3
	RateSourceID int32 `json:"rateSourceId,omitempty"`

	// DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use rateTypeCode instead.
	// The rate type for this tax detail.
	// Example: ReducedA
	// Enum: [ReducedA ReducedB Food General IncreasedStandard LinenRental Medical Construction Parking SuperReduced ReducedR Standard Leasing LeasingLow Services Zero]
	RateType string `json:"rateType,omitempty"`

	// Indicates the code of the rate type that was used to calculate this tax detail.  Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes.
	// Max Length: 25
	// Min Length: 0
	RateTypeCode *string `json:"rateTypeCode,omitempty"`

	// The two-or-three character ISO region code for the region where this tax detail is assigned.
	// Example: CA
	Region string `json:"region,omitempty"`

	// Number of units in this line item that were calculated to be exempt according to this rate detail in the reporting currency.
	// Example: 125
	ReportingExemptUnits float64 `json:"reportingExemptUnits,omitempty"`

	// Number of units in this line item that were calculated to be nontaxable according to this rate detail in the reporting currency.
	// Example: 2000
	ReportingNonTaxableUnits float64 `json:"reportingNonTaxableUnits,omitempty"`

	// The amount of tax for this tax detail in the reporting currency.
	// Example: 125
	ReportingTax float64 `json:"reportingTax,omitempty"`

	// The amount of tax that AvaTax calculated in the reporting currency.
	// If an override for tax amount is used, there may be a difference between the tax
	// field which applies your override, and the this amount that is calculated without override.
	// Example: 125
	ReportingTaxCalculated float64 `json:"reportingTaxCalculated,omitempty"`

	// Number of units in this line item that were calculated to be taxable according to this rate detail in the reporting currency.
	// Example: 125
	ReportingTaxableUnits float64 `json:"reportingTaxableUnits,omitempty"`

	// For Streamlined Sales Tax customers, the SST Electronic Return code under which this tax detail should be applied.
	SerCode string `json:"serCode,omitempty"`

	// The Avalara-specified signature code of the jurisdiction to which this tax detail applies.
	// Example: AGAM
	SignatureCode string `json:"signatureCode,omitempty"`

	// Indicates whether this tax detail applies to the origin or destination of the transaction.
	// Example: Mixed
	// Enum: [Mixed Destination Origin]
	Sourcing string `json:"sourcing,omitempty"`

	// The state assigned number of the jurisdiction to which this tax detail applies.
	StateAssignedNo string `json:"stateAssignedNo,omitempty"`

	// For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the state where this tax detail is assigned.
	// Example: 06
	StateFIPS string `json:"stateFIPS,omitempty"`

	// The amount of tax for this tax detail.
	// Example: 62.5
	Tax float64 `json:"tax,omitempty"`

	// The type of the tax authority to which this tax will be remitted.
	// Example: 45
	TaxAuthorityTypeID int32 `json:"taxAuthorityTypeId,omitempty"`

	// The amount of tax that AvaTax calculated.
	// If an override for tax amount is used, there may be a difference between the tax
	// field which applies your override, and the this amount that is calculated without override.
	// Example: 62.5
	TaxCalculated float64 `json:"taxCalculated,omitempty"`

	// The name of the tax against which this tax amount was calculated.
	// Example: CA STATE TAX
	TaxName string `json:"taxName,omitempty"`

	// The amount of tax override that was specified for this tax line.
	// Example: 0
	TaxOverride float64 `json:"taxOverride,omitempty"`

	// The unique ID number of the tax region.
	// Example: 2127184
	TaxRegionID int32 `json:"taxRegionId,omitempty"`

	// The id of the tax subtype.
	TaxSubTypeID string `json:"taxSubTypeId,omitempty"`

	// The type of tax that was calculated.  Depends on the company's nexus settings as well as the jurisdiction's tax laws.
	// Example: Sales
	TaxType string `json:"taxType,omitempty"`

	// The id of the tax type group.
	TaxTypeGroupID string `json:"taxTypeGroupId,omitempty"`

	// The taxable amount of this tax detail.
	// Example: 1000
	TaxableAmount float64 `json:"taxableAmount,omitempty"`

	// Number of units in this line item that were calculated to be taxable according to this rate detail.
	// Example: 62.5
	TaxableUnits float64 `json:"taxableUnits,omitempty"`

	// The unique ID number of this transaction.
	// Example: 123456789
	// Read Only: true
	TransactionID int64 `json:"transactionId,omitempty"`

	// The unique ID number of the line within this transaction.
	// Example: 123456789
	// Read Only: true
	TransactionLineID int64 `json:"transactionLineId,omitempty"`

	// When calculating units, what basis of measurement did we use for calculating the units?
	UnitOfBasis string `json:"unitOfBasis,omitempty"`
}

TransactionLineDetailModel An individual tax detail element. Represents the amount of tax calculated for a particular jurisdiction, for a particular line in an invoice. Example: {"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}

swagger:model TransactionLineDetailModel

func (*TransactionLineDetailModel) ContextValidate ¶ 

func (m *TransactionLineDetailModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction line detail model based on the context it is used

func (*TransactionLineDetailModel) MarshalBinary ¶ 

func (m *TransactionLineDetailModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLineDetailModel) UnmarshalBinary ¶ 

func (m *TransactionLineDetailModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLineDetailModel) Validate ¶ 

func (m *TransactionLineDetailModel) Validate(formats strfmt.Registry) error

Validate validates this transaction line detail model

type TransactionLineLocationTypeModel ¶ 

type TransactionLineLocationTypeModel struct {

	// The address ID corresponding to this model
	// Example: 789
	// Read Only: true
	DocumentAddressID int64 `json:"documentAddressId,omitempty"`

	// The unique ID number of the document line associated with this line location address model
	// Example: 456
	// Read Only: true
	DocumentLineID int64 `json:"documentLineId,omitempty"`

	// The unique ID number of this line location address model
	// Example: 123
	// Read Only: true
	DocumentLineLocationTypeID int64 `json:"documentLineLocationTypeId,omitempty"`

	// The location type code corresponding to this model
	// Example: SingleLocation
	// Read Only: true
	LocationTypeCode string `json:"locationTypeCode,omitempty"`
}

TransactionLineLocationTypeModel Represents information about location types stored in a line Example: {"documentAddressId":789,"documentLineId":456,"documentLineLocationTypeId":123,"locationTypeCode":"SingleLocation"}

swagger:model TransactionLineLocationTypeModel

func (*TransactionLineLocationTypeModel) ContextValidate ¶ 

func (m *TransactionLineLocationTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction line location type model based on the context it is used

func (*TransactionLineLocationTypeModel) MarshalBinary ¶ 

func (m *TransactionLineLocationTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLineLocationTypeModel) UnmarshalBinary ¶ 

func (m *TransactionLineLocationTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLineLocationTypeModel) Validate ¶ 

func (m *TransactionLineLocationTypeModel) Validate(formats strfmt.Registry) error

Validate validates this transaction line location type model

type TransactionLineModel ¶ 

type TransactionLineModel struct {

	// The unique ID number of the boundary override applied to this line item.
	// Example: 0
	BoundaryOverrideID int32 `json:"boundaryOverrideId,omitempty"`

	// VAT business identification number used for this transaction.
	BusinessIdentificationNo string `json:"businessIdentificationNo,omitempty"`

	// Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “.  Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.
	Category string `json:"category,omitempty"`

	// The CertCapture Certificate ID
	// Read Only: true
	CertificateID string `json:"certificateId,omitempty"`

	// Indicates the cost of insurance and freight for this line.
	CostInsuranceFreight float64 `json:"costInsuranceFreight,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
	// The customer usage type for this line item.  Usage type often affects taxability rules.
	CustomerUsageType string `json:"customerUsageType,omitempty"`

	// Deemed Supplier field indicates which party on the marketplace transaction is liable for collecting and reporting the VAT. This is based on the 2021 E-commerce legislative reforms in EU and UK. This field will not be used until after July 1, 2021.
	// Example: Marketplace
	// Enum: [Marketplace Merchant]
	DeemedSupplier string `json:"deemedSupplier,omitempty"`

	// A description of the item or service represented by this line.
	// Example: Yarn
	Description string `json:"description,omitempty"`

	// The unique ID number of the destination address where this line was delivered or sold.
	// In the case of a point-of-sale transaction, the destination address and origin address will be the same.
	// In the case of a shipped transaction, they will be different.
	// Example: 12345
	DestinationAddressID int64 `json:"destinationAddressId,omitempty"`

	// Optional: A list of tax details for this line item.
	//
	// Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `details` collection are intended to be
	// displayed to the customer and charged as a 'tax' on the invoice.
	//
	// To fetch this list, add the query string `?$include=Details` to your URL.
	// Example: [{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}]
	Details []*TransactionLineDetailModel `json:"details"`

	// The amount of discount that was applied to this line item.  This represents the difference between list price and sale price of the item.
	// In general, a discount represents money that did not change hands; tax is calculated on only the amount of money that changed hands.
	// Example: 100
	DiscountAmount float64 `json:"discountAmount,omitempty"`

	// The type of discount, if any, that was applied to this line item.
	// Example: 0
	DiscountTypeID int32 `json:"discountTypeId,omitempty"`

	// The entity use code for this line item.  Usage type often affects taxability rules.
	EntityUseCode string `json:"entityUseCode,omitempty"`

	// The amount of this line item that was exempt.
	// Example: 0
	ExemptAmount float64 `json:"exemptAmount,omitempty"`

	// The unique ID number of the exemption certificate that applied to this line item. It is the calc_id associated with a certificate in CertCapture.
	// Example: 0
	ExemptCertID int32 `json:"exemptCertId,omitempty"`

	// The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable
	// ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service
	// will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request,
	// and will perform exemption processing using either of those two options.
	ExemptNo string `json:"exemptNo,omitempty"`

	// The cross-border harmonized system code (HSCode) used to calculate tariffs and duties for this line item.
	// For a full list of HS codes, see `ListCrossBorderCodes()`.
	HsCode string `json:"hsCode,omitempty"`

	// The unique ID number of this transaction line item.
	// Example: 123456789
	ID int64 `json:"id,omitempty"`

	// True if this item is taxable.
	// Example: true
	IsItemTaxable bool `json:"isItemTaxable,omitempty"`

	// True if this item is a Streamlined Sales Tax line item.
	// Example: false
	IsSSTP bool `json:"isSSTP,omitempty"`

	// The code string of the item represented by this line item.
	// Example: 116292
	ItemCode string `json:"itemCode,omitempty"`

	// The total amount of the transaction, including both taxable and exempt.  This is the total price for all items.
	// To determine the individual item price, divide this by quantity.
	// Example: 1000
	LineAmount float64 `json:"lineAmount,omitempty"`

	// Optional: A list of location types for this line item.  To fetch this list, add the query string "?$include=LineLocationTypes" to your URL.
	LineLocationTypes []*TransactionLineLocationTypeModel `json:"lineLocationTypes"`

	// The line number or code indicating the line on this invoice or receipt or document.
	// Example: 1
	LineNumber string `json:"lineNumber,omitempty"`

	// This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.
	// Example: Marketplace
	// Enum: [Marketplace Seller]
	MarketplaceLiabilityType string `json:"marketplaceLiabilityType,omitempty"`

	// DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead.
	// ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
	MerchantSellerID int64 `json:"merchantSellerId,omitempty"`

	// ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
	MerchantSellerIdentifier string `json:"merchantSellerIdentifier,omitempty"`

	// Optional: A list of non-passthrough tax details for this line item.
	//
	// Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `nonPassthroughDetails` collection are
	// taxes that must be paid directly by the company and not shown to the customer.
	NonPassthroughDetails []*TransactionLineDetailModel `json:"nonPassthroughDetails"`

	// The unique ID number of the origin address where this line was delivered or sold.
	// In the case of a point-of-sale transaction, the origin address and destination address will be the same.
	// In the case of a shipped transaction, they will be different.
	// Example: 123456789
	OriginAddressID int64 `json:"originAddressId,omitempty"`

	// The transaction's original ID in its origination system
	OriginationDocumentID string `json:"originationDocumentId,omitempty"`

	// Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.
	OriginationSite string `json:"originationSite,omitempty"`

	// Contains a list of extra parameters that were set when the transaction was created.
	Parameters []*TransactionLineParameterModel `json:"parameters"`

	// The quantity of products sold on this line item.
	// Example: 1
	Quantity float64 `json:"quantity,omitempty"`

	// A user-defined reference identifier for this transaction line item.
	// Example: Note: Deliver to Bob
	Ref1 string `json:"ref1,omitempty"`

	// A user-defined reference identifier for this transaction line item.
	Ref2 string `json:"ref2,omitempty"`

	// The date when this transaction should be reported.  By default, all transactions are reported on the date when the actual transaction took place.
	// In some cases, line items may be reported later due to delayed shipments or other business reasons.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date
	ReportingDate strfmt.Date `json:"reportingDate,omitempty"`

	// The revenue account number for this line item.
	RevAccount string `json:"revAccount,omitempty"`

	// Indicates whether this line item was taxed according to the origin or destination.
	// Example: Mixed
	// Enum: [Mixed Destination Origin]
	Sourcing string `json:"sourcing,omitempty"`

	// A long description of the product.
	Summary string `json:"summary,omitempty"`

	// The tax for this line in this transaction.
	//
	// If you used a `taxOverride` of type `taxAmount` for this line, this value
	// will represent the amount of your override.  AvaTax will still attempt to calculate the correct tax
	// for this line and will store that calculated value in the `taxCalculated` field.
	//
	// You can compare the `tax` and `taxCalculated` fields to check for any discrepancies
	// between an external tax calculation provider and the calculation performed by AvaTax.
	// Example: 62.5
	Tax float64 `json:"tax,omitempty"`

	// Contains a list of TaxType that are to be overridden with their respective TaxOverrideAmount.
	TaxAmountByTaxTypes []*TransactionLineTaxAmountByTaxTypeModel `json:"taxAmountByTaxTypes"`

	// The amount of tax that AvaTax calculated for the transaction.
	//
	// If you used a `taxOverride` of type `taxAmount`, there may be a difference between
	// the `tax` field which applies your override, and the `taxCalculated` field which
	// represents the amount of tax that AvaTax calculated without the override.
	//
	// You can compare the `tax` and `taxCalculated` fields to check for any discrepancies
	// between an external tax calculation provider and the calculation performed by AvaTax.
	// Example: 62.5
	TaxCalculated float64 `json:"taxCalculated,omitempty"`

	// The code string for the tax code that was used to calculate this line item.
	// Example: PS081282
	TaxCode string `json:"taxCode,omitempty"`

	// The unique ID number for the tax code that was used to calculate this line item.
	TaxCodeID int32 `json:"taxCodeId,omitempty"`

	// The date that was used for calculating tax amounts for this line item.  By default, this date should be the same as the document date.
	// In some cases, for example when a consumer returns a product purchased previously, line items may be calculated using a tax date in the past
	// so that the consumer can receive a refund for the correct tax amount that was charged when the item was originally purchased.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date
	TaxDate strfmt.Date `json:"taxDate,omitempty"`

	// The tax engine identifier that was used to calculate this line item.
	TaxEngine string `json:"taxEngine,omitempty"`

	// Indicates whether the `amount` for this line already includes tax.
	//
	// If this value is `true`, the final price of this line including tax will equal the value in `amount`.
	//
	// If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line.
	// Example: false
	TaxIncluded bool `json:"taxIncluded,omitempty"`

	// If a tax override was specified, this indicates the amount of tax that was requested.
	// Example: 0
	TaxOverrideAmount float64 `json:"taxOverrideAmount,omitempty"`

	// If a tax override was specified, represents the reason for the tax override.
	TaxOverrideReason string `json:"taxOverrideReason,omitempty"`

	// If a tax override was specified, this indicates the type of tax override.
	// Example: None
	// Enum: [None TaxAmount Exemption TaxDate AccruedTaxAmount DeriveTaxable OutOfHarbor TaxAmountByTaxType]
	TaxOverrideType string `json:"taxOverrideType,omitempty"`

	// The taxable amount of this line item.
	// Example: 1000
	TaxableAmount float64 `json:"taxableAmount,omitempty"`

	// The unique ID number of the transaction to which this line item belongs.
	// Example: 123456789
	TransactionID int64 `json:"transactionId,omitempty"`

	// Custom user fields/flex fields for this transaction.
	UserDefinedFields []*TransactionLineUserDefinedFieldModel `json:"userDefinedFields"`

	// Indicates the VAT code for this line item.
	VatCode string `json:"vatCode,omitempty"`

	// Indicates the VAT number type for this line item.
	// Example: 0
	VatNumberTypeID int32 `json:"vatNumberTypeId,omitempty"`
}

TransactionLineModel One line item on this transaction. Example: {"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}

swagger:model TransactionLineModel

func (*TransactionLineModel) ContextValidate ¶ 

func (m *TransactionLineModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction line model based on the context it is used

func (*TransactionLineModel) MarshalBinary ¶ 

func (m *TransactionLineModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLineModel) UnmarshalBinary ¶ 

func (m *TransactionLineModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLineModel) Validate ¶ 

func (m *TransactionLineModel) Validate(formats strfmt.Registry) error

Validate validates this transaction line model

type TransactionLineParameterModel ¶ 

type TransactionLineParameterModel struct {

	// The name of the parameter.
	// Example: ScreenSize
	Name string `json:"name,omitempty"`

	// The unit of measure of the parameter value.
	// Example: Inch
	Unit string `json:"unit,omitempty"`

	// The value of the parameter.
	// Example: 22.0
	Value string `json:"value,omitempty"`
}

TransactionLineParameterModel Represents a transaction parameter. Example: {"name":"ScreenSize","unit":"Inch","value":"22.0"}

swagger:model TransactionLineParameterModel

func (*TransactionLineParameterModel) ContextValidate ¶ 

func (m *TransactionLineParameterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction line parameter model based on context it is used

func (*TransactionLineParameterModel) MarshalBinary ¶ 

func (m *TransactionLineParameterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLineParameterModel) UnmarshalBinary ¶ 

func (m *TransactionLineParameterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLineParameterModel) Validate ¶ 

func (m *TransactionLineParameterModel) Validate(formats strfmt.Registry) error

Validate validates this transaction line parameter model

type TransactionLineTaxAmountByTaxTypeModel ¶ 

type TransactionLineTaxAmountByTaxTypeModel struct {

	// The value of the TaxOverrideAmount.
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// The name of the TaxType.
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

TransactionLineTaxAmountByTaxTypeModel Represents a transaction parameter. Example: {"taxAmount":0,"taxTypeId":""}

swagger:model TransactionLineTaxAmountByTaxTypeModel

func (*TransactionLineTaxAmountByTaxTypeModel) ContextValidate ¶ 

func (m *TransactionLineTaxAmountByTaxTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction line tax amount by tax type model based on context it is used

func (*TransactionLineTaxAmountByTaxTypeModel) MarshalBinary ¶ 

func (m *TransactionLineTaxAmountByTaxTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLineTaxAmountByTaxTypeModel) UnmarshalBinary ¶ 

func (m *TransactionLineTaxAmountByTaxTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLineTaxAmountByTaxTypeModel) Validate ¶ 

func (m *TransactionLineTaxAmountByTaxTypeModel) Validate(formats strfmt.Registry) error

Validate validates this transaction line tax amount by tax type model

type TransactionLineUserDefinedFieldModel ¶ 

type TransactionLineUserDefinedFieldModel struct {

	// The name of the user defined field.
	// Example: UDF1
	Name string `json:"name,omitempty"`

	// The value of the user defined field.
	// Example: 100
	Value string `json:"value,omitempty"`
}

TransactionLineUserDefinedFieldModel User Defined fields/Flex Fields at Transaction Line level. Example: {"name":"UDF1","value":"100"}

swagger:model TransactionLineUserDefinedFieldModel

func (*TransactionLineUserDefinedFieldModel) ContextValidate ¶ 

func (m *TransactionLineUserDefinedFieldModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction line user defined field model based on context it is used

func (*TransactionLineUserDefinedFieldModel) MarshalBinary ¶ 

func (m *TransactionLineUserDefinedFieldModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLineUserDefinedFieldModel) UnmarshalBinary ¶ 

func (m *TransactionLineUserDefinedFieldModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLineUserDefinedFieldModel) Validate ¶ 

func (m *TransactionLineUserDefinedFieldModel) Validate(formats strfmt.Registry) error

Validate validates this transaction line user defined field model

type TransactionLocationTypeModel ¶ 

type TransactionLocationTypeModel struct {

	// Address ID for the transaction
	// Example: 789
	// Read Only: true
	DocumentAddressID int64 `json:"documentAddressId,omitempty"`

	// Transaction ID
	// Example: 456
	// Read Only: true
	DocumentID int64 `json:"documentId,omitempty"`

	// Location type ID for this location type in transaction
	// Example: 123
	// Read Only: true
	DocumentLocationTypeID int64 `json:"documentLocationTypeId,omitempty"`

	// Location type code
	// Example: SingleLocation
	// Read Only: true
	LocationTypeCode string `json:"locationTypeCode,omitempty"`
}

TransactionLocationTypeModel Information about a location type Example: {"documentAddressId":789,"documentId":456,"documentLocationTypeId":123,"locationTypeCode":"SingleLocation"}

swagger:model TransactionLocationTypeModel

func (*TransactionLocationTypeModel) ContextValidate ¶ 

func (m *TransactionLocationTypeModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction location type model based on the context it is used

func (*TransactionLocationTypeModel) MarshalBinary ¶ 

func (m *TransactionLocationTypeModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionLocationTypeModel) UnmarshalBinary ¶ 

func (m *TransactionLocationTypeModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionLocationTypeModel) Validate ¶ 

func (m *TransactionLocationTypeModel) Validate(formats strfmt.Registry) error

Validate validates this transaction location type model

type TransactionModel ¶ 

type TransactionModel struct {

	// A list of line items in this transaction.  To fetch this list, add the query string `?$include=Addresses` to your URL.
	//
	// For more information about transaction addresses, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/)
	// in the AvaTax Developer Guide.
	// Example: [{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}]
	Addresses []*TransactionAddressModel `json:"addresses"`

	// If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.
	AdjustmentDescription string `json:"adjustmentDescription,omitempty"`

	// If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted.
	// Example: NotAdjusted
	// Enum: [NotAdjusted SourcingIssue ReconciledWithGeneralLedger ExemptCertApplied PriceAdjusted ProductReturned ProductExchanged BadDebt Other Offline]
	AdjustmentReason string `json:"adjustmentReason,omitempty"`

	// If this transaction was created as part of a batch, this code indicates which batch.
	BatchCode string `json:"batchCode,omitempty"`

	// VAT business identification number used for this transaction.
	BusinessIdentificationNo string `json:"businessIdentificationNo,omitempty"`

	// A unique customer-provided code identifying this transaction.
	// Example: 594747b8-02a4-49ac-afae-3a6ebe47d2cb
	// Read Only: true
	Code string `json:"code,omitempty"`

	// The unique ID number of the company that recorded this transaction.
	// Example: 12345
	CompanyID int32 `json:"companyId,omitempty"`

	// The two-character ISO 3166 code of the country for this transaction.
	// Example: US
	// Max Length: 2
	// Min Length: 2
	Country string `json:"country,omitempty"`

	// The three-character ISO 4217 currency code that was used for payment for this transaction.
	// Example: USD
	CurrencyCode string `json:"currencyCode,omitempty"`

	// Unique code identifying the customer that requested this transaction.
	//
	// When you specify a `customerCode`, AvaTax will look to see if a customer exists with this code in the exemption certificate system.
	// If that customer exists, and if that customer has uploaded an exemption certificate that applies to this transaction, the relevant
	// parts of this transaction that can use the exemption certificate will be treated as exempt.
	// Example: ABC
	CustomerCode string `json:"customerCode,omitempty"`

	// The name of the supplier / exporter / seller.
	// For sales doctype this will be the name of your own company for which you are reporting.
	// For purchases doctype this will be the name of the supplier you have purchased from.
	CustomerSupplierName string `json:"customerSupplierName,omitempty"`

	// DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
	// The customer usage type for this transaction.  Customer usage types often affect exemption or taxability rules.
	CustomerUsageType string `json:"customerUsageType,omitempty"`

	// DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use `customerCode`
	// This field has been renamed to `customerCode` to match documentation for other APIs related to exemption customers.
	// Example: ABC
	CustomerVendorCode string `json:"customerVendorCode,omitempty"`

	// The Id of the datasource from which this transaction originated.
	// This value will be overridden by the system to take the datasource Id from the call header.
	DataSourceID int32 `json:"dataSourceId,omitempty"`

	// The date on which this transaction occurred.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date
	Date strfmt.Date `json:"date,omitempty"`

	// The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not.
	// Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that  indicate that Import Duty and Tax should be included in the transaction total.
	// This field is also used for reports.
	// This field is used for future feature support. This field is not currently in use.
	// Example: DAP
	// Enum: [DAP DDP]
	DeliveryTerms string `json:"deliveryTerms,omitempty"`

	// Description of this transaction.  Field permits unicode values.
	// Example: Yarn
	Description string `json:"description,omitempty"`

	// The unique ID number of the destination address for this transaction.
	// Example: 123456789
	DestinationAddressID int64 `json:"destinationAddressId,omitempty"`

	// Email address associated with this transaction.
	Email string `json:"email,omitempty"`

	// The entity use code for this transaction.  Entity use codes often affect exemption or taxability rules.
	EntityUseCode string `json:"entityUseCode,omitempty"`

	// If this transaction included foreign currency exchange, this is the exchange rate that was used.
	// Example: 2
	ExchangeRate float64 `json:"exchangeRate,omitempty"`

	// The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.
	// Example: USD
	ExchangeRateCurrencyCode string `json:"exchangeRateCurrencyCode,omitempty"`

	// If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date
	ExchangeRateEffectiveDate strfmt.Date `json:"exchangeRateEffectiveDate,omitempty"`

	// The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable
	// ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service
	// will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request,
	// and will perform exemption processing using either of those two options.
	ExemptNo string `json:"exemptNo,omitempty"`

	// The unique ID number of this transaction.
	// Example: 123456789
	// Read Only: true
	ID int64 `json:"id,omitempty"`

	// Invoice messages associated with this document. Currently, this stores legally-required VAT messages.
	InvoiceMessages []*InvoiceMessageModel `json:"invoiceMessages"`

	// By default, the value is null, when the value is null, the value can be set at nexus level and used.
	// If the value is not null, it will override the value at nexus level.
	//
	// If true, this seller was considered the importer of record of a product shipped internationally.
	//
	// If this transaction is not an international transaction, this field may be left blank.
	//
	// The "importer of record" is liable to pay customs and import duties for products shipped internationally.  If
	// you specify that the seller is the importer of record, then estimates of customs and import duties will be added
	// as tax details to the transaction.  Otherwise, the buyer is considered the importer of record, and customs
	// and import duties will not be added to the tax details for this transaction.
	// Example: false
	IsSellerImporterOfRecord bool `json:"isSellerImporterOfRecord,omitempty"`

	// A list of line items in this transaction.  To fetch this list, add the query string `?$include=Lines` or `?$include=Details` to your URL.
	// Example: [{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}]
	Lines []*TransactionLineModel `json:"lines"`

	// DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead.
	// This field has been replaced by the reportingLocationCode field
	// Example: DEFAULT
	LocationCode string `json:"locationCode,omitempty"`

	// A list of location types in this transaction.  To fetch this list, add the query string `?$include=Addresses` to your URL.
	LocationTypes []*TransactionLocationTypeModel `json:"locationTypes"`

	// If this transaction has been reported to a tax authority, this transaction is considered locked and may not be adjusted after reporting.
	// Example: false
	Locked bool `json:"locked,omitempty"`

	// List of informational and warning messages regarding this API call.  These messages are only relevant to the current API call.
	Messages []*AvaTaxMessage `json:"messages"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The unique ID number of the origin address for this transaction.
	// Example: 123456789
	OriginAddressID int64 `json:"originAddressId,omitempty"`

	// Contains a list of extra parameters that were set when the transaction was created.
	Parameters []*TransactionParameterModel `json:"parameters"`

	// DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed.
	// The date when payment was made on this transaction.  By default, this should be the same as the date of the transaction.
	// Format: date
	PaymentDate strfmt.Date `json:"paymentDate,omitempty"`

	// The customer-supplied purchase order number of this transaction.
	PurchaseOrderNo string `json:"purchaseOrderNo,omitempty"`

	// If this transaction has been reconciled against the company's ledger, this value is set to true.
	// Example: true
	Reconciled bool `json:"reconciled,omitempty"`

	// A user-defined reference code for this transaction.
	ReferenceCode string `json:"referenceCode,omitempty"`

	// The two-or-three character ISO region code of the region for this transaction.
	// Example: CA
	Region string `json:"region,omitempty"`

	// For customers who use [location-based tax reporting](https://developer.avalara.com/avatax/dev-guide/locations/location-based-reporting),
	// this field controls how this transaction will be filed for multi-location tax filings.
	//
	// If you specify a non-null value for this field, AvaTax will ensure that this transaction is reported on the tax return associated
	// with the [LocationModel](https://developer.avalara.com/api-reference/avatax/rest/v2/models/LocationModel/) identified by this code.
	//
	// This field does not affect any addresses for the transaction.  It only controls the tax filing behavior of this transaction.
	//
	// If you are looking for information about how to set up addresses for a transaction, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/)
	// in the AvaTax Developer Guide.
	ReportingLocationCode string `json:"reportingLocationCode,omitempty"`

	// The salesperson who provided this transaction.  Not required.
	// Example: DEF
	SalespersonCode string `json:"salespersonCode,omitempty"`

	// The software version used to calculate this transaction.
	SoftwareVersion string `json:"softwareVersion,omitempty"`

	// The status of the transaction.
	// Example: Temporary
	// Enum: [Temporary Saved Posted Committed Cancelled Adjusted Queued PendingApproval Any]
	Status string `json:"status,omitempty"`

	// Contains a summary of tax on this transaction.
	Summary []*TransactionSummary `json:"summary"`

	// Tax date for this transaction
	// Example: 2021-12-25
	// Read Only: true
	// Format: date
	TaxDate strfmt.Date `json:"taxDate,omitempty"`

	// Contains the tax details per tax type
	// Example: [{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}]
	TaxDetailsByTaxType []*TaxDetailsByTaxType `json:"taxDetailsByTaxType"`

	// If a tax override was applied to this transaction, indicates the amount of tax that was requested by the customer.
	// Example: 0
	TaxOverrideAmount float64 `json:"taxOverrideAmount,omitempty"`

	// If a tax override was applied to this transaction, indicates the reason for the tax override.
	TaxOverrideReason string `json:"taxOverrideReason,omitempty"`

	// If a tax override was applied to this transaction, indicates what type of tax override was applied.
	// Example: None
	// Enum: [None TaxAmount Exemption TaxDate AccruedTaxAmount DeriveTaxable OutOfHarbor TaxAmountByTaxType]
	TaxOverrideType string `json:"taxOverrideType,omitempty"`

	// The total amount of this transaction.
	// Example: 1000
	TotalAmount float64 `json:"totalAmount,omitempty"`

	// The total amount of discounts applied to all lines within this transaction.
	// Example: 0
	TotalDiscount float64 `json:"totalDiscount,omitempty"`

	// The amount of this transaction that was exempt.
	// Example: 0
	TotalExempt float64 `json:"totalExempt,omitempty"`

	// The total tax for all lines in this transaction.
	//
	// If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value
	// may be different than the amount of tax calculated by AvaTax.  The amount of tax calculated by
	// AvaTax will be stored in the `totalTaxCalculated` field, whereas this field will contain the
	// total tax that was charged on the transaction.
	//
	// You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies
	// between an external tax calculation provider and the calculation performed by AvaTax.
	// Example: 62.5
	TotalTax float64 `json:"totalTax,omitempty"`

	// The amount of tax that AvaTax calculated for the transaction.
	//
	// If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value
	// will represent the amount that AvaTax calculated for this transaction without applying the override.
	// The field `totalTax` will be the total amount of tax after all overrides are applied.
	//
	// You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies
	// between an external tax calculation provider and the calculation performed by AvaTax.
	// Example: 62.5
	TotalTaxCalculated float64 `json:"totalTaxCalculated,omitempty"`

	// The portion of the total amount of this transaction that was taxable.
	// Example: 1000
	TotalTaxable float64 `json:"totalTaxable,omitempty"`

	// The type of the transaction.
	//
	// Transactions of type `SalesOrder`, `ReturnOrder`, and so on are temporary estimates and will not be saved.
	//
	// Transactions of type `SalesInvoice, `ReturnInvoice`, and so on are permanent transactions that can be reported to tax authorities
	// if they are in status `Committed`.
	//
	// A sales transaction represents a sale from the company to a customer.  A purchase transaction represents a purchase made by the company.
	// A return transaction represents a customer who decided to request a refund after purchasing a product from the company.  An inventory
	// transfer transaction represents goods that were moved from one location of the company to another location without changing ownership.
	// Example: SalesOrder
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type string `json:"type,omitempty"`

	// Custom user fields/flex fields for this transaction.
	UserDefinedFields []*TransactionUserDefinedFieldModel `json:"userDefinedFields"`

	// If this transaction was adjusted, this indicates the version number of this transaction.  Incremented each time the transaction
	// is adjusted.
	// Example: 0
	Version int32 `json:"version,omitempty"`
}

TransactionModel This object represents a single transaction; for example, a sales invoice or purchase order. Example: {"addresses":[{"boundaryLevel":"Address","city":"Bainbridge Island","country":"US","id":0,"line1":"100 Ravine Lane Northeast #220","postalCode":"98110","region":"WA","taxRegionId":0,"transactionId":0}],"adjustmentDescription":"","adjustmentReason":"NotAdjusted","code":"594747b8-02a4-49ac-afae-3a6ebe47d2cb","companyId":12345,"country":"US","currencyCode":"USD","customerCode":"ABC","customerVendorCode":"ABC","date":"2021-12-25","description":"Yarn","destinationAddressId":123456789,"entityUseCode":"","exchangeRate":2,"exchangeRateCurrencyCode":"USD","exchangeRateEffectiveDate":"2021-12-25","exemptNo":"","id":123456789,"isSellerImporterOfRecord":false,"lines":[{"boundaryOverrideId":0,"description":"Yarn","destinationAddressId":12345,"details":[{"addressId":12345,"country":"US","exemptAmount":0,"exemptReasonId":4,"exemptUnits":62.5,"id":123456789,"inState":false,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"STA","jurisdictionId":5000531,"nonTaxableAmount":0,"nonTaxableRuleId":0,"nonTaxableType":"BaseRule","nonTaxableUnits":1000,"rate":0.0625,"rateRuleId":1321915,"rateSourceId":3,"rateType":"General","region":"CA","reportingExemptUnits":125,"reportingNonTaxableUnits":2000,"reportingTax":125,"reportingTaxCalculated":125,"reportingTaxableUnits":125,"serCode":"","signatureCode":"AGAM","sourcing":"Destination","stateAssignedNo":"","stateFIPS":"06","tax":62.5,"taxAuthorityTypeId":45,"taxCalculated":62.5,"taxName":"CA STATE TAX","taxOverride":0,"taxRegionId":2127184,"taxType":"Sales","taxableAmount":1000,"taxableUnits":62.5,"transactionId":123456789,"transactionLineId":123456789}],"discountAmount":100,"discountTypeId":0,"entityUseCode":"","exemptAmount":0,"exemptCertId":0,"exemptNo":"","id":123456789,"isItemTaxable":true,"isSSTP":false,"itemCode":"116292","lineAmount":1000,"lineNumber":"1","originAddressId":123456789,"quantity":1,"ref1":"Note: Deliver to Bob","reportingDate":"2021-12-25","revAccount":"","sourcing":"Destination","tax":62.5,"taxCalculated":62.5,"taxCode":"PS081282","taxDate":"2021-12-25","taxEngine":"","taxIncluded":false,"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","taxableAmount":1000,"transactionId":123456789,"vatNumberTypeId":0}],"locationCode":"DEFAULT","locked":false,"originAddressId":123456789,"reconciled":true,"region":"CA","salespersonCode":"DEF","status":"Committed","taxDate":"2021-12-25T00:00:00+00:00","taxDetailsByTaxType":[{"taxType":"SalesAndUse","totalExempt":0.05,"totalNonTaxable":0,"totalTax":0.625,"totalTaxable":100}],"taxOverrideAmount":0,"taxOverrideReason":"","taxOverrideType":"None","totalAmount":1000,"totalDiscount":0,"totalExempt":0,"totalTax":62.5,"totalTaxCalculated":62.5,"totalTaxable":1000,"type":"SalesInvoice","version":0}

swagger:model TransactionModel

func (*TransactionModel) ContextValidate ¶ 

func (m *TransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction model based on the context it is used

func (*TransactionModel) MarshalBinary ¶ 

func (m *TransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionModel) UnmarshalBinary ¶ 

func (m *TransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionModel) Validate ¶ 

func (m *TransactionModel) Validate(formats strfmt.Registry) error

Validate validates this transaction model

type TransactionModelFetchResult ¶ 

type TransactionModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*TransactionModel `json:"value"`
}

TransactionModelFetchResult transaction model fetch result

swagger:model TransactionModelFetchResult

func (*TransactionModelFetchResult) ContextValidate ¶ 

func (m *TransactionModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction model fetch result based on the context it is used

func (*TransactionModelFetchResult) MarshalBinary ¶ 

func (m *TransactionModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionModelFetchResult) UnmarshalBinary ¶ 

func (m *TransactionModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionModelFetchResult) Validate ¶ 

func (m *TransactionModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this transaction model fetch result

type TransactionParameterModel ¶ 

type TransactionParameterModel struct {

	// The name of the parameter.
	// Example: ScreenSize
	Name string `json:"name,omitempty"`

	// The unit of measure of the parameter value.
	// Example: Inch
	Unit string `json:"unit,omitempty"`

	// The value of the parameter.
	// Example: 22.0
	Value string `json:"value,omitempty"`
}

TransactionParameterModel Represents a transaction parameter. Example: {"name":"ScreenSize","unit":"Inch","value":"22.0"}

swagger:model TransactionParameterModel

func (*TransactionParameterModel) ContextValidate ¶ 

func (m *TransactionParameterModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction parameter model based on context it is used

func (*TransactionParameterModel) MarshalBinary ¶ 

func (m *TransactionParameterModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionParameterModel) UnmarshalBinary ¶ 

func (m *TransactionParameterModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionParameterModel) Validate ¶ 

func (m *TransactionParameterModel) Validate(formats strfmt.Registry) error

Validate validates this transaction parameter model

type TransactionSummary ¶ 

type TransactionSummary struct {

	// Two character ISO-3166 country code.
	// Example: US
	Country string `json:"country,omitempty"`

	// The amount of the transaction that was exempt.
	// Example: 0
	Exemption float64 `json:"exemption,omitempty"`

	// Jurisdiction Code for the taxing jurisdiction
	// Example: 06
	JurisCode string `json:"jurisCode,omitempty"`

	// The name of the jurisdiction that collects this tax.
	// Example: CALIFORNIA
	JurisName string `json:"jurisName,omitempty"`

	// The type of jurisdiction that collects this tax.
	// Example: Country
	// Enum: [Country State County City Special]
	JurisType string `json:"jurisType,omitempty"`

	// The amount of the transaction that was non-taxable.
	// Example: 0
	NonTaxable float64 `json:"nonTaxable,omitempty"`

	// Tax Rate - The rate of taxation, as a fraction of the amount.
	// Example: 0.0625
	Rate float64 `json:"rate,omitempty"`

	// DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead.
	// Indicates the tax rate type.
	// Example: ReducedA
	// Enum: [ReducedA ReducedB Food General IncreasedStandard LinenRental Medical Construction Parking SuperReduced ReducedR Standard Leasing LeasingLow Services Zero]
	RateType string `json:"rateType,omitempty"`

	// Indicates the code of the rate type.  Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes.
	// Example: G
	RateTypeCode string `json:"rateTypeCode,omitempty"`

	// Two or three character ISO region, state or province code, if applicable.
	// Example: CA
	Region string `json:"region,omitempty"`

	// The state assigned number of the jurisdiction that collects this tax.
	StateAssignedNo string `json:"stateAssignedNo,omitempty"`

	// Tax amount - The calculated tax (Base * Rate).
	// Example: 62.5
	Tax float64 `json:"tax,omitempty"`

	// The unique ID of the Tax Authority Type that collects this tax.
	// Example: 45
	TaxAuthorityType int32 `json:"taxAuthorityType,omitempty"`

	// The amount of tax that AvaTax calculated for the transaction.
	//
	// If you used a `taxOverride` of type `taxAmount`, there may be a difference between
	// the `tax` field which applies your override, and the `TaxCalculated` field which
	// represents the amount of tax that AvaTax calculated for this transaction without override.
	//
	// You can use this for comparison.
	// Example: 62.5
	TaxCalculated float64 `json:"taxCalculated,omitempty"`

	// Group code when special grouping is enabled.
	TaxGroup string `json:"taxGroup,omitempty"`

	// The name of the tax.
	// Example: CA STATE TAX
	TaxName string `json:"taxName,omitempty"`

	// The tax subtype of this tax.
	// Example: S
	TaxSubType string `json:"taxSubType,omitempty"`

	// The tax type of this tax.
	// Example: Sales
	TaxType string `json:"taxType,omitempty"`

	// Tax Base - The adjusted taxable amount.
	// Example: 1000
	Taxable float64 `json:"taxable,omitempty"`
}

TransactionSummary Summary information about an overall transaction. Example: {"country":"US","exemption":0,"jurisCode":"06","jurisName":"CALIFORNIA","jurisType":"State","nonTaxable":0,"rate":0.0625,"rateType":"General","rateTypeCode":"G","region":"CA","stateAssignedNo":"","tax":62.5,"taxAuthorityType":45,"taxCalculated":62.5,"taxGroup":"","taxName":"CA STATE TAX","taxSubType":"S","taxType":"Sales","taxable":1000}

swagger:model TransactionSummary

func (*TransactionSummary) ContextValidate ¶ 

func (m *TransactionSummary) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction summary based on context it is used

func (*TransactionSummary) MarshalBinary ¶ 

func (m *TransactionSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionSummary) UnmarshalBinary ¶ 

func (m *TransactionSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionSummary) Validate ¶ 

func (m *TransactionSummary) Validate(formats strfmt.Registry) error

Validate validates this transaction summary

type TransactionUserDefinedFieldModel ¶ 

type TransactionUserDefinedFieldModel struct {

	// The name of the user defined field.
	// Example: UDF1
	Name string `json:"name,omitempty"`

	// The value of the user defined field.
	// Example: 100
	Value string `json:"value,omitempty"`
}

TransactionUserDefinedFieldModel User Defined fields/Flex Fields at Transaction level. Example: {"name":"UDF1","value":"100"}

swagger:model TransactionUserDefinedFieldModel

func (*TransactionUserDefinedFieldModel) ContextValidate ¶ 

func (m *TransactionUserDefinedFieldModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction user defined field model based on context it is used

func (*TransactionUserDefinedFieldModel) MarshalBinary ¶ 

func (m *TransactionUserDefinedFieldModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionUserDefinedFieldModel) UnmarshalBinary ¶ 

func (m *TransactionUserDefinedFieldModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionUserDefinedFieldModel) Validate ¶ 

func (m *TransactionUserDefinedFieldModel) Validate(formats strfmt.Registry) error

Validate validates this transaction user defined field model

type UPCModel ¶ 

type UPCModel struct {

	// The unique ID number of the company to which this UPC belongs.
	// Example: 1234567
	// Read Only: true
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The User ID of the user who created this record.
	// Read Only: true
	CreatedUserID int32 `json:"createdUserId,omitempty"`

	// Description of the product to which this UPC applies.
	// Example: Yarn
	// Required: true
	// Max Length: 255
	// Min Length: 0
	Description *string `json:"description"`

	// If this UPC became effective on a certain date, this contains the first date on which the UPC was effective.
	// Format: date
	EffectiveDate strfmt.Date `json:"effectiveDate,omitempty"`

	// If this UPC expired or will expire on a certain date, this contains the last date on which the UPC was effective.
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The unique ID number for this UPC.
	// Example: 123456789
	// Read Only: true
	ID int32 `json:"id,omitempty"`

	// A flag indicating whether this UPC code is attached to the AvaTax system or to a company.
	IsSystem int32 `json:"isSystem,omitempty"`

	// Legacy Tax Code applied to any product sold with this UPC.
	// Example: PS081282
	// Max Length: 50
	// Min Length: 0
	LegacyTaxCode *string `json:"legacyTaxCode,omitempty"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The user ID of the user who last modified this record.
	// Read Only: true
	ModifiedUserID int32 `json:"modifiedUserId,omitempty"`

	// The 12-14 character Universal Product Code, European Article Number, or Global Trade Identification Number.
	// Example: 023032550992
	// Required: true
	// Max Length: 18
	// Min Length: 12
	Upc *string `json:"upc"`

	// A usage identifier for this UPC code.
	Usage int32 `json:"usage,omitempty"`
}

UPCModel One Universal Product Code object as defined for your company. Example: {"companyId":1234567,"description":"Yarn","id":123456789,"legacyTaxCode":"PS081282","upc":"023032550992"}

swagger:model UPCModel

func (*UPCModel) ContextValidate ¶ 

func (m *UPCModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this u p c model based on the context it is used

func (*UPCModel) MarshalBinary ¶ 

func (m *UPCModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UPCModel) UnmarshalBinary ¶ 

func (m *UPCModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UPCModel) Validate ¶ 

func (m *UPCModel) Validate(formats strfmt.Registry) error

Validate validates this u p c model

type UPCModelFetchResult ¶ 

type UPCModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*UPCModel `json:"value"`
}

UPCModelFetchResult u p c model fetch result

swagger:model UPCModelFetchResult

func (*UPCModelFetchResult) ContextValidate ¶ 

func (m *UPCModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this u p c model fetch result based on the context it is used

func (*UPCModelFetchResult) MarshalBinary ¶ 

func (m *UPCModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UPCModelFetchResult) UnmarshalBinary ¶ 

func (m *UPCModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UPCModelFetchResult) Validate ¶ 

func (m *UPCModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this u p c model fetch result

type UnitOfBasisModel ¶ 

type UnitOfBasisModel struct {

	// UnitOfBasis Name
	// Example: PerCurrencyUnit
	// Read Only: true
	UnitOfBasis string `json:"unitOfBasis,omitempty"`

	// UnitOfBasisId
	// Example: 13
	// Read Only: true
	UnitOfBasisID int32 `json:"unitOfBasisId,omitempty"`
}

UnitOfBasisModel unit of basis model Example: {"unitOfBasis":"PerCurrencyUnit","unitOfBasisId":13}

swagger:model UnitOfBasisModel

func (*UnitOfBasisModel) ContextValidate ¶ 

func (m *UnitOfBasisModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this unit of basis model based on the context it is used

func (*UnitOfBasisModel) MarshalBinary ¶ 

func (m *UnitOfBasisModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UnitOfBasisModel) UnmarshalBinary ¶ 

func (m *UnitOfBasisModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UnitOfBasisModel) Validate ¶ 

func (m *UnitOfBasisModel) Validate(formats strfmt.Registry) error

Validate validates this unit of basis model

type UnitOfBasisModelFetchResult ¶ 

type UnitOfBasisModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*UnitOfBasisModel `json:"value"`
}

UnitOfBasisModelFetchResult unit of basis model fetch result

swagger:model UnitOfBasisModelFetchResult

func (*UnitOfBasisModelFetchResult) ContextValidate ¶ 

func (m *UnitOfBasisModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this unit of basis model fetch result based on the context it is used

func (*UnitOfBasisModelFetchResult) MarshalBinary ¶ 

func (m *UnitOfBasisModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UnitOfBasisModelFetchResult) UnmarshalBinary ¶ 

func (m *UnitOfBasisModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UnitOfBasisModelFetchResult) Validate ¶ 

func (m *UnitOfBasisModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this unit of basis model fetch result

type UomModel ¶ 

type UomModel struct {

	// The code that refers to this unit of measurement.
	// Example: British thermal unit (International Table)
	Code string `json:"code,omitempty"`

	// A longer description of this unit of measurement.
	// Example: British thermal unit (International Table)
	Description string `json:"description,omitempty"`

	// The unique ID number of this unit of measurement.
	// Example: 2
	ID int32 `json:"id,omitempty"`

	// True if this measurement is an International System of Units (abbreviated SI) defined standard.
	// Example: false
	IsSiUom bool `json:"isSiUom,omitempty"`

	// The code describing the measurement type.
	// Example: Energy
	MeasurementTypeCode string `json:"measurementTypeCode,omitempty"`

	// A description of the measurement type system.
	// Example: Energy
	MeasurementTypeDescription string `json:"measurementTypeDescription,omitempty"`

	// The ID number of the measurement type, such as "Distance" or "Mass".
	// Example: 1
	MeasurementTypeID int32 `json:"measurementTypeId,omitempty"`

	// A short description of this unit of measurement.
	// Example: British thermal unit (International Table)
	ShortDesc string `json:"shortDesc,omitempty"`

	// For a particular measurement type, this is the ID number of the unit of measurement object corresponding to the
	// International System of Units (abbreviated SI) unit of measurement standard.  This pointer allows you to select
	// the SI unit of measurement for a particular measurement type.
	// Example: 374
	SiUOM string `json:"siUOM,omitempty"`
}

UomModel The "Unit of Measurement" model captures information about a type of measurement. Types of measurement refer to different scales for the same dimension. For example, measurements of type "Distance" may include units of measurement such as meters, feet, inches, and miles. Example: {"code":"British thermal unit (International Table)","description":"British thermal unit (International Table)","id":2,"isSiUom":false,"measurementTypeCode":"Energy","measurementTypeDescription":"Energy","measurementTypeId":1,"shortDesc":"British thermal unit (International Table)","siUOM":"374"}

swagger:model UomModel

func (*UomModel) ContextValidate ¶ 

func (m *UomModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this uom model based on context it is used

func (*UomModel) MarshalBinary ¶ 

func (m *UomModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UomModel) UnmarshalBinary ¶ 

func (m *UomModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UomModel) Validate ¶ 

func (m *UomModel) Validate(formats strfmt.Registry) error

Validate validates this uom model

type UomModelFetchResult ¶ 

type UomModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*UomModel `json:"value"`
}

UomModelFetchResult uom model fetch result

swagger:model UomModelFetchResult

func (*UomModelFetchResult) ContextValidate ¶ 

func (m *UomModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this uom model fetch result based on the context it is used

func (*UomModelFetchResult) MarshalBinary ¶ 

func (m *UomModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UomModelFetchResult) UnmarshalBinary ¶ 

func (m *UomModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UomModelFetchResult) Validate ¶ 

func (m *UomModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this uom model fetch result

type UpdateCompanyLocationRemittanceModel ¶ 

type UpdateCompanyLocationRemittanceModel struct {

	// Indicates whether this location is a physical place of business or a temporary salesperson location.
	// Example: Storefront
	// Required: true
	// Enum: [Storefront MainOffice Warehouse Salesperson Other SellerRemitsTax MarketplaceRemitsTax NonPhysical]
	AddressCategoryID *string `json:"addressCategoryId"`

	// The date when this location was opened for business.
	// Example: 2020-01-01T00:00:00
	// Required: true
	// Format: date
	EffectiveDate *strfmt.Date `json:"effectiveDate"`

	// If this place of business has closed, the date when this location closed business. If null it'll be set to the date of 9998-12-31.
	// Example: 2021-01-01T00:00:00
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`
}

UpdateCompanyLocationRemittanceModel Expire a location without restriction then update with new remittance and dates. Example: {"addressCategoryId":"MarketplaceRemitsTax","effectiveDate":"2020-01-01","endDate":"2021-01-01"}

swagger:model UpdateCompanyLocationRemittanceModel

func (*UpdateCompanyLocationRemittanceModel) ContextValidate ¶ 

func (m *UpdateCompanyLocationRemittanceModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this update company location remittance model based on context it is used

func (*UpdateCompanyLocationRemittanceModel) MarshalBinary ¶ 

func (m *UpdateCompanyLocationRemittanceModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateCompanyLocationRemittanceModel) UnmarshalBinary ¶ 

func (m *UpdateCompanyLocationRemittanceModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateCompanyLocationRemittanceModel) Validate ¶ 

func (m *UpdateCompanyLocationRemittanceModel) Validate(formats strfmt.Registry) error

Validate validates this update company location remittance model

type UserEntitlementModel ¶ 

type UserEntitlementModel struct {

	// What access privileges does the current user have to see companies?
	// Example: None
	// Enum: [None SingleCompany SingleAccount AllCompanies FirmManagedAccounts]
	AccessLevel string `json:"accessLevel,omitempty"`

	// The identities of all companies this user is permitted to access
	// Example: [123,456,789]
	Companies []int32 `json:"companies"`

	// List of API names and categories that this user is permitted to access
	// Example: ["CompanyFetch","CompanySave","NexusFetch","NexusSave"]
	Permissions []string `json:"permissions"`
}

UserEntitlementModel User Entitlement Model Example: {"accessLevel":"SingleAccount","companies":[123,456,789],"permissions":["CompanyFetch","CompanySave","NexusFetch","NexusSave"]}

swagger:model UserEntitlementModel

func (*UserEntitlementModel) ContextValidate ¶ 

func (m *UserEntitlementModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this user entitlement model based on context it is used

func (*UserEntitlementModel) MarshalBinary ¶ 

func (m *UserEntitlementModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserEntitlementModel) UnmarshalBinary ¶ 

func (m *UserEntitlementModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserEntitlementModel) Validate ¶ 

func (m *UserEntitlementModel) Validate(formats strfmt.Registry) error

Validate validates this user entitlement model

type UserModel ¶ 

type UserModel struct {

	// The unique ID number of the account to which this user belongs.
	// Example: 123456789
	// Required: true
	AccountID *int32 `json:"accountId"`

	// If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.
	// Example: 123456
	CompanyID int32 `json:"companyId,omitempty"`

	// The date when this record was created.
	// Read Only: true
	// Format: date-time
	CreatedDate strfmt.DateTime `json:"createdDate,omitempty"`

	// The email address to be used to contact this user.  If the user has forgotten a password, an email can be sent to this email address with information on how to reset this password.
	// Example: bob@example.org
	// Required: true
	// Max Length: 50
	// Min Length: 0
	Email *string `json:"email"`

	// The first or given name of the user.
	// Example: Bob
	// Required: true
	// Max Length: 50
	// Min Length: 0
	FirstName *string `json:"firstName"`

	// The unique ID number of this user.
	// Example: 12345
	// Required: true
	ID *int32 `json:"id"`

	// True if this user is currently active.
	// Example: true
	IsActive bool `json:"isActive,omitempty"`

	// The last or family name of the user.
	// Example: Example
	// Required: true
	// Max Length: 50
	// Min Length: 0
	LastName *string `json:"lastName"`

	// The date/time when this record was last modified.
	// Read Only: true
	// Format: date-time
	ModifiedDate strfmt.DateTime `json:"modifiedDate,omitempty"`

	// The status of the user's password. For a new user created, this is always going to be `UserMustChange`
	// Example: UserCannotChange
	// Enum: [UserCannotChange UserCanChange UserMustChange]
	PasswordStatus string `json:"passwordStatus,omitempty"`

	// The postal code in which this user resides.
	// Example: 98110
	// Max Length: 10
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// The security level for this user.
	// Example: NoAccess
	// Required: true
	// Enum: [NoAccess SiteAdmin AccountOperator AccountAdmin AccountUser SystemAdmin Registrar CSPTester CSPAdmin SystemOperator TechnicalSupportUser TechnicalSupportAdmin TreasuryUser TreasuryAdmin ComplianceUser ComplianceAdmin ProStoresOperator CompanyUser CompanyAdmin ComplianceTempUser ComplianceRootUser ComplianceOperator SSTAdmin FirmUser FirmAdmin]
	SecurityRoleID *string `json:"securityRoleId"`

	// Matches the subjectId of corresponding user record in AI.
	// Max Length: 32
	// Min Length: 0
	SubjectID *string `json:"subjectId,omitempty"`

	// Suppress new user email
	SuppressNewUserEmail bool `json:"suppressNewUserEmail,omitempty"`

	// The username which is used to log on to the AvaTax website, or to authenticate against API calls.
	// Example: bobExample
	// Required: true
	// Max Length: 50
	// Min Length: 5
	UserName *string `json:"userName"`
}

UserModel An account user who is permitted to use AvaTax. Example: {"accountId":123456789,"companyId":123456,"email":"bob@example.org","firstName":"Bob","id":12345,"isActive":true,"lastName":"Example","passwordStatus":"UserCanChange","postalCode":"98110","securityRoleId":"AccountUser","suppressNewUserEmail":false,"userName":"bobExample"}

swagger:model UserModel

func (*UserModel) ContextValidate ¶ 

func (m *UserModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this user model based on the context it is used

func (*UserModel) MarshalBinary ¶ 

func (m *UserModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserModel) UnmarshalBinary ¶ 

func (m *UserModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserModel) Validate ¶ 

func (m *UserModel) Validate(formats strfmt.Registry) error

Validate validates this user model

type UserModelFetchResult ¶ 

type UserModelFetchResult struct {

	// at next link
	AtNextLink string `json:"@nextLink,omitempty"`

	// at recordset count
	AtRecordsetCount int32 `json:"@recordsetCount,omitempty"`

	// page key
	PageKey string `json:"pageKey,omitempty"`

	// value
	Value []*UserModel `json:"value"`
}

UserModelFetchResult user model fetch result

swagger:model UserModelFetchResult

func (*UserModelFetchResult) ContextValidate ¶ 

func (m *UserModelFetchResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this user model fetch result based on the context it is used

func (*UserModelFetchResult) MarshalBinary ¶ 

func (m *UserModelFetchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserModelFetchResult) UnmarshalBinary ¶ 

func (m *UserModelFetchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserModelFetchResult) Validate ¶ 

func (m *UserModelFetchResult) Validate(formats strfmt.Registry) error

Validate validates this user model fetch result

type ValidatedAddressInfo ¶ 

type ValidatedAddressInfo struct {

	// Address type code. One of:
	// * Firm or company address
	// * General Delivery address
	// * High-rise or business complex
	// * PO Box address
	// * Rural route address
	// * Street or residential address
	// Example: S
	AddressType string `json:"addressType,omitempty"`

	// City component of the address
	// Example: Irvine
	// Max Length: 50
	// Min Length: 0
	City *string `json:"city,omitempty"`

	// Name or ISO 3166 code identifying the country.
	//
	// This field supports many different country identifiers:
	//  * Two character ISO 3166 codes
	//  * Three character ISO 3166 codes
	//  * Fully spelled out names of the country in ISO supported languages
	//  * Common alternative spellings for many countries
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
	// Example: US
	Country string `json:"country,omitempty"`

	// Geospatial latitude measurement, in Decimal Degrees floating point format.
	Latitude float64 `json:"latitude,omitempty"`

	// First line of the street address
	// Example: 2000 Main Street
	// Max Length: 50
	// Min Length: 0
	Line1 *string `json:"line1,omitempty"`

	// Second line of the street address
	// Max Length: 100
	// Min Length: 0
	Line2 *string `json:"line2,omitempty"`

	// Third line of the street address
	// Max Length: 100
	// Min Length: 0
	Line3 *string `json:"line3,omitempty"`

	// Geospatial longitude measurement, in Decimal Degrees floating point format.
	Longitude float64 `json:"longitude,omitempty"`

	// Postal Code / Zip Code component of the address.
	// Example: 92614
	// Max Length: 11
	// Min Length: 0
	PostalCode *string `json:"postalCode,omitempty"`

	// Name or ISO 3166 code identifying the region within the country.
	//
	// This field supports many different region identifiers:
	//  * Two and three character ISO 3166 region codes
	//  * Fully spelled out names of the region in ISO supported languages
	//  * Common alternative spellings for many regions
	//
	// For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
	// Example: CA
	Region string `json:"region,omitempty"`
}

ValidatedAddressInfo Represents a validated address Example: {"addressType":"S","city":"Irvine","country":"US","line1":"2000 Main Street","postalCode":"92614","region":"CA"}

swagger:model ValidatedAddressInfo

func (*ValidatedAddressInfo) ContextValidate ¶ 

func (m *ValidatedAddressInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this validated address info based on context it is used

func (*ValidatedAddressInfo) MarshalBinary ¶ 

func (m *ValidatedAddressInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ValidatedAddressInfo) UnmarshalBinary ¶ 

func (m *ValidatedAddressInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ValidatedAddressInfo) Validate ¶ 

func (m *ValidatedAddressInfo) Validate(formats strfmt.Registry) error

Validate validates this validated address info

type VerifyMultiDocumentModel ¶ 

type VerifyMultiDocumentModel struct {

	// Represents the unique code of this MultiDocument transaction.
	//
	// A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`.
	// Example: ABC
	// Required: true
	// Max Length: 45
	// Min Length: 0
	Code *string `json:"code"`

	// Represents the document type of this MultiDocument transaction.  For more information about
	// document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/).
	//
	// A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`.
	// Example: SalesOrder
	// Required: true
	// Enum: [SalesOrder SalesInvoice PurchaseOrder PurchaseInvoice ReturnOrder ReturnInvoice InventoryTransferOrder InventoryTransferInvoice ReverseChargeOrder ReverseChargeInvoice CustomsInvoice CustomsOrder Any]
	Type *string `json:"type"`

	// Set this value if you wish to verify a match between `verifyTotalAmount` and
	// the `totalAmount` value on the transaction recorded in AvaTax.
	//
	// If you leave this field empty, we will skip verification for this field.
	VerifyTotalAmount float64 `json:"verifyTotalAmount,omitempty"`

	// Set this value if you wish to verify a match between `verifyTotalTax` and
	// the `totalTax` value on the transaction recorded in AvaTax.
	//
	// If you leave this field empty, we will skip verification for this field.
	VerifyTotalTax float64 `json:"verifyTotalTax,omitempty"`

	// Set this value if you wish to verify a match between `verifyTransactionDate` and
	// the `documentDate` value on the transaction recorded in AvaTax.
	//
	// If you leave this field empty, we will skip verification for this field.
	// Format: date-time
	VerifyTransactionDate strfmt.DateTime `json:"verifyTransactionDate,omitempty"`
}

VerifyMultiDocumentModel Verify that a MultiDocument object matches the information in your accounting system.

If all attributes of the MultiDocument object match the values in your request, the MultiDocument object will be moved to the document status `Posted`.

For more information on document status, see [DocumentStatus](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentStatus/). Example: {"code":"ABC","type":"SalesInvoice"}

swagger:model VerifyMultiDocumentModel

func (*VerifyMultiDocumentModel) ContextValidate ¶ 

func (m *VerifyMultiDocumentModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this verify multi document model based on context it is used

func (*VerifyMultiDocumentModel) MarshalBinary ¶ 

func (m *VerifyMultiDocumentModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VerifyMultiDocumentModel) UnmarshalBinary ¶ 

func (m *VerifyMultiDocumentModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VerifyMultiDocumentModel) Validate ¶ 

func (m *VerifyMultiDocumentModel) Validate(formats strfmt.Registry) error

Validate validates this verify multi document model

type VerifyTransactionModel ¶ 

type VerifyTransactionModel struct {

	// Set this value if you wish to verify a match between `verifyTotalAmount` and
	// the `totalAmount` value on the transaction recorded in AvaTax.
	//
	// If you leave this field empty, we will skip verification for this field.
	// Example: 100
	VerifyTotalAmount float64 `json:"verifyTotalAmount,omitempty"`

	// Set this value if you wish to verify a match between `verifyTotalTax` and
	// the `totalTax` value on the transaction recorded in AvaTax.
	//
	// If you leave this field empty, we will skip verification for this field.
	// Example: 6.25
	VerifyTotalTax float64 `json:"verifyTotalTax,omitempty"`

	// Set this value if you wish to verify a match between `verifyTransactionDate` and
	// the `documentDate` value on the transaction recorded in AvaTax.
	//
	// If you leave this field empty, we will skip verification for this field.
	// Example: 2021-12-25T00:00:00+00:00
	// Format: date-time
	VerifyTransactionDate strfmt.DateTime `json:"verifyTransactionDate,omitempty"`
}

VerifyTransactionModel Verify this transaction by matching it to values in your accounting system.

You may specify one or more of the following fields to verify: `date`, `totalAmount`, or `totalTax`. This call will report an error if there is any difference between the data stored in AvaTax and the data stored in your accounting system. Example: {"verifyTotalAmount":100,"verifyTotalTax":6.25,"verifyTransactionDate":"2021-12-25T00:00:00+00:00"}

swagger:model VerifyTransactionModel

func (*VerifyTransactionModel) ContextValidate ¶ 

func (m *VerifyTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this verify transaction model based on context it is used

func (*VerifyTransactionModel) MarshalBinary ¶ 

func (m *VerifyTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VerifyTransactionModel) UnmarshalBinary ¶ 

func (m *VerifyTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VerifyTransactionModel) Validate ¶ 

func (m *VerifyTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this verify transaction model

type VoidTransactionModel ¶ 

type VoidTransactionModel struct {

	// Please specify the reason for voiding or cancelling this transaction.
	// To void the transaction, please specify the reason 'DocVoided'.
	// If you do not provide a reason, the void command will fail.
	// Example: Unspecified
	// Required: true
	// Enum: [Unspecified PostFailed DocDeleted DocVoided AdjustmentCancelled]
	Code *string `json:"code"`
}

VoidTransactionModel A request to void a previously created transaction Example: {"code":"DocVoided"}

swagger:model VoidTransactionModel

func (*VoidTransactionModel) ContextValidate ¶ 

func (m *VoidTransactionModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this void transaction model based on context it is used

func (*VoidTransactionModel) MarshalBinary ¶ 

func (m *VoidTransactionModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VoidTransactionModel) UnmarshalBinary ¶ 

func (m *VoidTransactionModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VoidTransactionModel) Validate ¶ 

func (m *VoidTransactionModel) Validate(formats strfmt.Registry) error

Validate validates this void transaction model

type WorksheetDocument ¶ 

type WorksheetDocument struct {

	// doc code
	DocCode string `json:"docCode,omitempty"`

	// doc date
	// Format: date-time
	DocDate strfmt.DateTime `json:"docDate,omitempty"`

	// lines
	Lines []*WorksheetDocumentLine `json:"lines"`

	// messages
	Messages []*Message `json:"messages"`

	// result code
	// Example: Success
	// Enum: [Success Warning Error Exception]
	ResultCode string `json:"resultCode,omitempty"`

	// total exempt
	TotalExempt float64 `json:"totalExempt,omitempty"`

	// total tax
	TotalTax float64 `json:"totalTax,omitempty"`

	// total taxable
	TotalTaxable float64 `json:"totalTaxable,omitempty"`

	// transaction Id
	TransactionID string `json:"transactionId,omitempty"`
}

WorksheetDocument worksheet document

swagger:model WorksheetDocument

func (*WorksheetDocument) ContextValidate ¶ 

func (m *WorksheetDocument) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this worksheet document based on the context it is used

func (*WorksheetDocument) MarshalBinary ¶ 

func (m *WorksheetDocument) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WorksheetDocument) UnmarshalBinary ¶ 

func (m *WorksheetDocument) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WorksheetDocument) Validate ¶ 

func (m *WorksheetDocument) Validate(formats strfmt.Registry) error

Validate validates this worksheet document

type WorksheetDocumentLine ¶ 

type WorksheetDocumentLine struct {

	// exempt amount
	ExemptAmount float64 `json:"exemptAmount,omitempty"`

	// line amount
	LineAmount float64 `json:"lineAmount,omitempty"`

	// line no
	LineNo string `json:"lineNo,omitempty"`

	// messages
	Messages []*Message `json:"messages"`

	// reporting date
	// Format: date-time
	ReportingDate strfmt.DateTime `json:"reportingDate,omitempty"`

	// result code
	// Example: Success
	// Enum: [Success Warning Error Exception]
	ResultCode string `json:"resultCode,omitempty"`

	// tax amount
	TaxAmount float64 `json:"taxAmount,omitempty"`

	// taxable amount
	TaxableAmount float64 `json:"taxableAmount,omitempty"`

	// transaction Id
	TransactionID string `json:"transactionId,omitempty"`
}

WorksheetDocumentLine worksheet document line

swagger:model WorksheetDocumentLine

func (*WorksheetDocumentLine) ContextValidate ¶ 

func (m *WorksheetDocumentLine) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this worksheet document line based on the context it is used

func (*WorksheetDocumentLine) MarshalBinary ¶ 

func (m *WorksheetDocumentLine) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WorksheetDocumentLine) UnmarshalBinary ¶ 

func (m *WorksheetDocumentLine) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WorksheetDocumentLine) Validate ¶ 

func (m *WorksheetDocumentLine) Validate(formats strfmt.Registry) error

Validate validates this worksheet document line

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.