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.
Field | Requests | Description |
---|---|---|
id | Retrieve 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
andcodevalue
fields are required to retrieve commodity code mapping for a commodity code.
Field | Requests | Description |
---|---|---|
type | List Commodity Codes for a Type Retrieve Mapping for a Commodity Code | string ([ 1 .. 60 ] characters) Commodity code type |
codevalue | Retrieve 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
, andstartDate
fields are required to create a taxability driver or to update a taxability driver.
Field | Requests | Description |
---|---|---|
id | Retrieve 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 |
code | Create a Taxability Driver Update a Taxability Driver | string ([ 1 .. 40 ] characters )External System identifier for the driver |
name | Create a Taxability Driver | string ([ 1 .. 60 ] characters) Full Name for driver. |
owningTaxpayerId | Create 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 |
startDate | Create a Taxability Driver Update a Taxability Driver | string <date> The date when the taxability driver becomes effective |
name | Update 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
, andstartDate
fields are required to create locations or to update location configuration.
Field | Requests | Description |
---|---|---|
id | Retrieve 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 |
taxAreaId | Create Locations Update a Location | string The distinct tax area identifier for the location |
locationCode | Create Locations Update a Location | string ([ 1 .. 20 ] characters) A client specified code for the location. |
name | Create Locations Update a Location | string ([ 1 .. 60 ] characters) A client specified name for the location. |
owningPartyId | Create 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 |
postalAddress | Create Locations Update a Location | object (PostalAddress )A postal address for a location. |
registrationCode | Create Locations Update a Location | string ([ 1 .. 20 ] characters) A tax authority specified identifier for the location |
startDate | Create Locations Update a Location | string The date when the location becomes effective |
Mandatory mapping fields
- The
mappedEntities
,categoryId
, andstartDate
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.
Field | Requests | Description |
---|---|---|
id | Retrieve 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 |
mappedEntities | Create a Taxability Mapping | object (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. |
categoryId | Create 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 |
startDate | Create a Taxability Mapping | string The date when the taxability mapping becomes effective |
Mandatory registration fields
- The
registeredJurisdiction
,owningPartyId
, andstartDate
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.
Field | Requests | Description |
---|---|---|
id | Retrieve 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 |
registeredJurisdiction | Create 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. |
owningPartyId | Create 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 |
startDate | Create Registrations Update a Registration | string The date when the registration becomes effective |
Mandatory taxpayer fields
- The
code
,name
, andstartDate
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.
Field | Request | Description |
---|---|---|
id | Retrieve 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 |
code | Create a Taxpayer Update a Taxpayer | string ([ 1 .. 40 ] characters0 )External System identifier for the taxpayer. |
name | Create a Taxpayer Update a Taxpayer | string ([ 1 .. 60 ] characters )Full Name for the taxpayer. |
startDate | Create a Taxpayer Update a Taxpayer | string The date when the taxpayer becomes effective |
Updated 2 months ago