ZRM Docs
Domain Model

Tax Agency

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
namestringYesName
codestringNoCode
jurisdictionTypeenum(state, county, city, special_district)YesJurisdiction type
ratenumberYesRate
descriptionstringNoDescription
isActivebooleanYesIs active
taxableCategoriesstring[]YesTaxable categories
workspaceIdstringYesID of the associated workspace

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
namestringYesName
codestringNoCode
jurisdictionTypeenum(state, county, city, special_district)YesJurisdiction type
ratenumberYesRate
descriptionstringNoDescription
isActivebooleanYestrueIs active
taxableCategoriesstring[]Yes["material","subcontract","other"]Taxable categories
workspaceIdstringNoID of the associated workspace

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNoName
codestringNoCode
jurisdictionTypeenum(state, county, city, special_district)NoJurisdiction type
ratenumberNoRate
descriptionstringNoDescription
isActivebooleanNotrueIs active
taxableCategoriesstring[]No["material","subcontract","other"]Taxable categories

On this page