Guides

Mandatory Fields Reference

Learn about the mandatory fields for O Series APIs.

About Mandatory fields

The O Series APIs, like all APIs, have mandatory fields that are required to send a successful request. If you do not complete these fields, the API returns an error that indicates that your request is incomplete. These are referred to as mandatory fields.

Schema Mandatory vs. Service Mandatory

Please note that the mandatory fields identified here are those fields mandatory to successfully complete a request using an O Series API. There are many values that may be required to successfully calculate tax, lookup a tax area, manage a transaction, or configure tax, many of which can vary based on jurisdiction, tax type, document type, or other criteria.

For details on the values required to successfully calculate tax or perform another function via the O Series APIs , see our O Series product documentation hosted on Vertex Community.

Mandatory field summaries

This table summarizes the mandatory fields for each O Series API.

Calculation, transaction, and lookup mandatory field summaries

APIRequestsSummary
Tax Calculation and Tax GISCalculateThe transactionType field is required for both Sales (Supplies) and Purchase (Procurement) requests.
Tax Calculation and Tax GISDelete, reverse, or check transactionThe id field is required to delete or reverse a transaction and the transactionid field is required to check a transaction.
Tax Calculation and Tax GISLookup tax areas

The postalAddress field is required to lookup a tax area by address.

The coordinates, latitude , and longitude fields are required to lookup a tax area by latitude and longitude.

The taxAreaId field is required to lookup a tax area by unique ID.

The externalJurisdictionCode and country fields are required to lookup a tax area by jurisdiction.

Tax Calculation and Tax GISTax area changes

The taxareaid field is required to check a tax area for changes.

The beginDate field is required to check a tax area for changes or to list all tax areas with changes.

See Tax Calculation and Tax GIS Mandatory Fields for details.

Tax configuration mandatory fields

APIRequestsSummary
Tax ConfigurationTax categoriesThe id field is required to retrieve a tax category by ID or to retrieve a tax category and all descendants by ID.
Tax ConfigurationCommodity code

The type field is required to retrieve a list of commodity codes by type.

The type and codevalue fields are required to retrieve commodity code mapping for a commodity code.

Tax ConfigurationTaxability driver

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.

Tax ConfigurationLocation

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.

Tax ConfigurationMapping

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.

Tax ConfigurationRegistration

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.

Tax ConfigurationTaxpayer

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, to update a taxpayer, or to delete a taxpayer.

See Tax Configuration Mandatory Fields for details.

User management mandatory field summaries

APIRequestSummary
User ManagementUsers

The partition and roles fields are required to create or update a user.

The uuid field is required to create a user, update a user, or retrieve a user by ID.

See User Management Mandatory Fields for details.