Retrieve a taxpayer's activity and profile through the new Tax and Revenue resources. Get the logged-in taxpayer's filings, documents, payments, refunds, and assessments for a tax year scoped to just the views you need, and get a taxpayer profile with the tax years that have filings on record.
New Connect REST API
- Get tax constituent activity
-
Make a POST request to the new /services/data/v68.0/connect/public-sector/tax-revenue/tax-account/activities resource. Retrieve a taxpayer's activity for a single tax year, scoped by the views you request (filings, documents, payments, refunds, assessments). The logged-in user determines the taxpayer. The response includes only the views and sub-views in the request. A failed section returns HTTP 200 with an error on that section.
New request body: Tax Constituent Activity Input
New response body: Tax Constituent Activity
- Get tax revenue profile
-
Make a POST request to the new /services/data/v68.0/connect/public-sector/tax-revenue/tax-account/profile resource. Retrieve a taxpayer's profile including display name and the tax years for which filings exist. The logged-in user determines the taxpayer. The request body is an empty JSON object.
New request body: Tax Revenue Profile Input
New response body: Tax Revenue Profile
New Connect in Apex Methods
These new methods are in the ConnectApi.MissionforceTaxRevenueApi class.
- Get tax constituent activity
-
Use the getTaxRevenueActivities(taxRevenueActivityInputRepresentation) method.
New input class: ConnectApi.TaxRevenueActivityInputRepresentation
The input carries taxYear and the views to return. Set includeAllViews to return every view. A sub-view is returned when includeAllSubViews is true or the sub-view is listed.
New output class: ConnectApi.TaxRevenueActivityRepresentation
- Get tax revenue profile
-
Use the getTaxRevenueProfile() method.
New output class: ConnectApi.TaxRevenueProfileRepresentation