Avalara Property Tax API
The guide provides an inventory of GraphQL APIs for Avalara’s Property Tax offering, exposed through the Managed Returns API gateway.
Avalara Property Tax API is a standardized GraphQL-based solution for automating property tax compliance across U.S. jurisdictions. It spans the full lifecycle—property and asset records, valuation, return filing, assessment notices, appeals, and tax bill payment—so you can embed property tax workflows directly into your platform, leveraging Avalara’s infrastructure for accuracy, scale, and ease of integration.
API Endpoints
https://returns-api.avalara.com/graphql
Standard error response structure
This code sample shows the standard error response structure we use in Managed Returns API:
{
"data": {
"filingRequests": null
},
"errors": [
{
"message": "Authorization failed.",
"extensions": {
"code": 403,
"status": "Forbidden",
"type": "AuthorizationException",
"documentation": "Failed fetching filingRequests",
"timestamp": "2025-04-17T11:51:28.548Z",
"requestId": "3b48f1ce-2323-40d6-922e-c78fee021af4"
}
}
]
}
Error response structure has the following information:
message: This parameter shows a brief description of the error.extensions:code: Shows the HTTP error code. For example, 403.status: Shows the status of the error. For example, Forbidden, NotFound, InternalServerError and so on.type: Shows the type of error. For example, AuthorizationException, EntityNotFoundError, InvalidEntry, UnhandledException and so on.documentation: Shows the details explanation about the error.timestamp: Shows the exact time when the error occurred in ISO 8601 format.requestId: Shows the unique identifier of the request.
Queries
propertyTaxAppealFilingAccountTrackerStatuses
Description
Lists appeal filing account tracker statuses with filtering, sorting, and pagination.
Response
Returns a PropertyTaxAppealFilingAccountTrackerStatusCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAppealFilingAccountTrackerStatusFilterInput!
|
The filter criteria. |
order - [PropertyTaxAppealFilingAccountTrackerStatusSortInput!]
|
The sort order for the returned appeal filing account tracker statuses. |
Example
Query
query propertyTaxAppealFilingAccountTrackerStatuses(
$skip: Int,
$top: Int,
$filter: PropertyTaxAppealFilingAccountTrackerStatusFilterInput!,
$order: [PropertyTaxAppealFilingAccountTrackerStatusSortInput!]
) {
propertyTaxAppealFilingAccountTrackerStatuses(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
appealFilingAccountTrackerStatusId
appealFilingAccountId
trackerStatusId
trackerStatus {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
assignedUser {
firstName
lastName
email
}
trackerComment
trackerFollowupDate
createdBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 987,
"top": 123,
"filter": PropertyTaxAppealFilingAccountTrackerStatusFilterInput,
"order": [
PropertyTaxAppealFilingAccountTrackerStatusSortInput
]
}
Response
{
"data": {
"propertyTaxAppealFilingAccountTrackerStatuses": {
"pageInfo": PageInfo,
"items": [
PropertyTaxAppealFilingAccountTrackerStatus
]
}
}
}
propertyTaxAppraisalAccountTypes
Description
Lists all available appraisal account types.
Response
Example
Query
query propertyTaxAppraisalAccountTypes {
propertyTaxAppraisalAccountTypes {
appraisalAccountTypeId
appraisalAccountTypeName
isActive
}
}
Response
{
"data": {
"propertyTaxAppraisalAccountTypes": [
{
"appraisalAccountTypeId": 987,
"appraisalAccountTypeName": "xyz789",
"isActive": true
}
]
}
}
propertyTaxAppraisalFirmAssessors
Description
Lists appraisal firm assessor mappings with filtering, sorting, and pagination.
Response
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAppraisalFirmAssessorFilterInput!
|
The filter criteria. |
order - [PropertyTaxAppraisalFirmAssessorSortInput!]
|
The sort order for the returned appraisal firm assessors. |
Example
Query
query propertyTaxAppraisalFirmAssessors(
$skip: Int,
$top: Int,
$filter: PropertyTaxAppraisalFirmAssessorFilterInput!,
$order: [PropertyTaxAppraisalFirmAssessorSortInput!]
) {
propertyTaxAppraisalFirmAssessors(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
appraisalFirmAssessorId
appraisalFirmId
assessorId
appraisalAccountTypeId
taxYear
appraisalAccountType {
appraisalAccountTypeId
appraisalAccountTypeName
isActive
}
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxAppraisalFirmAssessorFilterInput,
"order": [PropertyTaxAppraisalFirmAssessorSortInput]
}
Response
{
"data": {
"propertyTaxAppraisalFirmAssessors": {
"pageInfo": PageInfo,
"items": [PropertyTaxAppraisalFirmAssessor]
}
}
}
propertyTaxAppraisalFirms
Description
Lists appraisal firms with filtering, sorting, and pagination.
Response
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAppraisalFirmFilterInput!
|
The filter criteria. |
order - [PropertyTaxAppraisalFirmSortInput!]
|
The sort order for the returned appraisal firms. |
Example
Query
query propertyTaxAppraisalFirms(
$skip: Int,
$top: Int,
$filter: PropertyTaxAppraisalFirmFilterInput!,
$order: [PropertyTaxAppraisalFirmSortInput!]
) {
propertyTaxAppraisalFirms(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
appraisalFirmId
appraisalFirmName
emailAddress
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
physicalAddress {
address1
address2
city
state
zipCode
title
name
}
mailingAddress {
address1
address2
city
state
zipCode
title
name
}
phoneMain
phoneFax
webPage
}
}
}
Variables
{
"skip": 123,
"top": 987,
"filter": PropertyTaxAppraisalFirmFilterInput,
"order": [PropertyTaxAppraisalFirmSortInput]
}
Response
{
"data": {
"propertyTaxAppraisalFirms": {
"pageInfo": PageInfo,
"items": [PropertyTaxAppraisalFirm]
}
}
}
propertyTaxAssessorAccountNoticeTrackerStatuses
Description
Lists assessor account notice tracker statuses with filtering, sorting, and pagination.
Response
Returns a PropertyTaxAssessorAccountNoticeTrackerStatusCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAssessorAccountNoticeTrackerStatusFilterInput!
|
The filter criteria. |
order - [PropertyTaxAssessorAccountNoticeTrackerStatusSortInput!]
|
The sort order for the returned assessor account notice tracker statuses. |
Example
Query
query propertyTaxAssessorAccountNoticeTrackerStatuses(
$skip: Int,
$top: Int,
$filter: PropertyTaxAssessorAccountNoticeTrackerStatusFilterInput!,
$order: [PropertyTaxAssessorAccountNoticeTrackerStatusSortInput!]
) {
propertyTaxAssessorAccountNoticeTrackerStatuses(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
assessorAccountNoticeTrackerStatusId
assessorAccountId
trackerStatusId
trackerStatus {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
assignedUser {
firstName
lastName
email
}
trackerComment
trackerFollowupDate
createdBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxAssessorAccountNoticeTrackerStatusFilterInput,
"order": [
PropertyTaxAssessorAccountNoticeTrackerStatusSortInput
]
}
Response
{
"data": {
"propertyTaxAssessorAccountNoticeTrackerStatuses": {
"pageInfo": PageInfo,
"items": [
PropertyTaxAssessorAccountNoticeTrackerStatus
]
}
}
}
propertyTaxAssessorAccountTrackerStatuses
Description
Lists assessor account tracker statuses with filtering, sorting, and pagination.
Response
Returns a PropertyTaxAssessorAccountTrackerStatusCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAssessorAccountTrackerStatusFilterInput!
|
The filter criteria. |
order - [PropertyTaxAssessorAccountTrackerStatusSortInput!]
|
The sort order for the returned assessor account tracker statuses. |
Example
Query
query propertyTaxAssessorAccountTrackerStatuses(
$skip: Int,
$top: Int,
$filter: PropertyTaxAssessorAccountTrackerStatusFilterInput!,
$order: [PropertyTaxAssessorAccountTrackerStatusSortInput!]
) {
propertyTaxAssessorAccountTrackerStatuses(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
assessorAccountTrackerStatusId
assessorAccountId
trackerStatusId
trackerStatus {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
assignedUser {
firstName
lastName
email
}
trackerComment
trackerFollowupDate
createdBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 987,
"top": 987,
"filter": PropertyTaxAssessorAccountTrackerStatusFilterInput,
"order": [
PropertyTaxAssessorAccountTrackerStatusSortInput
]
}
Response
{
"data": {
"propertyTaxAssessorAccountTrackerStatuses": {
"pageInfo": PageInfo,
"items": [PropertyTaxAssessorAccountTrackerStatus]
}
}
}
propertyTaxAssessorAccounts
Description
Lists assessor accounts with filtering, sorting, and pagination.
Response
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAssessorAccountFilterInput!
|
The filter criteria for assessor accounts. |
order - [PropertyTaxAssessorAccountSortInput!]
|
The sort order for the returned assessor accounts. |
Example
Query
query propertyTaxAssessorAccounts(
$skip: Int,
$top: Int,
$filter: PropertyTaxAssessorAccountFilterInput!,
$order: [PropertyTaxAssessorAccountSortInput!]
) {
propertyTaxAssessorAccounts(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
assessorAccountId
assessorAccountNumber
assessorAltRefNumber
assessorAccountName
assessor {
assessorId
assessorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
efileAddress
county
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
assessorAccountNoticeStatus {
assessorAccountNoticeStatusId
assessorAccountNoticeStatusName
isActive
}
assessorAccountReturnStatus {
assessorAccountReturnStatusId
assessorAccountReturnStatusName
isActive
}
assessorAccountExtensionStatus {
assessorAccountExtensionStatusId
assessorAccountExtensionStatusName
isActive
}
assessorAccountAppealStatus {
assessorAccountAppealStatusId
assessorAccountAppealStatusName
isActive
}
creationType {
creationTypeId
creationTypeName
isActive
}
appealDeadline
isAppealDeadlineInherited
returnDueDate
isReturnDueDateInherited
returnExtensionDeadline
isReturnExtensionDeadlineInherited
returnExtendedDeadline
isReturnExtendedDeadlineInherited
assessmentDate
totalRenderedValue
totalCost
opinionOfValue
assessmentRatio
isAssessmentRatioInheritedFlag
isActive
isMasterAccountFlag
isExemptedReturnsFlag
isDeletedReturnFlag
taxYear
section
township
range
taxingDistrictName
taxingDistrictNumber
notes
renditionNotes
createdDateTime
modifiedDateTime
userDefinedFieldValues {
label
description
dataType
fieldValue
}
properties {
propertyId
propertyNumber
propertyName
address1
city
state
zipCode
isActive
clientName
legalEntityName
propertyLocationTypeName
userDefinedFieldValues {
label
description
dataType
fieldValue
}
}
}
}
}
Variables
{
"skip": 987,
"top": 123,
"filter": PropertyTaxAssessorAccountFilterInput,
"order": [PropertyTaxAssessorAccountSortInput]
}
Response
{
"data": {
"propertyTaxAssessorAccounts": {
"pageInfo": PageInfo,
"items": [PropertyTaxAssessorAccount]
}
}
}
propertyTaxAssessors
Description
Lists assessors with filtering, sorting, and pagination.
Response
Returns a PropertyTaxAssessorCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxAssessorFilterInput!
|
The filter criteria. |
order - [PropertyTaxAssessorSortInput!]
|
The sort order for the returned assessors. |
Example
Query
query propertyTaxAssessors(
$skip: Int,
$top: Int,
$filter: PropertyTaxAssessorFilterInput!,
$order: [PropertyTaxAssessorSortInput!]
) {
propertyTaxAssessors(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
assessorId
assessorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
efileAddress
county
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
}
}
Variables
{
"skip": 987,
"top": 123,
"filter": PropertyTaxAssessorFilterInput,
"order": [PropertyTaxAssessorSortInput]
}
Response
{
"data": {
"propertyTaxAssessors": {
"pageInfo": PageInfo,
"items": [PropertyTaxAssessor]
}
}
}
propertyTaxClients
Description
Lists clients with filtering, sorting, and pagination.
Response
Returns a PropertyTaxClientCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxClientFilterInput!
|
The filter criteria for clients. |
order - [PropertyTaxClientSortInput!]
|
The sort order for the returned clients. |
Example
Query
query propertyTaxClients(
$skip: Int,
$top: Int,
$filter: PropertyTaxClientFilterInput!,
$order: [PropertyTaxClientSortInput!]
) {
propertyTaxClients(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
clientId
clientName
clientNumber
federalTaxId
isActive
industryClassificationId
fiscalYearStartDay
fiscalYearStartMonth
incorporationDate
incorporationStateProvinceCode
incorporationTypeId
thirdPartyPayrollSystemNumber
packageReturnAddressTypeId
officerClientContactId
signatoryClientContactId
isBudgetClient
isAllocationClient
isApClientCodeRequired
isApCostCenterRequired
accountManager {
firstName
lastName
email
}
ppManager {
firstName
lastName
email
}
reManager {
firstName
lastName
email
}
incorporationStateProvince {
stateProvinceCode
stateProvinceName
isActive
}
modifiedBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
userDefinedFieldValues {
label
description
dataType
fieldValue
}
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxClientFilterInput,
"order": [PropertyTaxClientSortInput]
}
Response
{
"data": {
"propertyTaxClients": {
"pageInfo": PageInfo,
"items": [PropertyTaxClient]
}
}
}
propertyTaxCollectorAccountTrackerStatuses
Description
Lists collector account tracker statuses with filtering, sorting, and pagination.
Response
Returns a PropertyTaxCollectorAccountTrackerStatusCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxCollectorAccountTrackerStatusFilterInput!
|
The filter criteria. |
order - [PropertyTaxCollectorAccountTrackerStatusSortInput!]
|
The sort order for the returned collector account tracker statuses. |
Example
Query
query propertyTaxCollectorAccountTrackerStatuses(
$skip: Int,
$top: Int,
$filter: PropertyTaxCollectorAccountTrackerStatusFilterInput!,
$order: [PropertyTaxCollectorAccountTrackerStatusSortInput!]
) {
propertyTaxCollectorAccountTrackerStatuses(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
collectorAccountTrackerStatusId
collectorAccountId
trackerStatusId
trackerStatus {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
assignedUser {
firstName
lastName
email
}
trackerComment
trackerFollowupDate
createdBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxCollectorAccountTrackerStatusFilterInput,
"order": [
PropertyTaxCollectorAccountTrackerStatusSortInput
]
}
Response
{
"data": {
"propertyTaxCollectorAccountTrackerStatuses": {
"pageInfo": PageInfo,
"items": [PropertyTaxCollectorAccountTrackerStatus]
}
}
}
propertyTaxCollectorAccounts
Description
Lists collector accounts with filtering, sorting, and pagination.
Response
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxCollectorAccountFilterInput!
|
The filter criteria for collector accounts. |
order - [PropertyTaxCollectorAccountSortInput!]
|
The sort order for the returned collector accounts. |
Example
Query
query propertyTaxCollectorAccounts(
$skip: Int,
$top: Int,
$filter: PropertyTaxCollectorAccountFilterInput!,
$order: [PropertyTaxCollectorAccountSortInput!]
) {
propertyTaxCollectorAccounts(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
collectorAccountId
taxYear
collectorAccountNumber
alternateCollectorAccountNumber
isActive
collector {
collectorId
collectorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
collectorTypeId
useGrossAmountFromImported
useGrossDueDateFromImported
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
creationType {
creationTypeId
creationTypeName
isActive
}
effectiveTaxRate
totalTaxableValue
upcomingInstallmentDeadlineDate
collectorUpcomingInstallmentDeadlineDate
inheritUpcomingDeadlineDateFlag
expectSupplementalDate
expectRefundDate
isPaidPrevious
isRecurringBillFlag
includesNonAdValoremFlag
createdDateTime
modifiedDateTime
assessorAccounts {
assessorAccountId
assessorAccountNumber
assessorAltRefNumber
assessorAccountName
assessor {
assessorId
assessorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
efileAddress
county
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
assessorAccountNoticeStatus {
assessorAccountNoticeStatusId
assessorAccountNoticeStatusName
isActive
}
assessorAccountReturnStatus {
assessorAccountReturnStatusId
assessorAccountReturnStatusName
isActive
}
assessorAccountExtensionStatus {
assessorAccountExtensionStatusId
assessorAccountExtensionStatusName
isActive
}
assessorAccountAppealStatus {
assessorAccountAppealStatusId
assessorAccountAppealStatusName
isActive
}
creationType {
creationTypeId
creationTypeName
isActive
}
appealDeadline
isAppealDeadlineInherited
returnDueDate
isReturnDueDateInherited
returnExtensionDeadline
isReturnExtensionDeadlineInherited
returnExtendedDeadline
isReturnExtendedDeadlineInherited
assessmentDate
totalRenderedValue
totalCost
opinionOfValue
assessmentRatio
isAssessmentRatioInheritedFlag
isActive
isMasterAccountFlag
isExemptedReturnsFlag
isDeletedReturnFlag
taxYear
section
township
range
taxingDistrictName
taxingDistrictNumber
notes
renditionNotes
createdDateTime
modifiedDateTime
userDefinedFieldValues {
label
description
dataType
fieldValue
}
properties {
propertyId
propertyNumber
propertyName
address1
city
state
zipCode
isActive
clientName
legalEntityName
propertyLocationTypeName
userDefinedFieldValues {
label
description
dataType
fieldValue
}
}
}
}
}
}
Variables
{
"skip": 987,
"top": 987,
"filter": PropertyTaxCollectorAccountFilterInput,
"order": [PropertyTaxCollectorAccountSortInput]
}
Response
{
"data": {
"propertyTaxCollectorAccounts": {
"pageInfo": PageInfo,
"items": [PropertyTaxCollectorAccount]
}
}
}
propertyTaxCollectorTypes
Description
Lists all available collector types.
Response
Returns [PropertyTaxCollectorType]
Example
Query
query propertyTaxCollectorTypes {
propertyTaxCollectorTypes {
collectorTypeId
collectorTypeName
isActive
}
}
Response
{
"data": {
"propertyTaxCollectorTypes": [
{
"collectorTypeId": 123,
"collectorTypeName": "abc123",
"isActive": false
}
]
}
}
propertyTaxCollectors
Description
Lists collectors with filtering, sorting, and pagination.
Response
Returns a PropertyTaxCollectorCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxCollectorFilterInput!
|
The filter criteria. |
order - [PropertyTaxCollectorSortInput!]
|
The sort order for the returned collectors. |
Example
Query
query propertyTaxCollectors(
$skip: Int,
$top: Int,
$filter: PropertyTaxCollectorFilterInput!,
$order: [PropertyTaxCollectorSortInput!]
) {
propertyTaxCollectors(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
collectorId
collectorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
collectorTypeId
useGrossAmountFromImported
useGrossDueDateFromImported
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
}
}
Variables
{
"skip": 987,
"top": 987,
"filter": PropertyTaxCollectorFilterInput,
"order": [PropertyTaxCollectorSortInput]
}
Response
{
"data": {
"propertyTaxCollectors": {
"pageInfo": PageInfo,
"items": [PropertyTaxCollector]
}
}
}
propertyTaxCompanyUserWorkGroups
Description
Lists company user work groups with filtering, sorting, and pagination.
Response
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxCompanyUserWorkGroupFilterInput!
|
The filter criteria. |
order - [PropertyTaxCompanyUserWorkGroupSortInput!]
|
The sort order for the returned company user work groups. |
Example
Query
query propertyTaxCompanyUserWorkGroups(
$skip: Int,
$top: Int,
$filter: PropertyTaxCompanyUserWorkGroupFilterInput!,
$order: [PropertyTaxCompanyUserWorkGroupSortInput!]
) {
propertyTaxCompanyUserWorkGroups(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
companyUserWorkGroupId
companyUserWorkGroupName
isActive
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 987,
"top": 987,
"filter": PropertyTaxCompanyUserWorkGroupFilterInput,
"order": [PropertyTaxCompanyUserWorkGroupSortInput]
}
Response
{
"data": {
"propertyTaxCompanyUserWorkGroups": {
"pageInfo": PageInfo,
"items": [PropertyTaxCompanyUserWorkGroup]
}
}
}
propertyTaxFixedAssets
Description
Lists fixed assets with filtering, sorting, and pagination.
Response
Returns a PropertyTaxFixedAssetCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxFixedAssetFilterInput!
|
The filter criteria for fixed assets. |
order - [PropertyTaxFixedAssetSortInput!]
|
The sort order for the returned fixed assets. |
Example
Query
query propertyTaxFixedAssets(
$skip: Int,
$top: Int,
$filter: PropertyTaxFixedAssetFilterInput!,
$order: [PropertyTaxFixedAssetSortInput!]
) {
propertyTaxFixedAssets(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
fixedAssetId
assetNumber
alternateAssetId
description
description2
acquisitionDate
taxYear
fiscalYear
originalCost
bookCost
rebookCost
ltdDepreciation
renderedValue
opinionOfValue
assessedNoticedValue
assetLocation
isTaxableFlag
isReportableFlag
isDisposalFlag
disposalDate
disposalAmount
disposalDescription
isAdditionFlag
additionDate
additionAmount
createdDateTime
modifiedDateTime
vehicle {
fixedAssetId
vehicleModel
vehicleMake
vehicleYear
vehicleVin
createdDateTime
modifiedDateTime
}
pipeline {
fixedAssetId
inServiceDate
pipelineMaterialId
pipelineUsageId
pipelineStatusId
pipelineCommodityId
pipelineQuantityUnitId
commodityGroup
pipelineIdentifier
operatorIdentifier
lineName
beginLatitude
endLatitude
beginLongitude
endLongitude
permitNumber
organizationNumber
ownerName
capacityVolume
actualVolume
throughput
createdDateTime
modifiedDateTime
}
leasedVehicle {
fixedAssetId
monthlyRent
vehicleNumber
vehicleModel
vehicleMake
vehicleYear
vehicleVin
lessorName
lessorAddress
leaseNumber
leaseType
leaseStartDate
leaseEndDate
createdDateTime
modifiedDateTime
}
leasedEquipment {
fixedAssetId
equipmentNumber
monthlyRent
lessorName
lessorAddress
leaseNumber
leaseType
leaseStartDate
leaseEndDate
createdDateTime
modifiedDateTime
}
compressor {
fixedAssetId
serialNumber
engine
cylinders
leaseLocation
leaseLegalDescription
createdDateTime
modifiedDateTime
}
inventory {
fixedAssetId
monthlyJanuaryCost
monthlyFebruaryCost
monthlyMarchCost
monthlyAprilCost
monthlyMayCost
monthlyJuneCost
monthlyJulyCost
monthlyAugustCost
monthlySeptemberCost
monthlyOctoberCost
monthlyNovemberCost
monthlyDecemberCost
assessmentDate
createdDateTime
modifiedDateTime
}
}
}
}
Variables
{
"skip": 987,
"top": 987,
"filter": PropertyTaxFixedAssetFilterInput,
"order": [PropertyTaxFixedAssetSortInput]
}
Response
{
"data": {
"propertyTaxFixedAssets": {
"pageInfo": PageInfo,
"items": [PropertyTaxFixedAsset]
}
}
}
propertyTaxJurisdictionTypes
Description
Lists all available jurisdiction types.
Response
Returns [PropertyTaxJurisdictionType]
Example
Query
query propertyTaxJurisdictionTypes {
propertyTaxJurisdictionTypes {
jurisdictionTypeId
jurisdictionTypeName
isActive
}
}
Response
{
"data": {
"propertyTaxJurisdictionTypes": [
{
"jurisdictionTypeId": 123,
"jurisdictionTypeName": "xyz789",
"isActive": true
}
]
}
}
propertyTaxJurisdictions
Description
Lists jurisdictions with filtering, sorting, and pagination.
Response
Returns a PropertyTaxJurisdictionCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxJurisdictionFilterInput!
|
The filter criteria for jurisdictions. |
order - [PropertyTaxJurisdictionSortInput!]
|
The sort order for the returned jurisdictions. |
Example
Query
query propertyTaxJurisdictions(
$skip: Int,
$top: Int,
$filter: PropertyTaxJurisdictionFilterInput!,
$order: [PropertyTaxJurisdictionSortInput!]
) {
propertyTaxJurisdictions(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
jurisdictionId
jurisdictionName
reportedName
internalCode
isAdValorem
isExemptionOffered
isAbatementOffered
fiscalYearStartDay
fiscalYearStartMonth
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
jurisdictionTypeId
jurisdictionType {
jurisdictionTypeId
jurisdictionTypeName
isActive
}
jurisdictionTaxRates {
jurisdictionTaxRateId
taxYear
taxRate
propertyTypeId
isDefaultFlag
createdDateTime
modifiedDateTime
}
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxJurisdictionFilterInput,
"order": [PropertyTaxJurisdictionSortInput]
}
Response
{
"data": {
"propertyTaxJurisdictions": {
"pageInfo": PageInfo,
"items": [PropertyTaxJurisdiction]
}
}
}
propertyTaxLegalEntities
Description
Lists legal entities with filtering, sorting, and pagination.
Response
Returns a PropertyTaxLegalEntityCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxLegalEntityFilterInput!
|
The filter criteria. |
order - [PropertyTaxLegalEntitySortInput!]
|
The sort order for the returned legal entities. |
Example
Query
query propertyTaxLegalEntities(
$skip: Int,
$top: Int,
$filter: PropertyTaxLegalEntityFilterInput!,
$order: [PropertyTaxLegalEntitySortInput!]
) {
propertyTaxLegalEntities(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
legalEntityId
parentLegalEntityId
clientId
clientName
legalEntityName
legalEntityNumber
federalTaxId
isActive
industryClassificationId
fiscalYearStartDay
fiscalYearStartMonth
incorporationDate
incorporationStateProvinceCode
incorporationTypeId
thirdPartyPayrollSystemNumber
packageReturnAddressTypeId
officerClientContactId
signatoryClientContactId
accountManager {
firstName
lastName
email
}
ppManager {
firstName
lastName
email
}
reManager {
firstName
lastName
email
}
incorporationStateProvince {
stateProvinceCode
stateProvinceName
isActive
}
modifiedBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
userDefinedFieldValues {
label
description
dataType
fieldValue
}
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxLegalEntityFilterInput,
"order": [PropertyTaxLegalEntitySortInput]
}
Response
{
"data": {
"propertyTaxLegalEntities": {
"pageInfo": PageInfo,
"items": [PropertyTaxLegalEntity]
}
}
}
propertyTaxPPNotices
Description
Lists personal property notices with filtering, sorting, and pagination.
Response
Returns a PropertyTaxPPNoticeCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxPPNoticeFilterInput!
|
The filter criteria for personal property notices. |
order - [PropertyTaxPPNoticeSortInput!]
|
The sort order for the returned p p notices. |
Example
Query
query propertyTaxPPNotices(
$skip: Int,
$top: Int,
$filter: PropertyTaxPPNoticeFilterInput!,
$order: [PropertyTaxPPNoticeSortInput!]
) {
propertyTaxPPNotices(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
ppNoticeId
assessorAccountId
createdDateTime
modifiedDateTime
assessorAccountNumber
taxYear
isNewRevisedNotice
noticeFinalizedDateTime
appealDeadline
isActive
totalRenderedValue
opinionOfValue
totalCost
noticeStatus {
assessorAccountNoticeStatusId
assessorAccountNoticeStatusName
isActive
}
assessorAccountType {
assessorAccountTypeId
assessorAccountTypeName
shortName
isActive
}
subAssessorAccountType {
subAssessorAccountTypeId
subAssessorAccountTypeName
shortName
isActive
}
assessor {
assessorId
assessorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
efileAddress
county
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
noticeTrackerStatuses {
assessorAccountNoticeTrackerStatusId
assessorAccountId
trackerStatusId
trackerStatus {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
assignedUser {
firstName
lastName
email
}
trackerComment
trackerFollowupDate
createdBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
}
ppNoticeDetails {
ppNoticeDetailId
ppNoticeId
noticeDetailRevisionTypeId
ppNoticeDetailDescription
ppNoticeDetailDate
isBenchmarkFlag
isFinalFlag
isLatestAssessorResponseFlag
isOriginalFlag
isTargetFlag
isTaxableValueOverrideFlag
expectedValueFactor
countyValue
schoolValue
noticedExpectedTaxAmount
createdDateTime
modifiedDateTime
ppNoticeDetailValues {
ppNoticeDetailValueId
ppNoticeDetailId
ppNoticeDetailValueType {
ppNoticeDetailValueTypeId
ppNoticeDetailValueTypeName
isActive
}
noticedValue
exemptionValue
abatementValue
otherValue
adjustedTotalValue
createdDateTime
modifiedDateTime
}
}
}
}
}
Variables
{
"skip": 987,
"top": 123,
"filter": PropertyTaxPPNoticeFilterInput,
"order": [PropertyTaxPPNoticeSortInput]
}
Response
{
"data": {
"propertyTaxPPNotices": {
"pageInfo": PageInfo,
"items": [PropertyTaxPPNotice]
}
}
}
propertyTaxProperties
Description
Lists properties with filtering, sorting, and pagination.
Response
Returns a PropertyTaxPropertyCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxPropertyFilterInput!
|
The filter criteria for properties. |
order - [PropertyTaxPropertySortInput!]
|
The sort order for the returned properties. |
Example
Query
query propertyTaxProperties(
$skip: Int,
$top: Int,
$filter: PropertyTaxPropertyFilterInput!,
$order: [PropertyTaxPropertySortInput!]
) {
propertyTaxProperties(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
propertyId
propertyNumber
propertyName
address1
city
state
zipCode
isActive
clientName
legalEntityName
propertyLocationTypeName
userDefinedFieldValues {
label
description
dataType
fieldValue
}
}
}
}
Variables
{
"skip": 123,
"top": 123,
"filter": PropertyTaxPropertyFilterInput,
"order": [PropertyTaxPropertySortInput]
}
Response
{
"data": {
"propertyTaxProperties": {
"pageInfo": PageInfo,
"items": [PropertyTaxProperty]
}
}
}
propertyTaxRENotices
Description
Lists real estate notices with filtering, sorting, and pagination.
Response
Returns a PropertyTaxRENoticeCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxRENoticeFilterInput!
|
The filter criteria for real estate notices. |
order - [PropertyTaxRENoticeSortInput!]
|
The sort order for the returned r e notices. |
Example
Query
query propertyTaxRENotices(
$skip: Int,
$top: Int,
$filter: PropertyTaxRENoticeFilterInput!,
$order: [PropertyTaxRENoticeSortInput!]
) {
propertyTaxRENotices(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
reNoticeId
assessorAccountId
createdDateTime
modifiedDateTime
assessorAccountNumber
taxYear
isNewRevisedNotice
noticeFinalizedDateTime
appealDeadline
isActive
totalRenderedValue
opinionOfValue
totalCost
noticeStatus {
assessorAccountNoticeStatusId
assessorAccountNoticeStatusName
isActive
}
assessorAccountType {
assessorAccountTypeId
assessorAccountTypeName
shortName
isActive
}
subAssessorAccountType {
subAssessorAccountTypeId
subAssessorAccountTypeName
shortName
isActive
}
assessor {
assessorId
assessorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
efileAddress
county
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
noticeTrackerStatuses {
assessorAccountNoticeTrackerStatusId
assessorAccountId
trackerStatusId
trackerStatus {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
assignedUser {
firstName
lastName
email
}
trackerComment
trackerFollowupDate
createdBy {
firstName
lastName
email
}
createdDateTime
modifiedDateTime
}
reNoticeDetails {
reNoticeDetailId
reNoticeId
noticeDetailRevisionTypeId
reNoticeDetailDescription
reNoticeDetailDate
isBenchmarkFlag
isFinalFlag
isLatestAssessorResponseFlag
isOriginalFlag
isTargetFlag
isTaxableValueOverrideFlag
isClassBreakdownEnabledFlag
expectedValueFactor
countyValue
schoolValue
noticedExpectedTaxAmount
createdDateTime
modifiedDateTime
reNoticeDetailValues {
reNoticeDetailValueId
reNoticeDetailId
reNoticeDetailValueType {
reNoticeDetailValueTypeId
reNoticeDetailValueTypeName
isActive
}
landValue
buildingValue
miscValue
landExemptionValue
landAbatementValue
landOtherValue
buildingExemptionValue
buildingAbatementValue
buildingOtherValue
miscExemptionValue
miscAbatementValue
miscOtherValue
adjustedTotalValue
createdDateTime
modifiedDateTime
}
reNoticeDetailClassValues {
reNoticeDetailClassValueId
reNoticeDetailId
propertyClass {
propertyClassId
propertyClassName
isActive
}
reNoticeDetailValueType {
reNoticeDetailValueTypeId
reNoticeDetailValueTypeName
isActive
}
landValue
buildingValue
miscValue
landExemptionValue
landAbatementValue
landOtherValue
buildingExemptionValue
buildingAbatementValue
buildingOtherValue
miscExemptionValue
miscAbatementValue
miscOtherValue
adjustedTotalValue
createdDateTime
modifiedDateTime
}
}
}
}
}
Variables
{
"skip": 123,
"top": 987,
"filter": PropertyTaxRENoticeFilterInput,
"order": [PropertyTaxRENoticeSortInput]
}
Response
{
"data": {
"propertyTaxRENotices": {
"pageInfo": PageInfo,
"items": [PropertyTaxRENotice]
}
}
}
propertyTaxStateProvinces
Description
Lists all available state and province codes.
Response
Returns [PropertyTaxStateProvince]
Example
Query
query propertyTaxStateProvinces {
propertyTaxStateProvinces {
stateProvinceCode
stateProvinceName
isActive
}
}
Response
{
"data": {
"propertyTaxStateProvinces": [
{
"stateProvinceCode": "abc123",
"stateProvinceName": "xyz789",
"isActive": true
}
]
}
}
propertyTaxSystemEntityTypes
Description
Lists all available system entity types.
Response
Returns [PropertyTaxSystemEntityType]
Example
Query
query propertyTaxSystemEntityTypes {
propertyTaxSystemEntityTypes {
systemEntityTypeId
systemEntityTypeName
isActive
}
}
Response
{
"data": {
"propertyTaxSystemEntityTypes": [
{
"systemEntityTypeId": 123,
"systemEntityTypeName": "xyz789",
"isActive": false
}
]
}
}
propertyTaxTaxBills
Description
Lists property tax bills with filtering, sorting, and pagination.
Response
Returns a PropertyTaxTaxBillCollectionSegment
Arguments
| Name | Description |
|---|---|
skip - Int
|
The number of records to skip before returning results. |
top - Int
|
The maximum number of records to return. |
filter - PropertyTaxTaxBillFilterInput!
|
The filter criteria for tax bills. |
order - [PropertyTaxTaxBillSortInput!]
|
The sort order for the returned tax bills. |
Example
Query
query propertyTaxTaxBills(
$skip: Int,
$top: Int,
$filter: PropertyTaxTaxBillFilterInput!,
$order: [PropertyTaxTaxBillSortInput!]
) {
propertyTaxTaxBills(
skip: $skip,
top: $top,
filter: $filter,
order: $order
) {
pageInfo {
totalRecords
top
skip
hasNextPage
hasPreviousPage
}
items {
taxBillId
otherTitle
otherName
otherAddress1
otherAddress2
otherCity
otherStateProvinceCode
otherZipCode
otherZipCodeExtension
taxYear
collectorAccountNumber
collectorName
state
isActive
taxBillStatus {
collectorAccountTaxBillStatusId
collectorAccountTaxBillStatusName
isActive
}
billName {
collectorAccountTypeId
collectorAccountTypeName
isActive
}
collectorAccount {
collectorAccountId
taxYear
collectorAccountNumber
alternateCollectorAccountNumber
isActive
collector {
collectorId
collectorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
collectorTypeId
useGrossAmountFromImported
useGrossDueDateFromImported
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
creationType {
creationTypeId
creationTypeName
isActive
}
effectiveTaxRate
totalTaxableValue
upcomingInstallmentDeadlineDate
collectorUpcomingInstallmentDeadlineDate
inheritUpcomingDeadlineDateFlag
expectSupplementalDate
expectRefundDate
isPaidPrevious
isRecurringBillFlag
includesNonAdValoremFlag
createdDateTime
modifiedDateTime
assessorAccounts {
assessorAccountId
assessorAccountNumber
assessorAltRefNumber
assessorAccountName
assessor {
assessorId
assessorName
stateProvinceCode
stateProvince {
stateProvinceCode
stateProvinceName
isActive
}
isStateEntity
emailAddress
efileAddress
county
isActive
createdDateTime
modifiedDateTime
modifiedBy {
firstName
lastName
email
}
}
assessorAccountNoticeStatus {
assessorAccountNoticeStatusId
assessorAccountNoticeStatusName
isActive
}
assessorAccountReturnStatus {
assessorAccountReturnStatusId
assessorAccountReturnStatusName
isActive
}
assessorAccountExtensionStatus {
assessorAccountExtensionStatusId
assessorAccountExtensionStatusName
isActive
}
assessorAccountAppealStatus {
assessorAccountAppealStatusId
assessorAccountAppealStatusName
isActive
}
creationType {
creationTypeId
creationTypeName
isActive
}
appealDeadline
isAppealDeadlineInherited
returnDueDate
isReturnDueDateInherited
returnExtensionDeadline
isReturnExtensionDeadlineInherited
returnExtendedDeadline
isReturnExtendedDeadlineInherited
assessmentDate
totalRenderedValue
totalCost
opinionOfValue
assessmentRatio
isAssessmentRatioInheritedFlag
isActive
isMasterAccountFlag
isExemptedReturnsFlag
isDeletedReturnFlag
taxYear
section
township
range
taxingDistrictName
taxingDistrictNumber
notes
renditionNotes
createdDateTime
modifiedDateTime
userDefinedFieldValues {
label
description
dataType
fieldValue
}
properties {
propertyId
propertyNumber
propertyName
address1
city
state
zipCode
isActive
clientName
legalEntityName
propertyLocationTypeName
userDefinedFieldValues {
label
description
dataType
fieldValue
}
}
}
}
taxBillDetails {
taxBillDetailId
grossTaxAmount
prepaidTaxAmount
discountAmount
otherAdjustmentAmount
penaltyAmount
penaltyInterestAmount
originalBillPenaltyAmount
netTaxAmount
taxableValue
approvedTaxableValue
approvedDateTime
validatedDateTime
rejectedDateTime
rejectedDescription
exemptDateTime
isRushFlag
systemGeneratedVoucherNumber
resetToPendingReason
resetToPendingDateTime
detailType {
taxBillDetailTypeId
taxBillDetailTypeName
isActive
}
detailStatus {
taxBillStatusId
taxBillStatusName
isActive
}
rejectedReason {
taxBillRejectedReasonId
taxBillRejectedReasonName
isActive
}
taxBillDetailInstallments {
taxBillDetailInstallmentId
billAmount
isPaidFlag
checkRequestDate
rejectNotes
installmentStatus {
taxBillInstallmentStatusId
taxBillInstallmentStatusName
isActive
}
createdDateTime
modifiedDateTime
}
createdDateTime
modifiedDateTime
}
taxBillInstallments {
taxBillInstallmentId
taxBillDueDate
totalInstallmentAmount
installmentSequenceNumber
isApprovedFlag
invoiceDate
taxBillInstallmentRemarks
title
name
address1
address2
city
stateProvinceCode
zipCode
zipCodeExtension
addressType {
taxBillInstallmentAddressTypeId
taxBillInstallmentAddressTypeName
isActive
}
createdDateTime
modifiedDateTime
}
taxBillRefunds {
taxBillRefundId
refundDate
refundValueAmount
refundTaxAmount
refundInterestAmount
refundExplanationNotes
createdDateTime
modifiedDateTime
}
createdDateTime
modifiedDateTime
}
}
}
Variables
{
"skip": 123,
"top": 987,
"filter": PropertyTaxTaxBillFilterInput,
"order": [PropertyTaxTaxBillSortInput]
}
Response
{
"data": {
"propertyTaxTaxBills": {
"pageInfo": PageInfo,
"items": [PropertyTaxTaxBill]
}
}
}
propertyTaxTrackerStatuses
Description
Lists all available tracker statuses.
Response
Returns [PropertyTaxTrackerStatus]
Example
Query
query propertyTaxTrackerStatuses {
propertyTaxTrackerStatuses {
trackerStatusId
trackerStatusAreaId
statusGroup
statusName
statusDescription
isActive
}
}
Response
{
"data": {
"propertyTaxTrackerStatuses": [
{
"trackerStatusId": 123,
"trackerStatusAreaId": 123,
"statusGroup": "xyz789",
"statusName": "abc123",
"statusDescription": "abc123",
"isActive": false
}
]
}
}
Types
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
DateTime
Description
A date-time string, not necessarily in ISO 8601 format, used to represent a combined date and time value.
Example
"2007-12-03T10:15:30Z"
DateTimeISO
Description
A date-time string in ISO 8601 format, such as 2007-12-03T10:15:30Z, specifically serialized as an ISO string.
Example
"2007-12-03T10:15:30Z"
Decimal
Description
Represents a decimal floating-point number.
Example
Decimal
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
PageInfo
Example
{
"totalRecords": 987,
"top": 987,
"skip": 123,
"hasNextPage": false,
"hasPreviousPage": false
}
PropertyTaxAppealFilingAccountTrackerStatus
Description
Represents an appeal filing account tracker status entry.
Fields
| Field Name | Description |
|---|---|
appealFilingAccountTrackerStatusId - Int!
|
The ID of the appeal filing account tracker status. |
appealFilingAccountId - Int!
|
The appeal filing account ID. |
trackerStatusId - Int!
|
The tracker status ID. |
trackerStatus - PropertyTaxTrackerStatus
|
The tracker status reference. |
assignedUser - PropertyTaxCompanyUser
|
The user assigned to this tracker item. |
trackerComment - String
|
Optional comment for this tracker entry. |
trackerFollowupDate - DateTimeISO
|
Optional follow-up date. |
createdBy - PropertyTaxCompanyUser
|
The user who created this tracker entry. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"appealFilingAccountTrackerStatusId": 987,
"appealFilingAccountId": 987,
"trackerStatusId": 987,
"trackerStatus": PropertyTaxTrackerStatus,
"assignedUser": PropertyTaxCompanyUser,
"trackerComment": "abc123",
"trackerFollowupDate": "2007-12-03T10:15:30Z",
"createdBy": PropertyTaxCompanyUser,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxAppealFilingAccountTrackerStatusCollectionSegment
Description
A paginated collection of appeal filing account tracker status records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAppealFilingAccountTrackerStatus]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAppealFilingAccountTrackerStatus]
}
PropertyTaxAppealFilingAccountTrackerStatusFilterInput
Description
Filter criteria for querying appeal filing account tracker statuses.
Fields
| Input Field | Description |
|---|---|
appealFilingAccountTrackerStatusIds - [Int!]
|
Restrict results to tracker statuses with any of these IDs. |
trackerFollowupDateFrom - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or after this date. |
trackerFollowupDateTo - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or before this date. |
createdDateTimeFrom - DateTimeISO
|
Filter to tracker statuses created on or after this date. |
createdDateTimeTo - DateTimeISO
|
Filter to tracker statuses created on or before this date. |
Example
{
"appealFilingAccountTrackerStatusIds": [123],
"trackerFollowupDateFrom": "2007-12-03T10:15:30Z",
"trackerFollowupDateTo": "2007-12-03T10:15:30Z",
"createdDateTimeFrom": "2007-12-03T10:15:30Z",
"createdDateTimeTo": "2007-12-03T10:15:30Z"
}
PropertyTaxAppealFilingAccountTrackerStatusSortInput
Description
Sort options for querying appeal filing account tracker statuses.
Fields
| Input Field | Description |
|---|---|
trackerFollowupDate - SortEnumType
|
Sort by follow-up date. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"trackerFollowupDate": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxAppraisalAccountType
Description
Represents an appraisal account type (lookup).
Example
{
"appraisalAccountTypeId": 123,
"appraisalAccountTypeName": "xyz789",
"isActive": true
}
PropertyTaxAppraisalFirm
Description
Represents an appraisal firm.
Fields
| Field Name | Description |
|---|---|
appraisalFirmId - Int!
|
The ID of the appraisal firm. |
appraisalFirmName - String
|
The name of the appraisal firm. |
emailAddress - String
|
The appraisal firm's email address. |
isActive - Boolean!
|
Indicates whether the appraisal firm is active. |
createdDateTime - DateTimeISO
|
The date and time when the appraisal firm was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the appraisal firm was last modified (UTC). |
modifiedBy - PropertyTaxCompanyUser
|
The user who last modified this appraisal firm. |
physicalAddress - PropertyTaxTaxingAuthorityAddress
|
The physical address of the appraisal firm. |
mailingAddress - PropertyTaxTaxingAuthorityAddress
|
The mailing address of the appraisal firm. |
phoneMain - String
|
The main phone number of the appraisal firm. |
phoneFax - String
|
The fax phone number of the appraisal firm. |
webPage - String
|
The web page URL of the appraisal firm. |
Example
{
"appraisalFirmId": 123,
"appraisalFirmName": "abc123",
"emailAddress": "abc123",
"isActive": false,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"modifiedBy": PropertyTaxCompanyUser,
"physicalAddress": PropertyTaxTaxingAuthorityAddress,
"mailingAddress": PropertyTaxTaxingAuthorityAddress,
"phoneMain": "abc123",
"phoneFax": "xyz789",
"webPage": "xyz789"
}
PropertyTaxAppraisalFirmAssessor
Description
Represents an appraisal firm assessor mapping.
Fields
| Field Name | Description |
|---|---|
appraisalFirmAssessorId - Int!
|
The ID of the appraisal firm assessor mapping. |
appraisalFirmId - Int!
|
The ID of the appraisal firm. |
assessorId - Int!
|
The ID of the assessor. |
appraisalAccountTypeId - Int!
|
The ID of the appraisal account type. |
taxYear - Int!
|
The tax year for this mapping. |
appraisalAccountType - PropertyTaxAppraisalAccountType
|
The appraisal account type. |
createdDateTime - DateTimeISO
|
The date and time when the mapping was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the mapping was last modified (UTC). |
Example
{
"appraisalFirmAssessorId": 123,
"appraisalFirmId": 123,
"assessorId": 123,
"appraisalAccountTypeId": 123,
"taxYear": 123,
"appraisalAccountType": PropertyTaxAppraisalAccountType,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxAppraisalFirmAssessorCollectionSegment
Description
A paginated collection of appraisal firm assessor records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAppraisalFirmAssessor]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAppraisalFirmAssessor]
}
PropertyTaxAppraisalFirmAssessorFilterInput
Description
Filter criteria for querying appraisal firm assessor mappings.
Fields
| Input Field | Description |
|---|---|
appraisalFirmAssessorIds - [Int!]
|
Restrict results to mappings with any of these IDs. |
appraisalFirmIds - [Int!]
|
Restrict results to any of these appraisal firms. |
assessorIds - [Int!]
|
Restrict results to any of these assessors. |
appraisalAccountTypeIds - [Int!]
|
Restrict results to any of these appraisal account types. |
taxYear - Int
|
Filter by tax year. |
Example
{
"appraisalFirmAssessorIds": [987],
"appraisalFirmIds": [123],
"assessorIds": [987],
"appraisalAccountTypeIds": [987],
"taxYear": 123
}
PropertyTaxAppraisalFirmAssessorSortInput
Description
Sort options for querying appraisal firm assessor mappings.
Fields
| Input Field | Description |
|---|---|
taxYear - SortEnumType
|
Sort by tax year. |
appraisalFirmId - SortEnumType
|
Sort by appraisal firm ID. |
assessorId - SortEnumType
|
Sort by assessor ID. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"taxYear": "ASC",
"appraisalFirmId": "ASC",
"assessorId": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxAppraisalFirmCollectionSegment
Description
A paginated collection of appraisal firm records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAppraisalFirm]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAppraisalFirm]
}
PropertyTaxAppraisalFirmFilterInput
Description
Filter criteria for querying appraisal firms.
Fields
| Input Field | Description |
|---|---|
appraisalFirmIds - [Int!]
|
Restrict results to records with any of these IDs. |
appraisalFirmName - PropertyTaxStringOperationInput
|
The filter criteria for the appraisal firm name. |
isActive - Boolean
|
Filter by active status. |
Example
{
"appraisalFirmIds": [987],
"appraisalFirmName": PropertyTaxStringOperationInput,
"isActive": false
}
PropertyTaxAppraisalFirmSortInput
Description
Sort options for querying appraisal firms.
Fields
| Input Field | Description |
|---|---|
appraisalFirmName - SortEnumType
|
Sort by appraisal firm name. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"appraisalFirmName": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxAssessor
Description
Represents a property tax assessor.
Fields
| Field Name | Description |
|---|---|
assessorId - Int!
|
The ID of the assessor. |
assessorName - String
|
The name of the assessor. |
stateProvinceCode - String
|
The state or province code. |
stateProvince - PropertyTaxStateProvince
|
The state or province reference (code + name). |
isStateEntity - Boolean!
|
Indicates whether this is a state-level entity. |
emailAddress - String
|
The assessor's email address. |
efileAddress - String
|
The assessor's e-file address. |
county - String
|
The county of the assessor. |
isActive - Boolean!
|
Indicates whether the assessor is active. |
createdDateTime - DateTimeISO
|
The date and time when the assessor was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the assessor was last modified (UTC). |
modifiedBy - PropertyTaxCompanyUser
|
The user who last modified this assessor. |
Example
{
"assessorId": 123,
"assessorName": "abc123",
"stateProvinceCode": "abc123",
"stateProvince": PropertyTaxStateProvince,
"isStateEntity": true,
"emailAddress": "abc123",
"efileAddress": "xyz789",
"county": "abc123",
"isActive": true,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"modifiedBy": PropertyTaxCompanyUser
}
PropertyTaxAssessorAccount
Description
Represents an assessor account.
Fields
| Field Name | Description |
|---|---|
assessorAccountId - Int!
|
The ID of the assessor account. |
assessorAccountNumber - String
|
The assessor account number. |
assessorAltRefNumber - String
|
The alternate reference number. |
assessorAccountName - String
|
The name of the assessor account. |
assessor - PropertyTaxAssessor
|
The assessor this account belongs to. |
assessorAccountNoticeStatus - PropertyTaxAssessorAccountNoticeStatus
|
The notice status of this assessor account. |
assessorAccountReturnStatus - PropertyTaxAssessorAccountReturnStatus
|
The return status of this assessor account. |
assessorAccountExtensionStatus - PropertyTaxAssessorAccountExtensionStatus
|
The extension status of this assessor account. |
assessorAccountAppealStatus - PropertyTaxAssessorAccountAppealStatus
|
The appeal status of this assessor account. |
creationType - PropertyTaxCreationType
|
How this assessor account was created. |
appealDeadline - DateTimeISO
|
The appeal deadline. |
isAppealDeadlineInherited - Boolean!
|
Indicates whether the appeal deadline is inherited. |
returnDueDate - DateTimeISO
|
The return due date. |
isReturnDueDateInherited - Boolean!
|
Indicates whether the return due date is inherited. |
returnExtensionDeadline - DateTimeISO
|
The return extension deadline. |
isReturnExtensionDeadlineInherited - Boolean!
|
Indicates whether the return extension deadline is inherited. |
returnExtendedDeadline - DateTimeISO
|
The extended return deadline. |
isReturnExtendedDeadlineInherited - Boolean!
|
Indicates whether the return extended deadline is inherited. |
assessmentDate - DateTimeISO
|
The assessment date. |
totalRenderedValue - Decimal
|
The total rendered value. |
totalCost - Decimal
|
The total cost. |
opinionOfValue - Decimal
|
The opinion of value. |
assessmentRatio - Decimal
|
The assessment ratio. |
isAssessmentRatioInheritedFlag - Boolean!
|
Indicates whether the assessment ratio is inherited. |
isActive - Boolean!
|
Indicates whether the assessor account is active. |
isMasterAccountFlag - Boolean!
|
Indicates whether this is a master account. |
isExemptedReturnsFlag - Boolean!
|
Indicates whether returns are exempted. |
isDeletedReturnFlag - Boolean
|
Indicates whether the return is deleted. |
taxYear - Short!
|
The tax year. |
section - String
|
The section. |
township - String
|
The township. |
range - String
|
The range. |
taxingDistrictName - String
|
The taxing district name. |
taxingDistrictNumber - String
|
The taxing district number. |
notes - String
|
Notes for this assessor account. |
renditionNotes - String
|
Rendition notes. |
createdDateTime - DateTimeISO
|
The date and time when this assessor account was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this assessor account was last modified (UTC). |
userDefinedFieldValues - [PropertyTaxUserDefinedFieldValueSummary]
|
User-defined field values for this assessor account. |
properties - [PropertyTaxProperty]
|
Properties associated with this assessor account. |
Example
{
"assessorAccountId": 987,
"assessorAccountNumber": "abc123",
"assessorAltRefNumber": "xyz789",
"assessorAccountName": "xyz789",
"assessor": PropertyTaxAssessor,
"assessorAccountNoticeStatus": PropertyTaxAssessorAccountNoticeStatus,
"assessorAccountReturnStatus": PropertyTaxAssessorAccountReturnStatus,
"assessorAccountExtensionStatus": PropertyTaxAssessorAccountExtensionStatus,
"assessorAccountAppealStatus": PropertyTaxAssessorAccountAppealStatus,
"creationType": PropertyTaxCreationType,
"appealDeadline": "2007-12-03T10:15:30Z",
"isAppealDeadlineInherited": true,
"returnDueDate": "2007-12-03T10:15:30Z",
"isReturnDueDateInherited": false,
"returnExtensionDeadline": "2007-12-03T10:15:30Z",
"isReturnExtensionDeadlineInherited": true,
"returnExtendedDeadline": "2007-12-03T10:15:30Z",
"isReturnExtendedDeadlineInherited": true,
"assessmentDate": "2007-12-03T10:15:30Z",
"totalRenderedValue": Decimal,
"totalCost": Decimal,
"opinionOfValue": Decimal,
"assessmentRatio": Decimal,
"isAssessmentRatioInheritedFlag": false,
"isActive": false,
"isMasterAccountFlag": true,
"isExemptedReturnsFlag": true,
"isDeletedReturnFlag": true,
"taxYear": Short,
"section": "abc123",
"township": "abc123",
"range": "abc123",
"taxingDistrictName": "abc123",
"taxingDistrictNumber": "abc123",
"notes": "abc123",
"renditionNotes": "xyz789",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"userDefinedFieldValues": [
PropertyTaxUserDefinedFieldValueSummary
],
"properties": [PropertyTaxProperty]
}
PropertyTaxAssessorAccountAppealStatus
Description
Represents an assessor account appeal status.
Example
{
"assessorAccountAppealStatusId": 987,
"assessorAccountAppealStatusName": "abc123",
"isActive": true
}
PropertyTaxAssessorAccountCollectionSegment
Description
A paginated collection of assessor account records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAssessorAccount]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAssessorAccount]
}
PropertyTaxAssessorAccountExtensionStatus
Description
Represents an assessor account extension status.
Example
{
"assessorAccountExtensionStatusId": 987,
"assessorAccountExtensionStatusName": "xyz789",
"isActive": true
}
PropertyTaxAssessorAccountFilterInput
Description
Filter criteria for querying assessor accounts.
Fields
| Input Field | Description |
|---|---|
taxYear - Short
|
Filter by tax year. Required unless assessorAccountIds is supplied. |
assessorAccountIds - [Int!]
|
Restrict results to assessor accounts with any of these IDs. Required unless taxYear is supplied. |
assessorAccountNumber - PropertyTaxStringOperationInput
|
Filter by assessor account number. |
assessorAccountName - PropertyTaxStringOperationInput
|
Filter by assessor account name. |
isActive - Boolean
|
Filter by active status. |
assessorName - PropertyTaxStringOperationInput
|
Filter by assessor name. |
stateProvinceCodes - [String!]
|
Restrict results to assessor accounts in any of these states or provinces. |
propertyNumber - PropertyTaxStringOperationInput
|
Filter by the number of an associated property. |
clientName - PropertyTaxStringOperationInput
|
Filter by the root client name of an associated property. |
legalEntityName - PropertyTaxStringOperationInput
|
Filter by the legal entity name of an associated property. |
locationTypeName - PropertyTaxStringOperationInput
|
Filter by the location type name of an associated property. |
Example
{
"taxYear": Short,
"assessorAccountIds": [123],
"assessorAccountNumber": PropertyTaxStringOperationInput,
"assessorAccountName": PropertyTaxStringOperationInput,
"isActive": false,
"assessorName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["xyz789"],
"propertyNumber": PropertyTaxStringOperationInput,
"clientName": PropertyTaxStringOperationInput,
"legalEntityName": PropertyTaxStringOperationInput,
"locationTypeName": PropertyTaxStringOperationInput
}
PropertyTaxAssessorAccountNoticeStatus
Description
Represents an assessor account notice status.
Example
{
"assessorAccountNoticeStatusId": 987,
"assessorAccountNoticeStatusName": "xyz789",
"isActive": true
}
PropertyTaxAssessorAccountNoticeTrackerStatus
Description
Represents an assessor account notice tracker status entry.
Fields
| Field Name | Description |
|---|---|
assessorAccountNoticeTrackerStatusId - Int!
|
The ID of the assessor account notice tracker status. |
assessorAccountId - Int!
|
The assessor account ID. |
trackerStatusId - Int!
|
The tracker status ID. |
trackerStatus - PropertyTaxTrackerStatus
|
The tracker status reference. |
assignedUser - PropertyTaxCompanyUser
|
The user assigned to this tracker item. |
trackerComment - String
|
Optional comment for this tracker entry. |
trackerFollowupDate - DateTimeISO
|
Optional follow-up date. |
createdBy - PropertyTaxCompanyUser
|
The user who created this tracker entry. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"assessorAccountNoticeTrackerStatusId": 123,
"assessorAccountId": 987,
"trackerStatusId": 123,
"trackerStatus": PropertyTaxTrackerStatus,
"assignedUser": PropertyTaxCompanyUser,
"trackerComment": "abc123",
"trackerFollowupDate": "2007-12-03T10:15:30Z",
"createdBy": PropertyTaxCompanyUser,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxAssessorAccountNoticeTrackerStatusCollectionSegment
Description
A paginated collection of assessor account notice tracker status records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAssessorAccountNoticeTrackerStatus]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAssessorAccountNoticeTrackerStatus]
}
PropertyTaxAssessorAccountNoticeTrackerStatusFilterInput
Description
Filter criteria for querying assessor account notice tracker statuses.
Fields
| Input Field | Description |
|---|---|
assessorAccountNoticeTrackerStatusIds - [Int!]
|
Restrict results to tracker statuses with any of these IDs. |
trackerFollowupDateFrom - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or after this date. |
trackerFollowupDateTo - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or before this date. |
createdDateTimeFrom - DateTimeISO
|
Filter to tracker statuses created on or after this date. |
createdDateTimeTo - DateTimeISO
|
Filter to tracker statuses created on or before this date. |
Example
{
"assessorAccountNoticeTrackerStatusIds": [987],
"trackerFollowupDateFrom": "2007-12-03T10:15:30Z",
"trackerFollowupDateTo": "2007-12-03T10:15:30Z",
"createdDateTimeFrom": "2007-12-03T10:15:30Z",
"createdDateTimeTo": "2007-12-03T10:15:30Z"
}
PropertyTaxAssessorAccountNoticeTrackerStatusSortInput
Description
Sort options for querying assessor account notice tracker statuses.
Fields
| Input Field | Description |
|---|---|
trackerFollowupDate - SortEnumType
|
Sort by follow-up date. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"trackerFollowupDate": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxAssessorAccountReturnStatus
Description
Represents an assessor account return status.
Example
{
"assessorAccountReturnStatusId": 123,
"assessorAccountReturnStatusName": "xyz789",
"isActive": false
}
PropertyTaxAssessorAccountSortInput
Description
Sort options for querying assessor accounts.
Fields
| Input Field | Description |
|---|---|
assessorAccountId - SortEnumType
|
Sort by assessor account ID. |
assessorName - SortEnumType
|
Sort by assessor name. |
taxYear - SortEnumType
|
Sort by tax year. |
Example
{"assessorAccountId": "ASC", "assessorName": "ASC", "taxYear": "ASC"}
PropertyTaxAssessorAccountTrackerStatus
Description
Represents an assessor account tracker status entry.
Fields
| Field Name | Description |
|---|---|
assessorAccountTrackerStatusId - Int!
|
The ID of the assessor account tracker status. |
assessorAccountId - Int!
|
The assessor account ID. |
trackerStatusId - Int!
|
The tracker status ID. |
trackerStatus - PropertyTaxTrackerStatus
|
The tracker status reference. |
assignedUser - PropertyTaxCompanyUser
|
The user assigned to this tracker item. |
trackerComment - String
|
Optional comment for this tracker entry. |
trackerFollowupDate - DateTimeISO
|
Optional follow-up date. |
createdBy - PropertyTaxCompanyUser
|
The user who created this tracker entry. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"assessorAccountTrackerStatusId": 123,
"assessorAccountId": 987,
"trackerStatusId": 987,
"trackerStatus": PropertyTaxTrackerStatus,
"assignedUser": PropertyTaxCompanyUser,
"trackerComment": "abc123",
"trackerFollowupDate": "2007-12-03T10:15:30Z",
"createdBy": PropertyTaxCompanyUser,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxAssessorAccountTrackerStatusCollectionSegment
Description
A paginated collection of assessor account tracker status records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAssessorAccountTrackerStatus]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAssessorAccountTrackerStatus]
}
PropertyTaxAssessorAccountTrackerStatusFilterInput
Description
Filter criteria for querying assessor account tracker statuses.
Fields
| Input Field | Description |
|---|---|
assessorAccountTrackerStatusIds - [Int!]
|
Restrict results to tracker statuses with any of these IDs. |
trackerFollowupDateFrom - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or after this date. |
trackerFollowupDateTo - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or before this date. |
createdDateTimeFrom - DateTimeISO
|
Filter to tracker statuses created on or after this date. |
createdDateTimeTo - DateTimeISO
|
Filter to tracker statuses created on or before this date. |
Example
{
"assessorAccountTrackerStatusIds": [123],
"trackerFollowupDateFrom": "2007-12-03T10:15:30Z",
"trackerFollowupDateTo": "2007-12-03T10:15:30Z",
"createdDateTimeFrom": "2007-12-03T10:15:30Z",
"createdDateTimeTo": "2007-12-03T10:15:30Z"
}
PropertyTaxAssessorAccountTrackerStatusSortInput
Description
Sort options for querying assessor account tracker statuses.
Fields
| Input Field | Description |
|---|---|
trackerFollowupDate - SortEnumType
|
Sort by follow-up date. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"trackerFollowupDate": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxAssessorAccountType
Description
Represents an assessor account type.
Example
{
"assessorAccountTypeId": 987,
"assessorAccountTypeName": "abc123",
"shortName": "xyz789",
"isActive": true
}
PropertyTaxAssessorCollectionSegment
Description
A paginated collection of assessor records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxAssessor]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxAssessor]
}
PropertyTaxAssessorFilterInput
Description
Filter criteria for querying assessors.
Fields
| Input Field | Description |
|---|---|
assessorIds - [Int!]
|
Restrict results to records with any of these IDs. |
assessorName - PropertyTaxStringOperationInput
|
The filter criteria for the assessor name. |
stateProvinceCodes - [String!]
|
Restrict results to assessors in any of these states or provinces. |
isActive - Boolean
|
Filter by active status. |
Example
{
"assessorIds": [987],
"assessorName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["abc123"],
"isActive": false
}
PropertyTaxAssessorSortInput
Description
Sort options for querying assessors.
Fields
| Input Field | Description |
|---|---|
assessorName - SortEnumType
|
Sort by assessor name. |
stateProvinceCode - SortEnumType
|
Sort by state or province code. |
Example
{"assessorName": "ASC", "stateProvinceCode": "ASC"}
PropertyTaxClient
Description
Represents a property tax client.
Fields
| Field Name | Description |
|---|---|
clientId - Int!
|
The ID of the client. |
clientName - String!
|
The name of the client. |
clientNumber - String!
|
The client number. |
federalTaxId - String
|
The federal tax ID. |
isActive - Boolean!
|
Indicates whether the client is active. |
industryClassificationId - Int
|
Industry classification reference ID. |
fiscalYearStartDay - Short
|
The day of month when the fiscal year starts (1-31). |
fiscalYearStartMonth - Short
|
The month when the fiscal year starts (1-12). |
incorporationDate - DateTimeISO
|
The date of incorporation. |
incorporationStateProvinceCode - String
|
State/province code of incorporation. |
incorporationTypeId - Int
|
Incorporation type reference ID. |
thirdPartyPayrollSystemNumber - String
|
Third-party payroll system number. |
packageReturnAddressTypeId - Int!
|
Package return address type ID. |
officerClientContactId - Int
|
Officer client contact reference ID. |
signatoryClientContactId - Int
|
Signatory client contact reference ID. |
isBudgetClient - Boolean!
|
Indicates whether this is a budget client. |
isAllocationClient - Boolean!
|
Indicates whether this is an allocation client. |
isApClientCodeRequired - Boolean!
|
Indicates whether accounts payable client code is required. |
isApCostCenterRequired - Boolean!
|
Indicates whether accounts payable cost center is required. |
accountManager - PropertyTaxCompanyUser
|
The account manager. |
ppManager - PropertyTaxCompanyUser
|
The personal property manager. |
reManager - PropertyTaxCompanyUser
|
The real estate manager. |
incorporationStateProvince - PropertyTaxStateProvince
|
The incorporation state or province reference. |
modifiedBy - PropertyTaxCompanyUser
|
The user who last modified this client. |
createdDateTime - DateTimeISO
|
The date and time when the client was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the client was last modified (UTC). |
userDefinedFieldValues - [PropertyTaxUserDefinedFieldValueSummary]
|
User-defined field values for this client. |
Example
{
"clientId": 987,
"clientName": "abc123",
"clientNumber": "xyz789",
"federalTaxId": "abc123",
"isActive": false,
"industryClassificationId": 123,
"fiscalYearStartDay": Short,
"fiscalYearStartMonth": Short,
"incorporationDate": "2007-12-03T10:15:30Z",
"incorporationStateProvinceCode": "xyz789",
"incorporationTypeId": 123,
"thirdPartyPayrollSystemNumber": "abc123",
"packageReturnAddressTypeId": 123,
"officerClientContactId": 987,
"signatoryClientContactId": 123,
"isBudgetClient": false,
"isAllocationClient": false,
"isApClientCodeRequired": false,
"isApCostCenterRequired": false,
"accountManager": PropertyTaxCompanyUser,
"ppManager": PropertyTaxCompanyUser,
"reManager": PropertyTaxCompanyUser,
"incorporationStateProvince": PropertyTaxStateProvince,
"modifiedBy": PropertyTaxCompanyUser,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"userDefinedFieldValues": [
PropertyTaxUserDefinedFieldValueSummary
]
}
PropertyTaxClientCollectionSegment
Description
A paginated collection of client records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxClient]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxClient]
}
PropertyTaxClientFilterInput
Description
Filter criteria for querying clients.
Fields
| Input Field | Description |
|---|---|
clientIds - [Int!]
|
Restrict results to records with any of these IDs. |
clientName - PropertyTaxStringOperationInput
|
The filter criteria for the client name. |
clientNumber - PropertyTaxStringOperationInput
|
Filter by client number. |
isActive - Boolean
|
Filter by active status. |
incorporationStateProvinceCodes - [String!]
|
Restrict results to clients incorporated in any of these states or provinces. |
Example
{
"clientIds": [123],
"clientName": PropertyTaxStringOperationInput,
"clientNumber": PropertyTaxStringOperationInput,
"isActive": true,
"incorporationStateProvinceCodes": [
"xyz789"
]
}
PropertyTaxClientSortInput
Description
Sort options for querying clients.
Fields
| Input Field | Description |
|---|---|
clientName - SortEnumType
|
Sort by client name. |
clientNumber - SortEnumType
|
Sort by client number. |
isActive - SortEnumType
|
Sort by active status. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"clientName": "ASC",
"clientNumber": "ASC",
"isActive": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxCollector
Description
Represents a property tax collector.
Fields
| Field Name | Description |
|---|---|
collectorId - Int!
|
The ID of the collector. |
collectorName - String
|
The name of the collector. |
stateProvinceCode - String
|
The state or province code. |
stateProvince - PropertyTaxStateProvince
|
The state or province reference (code + name). |
isStateEntity - Boolean!
|
Indicates whether this is a state-level entity. |
emailAddress - String
|
The collector's email address. |
collectorTypeId - Int
|
The collector type. |
useGrossAmountFromImported - Boolean!
|
Indicates whether gross amount from imported data should be used. |
useGrossDueDateFromImported - Boolean!
|
Indicates whether gross due date from imported data should be used. |
isActive - Boolean!
|
Indicates whether the collector is active. |
createdDateTime - DateTimeISO
|
The date and time when the collector was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the collector was last modified (UTC). |
modifiedBy - PropertyTaxCompanyUser
|
The user who last modified this collector. |
Example
{
"collectorId": 987,
"collectorName": "xyz789",
"stateProvinceCode": "abc123",
"stateProvince": PropertyTaxStateProvince,
"isStateEntity": true,
"emailAddress": "abc123",
"collectorTypeId": 123,
"useGrossAmountFromImported": true,
"useGrossDueDateFromImported": true,
"isActive": false,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"modifiedBy": PropertyTaxCompanyUser
}
PropertyTaxCollectorAccount
Description
Represents a collector account.
Fields
| Field Name | Description |
|---|---|
collectorAccountId - Int!
|
The ID of the collector account. |
taxYear - Short!
|
The tax year. |
collectorAccountNumber - String
|
The collector account number. |
alternateCollectorAccountNumber - String
|
The alternate collector account number. |
isActive - Boolean
|
Indicates whether the collector account is active. |
collector - PropertyTaxCollector
|
The collector this account belongs to. |
creationType - PropertyTaxCreationType
|
How this collector account was created. |
effectiveTaxRate - Decimal
|
The effective tax rate. |
totalTaxableValue - Decimal
|
The total taxable value. |
upcomingInstallmentDeadlineDate - DateTimeISO
|
The upcoming installment deadline date. |
collectorUpcomingInstallmentDeadlineDate - DateTimeISO
|
The collector-set upcoming installment deadline date. |
inheritUpcomingDeadlineDateFlag - Boolean!
|
Indicates whether the upcoming deadline date is inherited. |
expectSupplementalDate - DateTimeISO
|
The expected supplemental date. |
expectRefundDate - DateTimeISO
|
The expected refund date. |
isPaidPrevious - Boolean!
|
Indicates whether the previous period is paid. |
isRecurringBillFlag - Boolean!
|
Indicates whether this is a recurring bill. |
includesNonAdValoremFlag - Boolean!
|
Indicates whether the account includes non-ad valorem charges. |
createdDateTime - DateTimeISO
|
The date and time when this collector account was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this collector account was last modified (UTC). |
assessorAccounts - [PropertyTaxAssessorAccount]
|
Assessor accounts associated with this collector account. |
Example
{
"collectorAccountId": 123,
"taxYear": Short,
"collectorAccountNumber": "xyz789",
"alternateCollectorAccountNumber": "abc123",
"isActive": true,
"collector": PropertyTaxCollector,
"creationType": PropertyTaxCreationType,
"effectiveTaxRate": Decimal,
"totalTaxableValue": Decimal,
"upcomingInstallmentDeadlineDate": "2007-12-03T10:15:30Z",
"collectorUpcomingInstallmentDeadlineDate": "2007-12-03T10:15:30Z",
"inheritUpcomingDeadlineDateFlag": false,
"expectSupplementalDate": "2007-12-03T10:15:30Z",
"expectRefundDate": "2007-12-03T10:15:30Z",
"isPaidPrevious": true,
"isRecurringBillFlag": false,
"includesNonAdValoremFlag": true,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"assessorAccounts": [PropertyTaxAssessorAccount]
}
PropertyTaxCollectorAccountCollectionSegment
Description
A paginated collection of collector account records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxCollectorAccount]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxCollectorAccount]
}
PropertyTaxCollectorAccountFilterInput
Description
Filter criteria for querying collector accounts.
Fields
| Input Field | Description |
|---|---|
taxYear - Short
|
Filter by tax year. Required unless collectorAccountIds is supplied. |
collectorAccountIds - [Int!]
|
Restrict results to collector accounts with any of these IDs. Required unless taxYear is supplied. |
collectorAccountNumber - PropertyTaxStringOperationInput
|
Filter by collector account number. |
isActive - Boolean
|
Filter by active status. |
collectorName - PropertyTaxStringOperationInput
|
Filter by collector name. |
stateProvinceCodes - [String!]
|
Restrict results to collector accounts in any of these states or provinces. |
assessorAccountNumber - PropertyTaxStringOperationInput
|
Filter by the account number of an associated assessor account. |
assessorName - PropertyTaxStringOperationInput
|
Filter by the assessor name of an associated assessor account. |
Example
{
"taxYear": Short,
"collectorAccountIds": [123],
"collectorAccountNumber": PropertyTaxStringOperationInput,
"isActive": false,
"collectorName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["abc123"],
"assessorAccountNumber": PropertyTaxStringOperationInput,
"assessorName": PropertyTaxStringOperationInput
}
PropertyTaxCollectorAccountSortInput
Description
Sort options for querying collector accounts.
Fields
| Input Field | Description |
|---|---|
collectorAccountId - SortEnumType
|
Sort by collector account ID. |
collectorName - SortEnumType
|
Sort by collector name. |
state - SortEnumType
|
Sort by state or province code. |
collectorAccountNumber - SortEnumType
|
Sort by collector account number. |
taxYear - SortEnumType
|
Sort by tax year. |
Example
{
"collectorAccountId": "ASC",
"collectorName": "ASC",
"state": "ASC",
"collectorAccountNumber": "ASC",
"taxYear": "ASC"
}
PropertyTaxCollectorAccountTaxBillStatus
Description
Represents a bill-level status for a collector account.
Example
{
"collectorAccountTaxBillStatusId": 123,
"collectorAccountTaxBillStatusName": "xyz789",
"isActive": false
}
PropertyTaxCollectorAccountTrackerStatus
Description
Represents a collector account tracker status entry.
Fields
| Field Name | Description |
|---|---|
collectorAccountTrackerStatusId - Int!
|
The ID of the collector account tracker status. |
collectorAccountId - Int!
|
The collector account ID. |
trackerStatusId - Int!
|
The tracker status ID. |
trackerStatus - PropertyTaxTrackerStatus
|
The tracker status reference. |
assignedUser - PropertyTaxCompanyUser
|
The user assigned to this tracker item. |
trackerComment - String
|
Optional comment for this tracker entry. |
trackerFollowupDate - DateTimeISO
|
Optional follow-up date. |
createdBy - PropertyTaxCompanyUser
|
The user who created this tracker entry. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"collectorAccountTrackerStatusId": 987,
"collectorAccountId": 987,
"trackerStatusId": 123,
"trackerStatus": PropertyTaxTrackerStatus,
"assignedUser": PropertyTaxCompanyUser,
"trackerComment": "abc123",
"trackerFollowupDate": "2007-12-03T10:15:30Z",
"createdBy": PropertyTaxCompanyUser,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxCollectorAccountTrackerStatusCollectionSegment
Description
A paginated collection of collector account tracker status records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxCollectorAccountTrackerStatus]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxCollectorAccountTrackerStatus]
}
PropertyTaxCollectorAccountTrackerStatusFilterInput
Description
Filter criteria for querying collector account tracker statuses.
Fields
| Input Field | Description |
|---|---|
collectorAccountTrackerStatusIds - [Int!]
|
Restrict results to tracker statuses with any of these IDs. |
trackerFollowupDateFrom - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or after this date. |
trackerFollowupDateTo - DateTimeISO
|
Filter to tracker statuses with a follow-up date on or before this date. |
createdDateTimeFrom - DateTimeISO
|
Filter to tracker statuses created on or after this date. |
createdDateTimeTo - DateTimeISO
|
Filter to tracker statuses created on or before this date. |
Example
{
"collectorAccountTrackerStatusIds": [123],
"trackerFollowupDateFrom": "2007-12-03T10:15:30Z",
"trackerFollowupDateTo": "2007-12-03T10:15:30Z",
"createdDateTimeFrom": "2007-12-03T10:15:30Z",
"createdDateTimeTo": "2007-12-03T10:15:30Z"
}
PropertyTaxCollectorAccountTrackerStatusSortInput
Description
Sort options for querying collector account tracker statuses.
Fields
| Input Field | Description |
|---|---|
trackerFollowupDate - SortEnumType
|
Sort by follow-up date. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"trackerFollowupDate": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxCollectorAccountType
Description
Represents a collector account type (bill name).
Example
{
"collectorAccountTypeId": 987,
"collectorAccountTypeName": "xyz789",
"isActive": false
}
PropertyTaxCollectorCollectionSegment
Description
A paginated collection of collector records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxCollector]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxCollector]
}
PropertyTaxCollectorFilterInput
Description
Filter criteria for querying collectors.
Fields
| Input Field | Description |
|---|---|
collectorIds - [Int!]
|
Restrict results to records with any of these IDs. |
collectorName - PropertyTaxStringOperationInput
|
The filter criteria for the collector name. |
stateProvinceCodes - [String!]
|
Restrict results to collectors in any of these states or provinces. |
collectorTypeIds - [Int!]
|
Restrict results to any of these collector types. |
isActive - Boolean
|
Filter by active status. |
Example
{
"collectorIds": [123],
"collectorName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["abc123"],
"collectorTypeIds": [123],
"isActive": true
}
PropertyTaxCollectorSortInput
Description
Sort options for querying collectors.
Fields
| Input Field | Description |
|---|---|
collectorName - SortEnumType
|
Sort by collector name. |
stateProvinceCode - SortEnumType
|
Sort by state or province code. |
Example
{"collectorName": "ASC", "stateProvinceCode": "ASC"}
PropertyTaxCollectorType
Description
Represents a collector type (lookup).
Example
{
"collectorTypeId": 123,
"collectorTypeName": "xyz789",
"isActive": true
}
PropertyTaxCompanyUser
PropertyTaxCompanyUserWorkGroup
Description
Represents a company user work group.
Fields
| Field Name | Description |
|---|---|
companyUserWorkGroupId - Int!
|
The ID of the work group. |
companyUserWorkGroupName - String
|
The name of the work group. |
isActive - Boolean!
|
Indicates whether this work group is active. |
createdDateTime - DateTimeISO
|
The date and time this work group was created. |
modifiedDateTime - DateTimeISO
|
The date and time this work group was last modified. |
Example
{
"companyUserWorkGroupId": 123,
"companyUserWorkGroupName": "xyz789",
"isActive": true,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxCompanyUserWorkGroupCollectionSegment
Description
A paginated collection of company user work group records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxCompanyUserWorkGroup]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxCompanyUserWorkGroup]
}
PropertyTaxCompanyUserWorkGroupFilterInput
Description
Filter criteria for querying company user work groups.
Fields
| Input Field | Description |
|---|---|
companyUserWorkGroupIds - [Int!]
|
Restrict results to records with any of these IDs. |
companyUserWorkGroupName - PropertyTaxStringOperationInput
|
Filter by name. |
isActive - Boolean
|
Filter by active status. |
Example
{
"companyUserWorkGroupIds": [987],
"companyUserWorkGroupName": PropertyTaxStringOperationInput,
"isActive": true
}
PropertyTaxCompanyUserWorkGroupSortInput
Description
Sort options for querying company user work groups.
Fields
| Input Field | Description |
|---|---|
companyUserWorkGroupName - SortEnumType
|
Sort by work group name. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"companyUserWorkGroupName": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxCompressor
Description
Represents a compressor fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
serialNumber - String
|
The serial number. |
engine - String
|
The engine description. |
cylinders - String
|
The number of cylinders. |
leaseLocation - String
|
The lease location. |
leaseLegalDescription - String
|
The lease legal description. |
createdDateTime - DateTimeISO
|
The date and time when the compressor record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the compressor record was last modified (UTC). |
Example
{
"fixedAssetId": 987,
"serialNumber": "abc123",
"engine": "abc123",
"cylinders": "abc123",
"leaseLocation": "xyz789",
"leaseLegalDescription": "abc123",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxCreationType
Description
Represents how an assessor account was created.
Example
{
"creationTypeId": 987,
"creationTypeName": "xyz789",
"isActive": true
}
PropertyTaxFixedAsset
Description
Represents a fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
assetNumber - String
|
The asset number. |
alternateAssetId - String
|
The alternate asset ID. |
description - String
|
The asset description. |
description2 - String
|
The secondary asset description. |
acquisitionDate - DateTimeISO!
|
The date the asset was acquired. |
taxYear - Short!
|
The tax year the asset is associated with. |
fiscalYear - Int!
|
The fiscal year the asset is associated with. |
originalCost - Decimal
|
The original cost of the asset. |
bookCost - Decimal
|
The book cost of the asset. |
rebookCost - Decimal
|
The rebooked cost of the asset. |
ltdDepreciation - Decimal
|
The life-to-date depreciation of the asset. |
renderedValue - Decimal
|
The rendered value of the asset. |
opinionOfValue - Decimal
|
The opinion of value for the asset. |
assessedNoticedValue - Decimal
|
The assessed value from the notice. |
assetLocation - String
|
The location of the asset. |
isTaxableFlag - Boolean!
|
Indicates whether the asset is taxable. |
isReportableFlag - Boolean!
|
Indicates whether the asset is reportable. |
isDisposalFlag - Boolean!
|
Indicates whether the asset has been disposed. |
disposalDate - DateTimeISO
|
The date the asset was disposed. |
disposalAmount - Decimal
|
The disposal amount for the asset. |
disposalDescription - String
|
The disposal description. |
isAdditionFlag - Boolean!
|
Indicates whether the asset was an addition. |
additionDate - DateTimeISO
|
The date the asset was added. |
additionAmount - Decimal
|
The addition amount for the asset. |
createdDateTime - DateTimeISO
|
The date and time when the asset was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the asset was last modified (UTC). |
vehicle - PropertyTaxVehicle
|
The vehicle details, if this asset is a vehicle. |
pipeline - PropertyTaxPipeline
|
The pipeline details, if this asset is a pipeline. |
leasedVehicle - PropertyTaxLeasedVehicle
|
The leased vehicle details, if this asset is a leased vehicle. |
leasedEquipment - PropertyTaxLeasedEquipment
|
The leased equipment details, if this asset is leased equipment. |
compressor - PropertyTaxCompressor
|
The compressor details, if this asset is a compressor. |
inventory - PropertyTaxInventory
|
The inventory details, if this asset is inventory. |
Example
{
"fixedAssetId": 987,
"assetNumber": "abc123",
"alternateAssetId": "xyz789",
"description": "abc123",
"description2": "xyz789",
"acquisitionDate": "2007-12-03T10:15:30Z",
"taxYear": Short,
"fiscalYear": 123,
"originalCost": Decimal,
"bookCost": Decimal,
"rebookCost": Decimal,
"ltdDepreciation": Decimal,
"renderedValue": Decimal,
"opinionOfValue": Decimal,
"assessedNoticedValue": Decimal,
"assetLocation": "xyz789",
"isTaxableFlag": true,
"isReportableFlag": true,
"isDisposalFlag": false,
"disposalDate": "2007-12-03T10:15:30Z",
"disposalAmount": Decimal,
"disposalDescription": "abc123",
"isAdditionFlag": false,
"additionDate": "2007-12-03T10:15:30Z",
"additionAmount": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"vehicle": PropertyTaxVehicle,
"pipeline": PropertyTaxPipeline,
"leasedVehicle": PropertyTaxLeasedVehicle,
"leasedEquipment": PropertyTaxLeasedEquipment,
"compressor": PropertyTaxCompressor,
"inventory": PropertyTaxInventory
}
PropertyTaxFixedAssetCollectionSegment
Description
A paginated collection of fixed asset records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxFixedAsset]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxFixedAsset]
}
PropertyTaxFixedAssetFilterInput
Description
Filter criteria for querying fixed assets.
Fields
| Input Field | Description |
|---|---|
taxYear - Short!
|
The tax year to filter by. |
clientName - PropertyTaxStringOperationInput
|
Filter by the name of the asset's root client. |
legalEntityName - PropertyTaxStringOperationInput
|
Filter by the name of the asset's legal entity. |
stateProvinceCodes - [String!]
|
Restrict results to fixed assets whose property is in any of these states or provinces. |
assetTypes - [String!]
|
Restrict results to fixed assets of any of these asset types. Valid values: Vehicle, Pipeline, LeasedVehicle, LeasedEquipment, Compressor, Inventory. |
acquisitionDateFrom - DateTimeISO
|
Filter to assets acquired on or after this date. |
acquisitionDateTo - DateTimeISO
|
Filter to assets acquired on or before this date. |
Example
{
"taxYear": Short,
"clientName": PropertyTaxStringOperationInput,
"legalEntityName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["abc123"],
"assetTypes": ["abc123"],
"acquisitionDateFrom": "2007-12-03T10:15:30Z",
"acquisitionDateTo": "2007-12-03T10:15:30Z"
}
PropertyTaxFixedAssetSortInput
Description
Sort options for querying fixed assets.
Fields
| Input Field | Description |
|---|---|
acquisitionDate - SortEnumType
|
Sort by acquisition date. |
taxYear - SortEnumType
|
Sort by tax year. |
Example
{"acquisitionDate": "ASC", "taxYear": "ASC"}
PropertyTaxInventory
Description
Represents an inventory fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
monthlyJanuaryCost - Decimal
|
The January monthly cost. |
monthlyFebruaryCost - Decimal
|
The February monthly cost. |
monthlyMarchCost - Decimal
|
The March monthly cost. |
monthlyAprilCost - Decimal
|
The April monthly cost. |
monthlyMayCost - Decimal
|
The May monthly cost. |
monthlyJuneCost - Decimal
|
The June monthly cost. |
monthlyJulyCost - Decimal
|
The July monthly cost. |
monthlyAugustCost - Decimal
|
The August monthly cost. |
monthlySeptemberCost - Decimal
|
The September monthly cost. |
monthlyOctoberCost - Decimal
|
The October monthly cost. |
monthlyNovemberCost - Decimal
|
The November monthly cost. |
monthlyDecemberCost - Decimal
|
The December monthly cost. |
assessmentDate - DateTimeISO
|
The assessment date. |
createdDateTime - DateTimeISO
|
The date and time when the inventory record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the inventory record was last modified (UTC). |
Example
{
"fixedAssetId": 987,
"monthlyJanuaryCost": Decimal,
"monthlyFebruaryCost": Decimal,
"monthlyMarchCost": Decimal,
"monthlyAprilCost": Decimal,
"monthlyMayCost": Decimal,
"monthlyJuneCost": Decimal,
"monthlyJulyCost": Decimal,
"monthlyAugustCost": Decimal,
"monthlySeptemberCost": Decimal,
"monthlyOctoberCost": Decimal,
"monthlyNovemberCost": Decimal,
"monthlyDecemberCost": Decimal,
"assessmentDate": "2007-12-03T10:15:30Z",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxJurisdiction
Description
Represents a taxing jurisdiction.
Fields
| Field Name | Description |
|---|---|
jurisdictionId - Int!
|
The ID of the jurisdiction. |
jurisdictionName - String
|
The name of the jurisdiction. |
reportedName - String
|
The reported name for the jurisdiction. |
internalCode - String
|
The internal jurisdiction code. |
isAdValorem - Boolean!
|
Indicates whether this is an ad valorem jurisdiction. |
isExemptionOffered - Boolean!
|
Indicates whether exemptions are offered. |
isAbatementOffered - Boolean!
|
Indicates whether abatements are offered. |
fiscalYearStartDay - Short
|
The day of month when the fiscal year starts (1-31). |
fiscalYearStartMonth - Short
|
The month when the fiscal year starts (1-12). |
isActive - Boolean!
|
Indicates whether the jurisdiction is active. |
createdDateTime - DateTimeISO
|
The date and time when the jurisdiction was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the jurisdiction was last modified (UTC). |
modifiedBy - PropertyTaxCompanyUser
|
The user who last modified this jurisdiction. |
stateProvinceCode - String
|
The state or province code. |
stateProvince - PropertyTaxStateProvince
|
The state or province reference (code + name). |
jurisdictionTypeId - Int!
|
The jurisdiction type ID. |
jurisdictionType - PropertyTaxJurisdictionType
|
The jurisdiction type details. |
jurisdictionTaxRates - [PropertyTaxJurisdictionTaxRate]
|
Tax rates associated with this jurisdiction. |
Example
{
"jurisdictionId": 987,
"jurisdictionName": "xyz789",
"reportedName": "abc123",
"internalCode": "xyz789",
"isAdValorem": false,
"isExemptionOffered": false,
"isAbatementOffered": true,
"fiscalYearStartDay": Short,
"fiscalYearStartMonth": Short,
"isActive": true,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"modifiedBy": PropertyTaxCompanyUser,
"stateProvinceCode": "abc123",
"stateProvince": PropertyTaxStateProvince,
"jurisdictionTypeId": 987,
"jurisdictionType": PropertyTaxJurisdictionType,
"jurisdictionTaxRates": [PropertyTaxJurisdictionTaxRate]
}
PropertyTaxJurisdictionCollectionSegment
Description
A paginated collection of jurisdiction records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxJurisdiction]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxJurisdiction]
}
PropertyTaxJurisdictionFilterInput
Description
Filter criteria for querying jurisdictions.
Fields
| Input Field | Description |
|---|---|
jurisdictionIds - [Int!]
|
Restrict results to records with any of these IDs. |
jurisdictionName - PropertyTaxStringOperationInput
|
The filter criteria for the jurisdiction name. |
stateProvinceCodes - [String!]
|
Restrict results to jurisdictions in any of these states or provinces. |
internalCode - PropertyTaxStringOperationInput
|
Filter by internal jurisdiction code. |
isActive - Boolean
|
Filter by active status. |
jurisdictionTypeIds - [Int!]
|
Restrict results to jurisdictions of any of these jurisdiction types. |
Example
{
"jurisdictionIds": [123],
"jurisdictionName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["xyz789"],
"internalCode": PropertyTaxStringOperationInput,
"isActive": false,
"jurisdictionTypeIds": [123]
}
PropertyTaxJurisdictionSortInput
Description
Sort options for querying jurisdictions.
Fields
| Input Field | Description |
|---|---|
jurisdictionName - SortEnumType
|
Sort by jurisdiction name. |
stateProvinceCode - SortEnumType
|
Sort by state or province code. |
isActive - SortEnumType
|
Sort by active status. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"jurisdictionName": "ASC",
"stateProvinceCode": "ASC",
"isActive": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxJurisdictionTaxRate
Description
Represents a tax rate for a specific jurisdiction and tax year.
Fields
| Field Name | Description |
|---|---|
jurisdictionTaxRateId - Int!
|
The ID of the tax rate. |
taxYear - Short!
|
The tax year (e.g., 2024). |
taxRate - Decimal
|
The tax rate percentage (decimal value). |
propertyTypeId - Int
|
The property type (optional, null means applies to all types). |
isDefaultFlag - Boolean
|
Indicates whether this is the default tax rate for the jurisdiction. |
createdDateTime - DateTimeISO
|
The date and time when the record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the record was last modified (UTC). |
Example
{
"jurisdictionTaxRateId": 123,
"taxYear": Short,
"taxRate": Decimal,
"propertyTypeId": 987,
"isDefaultFlag": true,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxJurisdictionType
Description
Represents a jurisdiction type (e.g., City, County, State, School District).
Example
{
"jurisdictionTypeId": 123,
"jurisdictionTypeName": "xyz789",
"isActive": false
}
PropertyTaxLeasedEquipment
Description
Represents a leased equipment fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
equipmentNumber - String
|
The equipment number. |
monthlyRent - Decimal
|
The monthly rent amount. |
lessorName - String
|
The lessor name. |
lessorAddress - String
|
The lessor address. |
leaseNumber - String
|
The lease number. |
leaseType - String
|
The lease type. |
leaseStartDate - DateTimeISO
|
The lease start date. |
leaseEndDate - DateTimeISO
|
The lease end date. |
createdDateTime - DateTimeISO
|
The date and time when the leased equipment record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the leased equipment record was last modified (UTC). |
Example
{
"fixedAssetId": 123,
"equipmentNumber": "abc123",
"monthlyRent": Decimal,
"lessorName": "xyz789",
"lessorAddress": "xyz789",
"leaseNumber": "xyz789",
"leaseType": "abc123",
"leaseStartDate": "2007-12-03T10:15:30Z",
"leaseEndDate": "2007-12-03T10:15:30Z",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxLeasedVehicle
Description
Represents a leased vehicle fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
monthlyRent - Decimal
|
The monthly rent amount. |
vehicleNumber - String
|
The vehicle number. |
vehicleModel - String
|
The vehicle model. |
vehicleMake - String
|
The vehicle make. |
vehicleYear - Int
|
The vehicle year. |
vehicleVin - String
|
The vehicle identification number. |
lessorName - String
|
The lessor name. |
lessorAddress - String
|
The lessor address. |
leaseNumber - String
|
The lease number. |
leaseType - String
|
The lease type. |
leaseStartDate - DateTimeISO
|
The lease start date. |
leaseEndDate - DateTimeISO
|
The lease end date. |
createdDateTime - DateTimeISO
|
The date and time when the leased vehicle record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the leased vehicle record was last modified (UTC). |
Example
{
"fixedAssetId": 987,
"monthlyRent": Decimal,
"vehicleNumber": "abc123",
"vehicleModel": "abc123",
"vehicleMake": "abc123",
"vehicleYear": 123,
"vehicleVin": "xyz789",
"lessorName": "abc123",
"lessorAddress": "abc123",
"leaseNumber": "xyz789",
"leaseType": "abc123",
"leaseStartDate": "2007-12-03T10:15:30Z",
"leaseEndDate": "2007-12-03T10:15:30Z",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxLegalEntity
Description
Represents a legal entity in Property Tax.
Fields
| Field Name | Description |
|---|---|
legalEntityId - Int!
|
The ID of the legal entity. |
parentLegalEntityId - Int
|
The parent client legal entity ID. |
clientId - Int
|
The ID of the legal entity's root client. |
clientName - String
|
The name of the legal entity's root client. |
legalEntityName - String!
|
The name of the legal entity. |
legalEntityNumber - String!
|
The legal entity number. |
federalTaxId - String
|
The federal tax ID. |
isActive - Boolean!
|
Indicates whether the legal entity is active. |
industryClassificationId - Int
|
Industry classification reference ID. |
fiscalYearStartDay - Short
|
The day of month when the fiscal year starts (1-31). |
fiscalYearStartMonth - Short
|
The month when the fiscal year starts (1-12). |
incorporationDate - DateTimeISO
|
The date of incorporation. |
incorporationStateProvinceCode - String
|
State/province code of incorporation. |
incorporationTypeId - Int
|
Incorporation type reference ID. |
thirdPartyPayrollSystemNumber - String
|
Third-party payroll system number. |
packageReturnAddressTypeId - Int!
|
Package return address type ID. |
officerClientContactId - Int
|
Officer client contact reference ID. |
signatoryClientContactId - Int
|
Signatory client contact reference ID. |
accountManager - PropertyTaxCompanyUser
|
The account manager. |
ppManager - PropertyTaxCompanyUser
|
The personal property manager. |
reManager - PropertyTaxCompanyUser
|
The real estate manager. |
incorporationStateProvince - PropertyTaxStateProvince
|
The incorporation state or province reference. |
modifiedBy - PropertyTaxCompanyUser
|
The user who last modified this legal entity. |
createdDateTime - DateTimeISO
|
The date and time when the legal entity was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the legal entity was last modified (UTC). |
userDefinedFieldValues - [PropertyTaxUserDefinedFieldValueSummary]
|
User-defined field values for this legal entity. |
Example
{
"legalEntityId": 123,
"parentLegalEntityId": 123,
"clientId": 987,
"clientName": "abc123",
"legalEntityName": "xyz789",
"legalEntityNumber": "xyz789",
"federalTaxId": "abc123",
"isActive": false,
"industryClassificationId": 123,
"fiscalYearStartDay": Short,
"fiscalYearStartMonth": Short,
"incorporationDate": "2007-12-03T10:15:30Z",
"incorporationStateProvinceCode": "abc123",
"incorporationTypeId": 123,
"thirdPartyPayrollSystemNumber": "abc123",
"packageReturnAddressTypeId": 123,
"officerClientContactId": 987,
"signatoryClientContactId": 987,
"accountManager": PropertyTaxCompanyUser,
"ppManager": PropertyTaxCompanyUser,
"reManager": PropertyTaxCompanyUser,
"incorporationStateProvince": PropertyTaxStateProvince,
"modifiedBy": PropertyTaxCompanyUser,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"userDefinedFieldValues": [
PropertyTaxUserDefinedFieldValueSummary
]
}
PropertyTaxLegalEntityCollectionSegment
Description
A paginated collection of legal entity records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxLegalEntity]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxLegalEntity]
}
PropertyTaxLegalEntityFilterInput
Description
Filter criteria for querying legal entities.
Fields
| Input Field | Description |
|---|---|
legalEntityIds - [Int!]
|
Restrict results to records with any of these IDs. |
legalEntityName - PropertyTaxStringOperationInput
|
The filter criteria for the legal entity name. |
legalEntityNumber - PropertyTaxStringOperationInput
|
Filter by legal entity number. |
clientName - PropertyTaxStringOperationInput
|
Filter by the name of the legal entity's root client. |
isActive - Boolean
|
Filter by active status. |
incorporationStateProvinceCodes - [String!]
|
Restrict results to legal entities incorporated in any of these states or provinces. |
Example
{
"legalEntityIds": [987],
"legalEntityName": PropertyTaxStringOperationInput,
"legalEntityNumber": PropertyTaxStringOperationInput,
"clientName": PropertyTaxStringOperationInput,
"isActive": true,
"incorporationStateProvinceCodes": [
"xyz789"
]
}
PropertyTaxLegalEntitySortInput
Description
Sort options for querying legal entities.
Fields
| Input Field | Description |
|---|---|
legalEntityName - SortEnumType
|
Sort by legal entity name. |
legalEntityNumber - SortEnumType
|
Sort by legal entity number. |
isActive - SortEnumType
|
Sort by active status. |
createdDateTime - SortEnumType
|
Sort by creation date. |
modifiedDateTime - SortEnumType
|
Sort by last modified date. |
Example
{
"legalEntityName": "ASC",
"legalEntityNumber": "ASC",
"isActive": "ASC",
"createdDateTime": "ASC",
"modifiedDateTime": "ASC"
}
PropertyTaxPPNotice
Description
Represents a personal property notice.
Fields
| Field Name | Description |
|---|---|
ppNoticeId - Int!
|
The ID of the personal property notice. |
assessorAccountId - Int!
|
The ID of the assessor account. |
createdDateTime - DateTimeISO
|
The date and time when this personal property notice was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this personal property notice was last modified (UTC). |
assessorAccountNumber - String
|
The assessor account number. |
taxYear - Short
|
The tax year. |
isNewRevisedNotice - Boolean
|
Indicates whether this is a new or revised notice. |
noticeFinalizedDateTime - DateTime
|
The date and time when the notice was finalized. |
appealDeadline - DateTime
|
The appeal deadline. |
isActive - Boolean
|
Indicates whether the assessor account is active. |
totalRenderedValue - Decimal
|
The total rendered value. |
opinionOfValue - Decimal
|
The opinion of value. |
totalCost - Decimal
|
The total cost. |
noticeStatus - PropertyTaxAssessorAccountNoticeStatus
|
The notice status of this assessor account. |
assessorAccountType - PropertyTaxAssessorAccountType
|
The assessor account type. |
subAssessorAccountType - PropertyTaxSubAssessorAccountType
|
The sub-assessor account type. |
assessor - PropertyTaxAssessor
|
The assessor this account belongs to. |
noticeTrackerStatuses - [PropertyTaxAssessorAccountNoticeTrackerStatus]
|
The notice tracker statuses for this assessor account. |
ppNoticeDetails - [PropertyTaxPPNoticeDetail]
|
The detail revisions for this personal property notice. |
Example
{
"ppNoticeId": 987,
"assessorAccountId": 123,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"assessorAccountNumber": "xyz789",
"taxYear": Short,
"isNewRevisedNotice": true,
"noticeFinalizedDateTime": "2007-12-03T10:15:30Z",
"appealDeadline": "2007-12-03T10:15:30Z",
"isActive": false,
"totalRenderedValue": Decimal,
"opinionOfValue": Decimal,
"totalCost": Decimal,
"noticeStatus": PropertyTaxAssessorAccountNoticeStatus,
"assessorAccountType": PropertyTaxAssessorAccountType,
"subAssessorAccountType": PropertyTaxSubAssessorAccountType,
"assessor": PropertyTaxAssessor,
"noticeTrackerStatuses": [
PropertyTaxAssessorAccountNoticeTrackerStatus
],
"ppNoticeDetails": [PropertyTaxPPNoticeDetail]
}
PropertyTaxPPNoticeCollectionSegment
Description
A paginated collection of p p notice records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxPPNotice]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxPPNotice]
}
PropertyTaxPPNoticeDetail
Description
Represents a personal property notice detail revision.
Fields
| Field Name | Description |
|---|---|
ppNoticeDetailId - Int!
|
The ID of the personal property notice detail. |
ppNoticeId - Int!
|
The ID of the personal property notice. |
noticeDetailRevisionTypeId - Int!
|
The ID of the notice detail revision type. |
ppNoticeDetailDescription - String
|
The description of this personal property notice detail. |
ppNoticeDetailDate - DateTimeISO!
|
The date of this personal property notice detail. |
isBenchmarkFlag - Boolean!
|
Indicates whether this detail is the benchmark revision. |
isFinalFlag - Boolean!
|
Indicates whether this detail is the final revision. |
isLatestAssessorResponseFlag - Boolean!
|
Indicates whether this detail represents the latest assessor response. |
isOriginalFlag - Boolean!
|
Indicates whether this detail is the original revision. |
isTargetFlag - Boolean!
|
Indicates whether this detail is the target revision. |
isTaxableValueOverrideFlag - Boolean!
|
Indicates whether this detail has a taxable value override. |
expectedValueFactor - Decimal
|
The expected value factor for this detail. |
countyValue - Decimal
|
The county assessed value. |
schoolValue - Decimal
|
The school assessed value. |
noticedExpectedTaxAmount - Decimal
|
The noticed expected tax amount. |
createdDateTime - DateTimeISO
|
The date and time when this detail was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this detail was last modified (UTC). |
ppNoticeDetailValues - [PropertyTaxPPNoticeDetailValue]
|
The value entries for this personal property notice detail. |
Example
{
"ppNoticeDetailId": 987,
"ppNoticeId": 987,
"noticeDetailRevisionTypeId": 123,
"ppNoticeDetailDescription": "abc123",
"ppNoticeDetailDate": "2007-12-03T10:15:30Z",
"isBenchmarkFlag": true,
"isFinalFlag": true,
"isLatestAssessorResponseFlag": false,
"isOriginalFlag": false,
"isTargetFlag": true,
"isTaxableValueOverrideFlag": false,
"expectedValueFactor": Decimal,
"countyValue": Decimal,
"schoolValue": Decimal,
"noticedExpectedTaxAmount": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"ppNoticeDetailValues": [PropertyTaxPPNoticeDetailValue]
}
PropertyTaxPPNoticeDetailValue
Description
Represents a personal property notice detail value entry.
Fields
| Field Name | Description |
|---|---|
ppNoticeDetailValueId - Int!
|
The ID of the personal property notice detail value. |
ppNoticeDetailId - Int!
|
The ID of the personal property notice detail. |
ppNoticeDetailValueType - PropertyTaxPPNoticeDetailValueType
|
The value type for this entry. |
noticedValue - Decimal
|
The noticed assessed value. |
exemptionValue - Decimal
|
The exemption value. |
abatementValue - Decimal
|
The abatement value. |
otherValue - Decimal
|
Other adjustments to the value. |
adjustedTotalValue - Decimal
|
The adjusted total value. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"ppNoticeDetailValueId": 987,
"ppNoticeDetailId": 987,
"ppNoticeDetailValueType": PropertyTaxPPNoticeDetailValueType,
"noticedValue": Decimal,
"exemptionValue": Decimal,
"abatementValue": Decimal,
"otherValue": Decimal,
"adjustedTotalValue": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxPPNoticeDetailValueType
Description
Represents a personal property notice detail value type.
Example
{
"ppNoticeDetailValueTypeId": 123,
"ppNoticeDetailValueTypeName": "xyz789",
"isActive": false
}
PropertyTaxPPNoticeFilterInput
Description
Filter criteria for querying personal property notices.
Fields
| Input Field | Description |
|---|---|
taxYear - Short
|
Filter by tax year. Required unless ppNoticeIds is supplied. |
ppNoticeIds - [Int!]
|
Restrict results to personal property notices with any of these IDs. Required unless taxYear is supplied. |
assessorAccountIds - [Int!]
|
Restrict results to notices on assessor accounts with any of these IDs. |
assessorAccountNumber - PropertyTaxStringOperationInput
|
Filter by assessor account number. |
noticeStatusIds - [Int!]
|
Restrict results to notices with any of these notice status IDs. |
isNewRevisedNotice - Boolean
|
Indicates whether to return only new or revised notices. |
isActive - Boolean
|
Filter by active status. |
appealDeadlineFrom - DateTimeISO
|
Restrict results to notices with an appeal deadline on or after this date. |
appealDeadlineTo - DateTimeISO
|
Restrict results to notices with an appeal deadline on or before this date. |
stateProvinceCodes - [String!]
|
Restrict results to notices in any of these states or provinces. |
assessorName - PropertyTaxStringOperationInput
|
Filter by assessor name. |
assessorAccountTypeIds - [Int!]
|
Restrict results to notices with any of these assessor account type IDs. |
subAssessorAccountTypeIds - [Int!]
|
Restrict results to notices with any of these sub-assessor account type IDs. |
Example
{
"taxYear": Short,
"ppNoticeIds": [123],
"assessorAccountIds": [123],
"assessorAccountNumber": PropertyTaxStringOperationInput,
"noticeStatusIds": [987],
"isNewRevisedNotice": false,
"isActive": false,
"appealDeadlineFrom": "2007-12-03T10:15:30Z",
"appealDeadlineTo": "2007-12-03T10:15:30Z",
"stateProvinceCodes": ["abc123"],
"assessorName": PropertyTaxStringOperationInput,
"assessorAccountTypeIds": [123],
"subAssessorAccountTypeIds": [123]
}
PropertyTaxPPNoticeSortInput
Description
Sort options for querying personal property notices.
Fields
| Input Field | Description |
|---|---|
ppNoticeId - SortEnumType
|
Sort by personal property notice ID. |
taxYear - SortEnumType
|
Sort by tax year. |
appealDeadline - SortEnumType
|
Sort by appeal deadline. |
state - SortEnumType
|
Sort by state or province code. |
assessorName - SortEnumType
|
Sort by assessor name. |
Example
{
"ppNoticeId": "ASC",
"taxYear": "ASC",
"appealDeadline": "ASC",
"state": "ASC",
"assessorName": "ASC"
}
PropertyTaxPipeline
Description
Represents a pipeline fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
inServiceDate - DateTimeISO
|
The date the pipeline was placed in service. |
pipelineMaterialId - Int
|
The ID of the pipeline material. |
pipelineUsageId - Int
|
The ID of the pipeline usage. |
pipelineStatusId - Int
|
The ID of the pipeline status. |
pipelineCommodityId - Int
|
The ID of the pipeline commodity. |
pipelineQuantityUnitId - Int
|
The ID of the pipeline quantity unit. |
commodityGroup - String
|
The commodity group. |
pipelineIdentifier - String
|
The pipeline identifier. |
operatorIdentifier - String
|
The operator identifier. |
lineName - String
|
The line name. |
beginLatitude - Decimal
|
The beginning latitude. |
endLatitude - Decimal
|
The ending latitude. |
beginLongitude - Decimal
|
The beginning longitude. |
endLongitude - Decimal
|
The ending longitude. |
permitNumber - String
|
The permit number. |
organizationNumber - String
|
The organization number. |
ownerName - String
|
The owner name. |
capacityVolume - Int
|
The capacity volume. |
actualVolume - Int
|
The actual volume. |
throughput - Decimal
|
The throughput. |
createdDateTime - DateTimeISO
|
The date and time when the pipeline record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the pipeline record was last modified (UTC). |
Example
{
"fixedAssetId": 987,
"inServiceDate": "2007-12-03T10:15:30Z",
"pipelineMaterialId": 987,
"pipelineUsageId": 123,
"pipelineStatusId": 987,
"pipelineCommodityId": 987,
"pipelineQuantityUnitId": 123,
"commodityGroup": "abc123",
"pipelineIdentifier": "abc123",
"operatorIdentifier": "abc123",
"lineName": "xyz789",
"beginLatitude": Decimal,
"endLatitude": Decimal,
"beginLongitude": Decimal,
"endLongitude": Decimal,
"permitNumber": "abc123",
"organizationNumber": "xyz789",
"ownerName": "abc123",
"capacityVolume": 987,
"actualVolume": 123,
"throughput": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxProperty
Description
Represents a property.
Fields
| Field Name | Description |
|---|---|
propertyId - Int!
|
The property ID. |
propertyNumber - String
|
The property number. |
propertyName - String
|
The property name. |
address1 - String
|
The property address. |
city - String
|
The property city. |
state - String
|
The property's state or province code. |
zipCode - String
|
The property zip code. |
isActive - Boolean!
|
Indicates whether the property is active. |
clientName - String
|
The root client name. |
legalEntityName - String
|
The legal entity name that owns the property. |
propertyLocationTypeName - String
|
The property location type name. |
userDefinedFieldValues - [PropertyTaxUserDefinedFieldValueSummary]
|
User-defined field values for this property. |
Example
{
"propertyId": 123,
"propertyNumber": "abc123",
"propertyName": "xyz789",
"address1": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "xyz789",
"isActive": false,
"clientName": "abc123",
"legalEntityName": "abc123",
"propertyLocationTypeName": "abc123",
"userDefinedFieldValues": [
PropertyTaxUserDefinedFieldValueSummary
]
}
PropertyTaxPropertyClass
Description
Represents a property class used in real estate notice class breakdowns.
Example
{
"propertyClassId": 123,
"propertyClassName": "xyz789",
"isActive": false
}
PropertyTaxPropertyCollectionSegment
Description
A paginated collection of property records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxProperty]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxProperty]
}
PropertyTaxPropertyFilterInput
Description
Filter criteria for querying properties.
Fields
| Input Field | Description |
|---|---|
propertyIds - [Int!]
|
Restrict results to properties with any of these IDs. |
propertyNumber - PropertyTaxStringOperationInput
|
Filter by property number. |
propertyName - PropertyTaxStringOperationInput
|
Filter by property name. |
address1 - PropertyTaxStringOperationInput
|
Filter by address. |
city - PropertyTaxStringOperationInput
|
Filter by city. |
zipCode - PropertyTaxStringOperationInput
|
Filter by zip code. |
stateProvinceCodes - [String!]
|
Restrict results to properties in any of these states or provinces. |
isActive - Boolean
|
Filter by active status. |
locationTypeIds - [Int!]
|
Restrict results to properties with any of these property location type IDs. |
clientName - PropertyTaxStringOperationInput
|
Filter by the name of the property's root client. |
legalEntityName - PropertyTaxStringOperationInput
|
Filter by the name of the property's legal entity. |
taxYear - Short
|
Filter by the tax year of an associated tax record. |
assessorName - PropertyTaxStringOperationInput
|
Filter by the assessor name of an associated tax record. |
Example
{
"propertyIds": [987],
"propertyNumber": PropertyTaxStringOperationInput,
"propertyName": PropertyTaxStringOperationInput,
"address1": PropertyTaxStringOperationInput,
"city": PropertyTaxStringOperationInput,
"zipCode": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["abc123"],
"isActive": true,
"locationTypeIds": [987],
"clientName": PropertyTaxStringOperationInput,
"legalEntityName": PropertyTaxStringOperationInput,
"taxYear": Short,
"assessorName": PropertyTaxStringOperationInput
}
PropertyTaxPropertySortInput
Description
Sort options for querying properties.
Fields
| Input Field | Description |
|---|---|
propertyNumber - SortEnumType
|
Sort by property number. |
propertyName - SortEnumType
|
Sort by property name. |
state - SortEnumType
|
Sort by state or province code. |
Example
{"propertyNumber": "ASC", "propertyName": "ASC", "state": "ASC"}
PropertyTaxRENotice
Description
Represents a real estate notice.
Fields
| Field Name | Description |
|---|---|
reNoticeId - Int!
|
The ID of the real estate notice. |
assessorAccountId - Int!
|
The ID of the assessor account. |
createdDateTime - DateTimeISO
|
The date and time when this real estate notice was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this real estate notice was last modified (UTC). |
assessorAccountNumber - String
|
The assessor account number. |
taxYear - Short
|
The tax year. |
isNewRevisedNotice - Boolean
|
Indicates whether this is a new or revised notice. |
noticeFinalizedDateTime - DateTime
|
The date and time when the notice was finalized. |
appealDeadline - DateTime
|
The appeal deadline. |
isActive - Boolean
|
Indicates whether the assessor account is active. |
totalRenderedValue - Decimal
|
The total rendered value. |
opinionOfValue - Decimal
|
The opinion of value. |
totalCost - Decimal
|
The total cost. |
noticeStatus - PropertyTaxAssessorAccountNoticeStatus
|
The notice status of this assessor account. |
assessorAccountType - PropertyTaxAssessorAccountType
|
The assessor account type. |
subAssessorAccountType - PropertyTaxSubAssessorAccountType
|
The sub-assessor account type. |
assessor - PropertyTaxAssessor
|
The assessor this account belongs to. |
noticeTrackerStatuses - [PropertyTaxAssessorAccountNoticeTrackerStatus]
|
The notice tracker statuses for this assessor account. |
reNoticeDetails - [PropertyTaxRENoticeDetail]
|
The detail revisions for this real estate notice. |
Example
{
"reNoticeId": 123,
"assessorAccountId": 987,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"assessorAccountNumber": "abc123",
"taxYear": Short,
"isNewRevisedNotice": false,
"noticeFinalizedDateTime": "2007-12-03T10:15:30Z",
"appealDeadline": "2007-12-03T10:15:30Z",
"isActive": false,
"totalRenderedValue": Decimal,
"opinionOfValue": Decimal,
"totalCost": Decimal,
"noticeStatus": PropertyTaxAssessorAccountNoticeStatus,
"assessorAccountType": PropertyTaxAssessorAccountType,
"subAssessorAccountType": PropertyTaxSubAssessorAccountType,
"assessor": PropertyTaxAssessor,
"noticeTrackerStatuses": [
PropertyTaxAssessorAccountNoticeTrackerStatus
],
"reNoticeDetails": [PropertyTaxRENoticeDetail]
}
PropertyTaxRENoticeCollectionSegment
Description
A paginated collection of r e notice records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxRENotice]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxRENotice]
}
PropertyTaxRENoticeDetail
Description
Represents a real estate notice detail revision.
Fields
| Field Name | Description |
|---|---|
reNoticeDetailId - Int!
|
The ID of the real estate notice detail. |
reNoticeId - Int!
|
The ID of the real estate notice. |
noticeDetailRevisionTypeId - Int!
|
The ID of the notice detail revision type. |
reNoticeDetailDescription - String
|
The description of this real estate notice detail. |
reNoticeDetailDate - DateTimeISO!
|
The date of this real estate notice detail. |
isBenchmarkFlag - Boolean!
|
Indicates whether this detail is the benchmark revision. |
isFinalFlag - Boolean!
|
Indicates whether this detail is the final revision. |
isLatestAssessorResponseFlag - Boolean!
|
Indicates whether this detail represents the latest assessor response. |
isOriginalFlag - Boolean!
|
Indicates whether this detail is the original revision. |
isTargetFlag - Boolean!
|
Indicates whether this detail is the target revision. |
isTaxableValueOverrideFlag - Boolean!
|
Indicates whether this detail has a taxable value override. |
isClassBreakdownEnabledFlag - Boolean!
|
Indicates whether class breakdown is enabled for this detail. |
expectedValueFactor - Decimal
|
The expected value factor for this detail. |
countyValue - Decimal
|
The county assessed value. |
schoolValue - Decimal
|
The school assessed value. |
noticedExpectedTaxAmount - Decimal
|
The noticed expected tax amount. |
createdDateTime - DateTimeISO
|
The date and time when this detail was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this detail was last modified (UTC). |
reNoticeDetailValues - [PropertyTaxRENoticeDetailValue]
|
The value entries for this real estate notice detail. |
reNoticeDetailClassValues - [PropertyTaxRENoticeDetailClassValue]
|
The class-breakdown value entries for this real estate notice detail. |
Example
{
"reNoticeDetailId": 987,
"reNoticeId": 123,
"noticeDetailRevisionTypeId": 123,
"reNoticeDetailDescription": "abc123",
"reNoticeDetailDate": "2007-12-03T10:15:30Z",
"isBenchmarkFlag": true,
"isFinalFlag": true,
"isLatestAssessorResponseFlag": true,
"isOriginalFlag": false,
"isTargetFlag": false,
"isTaxableValueOverrideFlag": true,
"isClassBreakdownEnabledFlag": false,
"expectedValueFactor": Decimal,
"countyValue": Decimal,
"schoolValue": Decimal,
"noticedExpectedTaxAmount": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z",
"reNoticeDetailValues": [
PropertyTaxRENoticeDetailValue
],
"reNoticeDetailClassValues": [
PropertyTaxRENoticeDetailClassValue
]
}
PropertyTaxRENoticeDetailClassValue
Description
Represents a real estate notice detail class breakdown value entry.
Fields
| Field Name | Description |
|---|---|
reNoticeDetailClassValueId - Int!
|
The ID of the real estate notice detail class value. |
reNoticeDetailId - Int!
|
The ID of the real estate notice detail. |
propertyClass - PropertyTaxPropertyClass
|
The property class for this breakdown entry. |
reNoticeDetailValueType - PropertyTaxRENoticeDetailValueType
|
The value type for this entry. |
landValue - Decimal
|
The land assessed value. |
buildingValue - Decimal
|
The building assessed value. |
miscValue - Decimal
|
The miscellaneous assessed value. |
landExemptionValue - Decimal
|
The land exemption value. |
landAbatementValue - Decimal
|
The land abatement value. |
landOtherValue - Decimal
|
Other land value adjustments. |
buildingExemptionValue - Decimal
|
The building exemption value. |
buildingAbatementValue - Decimal
|
The building abatement value. |
buildingOtherValue - Decimal
|
Other building value adjustments. |
miscExemptionValue - Decimal
|
The miscellaneous exemption value. |
miscAbatementValue - Decimal
|
The miscellaneous abatement value. |
miscOtherValue - Decimal
|
Other miscellaneous value adjustments. |
adjustedTotalValue - Decimal
|
The adjusted total value. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"reNoticeDetailClassValueId": 987,
"reNoticeDetailId": 123,
"propertyClass": PropertyTaxPropertyClass,
"reNoticeDetailValueType": PropertyTaxRENoticeDetailValueType,
"landValue": Decimal,
"buildingValue": Decimal,
"miscValue": Decimal,
"landExemptionValue": Decimal,
"landAbatementValue": Decimal,
"landOtherValue": Decimal,
"buildingExemptionValue": Decimal,
"buildingAbatementValue": Decimal,
"buildingOtherValue": Decimal,
"miscExemptionValue": Decimal,
"miscAbatementValue": Decimal,
"miscOtherValue": Decimal,
"adjustedTotalValue": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxRENoticeDetailValue
Description
Represents a real estate notice detail value entry.
Fields
| Field Name | Description |
|---|---|
reNoticeDetailValueId - Int!
|
The ID of the real estate notice detail value. |
reNoticeDetailId - Int!
|
The ID of the real estate notice detail. |
reNoticeDetailValueType - PropertyTaxRENoticeDetailValueType
|
The value type for this entry. |
landValue - Decimal
|
The land assessed value. |
buildingValue - Decimal
|
The building assessed value. |
miscValue - Decimal
|
The miscellaneous assessed value. |
landExemptionValue - Decimal
|
The land exemption value. |
landAbatementValue - Decimal
|
The land abatement value. |
landOtherValue - Decimal
|
Other land value adjustments. |
buildingExemptionValue - Decimal
|
The building exemption value. |
buildingAbatementValue - Decimal
|
The building abatement value. |
buildingOtherValue - Decimal
|
Other building value adjustments. |
miscExemptionValue - Decimal
|
The miscellaneous exemption value. |
miscAbatementValue - Decimal
|
The miscellaneous abatement value. |
miscOtherValue - Decimal
|
Other miscellaneous value adjustments. |
adjustedTotalValue - Decimal
|
The adjusted total value. |
createdDateTime - DateTimeISO
|
The date and time when this entry was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this entry was last modified (UTC). |
Example
{
"reNoticeDetailValueId": 987,
"reNoticeDetailId": 987,
"reNoticeDetailValueType": PropertyTaxRENoticeDetailValueType,
"landValue": Decimal,
"buildingValue": Decimal,
"miscValue": Decimal,
"landExemptionValue": Decimal,
"landAbatementValue": Decimal,
"landOtherValue": Decimal,
"buildingExemptionValue": Decimal,
"buildingAbatementValue": Decimal,
"buildingOtherValue": Decimal,
"miscExemptionValue": Decimal,
"miscAbatementValue": Decimal,
"miscOtherValue": Decimal,
"adjustedTotalValue": Decimal,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxRENoticeDetailValueType
Description
Represents a real estate notice detail value type.
Example
{
"reNoticeDetailValueTypeId": 123,
"reNoticeDetailValueTypeName": "xyz789",
"isActive": true
}
PropertyTaxRENoticeFilterInput
Description
Filter criteria for querying real estate notices.
Fields
| Input Field | Description |
|---|---|
taxYear - Short
|
Filter by tax year. Required unless reNoticeIds is supplied. |
reNoticeIds - [Int!]
|
Restrict results to real estate notices with any of these IDs. Required unless taxYear is supplied. |
assessorAccountIds - [Int!]
|
Restrict results to notices on assessor accounts with any of these IDs. |
assessorAccountNumber - PropertyTaxStringOperationInput
|
Filter by assessor account number. |
noticeStatusIds - [Int!]
|
Restrict results to notices with any of these notice status IDs. |
isNewRevisedNotice - Boolean
|
Indicates whether to return only new or revised notices. |
isActive - Boolean
|
Filter by active status. |
appealDeadlineFrom - DateTimeISO
|
Restrict results to notices with an appeal deadline on or after this date. |
appealDeadlineTo - DateTimeISO
|
Restrict results to notices with an appeal deadline on or before this date. |
stateProvinceCodes - [String!]
|
Restrict results to notices in any of these states or provinces. |
assessorName - PropertyTaxStringOperationInput
|
Filter by assessor name. |
assessorAccountTypeIds - [Int!]
|
Restrict results to notices with any of these assessor account type IDs. |
subAssessorAccountTypeIds - [Int!]
|
Restrict results to notices with any of these sub-assessor account type IDs. |
Example
{
"taxYear": Short,
"reNoticeIds": [987],
"assessorAccountIds": [123],
"assessorAccountNumber": PropertyTaxStringOperationInput,
"noticeStatusIds": [987],
"isNewRevisedNotice": true,
"isActive": false,
"appealDeadlineFrom": "2007-12-03T10:15:30Z",
"appealDeadlineTo": "2007-12-03T10:15:30Z",
"stateProvinceCodes": ["abc123"],
"assessorName": PropertyTaxStringOperationInput,
"assessorAccountTypeIds": [987],
"subAssessorAccountTypeIds": [123]
}
PropertyTaxRENoticeSortInput
Description
Sort options for querying real estate notices.
Fields
| Input Field | Description |
|---|---|
reNoticeId - SortEnumType
|
Sort by real estate notice ID. |
taxYear - SortEnumType
|
Sort by tax year. |
assessorAccountNumber - SortEnumType
|
Sort by assessor account number. |
appealDeadline - SortEnumType
|
Sort by appeal deadline. |
noticeFinalizedDateTime - SortEnumType
|
Sort by notice finalized date and time. |
state - SortEnumType
|
Sort by state or province code. |
assessorName - SortEnumType
|
Sort by assessor name. |
Example
{
"reNoticeId": "ASC",
"taxYear": "ASC",
"assessorAccountNumber": "ASC",
"appealDeadline": "ASC",
"noticeFinalizedDateTime": "ASC",
"state": "ASC",
"assessorName": "ASC"
}
PropertyTaxStateProvince
Description
Represents a state or province lookup value.
Example
{
"stateProvinceCode": "abc123",
"stateProvinceName": "abc123",
"isActive": true
}
PropertyTaxStringOperationInput
PropertyTaxSubAssessorAccountType
Description
Represents a sub-assessor account type.
Fields
| Field Name | Description |
|---|---|
subAssessorAccountTypeId - Int!
|
The ID of the sub-assessor account type. |
subAssessorAccountTypeName - String
|
The name of the sub-assessor account type. |
shortName - String
|
The short name of the sub-assessor account type. |
isActive - Boolean!
|
Indicates whether this sub-account type is active. |
Example
{
"subAssessorAccountTypeId": 123,
"subAssessorAccountTypeName": "xyz789",
"shortName": "abc123",
"isActive": false
}
PropertyTaxSystemEntityType
Description
Represents a system entity type.
Example
{
"systemEntityTypeId": 123,
"systemEntityTypeName": "xyz789",
"isActive": false
}
PropertyTaxTaxBill
Description
Represents a tax bill associated with a collector account.
Fields
| Field Name | Description |
|---|---|
taxBillId - Int!
|
The ID of the tax bill. |
otherTitle - String
|
The payee title on the tax bill. |
otherName - String
|
The payee name on the tax bill. |
otherAddress1 - String
|
The payee address line 1. |
otherAddress2 - String
|
The payee address line 2. |
otherCity - String
|
The payee city. |
otherStateProvinceCode - String
|
The payee state or province code. |
otherZipCode - String
|
The payee zip code. |
otherZipCodeExtension - String
|
The payee zip code extension. |
taxYear - Short
|
The tax year for this bill, from the associated collector account. |
collectorAccountNumber - String
|
The collector account number. |
collectorName - String
|
The name of the collector. |
state - String
|
The state or province code of the collector. |
isActive - Boolean
|
Indicates whether the collector account is active. |
taxBillStatus - PropertyTaxCollectorAccountTaxBillStatus
|
The bill-level status from the collector account. |
billName - PropertyTaxCollectorAccountType
|
The bill name (collector account type). |
collectorAccount - PropertyTaxCollectorAccount
|
The collector account associated with this tax bill. |
taxBillDetails - [PropertyTaxTaxBillDetail]
|
The line-item details of this tax bill. |
taxBillInstallments - [PropertyTaxTaxBillInstallment]
|
The installments of this tax bill. |
taxBillRefunds - [PropertyTaxTaxBillRefund]
|
The refunds associated with this tax bill. |
createdDateTime - DateTimeISO
|
The date and time when this tax bill was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this tax bill was last modified (UTC). |
Example
{
"taxBillId": 123,
"otherTitle": "xyz789",
"otherName": "xyz789",
"otherAddress1": "abc123",
"otherAddress2": "abc123",
"otherCity": "xyz789",
"otherStateProvinceCode": "abc123",
"otherZipCode": "abc123",
"otherZipCodeExtension": "xyz789",
"taxYear": Short,
"collectorAccountNumber": "xyz789",
"collectorName": "abc123",
"state": "abc123",
"isActive": true,
"taxBillStatus": PropertyTaxCollectorAccountTaxBillStatus,
"billName": PropertyTaxCollectorAccountType,
"collectorAccount": PropertyTaxCollectorAccount,
"taxBillDetails": [PropertyTaxTaxBillDetail],
"taxBillInstallments": [PropertyTaxTaxBillInstallment],
"taxBillRefunds": [PropertyTaxTaxBillRefund],
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxTaxBillCollectionSegment
Description
A paginated collection of tax bill records.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
items - [PropertyTaxTaxBill]
|
A flattened list of the items. |
Example
{
"pageInfo": PageInfo,
"items": [PropertyTaxTaxBill]
}
PropertyTaxTaxBillDetail
Description
Represents the detail of a tax bill.
Fields
| Field Name | Description |
|---|---|
taxBillDetailId - Int!
|
The ID of the tax bill detail. |
grossTaxAmount - Decimal
|
The gross tax amount. |
prepaidTaxAmount - Decimal
|
The prepaid tax amount. |
discountAmount - Decimal
|
The discount amount. |
otherAdjustmentAmount - Decimal
|
Other adjustment amount. |
penaltyAmount - Decimal
|
The penalty amount. |
penaltyInterestAmount - Decimal
|
The penalty interest amount. |
originalBillPenaltyAmount - Decimal
|
The original bill penalty amount. |
netTaxAmount - Decimal
|
The net tax amount. |
taxableValue - Decimal
|
The taxable value. |
approvedTaxableValue - Decimal
|
The approved taxable value. |
approvedDateTime - DateTimeISO
|
The date and time the detail was approved. |
validatedDateTime - DateTimeISO
|
The date and time the detail was validated. |
rejectedDateTime - DateTimeISO
|
The date and time the detail was rejected. |
rejectedDescription - String
|
The rejection description. |
exemptDateTime - DateTimeISO
|
The date and time the detail was marked exempt. |
isRushFlag - Boolean!
|
Indicates whether this is a rush detail. |
systemGeneratedVoucherNumber - String
|
The system-generated voucher number. |
resetToPendingReason - String
|
The reason the detail was reset to pending. |
resetToPendingDateTime - DateTimeISO
|
The date and time the detail was reset to pending. |
detailType - PropertyTaxTaxBillDetailType
|
The detail type (Original or Supplemental). |
detailStatus - PropertyTaxTaxBillStatus
|
The status of this tax bill detail. |
rejectedReason - PropertyTaxTaxBillRejectedReason
|
The reason for rejection, if applicable. |
taxBillDetailInstallments - [PropertyTaxTaxBillDetailInstallment]
|
The installment allocations for this detail. |
createdDateTime - DateTimeISO
|
The date and time when this detail was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this detail was last modified (UTC). |
Example
{
"taxBillDetailId": 123,
"grossTaxAmount": Decimal,
"prepaidTaxAmount": Decimal,
"discountAmount": Decimal,
"otherAdjustmentAmount": Decimal,
"penaltyAmount": Decimal,
"penaltyInterestAmount": Decimal,
"originalBillPenaltyAmount": Decimal,
"netTaxAmount": Decimal,
"taxableValue": Decimal,
"approvedTaxableValue": Decimal,
"approvedDateTime": "2007-12-03T10:15:30Z",
"validatedDateTime": "2007-12-03T10:15:30Z",
"rejectedDateTime": "2007-12-03T10:15:30Z",
"rejectedDescription": "abc123",
"exemptDateTime": "2007-12-03T10:15:30Z",
"isRushFlag": false,
"systemGeneratedVoucherNumber": "xyz789",
"resetToPendingReason": "abc123",
"resetToPendingDateTime": "2007-12-03T10:15:30Z",
"detailType": PropertyTaxTaxBillDetailType,
"detailStatus": PropertyTaxTaxBillStatus,
"rejectedReason": PropertyTaxTaxBillRejectedReason,
"taxBillDetailInstallments": [
PropertyTaxTaxBillDetailInstallment
],
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxTaxBillDetailInstallment
Description
Represents an installment allocation for a tax bill detail.
Fields
| Field Name | Description |
|---|---|
taxBillDetailInstallmentId - Int!
|
The ID of the tax bill detail installment. |
billAmount - Decimal
|
The bill amount for this installment allocation. |
isPaidFlag - Boolean!
|
Indicates whether this installment has been paid. |
checkRequestDate - DateTimeISO
|
The date a check was requested. |
rejectNotes - String
|
Notes for rejection, if applicable. |
installmentStatus - PropertyTaxTaxBillInstallmentStatus
|
The status of this detail installment. |
createdDateTime - DateTimeISO
|
The date and time when this record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this record was last modified (UTC). |
Example
{
"taxBillDetailInstallmentId": 987,
"billAmount": Decimal,
"isPaidFlag": false,
"checkRequestDate": "2007-12-03T10:15:30Z",
"rejectNotes": "abc123",
"installmentStatus": PropertyTaxTaxBillInstallmentStatus,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxTaxBillDetailType
Description
Represents the type of a tax bill detail (Original or Supplemental).
Example
{
"taxBillDetailTypeId": 123,
"taxBillDetailTypeName": "xyz789",
"isActive": true
}
PropertyTaxTaxBillFilterInput
Description
Filter criteria for querying tax bills.
Fields
| Input Field | Description |
|---|---|
taxYear - Short
|
Filter by tax year. Required unless taxBillIds is supplied. |
taxBillIds - [Int!]
|
Restrict results to tax bills with any of these IDs. Required unless taxYear is supplied. |
collectorAccountNumber - PropertyTaxStringOperationInput
|
Filter by collector account number. |
collectorName - PropertyTaxStringOperationInput
|
Filter by collector name. |
stateProvinceCodes - [String!]
|
Restrict results to tax bills in any of these states or provinces. |
isActive - Boolean
|
Filter by active status. |
taxBillStatusIds - [Int!]
|
Restrict results to tax bills with any of these tax bill status IDs. |
isRecurringBill - Boolean
|
Filter by recurring bill flag. |
includesNonAdValorem - Boolean
|
Filter by non-ad valorem flag. |
Example
{
"taxYear": Short,
"taxBillIds": [123],
"collectorAccountNumber": PropertyTaxStringOperationInput,
"collectorName": PropertyTaxStringOperationInput,
"stateProvinceCodes": ["abc123"],
"isActive": true,
"taxBillStatusIds": [987],
"isRecurringBill": false,
"includesNonAdValorem": true
}
PropertyTaxTaxBillInstallment
Description
Represents an installment on a tax bill.
Fields
| Field Name | Description |
|---|---|
taxBillInstallmentId - Int!
|
The ID of the tax bill installment. |
taxBillDueDate - DateTimeISO!
|
The due date of the installment. |
totalInstallmentAmount - Decimal
|
The total installment amount. |
installmentSequenceNumber - Int!
|
The sequence number of the installment. |
isApprovedFlag - Boolean!
|
Indicates whether the installment is approved. |
invoiceDate - DateTimeISO
|
The invoice date. |
taxBillInstallmentRemarks - String
|
Remarks for the installment. |
title - String
|
The payee title. |
name - String
|
The payee name. |
address1 - String
|
The payee address line 1. |
address2 - String
|
The payee address line 2. |
city - String
|
The payee city. |
stateProvinceCode - String
|
The payee state or province code. |
zipCode - String
|
The payee zip code. |
zipCodeExtension - String
|
The payee zip code extension. |
addressType - PropertyTaxTaxBillInstallmentAddressType
|
The address type for this installment. |
createdDateTime - DateTimeISO
|
The date and time when this installment was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this installment was last modified (UTC). |
Example
{
"taxBillInstallmentId": 123,
"taxBillDueDate": "2007-12-03T10:15:30Z",
"totalInstallmentAmount": Decimal,
"installmentSequenceNumber": 987,
"isApprovedFlag": false,
"invoiceDate": "2007-12-03T10:15:30Z",
"taxBillInstallmentRemarks": "abc123",
"title": "xyz789",
"name": "xyz789",
"address1": "abc123",
"address2": "abc123",
"city": "abc123",
"stateProvinceCode": "abc123",
"zipCode": "xyz789",
"zipCodeExtension": "abc123",
"addressType": PropertyTaxTaxBillInstallmentAddressType,
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxTaxBillInstallmentAddressType
Description
Represents the address type for a tax bill installment.
Example
{
"taxBillInstallmentAddressTypeId": 987,
"taxBillInstallmentAddressTypeName": "abc123",
"isActive": true
}
PropertyTaxTaxBillInstallmentStatus
Description
Represents the status of a tax bill detail installment.
Example
{
"taxBillInstallmentStatusId": 123,
"taxBillInstallmentStatusName": "abc123",
"isActive": true
}
PropertyTaxTaxBillRefund
Description
Represents a refund associated with a tax bill.
Fields
| Field Name | Description |
|---|---|
taxBillRefundId - Int!
|
The ID of the tax bill refund. |
refundDate - DateTimeISO
|
The date of the refund. |
refundValueAmount - Decimal!
|
The refund value amount. |
refundTaxAmount - Decimal!
|
The refund tax amount. |
refundInterestAmount - Decimal
|
The refund interest amount. |
refundExplanationNotes - String
|
Notes explaining the refund. |
createdDateTime - DateTimeISO
|
The date and time when this refund was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when this refund was last modified (UTC). |
Example
{
"taxBillRefundId": 987,
"refundDate": "2007-12-03T10:15:30Z",
"refundValueAmount": Decimal,
"refundTaxAmount": Decimal,
"refundInterestAmount": Decimal,
"refundExplanationNotes": "xyz789",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
PropertyTaxTaxBillRejectedReason
Description
Represents a reason for rejecting a tax bill detail.
Example
{
"taxBillRejectedReasonId": 123,
"taxBillRejectedReasonName": "xyz789",
"isActive": true
}
PropertyTaxTaxBillSortInput
Description
Sort options for querying tax bills.
Fields
| Input Field | Description |
|---|---|
taxBillId - SortEnumType
|
Sort by tax bill ID. |
taxYear - SortEnumType
|
Sort by tax year. |
collectorAccountNumber - SortEnumType
|
Sort by collector account number. |
collectorName - SortEnumType
|
Sort by collector name. |
state - SortEnumType
|
Sort by state or province code. |
Example
{
"taxBillId": "ASC",
"taxYear": "ASC",
"collectorAccountNumber": "ASC",
"collectorName": "ASC",
"state": "ASC"
}
PropertyTaxTaxBillStatus
Description
Represents the status of a tax bill detail.
Example
{
"taxBillStatusId": 987,
"taxBillStatusName": "abc123",
"isActive": true
}
PropertyTaxTaxingAuthorityAddress
Description
Represents an address associated with a taxing authority.
Example
{
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"title": "xyz789",
"name": "xyz789"
}
PropertyTaxTrackerStatus
Description
Represents a tracker status.
Fields
| Field Name | Description |
|---|---|
trackerStatusId - Int!
|
The ID of the tracker status. |
trackerStatusAreaId - Int!
|
The ID of the tracker status area. |
statusGroup - String
|
The tracker status group. |
statusName - String
|
The tracker status name. |
statusDescription - String
|
The description of the tracker status. |
isActive - Boolean!
|
Indicates whether the tracker status is active. |
Example
{
"trackerStatusId": 123,
"trackerStatusAreaId": 123,
"statusGroup": "abc123",
"statusName": "abc123",
"statusDescription": "xyz789",
"isActive": true
}
PropertyTaxUserDefinedFieldValueSummary
Description
Represents a user-defined field value.
Fields
| Field Name | Description |
|---|---|
label - String
|
The display label of the user-defined field. |
description - String
|
The description of the user-defined field. |
dataType - String
|
The data type of the field (Text, Number, Decimal, True/False, Date, Date/Time, Picklist Single, Picklist Multiple, Url). |
fieldValue - String
|
The stored value for this field. |
Example
{
"label": "abc123",
"description": "xyz789",
"dataType": "xyz789",
"fieldValue": "abc123"
}
PropertyTaxVehicle
Description
Represents a vehicle fixed asset.
Fields
| Field Name | Description |
|---|---|
fixedAssetId - Int!
|
The ID of the fixed asset. |
vehicleModel - String
|
The vehicle model. |
vehicleMake - String
|
The vehicle make. |
vehicleYear - Int
|
The vehicle year. |
vehicleVin - String
|
The vehicle identification number. |
createdDateTime - DateTimeISO
|
The date and time when the vehicle record was created (UTC). |
modifiedDateTime - DateTimeISO
|
The date and time when the vehicle record was last modified (UTC). |
Example
{
"fixedAssetId": 987,
"vehicleModel": "xyz789",
"vehicleMake": "abc123",
"vehicleYear": 123,
"vehicleVin": "abc123",
"createdDateTime": "2007-12-03T10:15:30Z",
"modifiedDateTime": "2007-12-03T10:15:30Z"
}
Short
Description
Represents a 16-bit signed integer.
Example
Short
SortEnumType
Description
Specifies the sort direction.
Values
| Enum Value | Description |
|---|---|
|
|
Sorts results in ascending order. |
|
|
Sorts results in descending order. |
Example
"ASC"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"