Servidor MCPHerramientas disponibles
Leer documento
Recupera un documento mediante su documentRef público.
Herramienta MCP
get_documentPropósito
- Usar cuando
- Ya tienes un documentRef devuelto por la búsqueda.
- No usar cuando
- Necesitas encontrar un documento sin conocer su referencia.
- Permisos requeridos
- Efectos secundarios
- Ninguno
- Idempotencia
- Idempotente
Esquema de entrada
JSON Schema{ "type": "object", "properties": { "documentRef": { "type": "string", "pattern": "^(?:invoice|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$", "description": "DocumentRef returned by search_documents" } }, "required": [ "documentRef" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false}Contrato de salida en vivo
JSON Schema{ "type": "object", "properties": { "data": { "type": "object", "properties": { "documentRef": { "type": "string" }, "category": { "enum": [ "invoice", "withholding", "sales_receipt", "declaration", "tax_compliance_opinion", "sales_receipt_refund" ] }, "status": { "type": "string" }, "simulated": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "const": true }, "direction": { "enum": [ "issued", "received" ] }, "counterpartyName": { "type": "string" }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ], "additionalProperties": false } }, "required": [ "documentRef", "category" ], "additionalProperties": true }, "error": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "code": { "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" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentRef": { "type": "string", "pattern": "^(invoice|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$" }, "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 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "oneOf": [ { "required": [ "data" ] }, { "required": [ "error" ] } ]}Esquema de salida canónico
JSON Schema{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "kind": { "$ref": "#/definitions/__schema25" }, "cfdiType": { "$ref": "#/definitions/__schema26" }, "issuer": { "$ref": "#/definitions/__schema27" }, "receiver": { "$ref": "#/definitions/__schema27" }, "items": { "$ref": "#/definitions/__schema28" }, "payment": { "$ref": "#/definitions/__schema29" }, "detail": { "$ref": "#/definitions/__schema31" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "issuer", "receiver", "items", "payment", "detail" ], "additionalProperties": false }, { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "kind": { "$ref": "#/definitions/__schema25" }, "cfdiType": { "$ref": "#/definitions/__schema26" }, "issuer": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "receiver": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "items": { "allOf": [ { "$ref": "#/definitions/__schema28" } ] }, "payment": { "allOf": [ { "$ref": "#/definitions/__schema29" } ] }, "detail": { "$ref": "#/definitions/__schema32" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "detail" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "type": "array", "items": { "type": "object", "properties": { "relationshipType": { "type": "string" }, "uuids": { "type": "array", "items": { "type": "string" } } }, "required": [ "relationshipType", "uuids" ], "additionalProperties": false } }, "kind": { "$ref": "#/definitions/__schema34" }, "cfdiType": { "$ref": "#/definitions/__schema35" }, "issuer": { "$ref": "#/definitions/__schema27" }, "receiver": { "$ref": "#/definitions/__schema27" }, "items": { "$ref": "#/definitions/__schema28" }, "payment": { "allOf": [ { "$ref": "#/definitions/__schema29" } ] }, "detail": { "$ref": "#/definitions/__schema31" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "relatedDocuments", "kind", "cfdiType", "issuer", "receiver", "items", "detail" ], "additionalProperties": false }, { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "type": "array", "items": { "type": "object", "properties": { "relationshipType": { "type": "string" }, "uuids": { "type": "array", "items": { "type": "string" } } }, "required": [ "relationshipType", "uuids" ], "additionalProperties": false } }, "kind": { "$ref": "#/definitions/__schema34" }, "cfdiType": { "$ref": "#/definitions/__schema35" }, "issuer": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "receiver": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "items": { "allOf": [ { "$ref": "#/definitions/__schema28" } ] }, "payment": { "allOf": [ { "$ref": "#/definitions/__schema29" } ] }, "detail": { "$ref": "#/definitions/__schema32" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "detail" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "kind": { "$ref": "#/definitions/__schema36" }, "cfdiType": { "$ref": "#/definitions/__schema37" }, "issuer": { "$ref": "#/definitions/__schema27" }, "receiver": { "$ref": "#/definitions/__schema27" }, "items": { "$ref": "#/definitions/__schema28" }, "detail": { "$ref": "#/definitions/__schema31" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "issuer", "receiver", "items", "detail" ], "additionalProperties": false }, { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "kind": { "$ref": "#/definitions/__schema36" }, "cfdiType": { "$ref": "#/definitions/__schema37" }, "issuer": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "receiver": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "items": { "allOf": [ { "$ref": "#/definitions/__schema28" } ] }, "detail": { "$ref": "#/definitions/__schema32" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "detail" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "items": { "$ref": "#/definitions/__schema38" }, "kind": { "$ref": "#/definitions/__schema39" }, "cfdiType": { "$ref": "#/definitions/__schema40" }, "issuer": { "$ref": "#/definitions/__schema27" }, "receiver": { "$ref": "#/definitions/__schema27" }, "paymentComplement": { "$ref": "#/definitions/__schema41" }, "detail": { "$ref": "#/definitions/__schema31" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "issuer", "receiver", "paymentComplement", "detail" ], "additionalProperties": false }, { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "items": { "$ref": "#/definitions/__schema38" }, "kind": { "$ref": "#/definitions/__schema39" }, "cfdiType": { "$ref": "#/definitions/__schema40" }, "issuer": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "receiver": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "paymentComplement": { "allOf": [ { "$ref": "#/definitions/__schema41" } ] }, "detail": { "$ref": "#/definitions/__schema32" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "detail" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "kind": { "$ref": "#/definitions/__schema44" }, "cfdiType": { "$ref": "#/definitions/__schema45" }, "employeeId": { "$ref": "#/definitions/__schema46" }, "issuer": { "$ref": "#/definitions/__schema47" }, "receiver": { "$ref": "#/definitions/__schema48" }, "payroll": { "$ref": "#/definitions/__schema49" }, "detail": { "$ref": "#/definitions/__schema31" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "payroll", "detail" ], "additionalProperties": false }, { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "payableArchived": { "$ref": "#/definitions/__schema10" }, "receivableArchived": { "$ref": "#/definitions/__schema11" }, "settlementTerms": { "$ref": "#/definitions/__schema12" }, "documentRef": { "$ref": "#/definitions/__schema13" }, "category": { "$ref": "#/definitions/__schema14" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema15" }, "inventoryImpact": { "$ref": "#/definitions/__schema17" }, "customerId": { "$ref": "#/definitions/__schema19" }, "series": { "$ref": "#/definitions/__schema20" }, "folio": { "$ref": "#/definitions/__schema21" }, "fiscal": { "$ref": "#/definitions/__schema22" }, "relatedDocuments": { "$ref": "#/definitions/__schema24" }, "kind": { "$ref": "#/definitions/__schema44" }, "cfdiType": { "$ref": "#/definitions/__schema45" }, "employeeId": { "$ref": "#/definitions/__schema46" }, "issuer": { "$ref": "#/definitions/__schema47" }, "receiver": { "$ref": "#/definitions/__schema48" }, "payroll": { "allOf": [ { "$ref": "#/definitions/__schema49" } ] }, "detail": { "$ref": "#/definitions/__schema32" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "kind", "cfdiType", "detail" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "documentRef": { "$ref": "#/definitions/__schema52" }, "category": { "$ref": "#/definitions/__schema53" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema54" }, "withholding": { "type": "object", "properties": { "foreignReceiver": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "taxRegistrationId": { "type": "string", "minLength": 1, "maxLength": 20 } }, "required": [ "name" ], "additionalProperties": false }, "withholdingTypeCode": { "type": "string" }, "description": { "type": "string" }, "internalFolio": { "type": "string" }, "period": { "type": "object", "properties": { "fromMonth": { "type": "number" }, "toMonth": { "type": "number" }, "year": { "type": "number" } }, "required": [ "fromMonth", "toMonth", "year" ], "additionalProperties": false }, "totals": { "type": "object", "properties": { "operation": { "type": "number" }, "gravable": { "type": "number" }, "exempt": { "type": "number" }, "retained": { "type": "number" } }, "additionalProperties": false }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "tax": { "type": "string" }, "amount": { "type": "number" }, "paymentType": { "type": "string" } }, "required": [ "tax", "amount" ], "additionalProperties": false } } }, "required": [ "withholdingTypeCode", "period", "totals", "taxes" ], "additionalProperties": false }, "detail": { "$ref": "#/definitions/__schema31" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "withholding", "detail" ], "additionalProperties": false }, { "type": "object", "properties": { "cancellationReceiptFormats": { "$ref": "#/definitions/__schema0" }, "direction": { "$ref": "#/definitions/__schema2" }, "status": { "$ref": "#/definitions/__schema3" }, "archived": { "$ref": "#/definitions/__schema4" }, "uuid": { "$ref": "#/definitions/__schema5" }, "simulated": { "$ref": "#/definitions/__schema6" }, "counterpartyName": { "$ref": "#/definitions/__schema8" }, "total": { "$ref": "#/definitions/__schema9" }, "documentRef": { "$ref": "#/definitions/__schema52" }, "category": { "$ref": "#/definitions/__schema53" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema54" }, "detail": { "$ref": "#/definitions/__schema32" } }, "required": [ "direction", "status", "archived", "total", "documentRef", "category", "detail" ], "additionalProperties": false } ] }, { "type": "object", "properties": { "category": { "const": "sales_receipt" }, "folio": { "type": "string" }, "customerName": { "type": "string" }, "locationName": { "type": "string" }, "total": { "$ref": "#/definitions/__schema9" }, "paymentForm": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "lineRef": { "type": "string" }, "productId": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "number" }, "refundableQuantity": { "type": "number" }, "unitPrice": { "type": "number" }, "discount": { "type": "number" }, "lineTotal": { "type": "number" }, "refundableAmount": { "type": "number" } }, "required": [ "lineRef", "description", "quantity", "refundableQuantity", "unitPrice", "lineTotal", "refundableAmount" ], "additionalProperties": false } }, "documentRef": { "type": "string", "pattern": "^sales_receipt:.+$" }, "status": { "enum": [ "open", "invoiced", "global_invoiced", "canceled" ] }, "createdAt": { "$ref": "#/definitions/__schema18" }, "businessDate": { "$ref": "#/definitions/__schema30" }, "saleType": { "enum": [ "paid", "credit", "courtesy" ] }, "selfInvoice": { "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "expiresAt": { "allOf": [ { "$ref": "#/definitions/__schema18" } ] } }, "required": [ "url", "expiresAt" ], "additionalProperties": false } ] } }, "required": [ "category", "folio", "total", "documentRef", "status", "createdAt", "businessDate", "saleType" ], "additionalProperties": false }, { "type": "object", "properties": { "category": { "const": "declaration" }, "fiscalYear": { "type": "number" }, "period": { "type": "number" }, "periodicity": { "type": "string" }, "declarationType": { "type": "string" }, "complementaryType": { "type": "string" }, "operationNumber": { "type": "string" }, "captureLine": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "const": "MXN" } }, "required": [ "amount", "currency" ], "additionalProperties": false }, "paidAmount": { "type": "number" }, "documentRef": { "type": "string", "pattern": "^declaration:.+$" }, "scrapedAt": { "$ref": "#/definitions/__schema18" }, "filedAt": { "$ref": "#/definitions/__schema30" }, "paymentDate": { "allOf": [ { "$ref": "#/definitions/__schema30" } ] } }, "required": [ "category", "fiscalYear", "period", "periodicity", "declarationType", "operationNumber", "documentRef", "scrapedAt", "filedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "category": { "const": "tax_compliance_opinion" }, "status": { "enum": [ "positive", "negative", "unknown" ] }, "pdfAvailable": { "type": "boolean" }, "documentRef": { "type": "string", "pattern": "^tax_compliance_opinion:.+$" }, "issuedLocalDateTime": { "$ref": "#/definitions/__schema16" }, "retrievedAt": { "$ref": "#/definitions/__schema18" } }, "required": [ "category", "status", "pdfAvailable", "documentRef", "issuedLocalDateTime", "retrievedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "reason": { "enum": [ "commercial_refund", "resico_reconciliation" ] }, "settlementMethod": { "enum": [ "cash", "transfer", "original_method", "customer_credit" ] }, "fiscalTreatment": { "enum": [ "none", "credit_note" ] }, "total": { "$ref": "#/definitions/__schema9" }, "note": { "type": "string" }, "documentRef": { "type": "string", "pattern": "^sales_receipt_refund:.+$" }, "category": { "const": "sales_receipt_refund" }, "creditNoteDocumentRef": { "allOf": [ { "type": "string", "pattern": "^invoice:.+$" } ] }, "receiptDocumentRef": { "type": "string", "pattern": "^sales_receipt:.+$" }, "status": { "enum": [ "pending", "processing", "completed", "failed", "recovery_required", "canceled" ] }, "businessDate": { "allOf": [ { "$ref": "#/definitions/__schema30" } ] }, "createdAt": { "$ref": "#/definitions/__schema18" }, "completedAt": { "allOf": [ { "$ref": "#/definitions/__schema18" } ] } }, "required": [ "reason", "settlementMethod", "fiscalTreatment", "total", "documentRef", "category", "receiptDocumentRef", "status", "createdAt" ], "additionalProperties": false } ] }, "error": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "code": { "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" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentRef": { "type": "string", "pattern": "^(invoice|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$" }, "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 } }, "required": [ "code", "message" ], "additionalProperties": false } }, "additionalProperties": false, "definitions": { "__schema0": { "allOf": [ { "type": "array", "items": { "enum": [ "xml", "pdf" ] } } ] }, "__schema2": { "enum": [ "issued", "received" ] }, "__schema3": { "enum": [ "draft", "valid", "canceled" ] }, "__schema4": { "type": "boolean" }, "__schema5": { "type": "string" }, "__schema6": { "allOf": [ { "type": "boolean", "const": true } ] }, "__schema8": { "type": "string" }, "__schema9": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ], "additionalProperties": false }, "__schema10": { "type": "boolean" }, "__schema11": { "type": "boolean" }, "__schema12": { "type": "object", "properties": { "installmentCount": { "type": "integer", "minimum": 1, "maximum": 60 }, "firstDue": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "transaction_date" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "months_after_transaction" }, "months": { "type": "integer", "minimum": 1, "maximum": 60 } }, "required": [ "kind", "months" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "fixed_date" }, "date": { "type": "string" } }, "required": [ "kind", "date" ], "additionalProperties": false } ] }, "recurrence": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "anchor_day" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "day_of_month" }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "kind", "day" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "last_day" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "installmentCount", "firstDue", "recurrence" ], "additionalProperties": false }, "__schema13": { "type": "string", "pattern": "^invoice:.+$" }, "__schema14": { "const": "invoice" }, "__schema15": { "allOf": [ { "$ref": "#/definitions/__schema16" } ] }, "__schema16": { "type": "string", "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(?:\\.(\\d{1,9}))?$" }, "__schema17": { "type": "object", "properties": { "locationId": { "type": "string" }, "status": { "enum": [ "pending", "deducted", "reversed" ] }, "appliedAt": { "allOf": [ { "$ref": "#/definitions/__schema18" } ] }, "reversedAt": { "allOf": [ { "$ref": "#/definitions/__schema18" } ] }, "stockShortage": { "type": "boolean" } }, "required": [ "status" ], "additionalProperties": false }, "__schema18": { "type": "string", "format": "date-time" }, "__schema19": { "type": "string" }, "__schema20": { "type": "string" }, "__schema21": { "type": "string" }, "__schema22": { "type": "object", "properties": { "subtotal": { "type": "number" }, "ivaTransferred": { "type": "number" }, "ivaWithheld": { "type": "number" }, "isrWithheld": { "type": "number" }, "exchangeRate": { "type": "number" }, "totalMxn": { "type": "number" }, "placeOfIssue": { "type": "string" }, "exportation": { "type": "string" }, "draftIssueDate": { "allOf": [ { "$ref": "#/definitions/__schema18" } ] }, "taxes": { "type": "object", "properties": { "transfers": { "type": "array", "items": { "$ref": "#/definitions/__schema23" } }, "withholdings": { "type": "array", "items": { "$ref": "#/definitions/__schema23" } } }, "required": [ "transfers", "withholdings" ], "additionalProperties": false }, "globalInformation": { "type": "object", "properties": { "frequency": { "type": "string" }, "months": { "type": "string" }, "year": { "type": "number" } }, "required": [ "frequency", "months", "year" ], "additionalProperties": false }, "cfdiUse": { "type": "string" }, "stampedLocalDateTime": { "allOf": [ { "$ref": "#/definitions/__schema16" } ] } }, "additionalProperties": false }, "__schema23": { "type": "object", "properties": { "tax": { "type": "string" }, "factorType": { "type": "string" }, "rateOrFee": { "type": "string" }, "amount": { "type": "string" }, "base": { "type": "string" } }, "required": [ "tax", "factorType" ], "additionalProperties": false }, "__schema24": { "type": "array", "items": { "type": "object", "properties": { "relationshipType": { "type": "string" }, "uuids": { "type": "array", "items": { "type": "string" } } }, "required": [ "relationshipType", "uuids" ], "additionalProperties": false } }, "__schema25": { "const": "income" }, "__schema26": { "const": "I" }, "__schema27": { "type": "object", "properties": { "rfc": { "type": "string" }, "legalName": { "type": "string" }, "taxSystem": { "type": "string" }, "postalCode": { "type": "string" }, "cfdiUse": { "type": "string" } }, "required": [ "rfc", "legalName", "taxSystem" ], "additionalProperties": false }, "__schema28": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "number" }, "unitPrice": { "type": "number" }, "discount": { "type": "number" }, "unitName": { "type": "string" }, "taxObject": { "type": "string" }, "taxes": { "type": "object", "properties": { "transfers": { "type": "array", "items": { "$ref": "#/definitions/__schema23" } }, "withholdings": { "type": "array", "items": { "$ref": "#/definitions/__schema23" } } }, "required": [ "transfers", "withholdings" ], "additionalProperties": false }, "satProductCode": { "type": "string" }, "satUnitCode": { "type": "string" } }, "required": [ "description", "quantity", "unitPrice" ], "additionalProperties": false } }, "__schema29": { "type": "object", "properties": { "timing": { "enum": [ "single_payment", "deferred_or_installments" ] }, "formCode": { "type": "string" }, "methodCode": { "type": "string" }, "dueDate": { "allOf": [ { "$ref": "#/definitions/__schema30" } ] }, "remainingBalance": { "type": "number" }, "conditions": { "type": "string" } }, "required": [ "timing" ], "additionalProperties": false }, "__schema30": { "type": "string", "format": "date" }, "__schema31": { "type": "object", "properties": { "availability": { "const": "complete" } }, "required": [ "availability" ], "additionalProperties": false }, "__schema32": { "type": "object", "properties": { "availability": { "const": "partial" }, "missing": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "availability", "missing" ], "additionalProperties": false }, "__schema34": { "const": "credit_note" }, "__schema35": { "const": "E" }, "__schema36": { "const": "transfer" }, "__schema37": { "const": "T" }, "__schema38": { "allOf": [ { "$ref": "#/definitions/__schema28" } ] }, "__schema39": { "const": "payment_complement" }, "__schema40": { "const": "P" }, "__schema41": { "type": "object", "properties": { "version": { "type": "string" }, "totalPayments": { "type": "number" }, "payments": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string" }, "amount": { "type": "number" }, "exchangeRate": { "allOf": [ { "type": "number" } ] }, "relatedCfdis": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string" }, "series": { "type": "string" }, "folio": { "type": "string" }, "currency": { "type": "string" }, "exchangeRate": { "allOf": [ { "type": "number" } ] }, "taxObject": { "type": "string" }, "installment": { "type": "string" }, "balances": { "type": "object", "properties": { "previous": { "type": "number" }, "paid": { "type": "number" }, "remaining": { "type": "number" } }, "additionalProperties": false }, "taxes": { "type": "object", "properties": { "transfers": { "type": "array", "items": { "$ref": "#/definitions/__schema23" } }, "withholdings": { "type": "array", "items": { "$ref": "#/definitions/__schema23" } } }, "required": [ "transfers", "withholdings" ], "additionalProperties": false } }, "required": [ "uuid", "currency" ], "additionalProperties": false } }, "formCode": { "type": "string" }, "paidLocalDateTime": { "$ref": "#/definitions/__schema16" } }, "required": [ "currency", "amount", "relatedCfdis", "formCode", "paidLocalDateTime" ], "additionalProperties": false } } }, "required": [ "version", "totalPayments", "payments" ], "additionalProperties": false }, "__schema44": { "const": "payroll" }, "__schema45": { "const": "N" }, "__schema46": { "type": "string" }, "__schema47": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "__schema48": { "allOf": [ { "$ref": "#/definitions/__schema27" } ] }, "__schema49": { "type": "object", "properties": { "type": { "type": "string" }, "paidDays": { "type": "number" }, "earnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "$ref": "#/definitions/__schema50" }, "description": { "$ref": "#/definitions/__schema51" }, "type": { "type": "string" }, "taxableAmount": { "type": "number" }, "exemptAmount": { "type": "number" }, "stock": { "type": "object", "properties": { "marketValue": { "type": "number" }, "grantPrice": { "type": "number" } }, "additionalProperties": false }, "overtime": { "type": "array", "items": { "type": "object", "properties": { "days": { "type": "number" }, "type": { "type": "string" }, "hours": { "type": "number" }, "amount": { "type": "number" } }, "required": [ "days", "type", "hours" ], "additionalProperties": false } } }, "additionalProperties": false } }, "incapacities": { "type": "array", "items": { "type": "object", "properties": { "days": { "type": "number" }, "type": { "type": "string" }, "amount": { "type": "number" } }, "required": [ "days", "type" ], "additionalProperties": false } }, "pension": { "type": "object", "properties": { "singlePayment": { "type": "number" }, "installment": { "type": "number" }, "dailyAmount": { "type": "number" }, "accumulableIncome": { "type": "number" }, "nonAccumulableIncome": { "type": "number" } }, "additionalProperties": false }, "separation": { "type": "object", "properties": { "totalPaid": { "type": "number" }, "serviceYears": { "type": "number" }, "lastMonthlySalary": { "type": "number" }, "accumulableIncome": { "type": "number" }, "nonAccumulableIncome": { "type": "number" } }, "required": [ "serviceYears" ], "additionalProperties": false }, "deductions": { "type": "array", "items": { "type": "object", "properties": { "code": { "$ref": "#/definitions/__schema50" }, "description": { "$ref": "#/definitions/__schema51" }, "type": { "type": "string" }, "amount": { "type": "number" } }, "additionalProperties": false } }, "otherPayments": { "type": "array", "items": { "type": "object", "properties": { "code": { "$ref": "#/definitions/__schema50" }, "description": { "$ref": "#/definitions/__schema51" }, "type": { "type": "string" }, "amount": { "type": "number" }, "employmentSubsidy": { "type": "number" }, "compensation": { "type": "object", "properties": { "balance": { "type": "number" }, "year": { "type": "number" }, "remainingBalance": { "type": "number" } }, "required": [ "year" ], "additionalProperties": false } }, "additionalProperties": false } }, "totals": { "type": "object", "properties": { "earnings": { "type": "number" }, "deductions": { "type": "number" }, "otherPayments": { "type": "number" }, "net": { "type": "number" } }, "additionalProperties": false }, "employee": { "type": "object", "properties": { "curp": { "type": "string" }, "employeeNumber": { "type": "string" }, "socialSecurityNumber": { "type": "string" }, "contractType": { "type": "string" }, "regimeType": { "type": "string" }, "paymentFrequency": { "type": "string" }, "stateCode": { "type": "string" }, "positionRisk": { "type": "string" }, "integratedDailySalary": { "type": "number" }, "contributionBaseSalary": { "type": "number" }, "department": { "type": "string" }, "position": { "type": "string" }, "workScheduleType": { "type": "string" }, "unionMember": { "type": "string" }, "bankCode": { "type": "string" }, "bankAccount": { "type": "string" }, "employmentStartedOn": { "allOf": [ { "$ref": "#/definitions/__schema30" } ] } }, "additionalProperties": false }, "period": { "type": "object", "properties": { "paidOn": { "$ref": "#/definitions/__schema30" }, "startedOn": { "allOf": [ { "$ref": "#/definitions/__schema30" } ] }, "endedOn": { "allOf": [ { "$ref": "#/definitions/__schema30" } ] } }, "required": [ "paidOn" ], "additionalProperties": false } }, "required": [ "earnings", "deductions", "otherPayments", "totals", "employee", "period" ], "additionalProperties": false }, "__schema50": { "type": "string" }, "__schema51": { "type": "string" }, "__schema52": { "type": "string", "pattern": "^withholding:.+$" }, "__schema53": { "const": "withholding" }, "__schema54": { "allOf": [ { "$ref": "#/definitions/__schema16" } ] } }, "oneOf": [ { "required": [ "data" ] }, { "required": [ "error" ] } ]}