Get tax summary
Get authoritative taxes declared, paid, and pending for a fiscal year or month. Tax amounts come only from parsed declarations; CFDI contributor context is informational and never affects tax totals. If declarations are unavailable, tax totals are null rather than estimated.
get_tax_summaryPurpose
Read authoritative declared, paid, and pending tax totals.
- Use when
- You need tax totals sourced from SAT declarations.
- Do not use when
- You need estimated tax amounts from CFDI activity.
- Required permissions
- Side effects
- None
- Idempotency
- Idempotent
Input schema
JSON Schema{ "type": "object", "properties": { "fiscalYear": { "type": "integer", "minimum": 2000, "maximum": 2100, "description": "Four-digit fiscal year" }, "period": { "description": "Optional month number from 1 to 12", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "contributorLimit": { "description": "Top CFDI contributors in the informational context", "allOf": [ { "$ref": "#/definitions/__schema1" } ] } }, "required": [ "fiscalYear" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 12 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 10 } }}Output schema
JSON Schema{ "type": "object", "properties": { "data": { "type": "object", "properties": { "source": { "type": "string", "const": "sat_declarations" }, "currency": { "type": "string", "const": "MXN" }, "fiscalYear": { "type": "number" }, "selectedPeriod": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "declarationCoverage": { "type": "string", "enum": [ "none", "partial", "complete" ] }, "filedPeriods": { "type": "array", "items": { "type": "number" } }, "missingPeriods": { "type": "array", "items": { "type": "number" } }, "totals": { "anyOf": [ { "type": "object", "properties": { "declaredTaxTotal": { "type": "number" }, "paidTaxTotal": { "type": "number" }, "pendingTaxTotal": { "type": "number" }, "breakdown": { "$ref": "#/definitions/__schema0" } }, "required": [ "declaredTaxTotal", "paidTaxTotal", "pendingTaxTotal", "breakdown" ], "additionalProperties": false }, { "type": "null" } ] }, "periods": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "number" }, "filingCount": { "type": "number" }, "declaredTaxTotal": { "type": "number" }, "paidTaxTotal": { "type": "number" }, "pendingTaxTotal": { "type": "number" }, "paymentStatus": { "type": "string", "enum": [ "no_obligation", "pending", "partially_paid", "paid" ] }, "breakdown": { "$ref": "#/definitions/__schema0" }, "withholdingDetails": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "number" } }, "required": [ "name", "amount" ], "additionalProperties": false } } }, "required": [ "period", "filingCount", "declaredTaxTotal", "paidTaxTotal", "pendingTaxTotal", "paymentStatus", "breakdown", "withholdingDetails" ], "additionalProperties": false } }, "cfdiContext": { "anyOf": [ { "type": "object", "properties": { "usedForTaxAmounts": { "type": "boolean", "const": false }, "contributors": { "type": "object", "properties": { "source": { "type": "string", "const": "cfdi_activity" }, "income": { "type": "array", "items": { "$ref": "#/definitions/__schema1" } }, "expenses": { "type": "array", "items": { "$ref": "#/definitions/__schema1" } }, "payroll": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/definitions/__schema2" }, "amount": { "$ref": "#/definitions/__schema3" }, "isOther": { "$ref": "#/definitions/__schema4" }, "direction": { "type": "string", "enum": [ "paid", "received" ] } }, "required": [ "name", "amount", "isOther", "direction" ], "additionalProperties": false } } }, "required": [ "source", "income", "expenses", "payroll" ], "additionalProperties": false } }, "required": [ "usedForTaxAmounts", "contributors" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "source", "currency", "fiscalYear", "selectedPeriod", "declarationCoverage", "filedPeriods", "missingPeriods", "totals", "periods", "cfdiContext" ], "additionalProperties": false }, "error": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "code": { "type": "string", "enum": [ "validation_error", "unauthenticated", "forbidden", "not_found", "method_not_allowed", "conflict", "idempotency_conflict", "operation_in_progress", "recovery_required", "rate_limited", "provider_unavailable", "internal" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "retryable": { "type": "boolean" }, "retryAfterSeconds": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "type": "object", "properties": { "isr": { "type": "number" }, "iva": { "type": "number" }, "withholdings": { "type": "number" }, "unclassified": { "type": "number" } }, "required": [ "isr", "iva", "withholdings", "unclassified" ], "additionalProperties": false }, "__schema1": { "type": "object", "properties": { "name": { "$ref": "#/definitions/__schema2" }, "amount": { "$ref": "#/definitions/__schema3" }, "isOther": { "$ref": "#/definitions/__schema4" } }, "required": [ "name", "amount", "isOther" ], "additionalProperties": false }, "__schema2": { "type": "string" }, "__schema3": { "type": "number" }, "__schema4": { "type": "boolean" } }, "oneOf": [ { "required": [ "data" ] }, { "required": [ "error" ] } ]}Related workflow
See the canonical workflows in the introductionRelated tools
Get CFDI collection summary
Summarize gross cash collected through valid sent Type I invoices for one CFDI civil day. PUE invoices are recognized on Fecha and PPD collections on payment-complement FechaPago. PPD parents are never counted as cash, so payment allocations cannot double count them. Historical coverage is forward-only until an intentional backfill.
Sync SAT data
Refresh one SAT source for the active organization. Use documents for CFDIs/withholdings in a date range, declarations for one fiscal year, or compliance_opinion for the latest SAT opinion. This starts external SAT work; read results with search_documents or get_tax_summary.