ModelTaxes module

StripeTaxProvider

Class StripeTaxProvider

A model in the Taxes module, with 24 members for templates, 20 API properties and 28 members for admin templates.

Taxes\Models\Frontend\StripeTaxProvider Taxes\Models\Api\StripeTaxProvider Taxes\Models\Backend\StripeTaxProvider Also in Taxes: AvalaraProvider Category CategoryProviderCode Location MockTaxProvider Provider Rate Transaction Zone
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 23

Take no arguments.

# isSubmittingTaxes()
bool
# getResolvedAccountId()
?string
Resolves the connected Stripe account id to scope tax calls to. Uses the account configured on the provider when set; otherwise falls back to the connected account of the site's Stripe payment method so tax is calculated against the same registrations the payment settles to.
# getAccountId()
?string
Get the connected Stripe account id
# isTestMode()
bool
Get whether the test-mode Stripe environment should be used
# isSubmitDocuments()
bool
Get whether tax transactions should be recorded with Stripe for reporting
# getDefaultItemTaxCode()
string
Get the default Stripe tax code applied to items without a category mapping
# getShippingTaxCode()
string
Get the Stripe tax code applied to shipping lines
# 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 20

Read-only values on the record.

# submittingTaxes
bool
# resolvedAccountId
?string
Resolves the connected Stripe account id to scope tax calls to. Uses the account configured on the provider when set; otherwise falls back to the connected account of the site's Stripe payment method so tax is calculated against the same registrations the payment settles to.
# accountId
?string
Get the connected Stripe account id
# testMode
bool
Get whether the test-mode Stripe environment should be used
# submitDocuments
bool
Get whether tax transactions should be recorded with Stripe for reporting
# defaultItemTaxCode
string
Get the default Stripe tax code applied to items without a category mapping
# shippingTaxCode
string
Get the Stripe tax code applied to shipping lines
# 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 27

Take no arguments.

# isSubmittingTaxes()
bool
# getResolvedAccountId()
?string
Resolves the connected Stripe account id to scope tax calls to. Uses the account configured on the provider when set; otherwise falls back to the connected account of the site's Stripe payment method so tax is calculated against the same registrations the payment settles to.
# getAccountId()
?string
Get the connected Stripe account id
# isTestMode()
bool
Get whether the test-mode Stripe environment should be used
# isSubmitDocuments()
bool
Get whether tax transactions should be recorded with Stripe for reporting
# getDefaultItemTaxCode()
string
Get the default Stripe tax code applied to items without a category mapping
# getShippingTaxCode()
string
Get the Stripe tax code applied to shipping lines
# 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
# 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