Configuration API Fields
Learn about the fields in the O Series Tax Configuration APIs.
Configuration API fields
This table lists the fields included in the request body for O Series Tax Configuration API requests.
| Field | Details | Description |
|---|---|---|
adoptParentSetup | boolean | Adopt Parent Setup indicates that the current taxpayer entity inherits the tax exceptions of its parent taxpayer. Default: false |
categoryId | Required 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 |
city | string [ 0 .. 60 ] characters | The city name for the postal address. |
code (Taxability Driver) | Required string [ 1 .. 40 ] characters | External System identifier for the driver. |
code (Taxpayer) | Required string [ 1 .. 40 ] characters | External System identifier for the taxpayer. |
codevalue | Required string [ 1 .. 40 ] characters | Commodity code value |
country | string [ 0 .. 60 ] characters | The country name for the postal address. |
discountCategory | string (DiscountCategoryEnum) | Discount Category is used to select the default type of discount that is applied to all transactions for a given taxpayer. The discount categories are automatically mapped to taxability categories of the same name. These taxability categories specify the Vertex-defined basis rule and calculation rule to use for that discount category for a particular jurisdiction. Enum: - "GENERAL_DISCOUNT"- "CASH_DISCOUNT"- "MANUFACTURERS_COUPON"- "RETAILERS_COUPON"- "TRADE_DISCOUNT"- "QUANTITY_DISCOUNT"- "EARLY_PAYMENT_DISCOUNT"- "FLEXIBLE_DISCOUNT" |
discountMappings | Array of objects (DiscountMapping) | Collection of discount mappings Array [ - discountCategory- discountCode] |
driverType | string (DriverTypeEnum) | The taxability driver types. Enum: - "PRODUCT"- "PRODUCT_CLASS"- "USAGE"- "USAGE_CLASS" |
endDate (Locations) | string <date> | The date after which the location is no longer effective. |
endDate (Registrations) | string <date> | The date after which the registration is no longer effective. |
endDate (RegisteredJurisdiction) | string <date> | The date after which the jurisdiction is no longer effective. |
endDate (Taxability Driver) | string <date> | The date after which the taxability driver is no longer effective. |
endDate (Taxability Mapping) | string <date> | The date after which the taxability mapping is no longer effective. |
endDate (Taxpayer) | string <date> | The date after which the taxpayer is no longer effective. |
filingCurrencyIsoCode | string 3 characters | The ISO 4217 Alpha-3 code for the currency used for tax filing in the country of registration. This value is required for registration types UNION_SCHEME, NON_UNION_SCHEME, and IMPORT_ONE_STOP_SHOP. |
filingEntity | boolean | Indicates that the taxpayer is responsible for collecting and remitting taxes by filing tax returns. Default: true |
id (Locations) | 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} | location id Example: 123e4567-e89b-12d3-a456-426614174000 |
id (Registrations) | Required 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} | registration id Example: 123e4567-e89b-12d3-a456-426614174000 |
id (Taxability Category) | Required 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} | categoryIdExample: 123e4567-e89b-12d3-a456-426614174000 |
id (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} | driver id Example: 123e4567-e89b-12d3-a456-426614174000 |
id (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} | mapping id Example: 123e4567-e89b-12d3-a456-426614174000 |
id (Taxpayer) | Required 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} | taxpayer id Example: 123e4567-e89b-12d3-a456-426614174000 |
level | string (JurisdictionLevelEnum) | The level of the jurisdiction for which the tax on the line item is applied. Enum: - "COUNTRY"- "MAIN_DIVISION"- "SUB_DIVISION"- "CITY"- "DISTRICT" |
locationCode | Required string [ 1 .. 20 ] characters | A client specified code for the location. |
mainDivision | string [ 0 .. 60 ] characters | The main division (e.g. State) name for the postal address. |
mappedEntities | Required 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. Object: - taxpayerId- driverIds |
name (Locations) | Required string [ 1 .. 60 ] character | A client specified name for the location. |
name (Taxpayer) | Required string [ 1 .. 60 ] character | Full Name for the taxpayer. |
name (Taxability Driver) | Required string [ 1 .. 60 ] characters | Full Name for driver. |
name (RegisteredJurisdiction) | string | Jurisdiction Name or other identifier, such as a two letter State abbreviation. |
note | string [ 0 .. 1000 ] characters | A free-form text for additional driver or taxpayer information. |
owningPartyId | Required 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 |
owningPartyType | string (PartyTypeEnum) | The party types. Enum: - TAXPAYER- CUSTOMER- VENDOR- REGULATED_TAXPAYER- UNREGULATED_TAXPAYER |
owningTaxpayerId | Required 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 |
parentCountry | string | The country in which this jurisdiction resides. |
parentMainDivision | string | The main division of this jurisdiction, which is a State, Territory, or a similar main division of a country. |
parentTaxpayerId | Required 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 |
partyTypeId | integer | Type of taxpayer (1=Normal, 4=Regulated, 5=Unregulated) |
physicalPresence | boolean | True if the business entity has a physical location in the jurisdiction. Default: false |
postalAddress | object (PostalAddress) | Object: - city- country- mainDivision- postalCode- streetAddress1- streetAddress2- subDivision |
postalCode | string [ 0 .. 20 ] characters | The postal code for the postal address. |
registeredJurisdiction | 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. Object: - parentCountry- parentMainDivision- name- vertexJurisdictionId- type- level- startDate- endDate |
registrationCode | Required string [ 1 .. 20 ] characters | A tax authority specified identifier for the location. |
registrationNumber | string [ 0 .. 40 ] characters | A tax jurisdiction assigned number. Registration number is required for registration types UNION_SCHEME, NON_UNION_SCHEME, and IMPORT_ONE_STOP_SHOP. |
registrationType | string (RegistrationTypeEnum) | Registration Type indicates the category to which this registration belongs. Enum: - "VAT_REGISTRATION"- "FEDERAL_EMPLOYER_IDENTIFICATION_NUMBER"- "TAX_IDENTIFICATION_NUMBER"- "SOCIAL_SECURITY_NUMBER"- "BUSINESS_NUMBER"- "STATE_IDENTIFICATION_NUMBER"- "NON_UNION_SCHEME"- "UNION_SCHEME"- "IMPORT_ONE_STOP_SHOP" |
shippingTerms | string (ShippingTermsEnum) | Shipping Terms determine the point in a transaction at which title transfer of goods takes place, which impacts identification of the taxing jurisdiction. Enum: - "EXW"- "FCA"- "FAS"- "FOB"- "CFR"- "CIF"- "CPT"- "CIP"- "DAF"- "DES"- "DEQ"- "DDU"- "DDP"- "DAP"- "DAT"- "SUP"- "CUS"- "DPU" |
startDate (Taxability Driver) | string <date> | The date when the taxability driver becomes effective. |
startDate (Taxability Mapping) | string <date> | The date when the taxability mapping becomes effective |
startDate (Taxpayer) | Required string <date> | The date when the taxpayer becomes effective. |
startDate (Locations) | string <date> | The date when the location becomes effective. |
startDate (RegisteredJurisdiction) | string <date> | The date when the jurisdiction becomes effective. |
startDate (Registrations) | Required string <date> | The date when the registration becomes effective. |
taxAreaId | Required string | The distinct tax area identifier for the location. |
type (Commodity Code) | required string [ 1 .. 60 ] characters | Commodity code type |
type (RegisteredJurisdiction) | string (JurisdictionTypeEnum) | Identifies the common classification of a jurisdiction, based on its geopolitical or taxing context. Enum: - "APO"- "BOROUGH"- "CITY"- "COUNTRY"- "COUNTY"- "DISTRICT"- "FPO"- "LOCAL_IMPROVEMENT_DISTRICT"- "PARISH"- "PROVINCE"- "SPECIAL_PURPOSE_DISTRICT"- "STATE" "TERRITORY"- "TOWNSHIP"- "TRADE_BLOCK"- "TRANSIT_DISTRICT" |
postalAddres | Required object ( PostalAddres) | A postal address for a location. |
vertexJurisdictionId | integer <int64> | The Vertex-specific number that identifies a jurisdiction. |
Updated about 2 months ago