You are here:
Taxpayer Portal Data Providers and Expressions
Reference for the TaxpayerProfile and TaxpayerActivity data providers and related platform expressions. Data providers and expressions supply the live taxpayer data to Tax Center components in the Taxpayer portal.
Required Editions
| View supported product editions. |
About Tax Center Data Providers
The Tax Center page uses two data providers that supply live taxpayer data to portal components. Bind component properties to these expressions in Experience Builder. To learn more about how to customize Tax Center tabs, fields, branding, and error and empty states, see Customize the Taxpayer Portal. To learn more about general platform data expressions, see Use Expressions to Add Dynamic Data to LWR Sites.
TaxpayerProfile Expressions
TaxpayerProfile is a page-level data provider. It fetches the taxpayer's profile when the page loads by using the logged-in user's Contact ID.
| Expression | Type | Description |
|---|---|---|
{!TaxpayerProfile.ClientState} |
Object | Provider lifecycle state. |
{!TaxpayerProfile.ClientState.isLoading} |
Boolean | True while fetching. |
{!TaxpayerProfile.ClientState.hasErrors} |
Boolean | True on API error. |
{!TaxpayerProfile.ClientState.isEmpty} |
Boolean | True when the taxpayer isn't linked to a tax account. |
{!TaxpayerProfile.TaxAccount.availableTaxYears} |
Array | List of tax years available for this taxpayer. |
{!TaxpayerProfile.LatestTaxYear} |
Integer | Most recent tax year. Auto-seeds the Activity provider. |
TaxpayerActivity Expressions
TaxpayerActivity is a component-level data provider scoped to the Tax Center Container. It fetches tax data for the selected year and refetches automatically when the taxpayer changes the year in the Filing Period selector.
| Expression | Type | Description |
|---|---|---|
{!TaxpayerActivity.ClientState} |
Object | Provider lifecycle state. |
{!TaxpayerActivity.ClientState.isLoading} |
Boolean | True while fetching. |
{!TaxpayerActivity.ClientState.hasErrors} |
Boolean | True on API error. |
{!TaxpayerActivity.ClientState.isEmpty} |
Boolean | True when the year has no records. |
{!TaxpayerActivity.Filings} |
Array | All tax filings for the selected year. |
{!TaxpayerActivity.Documents} |
Array | Income documents such as W-2 and 1099. |
{!TaxpayerActivity.Payments} |
Array | Tax payments and deposits. |
{!TaxpayerActivity.Refunds} |
Array | Refund records. |
{!TaxpayerActivity.Assessments} |
Array | Tax assessments linked to filings. |
{!TaxpayerActivity.TaxYear} |
Integer | Currently selected tax year. |
{!TaxpayerActivity.Currency} |
String | Currency code, such as USD. |
{!TaxpayerActivity} |
Object | Full activity object. Pass to panels and AI Summary. |
