form_aggregates

T2 Corporation Income Tax Return

Kind
batch
Supported tax years
2023–2027
Strict profile
form_aggregates_v1
Payload schema version
0.1.0
Dependencies (run automatically)
none

Example request

Send this body to POST /api/v1/computations/batch. This example works with or without payloadContract.

{
  "compute": [
    "form_aggregates"
  ],
  "inputs": {
    "taxYear": 2025,
    "formId": "t2jacket",
    "seeded": {
      "300": 500000,
      "311": 20000,
      "320": 30000,
      "331": 50000,
      "355": 10000
    }
  }
}

Input cells (6)

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

Cells marked always require a non-null value in every request. Cells marked strict are required when you supply this target's payloadContract. See Run computations.

Unknown cells and JSON type mismatches return 400 with the affected cells in the error details.

Input cells for form_aggregates
CellTypesRequired
fiscalEndstring
fiscalStartstring
formIdThe form whose aggregate boxes should be evaluated.stringstrict
revisionOptional configured form revision.null | string
seededEntered values keyed by form line code.null | objectstrict
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.integer | stringalways
Strict profile accepted values (5 of 6 cells)

These constraints apply when you supply this target's payloadContract. Cells marked pinned must equal the listed value.

Strict profile accepted values for form_aggregates
CellAccepted values
fiscalEnddate (YYYY-MM-DD); 10 to 10 characters
fiscalStartdate (YYYY-MM-DD); 10 to 10 characters
formIdone of "schedule1", "schedule10", "schedule100", "schedule101", "schedule11", "schedule125", "schedule13", "schedule130", "schedule14", "schedule141", "schedule15", "schedule17", "schedule18", "schedule2", "schedule20", "schedule21", "schedule23", "schedule24", "schedule25", "schedule27", "schedule28", "schedule29", "schedule3", "schedule305", "schedule306", "schedule31", "schedule33", "schedule34", "schedule35", "schedule352", "schedule353", "schedule38", "schedule39", "schedule4", "schedule404", "schedule42", "schedule43", "schedule44", "schedule45", "schedule49", "schedule5", "schedule50", "schedule502", "schedule510", "schedule511", "schedule512", "schedule513", "schedule53", "schedule54", "schedule55", "schedule56", "schedule572", "schedule58", "schedule6", "schedule63", "schedule67", "schedule68", "schedule7", "schedule71", "schedule72", "schedule73", "schedule74", "schedule75", "schedule76", "schedule78", "schedule8", "schedule88", "schedule89", "schedule9", "schedule91", "schedule97", "t2142", "t2jacket"
revision1 to 64 characters
taxYearmatches ^\s*(?:1[0-9]{3}|2(?:0(?:[0-1][0-9]{1}|2[0-7])))\s*$; 1000 to 2027

Output cells (8)

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

Output cells for form_aggregates
CellTypes
evaluatedobject
projection.formIdstring
projection.revisionstring
projection.pdfAssetstring
projection.rowOrder[]string
projection.boxesobject
projection.invalidSeedsobject
projection.warnings[]string
Filemark | form_aggregates cells