pool_tracking

Filemark T2 batch computation internal aggregate

Kind
batch
Supported tax years
Strict profile
pool_tracking_exact_2025_default_branch_v1
Payload schema version
7.0.0
Dependencies (run automatically)
aoc, dividend_pool_status, division_c, part_i_tax, sbd, schedule24, schedule3, schedule31, schedule43, schedule53, schedule54, schedule55, schedule6, schedule7

Example request

Send this body to POST /api/v1/computations/batch. It satisfies the strict profile, so it works with or without the payloadContract selector.

{
  "compute": [
    "pool_tracking"
  ],
  "inputs": {
    "schedule1": {},
    "taxYear": 2025,
    "fiscalStart": "2025-01-01",
    "fiscalEnd": "2025-12-31",
    "isCCPC": true,
    "t2Jacket": {
      "filingStatus": {
        "firstYearAfterIncorporation": true,
        "firstYearAfterAmalgamation": false,
        "subsidiaryWindupS88": false
      }
    },
    "daysInYear": 365
  }
}

Input cells (13)

Paths are relative to the request’s inputs object; [] marks an array element.

Required says when a cell must be present. Always means every request needs it: the default boundary rejects the call when the cell is omitted or null. Strict means only a request that sends this target’s payloadContract selector needs it. See Run computations for the default boundary.

These cells are everything this target accepts. A member that is not published here, or is sent with the wrong JSON type, fails the call with a 400 naming each failing cell.

Input cells for pool_tracking
CellTypesRequired
daysInYearInclusive day count of the taxation year. It must equal the fiscalStart-to-fiscalEnd span, counting both end days, so a leap year states 366. Required for the same reason as fiscalStart; the count reconciles the bounds and never constructs them.integerstrict
fiscalEndLast day of the taxation year, as YYYY-MM-DD, on or after fiscalStart. Its calendar year must equal taxYear. Required for the same reason as fiscalStart.stringstrict
fiscalStartFirst day of the taxation year, as YYYY-MM-DD. Required because this target's dependency closure reaches part_i_tax, whose rates and limits are day-weighted; ITA s.249(1)(a) makes the taxation year the fiscal period, and the engine will not invent calendar-year bounds.stringstrict
isCCPCThe corporation was a Canadian-controlled private corporation (ITA s.125(7) definition) throughout the taxation year.boolean
pool_tracking.provisionalboolean
pool_tracking.totalDividendRefundnumber
pool_tracking.warningsarray
pyPoolsPrior-year balances for the corporation's tax pools, keyed by pool name (cda, erdtoh, nerdtoh). Each value is an object carrying opening, closingBalance or priorClosing as a number or plain decimal string; a bare amount is also read. Omit the key entirely when there is no prior year rather than sending an explicit null, which raises.object
schedule1objectstrict
t2Jacket.filingStatus.firstYearAfterAmalgamationbooleanstrict
t2Jacket.filingStatus.firstYearAfterIncorporationbooleanstrict
t2Jacket.filingStatus.subsidiaryWindupS88booleanstrict
taxYearFour-digit taxation year accepted by the batch reader. Historical applicability is decided by the requested form; years after 2027 fail at the shared verified-rate horizon.number | stringalways
Strict profile accepted values (4 of 13 cells)

These values apply only when the request sends this target’s payloadContract selector. A cell marked pinned must equal the value shown to satisfy the strict profile. On the default boundary the same cell accepts any value of its published type.

Strict profile accepted values for pool_tracking
CellAccepted values
daysInYear1 to 1000000000000000
fiscalEnddate (YYYY-MM-DD); 10 to 10 characters
fiscalStartdate (YYYY-MM-DD); 10 to 10 characters
taxYearmatches ^\s*(?:1[0-9]{3}|2(?:0(?:[0-1][0-9]{1}|2[0-7])))\s*$; 1000 to 2027

Output cells (117)

Paths are relative to this target’s result object in the response.

Output cells for pool_tracking
CellTypes
carryforwardMovementLedger.pools[].closingnull | number
carryforwardMovementLedger.pools[].ita_referencestring
carryforwardMovementLedger.pools[].labelstring
carryforwardMovementLedger.pools[].movements[].amountnull | number
carryforwardMovementLedger.pools[].movements[].labelstring
carryforwardMovementLedger.pools[].openingnull | number
carryforwardMovementLedger.pools[].pool_idstring
carryforwardMovementLedger.pools[].reconciliation_completeboolean
carryforwardMovementLedger.pools[].reconciliation_notenull | string
carryforwardMovementLedger.pools[].warnings[]string
carryforwardMovementLedger.schemaVersioninteger
cda.capitalDividendsPaidnumber
cda.capitalDividendsReceivednumber
cda.capitalGainsAdditionnumber
cda.closingnumber
cda.closingParagraphAnumber
cda.deemedNilAmount_131_11_enumber
cda.deemedNilUnder_131_11_eboolean
cda.lifeInsuranceNetnumber
cda.lifeInsurancePoliciesarray
cda.openingnumber
cda.openingParagraphAnumber
cda.openingParagraphAWasSuppliedboolean
cda.paragraphHnumber
cda.paragraphHOmittedUnder_93_4_3boolean
cda.reset_89_1_1number
cda.reset_89_1_2number
cda.trustDistributionsarray
cda.trustParagraphAI1number
cda.trustParagraphFnumber
cda.trustParagraphGnumber
cda.aocTimingAdjustment111_4_fnumber
cda.successorContinuityEstablishedboolean
cda.successorContinuityEventsarray
cda.successorContinuityParagraphAnumber
cda.successorContinuityTransfernumber
cda.authority.asOfstring
cda.authority.establishedboolean
cda.authority.statusstring
cda.authority.unestablishedReasons[]string
cda.paragraphHStatus.a1Limbnumber
cda.paragraphHStatus.amountnumber
cda.paragraphHStatus.ccpcThroughoutYeararray | boolean | null | number | object | string
cda.paragraphHStatus.effectiveFiscalStartstring
cda.paragraphHStatus.election93_4_3Madearray | boolean | null | number | object | string
cda.paragraphHStatus.establishedboolean
cda.paragraphHStatus.fiscalStartstring
cda.paragraphHStatus.lowRtfLimbnumber
cda.paragraphHStatus.materialboolean
cda.paragraphHStatus.statusstring
cda.paragraphHStatus.substantiveCcpcAnytimearray | boolean | null | number | object | string
cda.capitalDividendElectionsarray
cda.closingParagraphARunningnumber
cda.openingParagraphARunningnumber
cda.closingRunningnumber
continuityChecksarray
dividendPool.authorityarray | boolean | null | number | object | string
dividendPool.closingarray | boolean | null | number | object | string
dividendPool.regimestring
dividendPool.statusstring
dividendPool.triggerarray | boolean | null | number | object | string
dividendRefundInputs.eligibleDividendsPaidnumber
dividendRefundInputs.nonEligibleDividendsPaidnumber
dividendRefundStatusstring
erdtoh.additionsnumber
erdtoh.closingnumber
erdtoh.eligibleDividendRefundnumber
erdtoh.nonEligibleRefundDrawFromERDTOHnumber
erdtoh.openingnumber
erdtoh.openingEnterednumber
erdtoh.partIV1Reductionnumber
erdtoh.partIVConnectednumber
erdtoh.partIVEligiblenumber
erdtoh.priorYearDividendRefundnumber
erdtoh.transfernumber
erdtoh.partIVAmountCnumber
erdtoh.partIVAmountDnumber
erdtoh.partIVAmountEnumber
erdtoh.partIVAmountQnumber
griparray | boolean | null | number | object | string
lriparray | boolean | null | number | object | string
nerdtoh.additionsnumber
nerdtoh.closingnumber
nerdtoh.nonEligibleDividendRefundnumber
nerdtoh.nonEligibleDividendsPaidnumber
nerdtoh.openingnumber
nerdtoh.openingEnterednumber
nerdtoh.partIV1Reductionnumber
nerdtoh.partIVConnectednumber
nerdtoh.partIVNonEligiblenumber
nerdtoh.priorYearDividendRefundnumber
nerdtoh.refundablePartInumber
nerdtoh.refundablePartIAmountEnumber
nerdtoh.refundablePartIAmountLnumber
nerdtoh.refundablePartIAmountMnull | number
nerdtoh.transfernumber
nerdtoh.partIVAmountInumber
nerdtoh.partIVAmountLnumber
nerdtoh.partIVAmountOnumber
nerdtoh.partIVAmountPnumber
poolOpeningsSupplied.cdaboolean
poolOpeningsSupplied.erdtohboolean
poolOpeningsSupplied.nerdtohboolean
provisionalboolean
totalDividendRefundnumber
warnings[]string
warnings[].codestring
warnings[].severitystring
warnings[].messagestring
warnings[].poolstring
warnings[].expectedAsOfnull | string
warnings[].reportedAsOfnull | string
warnings[].reportedMemberstring
warnings[].reportedAmountboolean | null | number | string
warnings[].actualnumber
warnings[].expectednumber
warnings[].unreconciledAmountnumber
Filemark | pool_tracking cells