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 | string Example: taxability category id |
Mandatory commodity code fields
- The
typefield is required to retrieve a list of commodity codes for a type. - The
typeandcodevaluefields are required to retrieve commodity code mapping for a commodity code.
| Field | Requests | Description |
|---|---|---|
type | 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
idfield is required to retrieve a taxability driver by ID, update a taxability driver, or delete a taxability driver. - The
code,name,owningTaxpayerId, andstartDatefields are required to create a taxability driver or to update a taxability driver.
| Field | Requests | Description |
|---|---|---|
id | string Example: driver id | |
code | string ( External System identifier for the driver | |
name | Create a Taxability Driver | string ([ 1 .. 60 ] characters) Full Name for driver. |
owningTaxpayerId | string Stringified UUIDv4. See RFC 4112 | |
startDate | string The date when the taxability driver becomes effective | |
name | Update a Taxability Driver | string ( Full name for driver. |
Mandatory location fields
- The
idfield is required to retrieve a location by ID, to update location configuration, or to delete a location. - The
taxAreaId,locationCode,name,owningPartyId,postalAddress,registrationCode, andstartDatefields are required to create locations or to update location configuration.
| Field | Requests | Description |
|---|---|---|
id | string Example: location id | |
taxAreaId | string The distinct tax area identifier for the location | |
locationCode | string ([ 1 .. 20 ] characters) A client specified code for the location. | |
name | string ([ 1 .. 60 ] characters) A client specified name for the location. | |
owningPartyId | string Stringified UUIDv4. See RFC 4112 | |
postalAddress | object ( A postal address for a location. | |
registrationCode | string ([ 1 .. 20 ] characters) A tax authority specified identifier for the location | |
startDate | string <date> The date when the location becomes effective |
Mandatory mapping fields
- The
mappedEntities,categoryId, andstartDatefields are required to create a taxability mapping. - The
idfield is required to retrieve a taxability mapping by ID or to delete a mapping.
| Field | Requests | Description |
|---|---|---|
id | string Example: Mapping id | |
mappedEntities | Create a Taxability Mapping | object ( 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 Stringified UUIDv4. See RFC 4112 |
startDate | Create a Taxability Mapping | string <date> The date when the taxability mapping becomes effective |
Mandatory registration fields
- The
registeredJurisdiction,owningPartyId, andstartDatefields are required to create registrations or to update registrations. - The
idfield is required to retrieve registrations by ID, to update registrations, or to delete registrations.
| Field | Requests | Description |
|---|---|---|
id | string Example: registration id | |
registeredJurisdiction | object ( 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 | string Stringified UUIDv4. See RFC 4112 | |
startDate | string <date> The date when the registration becomes effective |
Mandatory taxpayer fields
- The
code,name, andstartDatefields are required to create a taxpayer or to update a taxpayer. - The
idfield is required to retrieve a taxpayer by ID or to update a taxpayer.
| Field | Request | Description |
|---|---|---|
id | string Example: taxpayer id | |
code | string ( External System identifier for the taxpayer. | |
name | string ( Full Name for the taxpayer. | |
startDate | string <date> The date when the taxpayer becomes effective |
Updated 15 days ago