☰ Browse the reference

Model·Taxes module

AvalaraProvider

Class AvalaraProvider

A model in the Taxes module, with 25 members for templates, 21 API properties and 31 members for admin templates.

Taxes\Models\Frontend\AvalaraProviderCopy Taxes\Models\Api\AvalaraProviderCopy Taxes\Models\Backend\AvalaraProviderCopy Also in Taxes: Category CategoryProviderCode Location MockTaxProvider Provider Rate StripeTaxProvider Transaction Zone

View

Templates25 API & Jobs21 Admin31

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 24

Take no arguments.

# isSubmittingTaxes()

bool

# getAccountId()

?string

Get the account id

# isSandboxEnvironment()

bool

Get if the sandbox environment should be used

# isSubmitDocuments()

bool

Get if the documents should be submitted to Avalara

# getShippingTaxCode()

string

Get the shipping tax code

# getDefaultItemTaxCode()

string

Get the default item tax code

# getCompanyCode()

?string

Get the company code

# isAddressValidationEnabled()

bool

Get if the address validation should be enabled

# isConnectionTestSupported()

bool

Does this provider support testing the connection

# isExternalProvider()

bool

Is this provider linked to an external service?

# getType()

string

Get the type of this provider

# getId()

?int

# getName()

?string

# getEntity()

?string

# isEnabled()

bool

# getCreated()

?DateTime

Date the record was created.

# getModified()

?DateTime

Last modification date for the record.

# getSite()

?Site

# getCategoryProviderCodes()

?Collection<CategoryProviderCode>

# getZones()

?Collection<Zone>

# getRates()

?Collection<Rate>

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned

Methods 1

Take arguments. The API serialises only getters that need none.

# getCategories(?array $criteria, string $sort, string $direction)

Collection

Helper that will fetch instances of Taxes\Models\Category through Taxes\Models\CategoryProviderCode

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 21

Read-only values on the record.

# submittingTaxes

bool

# accountId

?string

Get the account id

# sandboxEnvironment

bool

Get if the sandbox environment should be used

# submitDocuments

bool

Get if the documents should be submitted to Avalara

# shippingTaxCode

string

Get the shipping tax code

# defaultItemTaxCode

string

Get the default item tax code

# companyCode

?string

Get the company code

# addressValidationEnabled

bool

Get if the address validation should be enabled

# connectionTestSupported

bool

Does this provider support testing the connection

# externalProvider

bool

Is this provider linked to an external service?

# type

string

Get the type of this provider

# id

?int

# name

?string

# entity

?string

# enabled

bool

# created

?DateTime

Date the record was created.

# modified

?DateTime

Last modification date for the record.

# site

?Site

# categoryProviderCodes

?Collection<CategoryProviderCode>

# zones

?Collection<Zone>

# rates

?Collection<Rate>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 30

Take no arguments.

# getLicenseKey() Admin only

string

Get the license key

# isSubmittingTaxes()

bool

# getAccountId()

?string

Get the account id

# isSandboxEnvironment()

bool

Get if the sandbox environment should be used

# isSubmitDocuments()

bool

Get if the documents should be submitted to Avalara

# getShippingTaxCode()

string

Get the shipping tax code

# getDefaultItemTaxCode()

string

Get the default item tax code

# getCompanyCode()

?string

Get the company code

# isAddressValidationEnabled()

bool

Get if the address validation should be enabled

# isConnectionTestSupported()

bool

Does this provider support testing the connection

# isExternalProvider()

bool

Is this provider linked to an external service?

# getType()

string

Get the type of this provider

# getId()

?int

# getName()

?string

# getEntity()

?string

# isEnabled()

bool

# getCreated()

?DateTime

Date the record was created.

# getModified()

?DateTime

Last modification date for the record.

# getSite()

?Site

# getCategoryProviderCodes()

?Collection<CategoryProviderCode>

# getZones()

?Collection<Zone>

# getRates()

?Collection<Rate>

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned

# getAvailableCompanies() Admin only

array

Get a list of available companies

# getHateoasLinks() Admin only

array

Get the HATEOAS links for the record

# getEditUrl() Admin only

?string

Get the url for editing the record.

# getDeleteUrl() Admin only

?string

Get the url for deleting the record.

# getManageUrl() Admin only

?string

Get the url for managing records.

Methods 1

Take arguments. The API serialises only getters that need none.

# getCategories(?array $criteria, string $sort, string $direction)

Collection

Helper that will fetch instances of Taxes\Models\Category through Taxes\Models\CategoryProviderCode