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.
| Cell | Types | Required |
|---|---|---|
| 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. | integer | strict |
| 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. | string | strict |
| 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. | string | strict |
| isCCPCThe corporation was a Canadian-controlled private corporation (ITA s.125(7) definition) throughout the taxation year. | boolean | |
| pool_tracking.provisional | boolean | |
| pool_tracking.totalDividendRefund | number | |
| pool_tracking.warnings | array | |
| 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 | |
| schedule1 | object | strict |
| t2Jacket.filingStatus.firstYearAfterAmalgamation | boolean | strict |
| t2Jacket.filingStatus.firstYearAfterIncorporation | boolean | strict |
| t2Jacket.filingStatus.subsidiaryWindupS88 | boolean | strict |
| 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 | string | always |
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.
| Cell | Accepted values |
|---|---|
| daysInYear | 1 to 1000000000000000 |
| fiscalEnd | date (YYYY-MM-DD); 10 to 10 characters |
| fiscalStart | date (YYYY-MM-DD); 10 to 10 characters |
| taxYear | matches ^\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.
| Cell | Types |
|---|---|
| carryforwardMovementLedger.pools[].closing | null | number |
| carryforwardMovementLedger.pools[].ita_reference | string |
| carryforwardMovementLedger.pools[].label | string |
| carryforwardMovementLedger.pools[].movements[].amount | null | number |
| carryforwardMovementLedger.pools[].movements[].label | string |
| carryforwardMovementLedger.pools[].opening | null | number |
| carryforwardMovementLedger.pools[].pool_id | string |
| carryforwardMovementLedger.pools[].reconciliation_complete | boolean |
| carryforwardMovementLedger.pools[].reconciliation_note | null | string |
| carryforwardMovementLedger.pools[].warnings[] | string |
| carryforwardMovementLedger.schemaVersion | integer |
| cda.capitalDividendsPaid | number |
| cda.capitalDividendsReceived | number |
| cda.capitalGainsAddition | number |
| cda.closing | number |
| cda.closingParagraphA | number |
| cda.deemedNilAmount_131_11_e | number |
| cda.deemedNilUnder_131_11_e | boolean |
| cda.lifeInsuranceNet | number |
| cda.lifeInsurancePolicies | array |
| cda.opening | number |
| cda.openingParagraphA | number |
| cda.openingParagraphAWasSupplied | boolean |
| cda.paragraphH | number |
| cda.paragraphHOmittedUnder_93_4_3 | boolean |
| cda.reset_89_1_1 | number |
| cda.reset_89_1_2 | number |
| cda.trustDistributions | array |
| cda.trustParagraphAI1 | number |
| cda.trustParagraphF | number |
| cda.trustParagraphG | number |
| cda.aocTimingAdjustment111_4_f | number |
| cda.successorContinuityEstablished | boolean |
| cda.successorContinuityEvents | array |
| cda.successorContinuityParagraphA | number |
| cda.successorContinuityTransfer | number |
| cda.authority.asOf | string |
| cda.authority.established | boolean |
| cda.authority.status | string |
| cda.authority.unestablishedReasons[] | string |
| cda.paragraphHStatus.a1Limb | number |
| cda.paragraphHStatus.amount | number |
| cda.paragraphHStatus.ccpcThroughoutYear | array | boolean | null | number | object | string |
| cda.paragraphHStatus.effectiveFiscalStart | string |
| cda.paragraphHStatus.election93_4_3Made | array | boolean | null | number | object | string |
| cda.paragraphHStatus.established | boolean |
| cda.paragraphHStatus.fiscalStart | string |
| cda.paragraphHStatus.lowRtfLimb | number |
| cda.paragraphHStatus.material | boolean |
| cda.paragraphHStatus.status | string |
| cda.paragraphHStatus.substantiveCcpcAnytime | array | boolean | null | number | object | string |
| cda.capitalDividendElections | array |
| cda.closingParagraphARunning | number |
| cda.openingParagraphARunning | number |
| cda.closingRunning | number |
| continuityChecks | array |
| dividendPool.authority | array | boolean | null | number | object | string |
| dividendPool.closing | array | boolean | null | number | object | string |
| dividendPool.regime | string |
| dividendPool.status | string |
| dividendPool.trigger | array | boolean | null | number | object | string |
| dividendRefundInputs.eligibleDividendsPaid | number |
| dividendRefundInputs.nonEligibleDividendsPaid | number |
| dividendRefundStatus | string |
| erdtoh.additions | number |
| erdtoh.closing | number |
| erdtoh.eligibleDividendRefund | number |
| erdtoh.nonEligibleRefundDrawFromERDTOH | number |
| erdtoh.opening | number |
| erdtoh.openingEntered | number |
| erdtoh.partIV1Reduction | number |
| erdtoh.partIVConnected | number |
| erdtoh.partIVEligible | number |
| erdtoh.priorYearDividendRefund | number |
| erdtoh.transfer | number |
| erdtoh.partIVAmountC | number |
| erdtoh.partIVAmountD | number |
| erdtoh.partIVAmountE | number |
| erdtoh.partIVAmountQ | number |
| grip | array | boolean | null | number | object | string |
| lrip | array | boolean | null | number | object | string |
| nerdtoh.additions | number |
| nerdtoh.closing | number |
| nerdtoh.nonEligibleDividendRefund | number |
| nerdtoh.nonEligibleDividendsPaid | number |
| nerdtoh.opening | number |
| nerdtoh.openingEntered | number |
| nerdtoh.partIV1Reduction | number |
| nerdtoh.partIVConnected | number |
| nerdtoh.partIVNonEligible | number |
| nerdtoh.priorYearDividendRefund | number |
| nerdtoh.refundablePartI | number |
| nerdtoh.refundablePartIAmountE | number |
| nerdtoh.refundablePartIAmountL | number |
| nerdtoh.refundablePartIAmountM | null | number |
| nerdtoh.transfer | number |
| nerdtoh.partIVAmountI | number |
| nerdtoh.partIVAmountL | number |
| nerdtoh.partIVAmountO | number |
| nerdtoh.partIVAmountP | number |
| poolOpeningsSupplied.cda | boolean |
| poolOpeningsSupplied.erdtoh | boolean |
| poolOpeningsSupplied.nerdtoh | boolean |
| provisional | boolean |
| totalDividendRefund | number |
| warnings[] | string |
| warnings[].code | string |
| warnings[].severity | string |
| warnings[].message | string |
| warnings[].pool | string |
| warnings[].expectedAsOf | null | string |
| warnings[].reportedAsOf | null | string |
| warnings[].reportedMember | string |
| warnings[].reportedAmount | boolean | null | number | string |
| warnings[].actual | number |
| warnings[].expected | number |
| warnings[].unreconciledAmount | number |