Tax Configuration Mandatory Fields

Learn about the mandatory fields for the O Series Tax Configuration APIs.

Tax Configuration API mandatory fields

In general, the id field is required to retrieve, update, or delete tax configurations, and additional, configuration-specific fields are required to create or update tax configurations.

Mandatory taxability category fields

The id field is required to retrieve a tax category by ID or to retrieve a tax category and all descendants by ID.

FieldRequestsDescription
idRetrieve a Taxability Category by ID

List Taxability Category Descendants
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

taxability category id

Mandatory commodity code fields

  • The type field is required to retrieve a list of commodity codes for a type.
  • The type and codevalue fields are required to retrieve commodity code mapping for a commodity code.
FieldRequestsDescription
typeList Commodity Codes for a Type

Retrieve Mapping for a Commodity Code
string ([ 1 .. 60 ] characters)

Commodity code type
codevalueRetrieve Mapping for a Commodity Code string ([ 1 .. 40 ] characters)

Commodity code value

Mandatory taxability driver fields

  • The id field is required to retrieve a taxability driver by ID, update a taxability driver, or delete a taxability driver.
  • The code, name, owningTaxpayerId, and startDate fields are required to create a taxability driver or to update a taxability driver.
FieldRequestsDescription
idRetrieve a Taxability Driver by ID

Update a Taxability Driver

Delete a Taxability Driver
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

driver id
codeCreate a Taxability Driver

Update a Taxability Driver
string ([ 1 .. 40 ] characters )

External System identifier for the driver
nameCreate a Taxability Driver string ([ 1 .. 60 ] characters)

Full Name for driver.
owningTaxpayerIdCreate a Taxability Driver

Update a Taxability Driver
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Stringified UUIDv4. See RFC 4112
startDateCreate a Taxability Driver

Update a Taxability Driver
string <date>

The date when the taxability driver becomes effective
nameUpdate a Taxability Driver string ([ 1 .. 60 ]characters)

Full name for driver.

Mandatory location fields

  • The id field is required to retrieve a location by ID, to update location configuration, or to delete a location.
  • The taxAreaId, locationCode, name, owningPartyId, postalAddress, registrationCode, and startDate fields are required to create locations or to update location configuration.
FieldRequestsDescription
idRetrieve a Location by ID

Update a Location

Delete a Location
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

location id
taxAreaIdCreate Locations

Update a Location
string

The distinct tax area identifier for the location
locationCodeCreate Locations

Update a Location
string ([ 1 .. 20 ] characters)

A client specified code for the location.
nameCreate Locations

Update a Location
string ([ 1 .. 60 ] characters)

A client specified name for the location.
owningPartyIdCreate Locations

Update a Location
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Stringified UUIDv4. See RFC 4112
postalAddressCreate Locations

Update a Location
object (PostalAddress)

A postal address for a location.
registrationCodeCreate Locations

Update a Location
string ([ 1 .. 20 ] characters)

A tax authority specified identifier for the location
startDateCreate Locations

Update a Location
string

The date when the location becomes effective

Mandatory mapping fields

  • The mappedEntities, categoryId, and startDate fields are required to create a taxability mapping.
  • The id field is required to retrieve a taxability mapping by ID or to delete a mapping.
FieldRequestsDescription
idRetrieve a Taxability Mapping by ID

Delete a Taxability Mapping
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

Mapping id
mappedEntitiesCreate a Taxability Mappingobject (MappedEntities)

The entities that can be mapped to a taxability category. You can map a taxpayer to a category, a taxability driver to a category, a taxpayer and a taxability driver to a category, or map different types of drivers to a category.
categoryIdCreate a Taxability Mapping string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Stringified UUIDv4. See RFC 4112
startDateCreate a Taxability Mapping string

The date when the taxability mapping becomes effective

Mandatory registration fields

  • The registeredJurisdiction, owningPartyId, and startDate fields are required to create registrations or to update registrations.
  • The id field is required to retrieve registrations by ID, to update registrations, or to delete registrations.
FieldRequestsDescription
idRetrieve a Registration by ID

Update a Registration

Delete a Registration
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

registration id
registeredJurisdictionCreate Registrations

Update a Registration
object (RegisteredJurisdiction)

Represents a government entity. The jurisdiction is best identified by the globally unique id property. Otherwise, jurisdictions provided on request will be matched based on the other properties that are available to the requester, such as name, country, and level. These must be sufficient to uniquely identify the jurisdiction.
owningPartyIdCreate Registrations

Update a Registration
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Stringified UUIDv4. See RFC 4112
startDateCreate Registrations

Update a Registration
string

The date when the registration becomes effective

Mandatory taxpayer fields

  • The code, name, and startDate fields are required to create a taxpayer or to update a taxpayer.
  • The id field is required to retrieve a taxpayer by ID or to update a taxpayer.
FieldRequestDescription
idRetrieve a Taxpayer by ID

Update a Taxpayer
string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

taxpayer id
codeCreate a Taxpayer

Update a Taxpayer
string ([ 1 .. 40 ] characters0)

External System identifier for the taxpayer.
nameCreate a Taxpayer

Update a Taxpayer
string ([ 1 .. 60 ] characters)

Full Name for the taxpayer.
startDateCreate a Taxpayer

Update a Taxpayer
string

The date when the taxpayer becomes effective