logo
API docs by Redocly

Tax Management (1.14)

Download OpenAPI specification:Download

Tax Management Concepts

The Tax Management API provides developers a way to calculate taxes for given features at the customer and/or service level.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the Tax Management API is up and running.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "isLicensed": true
}

Taxes

Resources related to taxes.

Calculate Taxes

Provides the ability to calculate taxes for given features.

The request must contain at least one jurisdiction that will be associated to the customer.

The customer must contain a list of features to tax or a service which has a list of features to tax.

A service must have a serviceReference which will link the service in the request with the taxes returned in the response.

Customer level taxes will be returned with a serviceReference value of 0.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
required
object (Customer)

A Customer object.

required
Array of objects (Jurisdiction)

A list of Jurisdiction objects.

The jurisdiction object information will be used to look up a specific tax jurisdiction. The jurisdictionReference value will be used to link a specific jurisdiction to a customer or service. Non-US states will not result in a specifc tax jurisdiction; only state and federal level taxes will be applied.

There are four different ways in which the jurisdiction object can be populated.

1) Using city, state, and county

If the city, state, and county of the address are known for the desired jurisdiction, populate these three fields. The jurisdiction(s) matching these will be used.

2) Using state and taxJurisdictionIDs

If the specific taxJurisdictionIDs (unique CostGuard identifiers) are already known, populate them directly, along with state.

3) Using state only

If only state-level (and any applicable federal-level) taxes are to be applied, populate only state.

4) Using city, state, and zipCode

Finally, if the county is not known directly, zipCode can be populated alongside city and state. This is the least-preferred method, because a unique county cannot always be determined. If an unqiue county cannot be determined, only one of the matching counties will be used.

taxActiveDate
string

When determining which taxes to apply, by default, taxes that are active for the current date will be used. If taxActiveDate is specified, though, taxes that are active on that date will be used instead.

Responses

Request samples

Content type
application/json
{
  • "customer": {
    },
  • "jurisdictions": [
    ],
  • "taxActiveDate": "2020-03-13"
}

Response samples

Content type
application/json
{
  • "taxes": [
    ]
}

Find Tax Jurisdictions

Provides the ability to find tax jurisdiction(s).

Note: Either zipCode or county must be provided in order to perform this operation. If both are provided, county will be used and zipCode will be ignored.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
city
required
string

The city in which to look to find matching tax jurisdiction(s).

county
string

The county in which to look to find matching tax jurisdiction(s). Required if zipCode is not specified.

state
required
string

The state (two-character) in which to look to find matching tax jurisdiction(s).

zipCode
string

The ZIP code to use to find matching tax jurisdiction(s). Required if county is not specified.

Note: Only five-digit ZIP codes are supported.

Responses

Request samples

Content type
application/json
{
  • "city": "Rochester",
  • "county": "Monroe",
  • "state": "NY",
  • "zipCode": "14607"
}

Response samples

Content type
application/json
[
  • {
    }
]

Release Notes

Release Notes 1.14

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.13

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.12

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.10

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.09

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

Release Notes 1.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01