Skip to main content

TaxRate

A tax rate.

type TaxRate {
calculationMethod: String
city: String
code: String!
country: String!
createdAt: DateTime!
deletedAt: DateTime
description: String
groupId: String
groupName: String
groupType: String
id: ID!
isActive: Boolean!
isDefault: Boolean!
jurisdiction: String!
maximumAmount: Float
minimumAmount: Float
name: String!
organizationId: String!
postalCode: String
rate: Float!
state: String
type: String!
updatedAt: DateTime!
validFrom: DateTime
validTo: DateTime
}

Fields​

TaxRate.calculationMethod ● String scalar​

How the tax is worked out against the price.

TaxRate.city ● String scalar​

The city the tax applies in.

TaxRate.code ● String! non-null scalar​

The code of the tax rate.

TaxRate.country ● String! non-null scalar​

The country the tax applies in.

TaxRate.createdAt ● DateTime! non-null scalar​

When the record was created.

TaxRate.deletedAt ● DateTime scalar​

When the record was deleted. Empty while the record is live.

TaxRate.description ● String scalar​

What the tax rate is for.

TaxRate.groupId ● String scalar​

ID of the tax group this rate belongs to

TaxRate.groupName ● String scalar​

Name of the tax group this rate belongs to

TaxRate.groupType ● String scalar​

Tax group type: INTRASTATE, INTERSTATE, or UNKNOWN

TaxRate.id ● ID! non-null scalar​

The unique ID of this record.

TaxRate.isActive ● Boolean! non-null scalar​

Whether the record is active.

TaxRate.isDefault ● Boolean! non-null scalar​

Whether this is the default.

TaxRate.jurisdiction ● String! non-null scalar​

The level the tax applies at.

TaxRate.maximumAmount ● Float scalar​

The largest amount the tax applies to.

TaxRate.minimumAmount ● Float scalar​

The smallest amount the tax applies to.

TaxRate.name ● String! non-null scalar​

The name of the tax rate.

TaxRate.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

TaxRate.postalCode ● String scalar​

The postal code the tax applies in.

TaxRate.rate ● Float! non-null scalar​

The rate, in percent.

TaxRate.state ● String scalar​

The state or region the tax applies in.

TaxRate.type ● String! non-null scalar​

The kind of tax.

TaxRate.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

TaxRate.validFrom ● DateTime scalar​

When the tax starts to apply.

TaxRate.validTo ● DateTime scalar​

When the tax stops applying.

Returned By​

createTaxRate mutation ● seedGlobalTaxRates mutation ● taxRate query ● taxRates query ● taxRatesByLocation query ● updateTaxRate mutation

Member Of​

Product object ● TaxGroupRate object