--- title: "Get payroll report" description: "Returns the payroll issued before deductions today, over the last 7 days, or this month, with its receipt count, net pay, ISR withheld, the payroll ISR of the next monthly payment, and the month's top employees." language: en canonical_url: "https://exac.mx/docs/en/api/tax-reports/reports/get-payroll-report" md_url: "https://exac.mx/docs/en/api/tax-reports/reports/get-payroll-report.md" --- # Get payroll report Returns the payroll issued before deductions today, over the last 7 days, or this month, with its receipt count, net pay, ISR withheld, the payroll ISR of the next monthly payment, and the month's top employees. ## Request `GET /v1/reports/payroll` - **Authorization:** Required permission: `analytics:read`. - **Environments:** Production and sandbox - **Idempotency:** Not required ## Canonical machine contract This fragment is generated from the canonical operation and Zod contracts used by the route. ```json { "method": "GET", "path": "/v1/reports/payroll", "operation": { "operationId": "getPayrollReport", "tags": [ "Reports" ], "summary": "Get payroll report", "description": "Returns the payroll issued before deductions today, over the last 7 days, or this month, with its receipt count, net pay, ISR withheld, the payroll ISR of the next monthly payment, and the month's top employees.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "period", "in": "query", "required": false, "schema": { "description": "The organization's current day, the 7 days ending on it, or its calendar month so far; defaults to last_7_days", "type": "string", "enum": [ "today", "last_7_days", "month" ] } } ], "responses": { "200": { "description": "Operation completed.", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dateFrom": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dateTo": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "total": { "type": "number" }, "receipts": { "type": "number" }, "net": { "type": "number" }, "isrWithheld": { "type": "number" }, "isrPayment": { "type": "object", "properties": { "month": { "type": "string", "pattern": "^\\d{4}-\\d{2}$" }, "isrWithheld": { "type": "number" } }, "required": [ "month", "isrWithheld" ], "additionalProperties": false }, "employees": { "type": "object", "properties": { "month": { "type": "string", "pattern": "^\\d{4}-\\d{2}$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "number" }, "isOther": { "type": "boolean" }, "counterpartyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "share": { "type": "number" } }, "required": [ "name", "amount", "isOther", "counterpartyId", "share" ], "additionalProperties": false } } }, "required": [ "month", "items" ], "additionalProperties": false }, "source": { "type": "string", "const": "payroll_summary" }, "currency": { "type": "string", "const": "MXN" }, "period": { "type": "string", "enum": [ "today", "last_7_days", "month" ] }, "amountBasis": { "type": "string", "const": "before_deductions" } }, "required": [ "dateFrom", "dateTo", "total", "receipts", "net", "isrWithheld", "isrPayment", "employees", "source", "currency", "period", "amountBasis" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false }, "example": { "data": { "dateFrom": "2026-07-12", "dateTo": "2026-07-18", "total": 42000, "receipts": 3, "net": 35280, "isrWithheld": 4620, "isrPayment": { "month": "2026-06", "isrWithheld": 10080 }, "employees": { "month": "2026-07", "items": [ { "name": "Persona Ejemplo", "amount": 36000, "isOther": false, "counterpartyId": "employee-example", "share": 0.4 }, { "name": "Otros", "amount": 54000, "isOther": true, "counterpartyId": null, "share": 0.6 } ] }, "source": "payroll_summary", "currency": "MXN", "period": "last_7_days", "amountBasis": "before_deductions" } } } } }, "400": { "description": "Invalid request.\n\n`validation_error`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Missing or invalid credential.\n\n`unauthenticated`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "WWW-Authenticate": { "$ref": "#/components/headers/WWWAuthenticate" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The credential does not include the `analytics:read` permission.\n\n`forbidden`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "WWW-Authenticate": { "$ref": "#/components/headers/WWWAuthenticate" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Resource not found.\n\n`not_found`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "405": { "description": "Method not allowed.\n\n`method_not_allowed`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "Allow": { "$ref": "#/components/headers/Allow" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many requests.\n\n`rate_limited`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Internal server error.\n\n`internal`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Service temporarily unavailable.\n\n`provider_unavailable`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-exac-environments": [ "production", "sandbox" ] }, "components": { "schemas": { "ApiError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ProgrammaticError" } }, "required": [ "error" ], "additionalProperties": false }, "ProgrammaticError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "validation_error", "unauthenticated", "forbidden", "payment_required", "not_found", "method_not_allowed", "conflict", "idempotency_conflict", "operation_in_progress", "recovery_required", "migration_required", "rate_limited", "provider_unavailable", "internal" ], "description": "Recommended action by code:\n\n- `validation_error` — Correct each details.issues entry using its path and stable issue code.\n- `unauthenticated` — Provide a valid API key or OAuth access token.\n- `forbidden` — Use a credential with the required permission.\n- `payment_required` — Review the RFC plan, payment method, and spending limit in billing settings. Retry only after the billing requirement is resolved.\n- `not_found` — Check the organization-scoped resource identifier.\n- `method_not_allowed` — Use the documented HTTP method.\n- `conflict` — Refresh the resource and resolve its current state.\n- `idempotency_conflict` — Use a new idempotency key for a changed request.\n- `operation_in_progress` — Wait for Retry-After, then repeat the exact request.\n- `recovery_required` — Do not retry automatically; reconcile the provider outcome.\n- `migration_required` — Contact support to complete historical document migration; do not reissue the document.\n- `rate_limited` — Wait for Retry-After before retrying.\n- `provider_unavailable` — Retry only when the response marks the failure as retryable.\n- `internal` — Retry later and contact support if the error persists." }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentRef": { "$ref": "#/components/schemas/DocumentRef" }, "editable": { "type": "boolean" } }, "required": [ "documentRef", "editable" ], "additionalProperties": false }, "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 }, "reason": { "type": "string" }, "balanceMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "topUpUrl": { "type": "string" } }, "additionalProperties": false }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "code", "message", "status" ], "additionalProperties": false }, "DocumentRef": { "type": "string", "pattern": "^(invoice|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$" } } } } ``` [OpenAPI 3.1](/openapi.json) ## Equivalent MCP tools - [`get_payroll_summary`](/docs/en/mcp/tools/get_payroll_summary.md) Complete documentation: https://exac.mx/docs/en.md Agent documentation index: https://exac.mx/docs/en/llms.txt