Get sales receipt summary
Summarize sales recorded as Exac receipts for one business day. Use this for 'how much did I sell?'. It includes receipts later invoiced and receipts never invoiced, and never adds CFDI totals separately.
get_sales_receipt_summaryPurpose
Summarize sales recorded as Exac receipts for a business day.
- Use when
- You need POS sales totals, including invoiced and uninvoiced receipts.
- Do not use when
- You need recognized CFDI activity instead of receipt activity.
- Required permissions
- Side effects
- None
- Idempotency
- Idempotent
Input schema
JSON Schema{ "type": "object", "properties": { "date": { "description": "Business date in YYYY-MM-DD; defaults to the org's today", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "activityLimit": { "description": "Top customers, products, and locations; defaults to 4", "allOf": [ { "$ref": "#/definitions/__schema1" } ] } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "type": "string" }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 10 } }}Output schema
JSON Schema{ "type": "object", "properties": { "data": { "type": "object", "properties": { "source": { "type": "string", "const": "sales_receipts" }, "currency": { "type": "string", "const": "MXN" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "includesInvoicedReceipts": { "type": "boolean", "const": true }, "cfdiTotalsIncluded": { "type": "boolean", "const": false }, "totals": { "type": "object", "properties": { "netSales": { "type": "number" }, "receiptCount": { "type": "number" } }, "required": [ "netSales", "receiptCount" ], "additionalProperties": false }, "byPaymentMethod": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "enum": [ "cash", "card", "transfer", "credit", "other" ] }, "netSales": { "type": "number" }, "share": { "type": "number" } }, "required": [ "paymentMethod", "netSales", "share" ], "additionalProperties": false } }, "top": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, "products": { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, "locations": { "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "customers", "products", "locations" ], "additionalProperties": false } }, "required": [ "source", "currency", "date", "includesInvoicedReceipts", "cfdiTotalsIncluded", "totals", "byPaymentMethod", "top" ], "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": { "name": { "type": "string" }, "amount": { "type": "number" }, "quantity": { "type": "number" }, "receiptCount": { "type": "number" }, "share": { "type": "number" } }, "required": [ "name", "amount", "quantity", "receiptCount", "share" ], "additionalProperties": false } }, "oneOf": [ { "required": [ "data" ] }, { "required": [ "error" ] } ]}Related workflow
See the canonical workflows in the introductionRelated tools
Get CFDI summary
Summarize CFDI activity for a month range: recognized income, recognized expenses, payroll paid, payroll received, balance, and top contributors. Every payroll contributor has a paid or received direction. Uses CFDI aggregates only. It excludes receipt/POS sales and is never a source for taxes paid or owed.
Get expense cash summary
Summarize manual operational cash outflows for one business day. It includes paid manual expenses and payments allocated to manual credit expenses. It excludes received CFDI invoices and unpaid manual expenses. Historical coverage is forward-only until a backfill is intentionally run.