Fields the Tax Portal Queries

Field names, types, and query requirements for the data model objects the taxpayer portal reads.

How to Read This Reference

Map these fields when you ingest tax data for the self-service taxpayer portal. Required and Optional describe the portal query contract. They’re separate from the load order described in the DMO Dependency Tier in Tax and Revenue Management.

Required: A missing mapping makes that view or sub-view return empty.
Optional: A missing mapping omits that column. The rest of the view still returns. Optional covers display-only fields and fields the portal queries skip.

Every ingested record still includes DataSourceId, DataSourceObjectId, and InternalOrganizationId.

AccountDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`NameInterfaceField`	TEXT	Optional
`IndividualId`	TEXT	Required

IndividualDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`FirstName`	TEXT	Required
`LastName`	TEXT	Required

ContactPointAddressDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`ActiveFromDate`	DATETIME	Required
`CreatedDate`	DATETIME	Required
`UsageType`	TEXT	Required
`AddressLine1`	TEXT	Optional
`AddressLine2`	TEXT	Optional
`AddressLine3`	TEXT	Optional
`AddressLine4`	TEXT	Optional
`CityName`	TEXT	Optional
`StateProvinceName`	TEXT	Optional
`PostalCodeText`	TEXT	Optional
`CountryName`	TEXT	Optional

PartyIdentificationDmo

Field	Type	Required or Optional
`Id`	TEXT	Optional
`IdentificationNumber`	TEXT	Optional
`PartyIdentificationTypeId`	TEXT	Optional

TaxAccountDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxAccountName`	TEXT	Optional
`TaxAccountIdentifier`	TEXT	Optional
`AccountId`	TEXT	Required
`PartyIdentificationId`	TEXT	Optional
`TaxTypeId`	TEXT	Optional
`Status`	TEXT	Optional
`ValidFromDateTime`	DATETIME	Optional
`ValidToDateTime`	DATETIME	Required
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxFilingDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxFilingName`	TEXT	Optional
`TaxTypePeriodId`	TEXT	Required
`TaxAccountId`	TEXT	Required
`FormType`	TEXT	Optional
`FilingStatus`	TEXT	Optional
`DependentCount`	DOUBLE	Optional
`DeductionType`	TEXT	Optional
`GrossIncomeAmt`	CURRENCY	Optional
`AdjustedGrossIncomeAmt`	CURRENCY	Optional
`TotalDeductionAmt`	CURRENCY	Optional
`TaxableIncomeAmt`	CURRENCY	Optional
`TotalTaxLiabilityAmt`	CURRENCY	Optional
`TotalCreditAmt`	CURRENCY	Optional
`TotalTaxAfterCreditAmt`	CURRENCY	Optional
`PaymentWithholdingAmt`	CURRENCY	Optional
`PenaltyAmt`	CURRENCY	Optional
`InterestAmt`	CURRENCY	Optional
`OverpaymentAmt`	CURRENCY	Optional
`RefundAmt`	CURRENCY	Optional
`OwedAmt`	CURRENCY	Optional
`PriorYearOverpaymentAppliedAmt`	CURRENCY	Optional
`FilingDate`	DATEONLY	Required
`IsExtensionFiled`	BOOLEAN	Optional
`ExtensionFiledDate`	DATEONLY	Optional
`ExtendedDueDate`	DATEONLY	Optional
`IsAmended`	BOOLEAN	Optional
`AmendedFromFilingId`	TEXT	Optional
`AmendedReturnReasonText`	TEXT	Optional
`FilingMethodType`	TEXT	Optional
`Status`	TEXT	Optional
`ConfirmationNumber`	TEXT	Optional
`CreatedDateTime`	DATETIME	Required
`LastModifiedDateTime`	DATETIME	Optional

TaxFilingTaxAccountDmo

Field	Type	Required or Optional
`Id`	TEXT	Optional
`TaxFilingId`	TEXT	Required
`TaxAccountId`	TEXT	Required
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxTypePeriodDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxTypePeriodName`	TEXT	Optional
`TaxTypeId`	TEXT	Optional
`TaxYear`	TEXT	Required
`AssessmentYear`	TEXT	Optional
`Category`	TEXT	Optional
`StartDate`	DATEONLY	Optional
`EndDate`	DATEONLY	Optional
`TaxDueDate`	DATEONLY	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxTypeDmo

Field	Type	Required or Optional
`Id`	TEXT	Optional
`Category`	TEXT	Optional
`TaxTypeName`	TEXT	Optional
`Subcategory`	TEXT	Optional
`AuthorityName`	TEXT	Optional
`Status`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxFilingParticipantDmo

Field	Type	Required or Optional
`Id`	TEXT	Optional
`TaxFilingId`	TEXT	Required
`IndividualId`	TEXT	Required
`AccountId`	TEXT	Optional
`RelationshipName`	TEXT	Required
`DependentType`	TEXT	Optional
`IsDependent`	BOOLEAN	Required
`IsDisabled`	BOOLEAN	Optional
`IsStudent`	BOOLEAN	Optional
`IsJointFiler`	BOOLEAN	Required
`IsTaxPreparer`	BOOLEAN	Required
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional
`PartyIdentificationId`	TEXT	Optional
`IsPrimary__c / IsSpouse__c`	computed	Computed. Derive this value, and leave it out of the ingestion mapping.

TaxFilingContactPointDmo

Field	Type	Required or Optional
`Id`	TEXT	Optional
`TaxFilingId`	TEXT	Required
`TaxFilingParticipantId`	TEXT	Optional
`ContactPointAddressId`	TEXT	Required
`ContactPointPhoneId`	TEXT	Optional
`ContactPointEmailId`	TEXT	Optional
`ContactRoleType`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxFilingLineItemDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxFilingId`	TEXT	Required
`TaxFilingParticipantId`	TEXT	Optional
`IncomeSourceTaxAccountId`	TEXT	Optional
`FormType`	TEXT	Optional
`LineReferenceText`	TEXT	Required
`Category`	TEXT	Optional
`Subcategory`	TEXT	Optional
`Amt`	CURRENCY	Optional
`ParentLineItemId`	TEXT	Optional
`Description`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxPaymentDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxPaymentName`	TEXT	Optional
`TaxpayerTaxAccountId`	TEXT	Required
`RemitterTaxAccountId`	TEXT	Required
`TaxFilingId`	TEXT	Optional
`TaxTypePeriodId`	TEXT	Required
`PaymentReasonType`	TEXT	Optional
`Amt`	CURRENCY	Optional
`PaymentDate`	DATEONLY	Required
`PaymentInstrumentId`	TEXT	Required
`PaymentIdentifier`	TEXT	Optional
`Status`	TEXT	Optional
`FailureReasonText`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

PaymentInstrumentDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`Type`	TEXT	Optional
`InstrumentNumber`	TEXT	Optional
`IssuingEntity`	TEXT	Optional
`IssueDate`	DATEONLY	Optional
`BankAccountNumber`	TEXT	Optional
`BankName`	TEXT	Optional
`CardBrandName`	TEXT	Optional
`Last4Text`	TEXT	Optional
`ExpiryYear`	TEXT	Optional
`ExpiryMonth`	TEXT	Optional
`ExpiryDayOfMonth`	DOUBLE	Optional

TaxRefundDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxRefundName`	TEXT	Optional
`TaxpayerTaxAccountId`	TEXT	Optional
`TaxFilingId`	TEXT	Required
`TaxTypePeriodId`	TEXT	Optional
`PaymentInstrumentId`	TEXT	Required
`OriginalRefundId`	TEXT	Optional
`ReasonCode`	TEXT	Optional
`ReasonText`	TEXT	Optional
`NetAmt`	CURRENCY	Optional
`DisbursementDate`	DATEONLY	Required
`PaymentIdentifier`	TEXT	Optional
`Status`	TEXT	Optional
`FailureReasonText`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxFilingAssessmentDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxFilingAssessmentName`	TEXT	Optional
`TaxFilingId`	TEXT	Required
`PreviousAssessmentId`	TEXT	Optional
`Status`	TEXT	Optional
`AssessmentDate`	DATEONLY	Required
`GrossIncomeAmt`	CURRENCY	Optional
`AdjustedGrossIncomeAmt`	CURRENCY	Optional
`TotalDeductionAmt`	CURRENCY	Optional
`TaxableIncomeAmt`	CURRENCY	Optional
`TotalTaxLiabilityAmt`	CURRENCY	Optional
`TotalCreditAmt`	CURRENCY	Optional
`TotalTaxAfterCreditAmt`	CURRENCY	Optional
`TotalPaymentWithholdingAmt`	CURRENCY	Optional
`PenaltyAmt`	CURRENCY	Optional
`InterestAmt`	CURRENCY	Optional
`OverpaymentAmt`	CURRENCY	Optional
`RefundAmt`	CURRENCY	Optional
`OwedAmt`	CURRENCY	Optional
`ReasonCode`	TEXT	Optional
`ReasonText`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxFilingAssessmentLineItemDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxFilingAssessmentId`	TEXT	Required
`TaxFilingLineItemId`	TEXT	Optional
`TaxFilingParticipantId`	TEXT	Optional
`TaxAccountId`	TEXT	Optional
`FormType`	TEXT	Optional
`LineReferenceText`	TEXT	Required
`Category`	TEXT	Optional
`Subcategory`	TEXT	Optional
`Amt`	CURRENCY	Optional
`ParentLineItemId`	TEXT	Optional
`AdjustmentCode`	TEXT	Optional
`AdjustmentReasonText`	TEXT	Optional
`Description`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxDocumentDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxDocumentName`	TEXT	Optional
`TaxpayerTaxAccountId`	TEXT	Required
`IssuerTaxAccountId`	TEXT	Optional
`DocumentType`	TEXT	Optional
`GrossEarningAmt`	CURRENCY	Optional
`TaxWithheldAmt`	CURRENCY	Optional
`TaxTypePeriodId`	TEXT	Required
`ContentDocumentId`	TEXT	Optional
`ResolvedFilePathText`	TEXT	Optional
`Status`	TEXT	Optional
`IssueDate`	DATEONLY	Required
`IsCorrected`	BOOLEAN	Optional
`OriginalDocumentId`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional

TaxDocumentItemDmo

Field	Type	Required or Optional
`Id`	TEXT	Required
`TaxDocumentId`	TEXT	Required
`LineReferenceTxt`	TEXT	Required
`Category`	TEXT	Optional
`Subcategory`	TEXT	Optional
`ReportedAmt`	CURRENCY	Optional
`ParentLineItemId`	TEXT	Optional
`Description`	TEXT	Optional
`CreatedDateTime`	DATETIME	Optional
`LastModifiedDateTime`	DATETIME	Optional