Tax Constituent Activity (POST)
Returns activity for a taxpayer, including optional views for filing, earnings, payments,
and assessments for a given tax year.
- Resource
-
1/connect/public-sector/tax-revenue/constituents/${constituentId}/activity - Available version
- 68.0
- HTTP methods
- POST
- Request body for POST
-
- JSON Filing example
-
1{ 2 "taxYear": 2025, 3 "views": { 4"filing": ["lineItem","participants"], 5"document": [], 6} 7} - JSON Payments example
-
1{ 2 "taxYear": 2025, 3 "views": ["payments"] 4} - JSON Refunds example
-
1{ 2 "taxYear": 2025, 3 "views": ["refunds"] 4} - JSON Assessments example
-
1{ 2 "taxYear": 2025, 3 "views": ["assessments"] 4} - JSON All views example
-
1{ 2 "taxYear": 2025 3} - Properties
-
Name Type Description Required or Optional Available Version dataMappingObjects Map<String, ConnectApi.DataMappingObjectInput> Per-DMO additional fields beyond defaults. Key = DMO name (TaxFiling, TaxFilingParticipant, TaxFilingLineItem, TaxPayment, TaxRefund, TaxFilingAssessment, TaxFilingLineItemAssessment, TaxDocument, TaxDocumentItem). Value = object with fields array. Maximum 30 additional fields total. 68.0 taxYear Integer Required. The tax year to return activity for. Required 68.0 views Map<String, ConnectApi.TaxActivityViewInput> Scopes which sections are returned and, per section, which child sub-sections to expand. Map of view name to a per-view expansion object whose subViews lists the child sub-sections to expand. Allowed view keys are filings, documents, payments, refunds, and assessments. Sub-view names per view are filings = [participants, lineItems] and assessments = [lineItems]; documents, payments, and refunds have no sub-views. An empty object or omitted subViews for a view (e.g. "documents": {}) selects that view with its default sub-views. An empty or omitted map returns all views with their default sub-views. Unknown view keys are rejected. 68.0
- Response body for POST
- Tax Constituent Activity
- Request parameters for POST
-
Parameter Name Type Description Required or Optional Available Version constituentId String The ID of the constituent (taxpayer). Supplied as a variable in the resource URL. Required 68.0 taxConstituentActivityInput Object The query input. The request body maps to TaxConstituentActivityInput . Required 68.0