Listar documentos
Lista los documentos de un contribuyente, los más recientes primero y los preparados sin fecha al principio. Filtra por tipo, estado, dirección (emitidos o recibidos), origen (creados en Cefidia o externos), receptor (id o parte del nombre), rango de fechas de emisión en hora de la Ciudad de México, ambiente y folio fiscal. Devuelve una página con, de cada documento, id, tipo, estado, dirección, origen, ambiente, serie, folio, fecha, nombre y RFC de la contraparte (el receptor en un emitido, el emisor en un recibido), moneda, total y folio fiscal; y el next_cursor para pedir la siguiente, que es null en la última. Con client, un distribuidor lista los documentos de uno de sus clientes en solo lectura, cada uno con los enlaces al XML y al PDF si está timbrado; la consulta queda anotada en la cuenta del cliente. Errores: invalid_input, not_found, forbidden.
Alcance (scope): cefidia:read · Características: Solo lectura, Idempotente
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
client |
texto | No | Id o nombre de uno de los clientes de list_clients: consulta sus documentos, solo lectura. Se omite para los de la cuenta propia. |
taxpayer |
texto | No | Nombre o RFC del contribuyente. Se puede omitir si solo hay uno. |
type |
lista de texto | No | Tipos de CFDI: I ingreso, E egreso, P complemento de pago, T traslado, N nómina. |
state |
texto | No | Estado del documento. |
direction |
texto | No | issued son los emitidos y received los recibidos; ambos si se omite. |
origin |
texto | No | cefidia son los preparados o timbrados aquí; external los traídos del SAT, importados o de referencia. |
receiver |
texto | No | Id de un receptor del directorio, o parte de su nombre sin distinguir mayúsculas ni acentos. |
date_from |
texto | No | Fecha de emisión desde, inclusive, AAAA-MM-DD, hora de la Ciudad de México. |
date_to |
texto | No | Fecha de emisión hasta, inclusive, AAAA-MM-DD, hora de la Ciudad de México. |
environment |
texto | No | Ambiente del timbrado. |
uuid |
texto | No | Folio fiscal (UUID del SAT). |
cursor |
texto | No | El next_cursor de la página anterior. |
limit |
entero | No | Documentos por página, de 1 a 100; 25 si se omite. |
Esquema de entrada (JSON Schema)¶
{
"additionalProperties": false,
"properties": {
"client": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Id o nombre de uno de los clientes de list_clients: consulta sus documentos, solo lectura. Se omite para los de la cuenta propia.",
"title": "Client"
},
"taxpayer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Nombre o RFC del contribuyente. Se puede omitir si solo hay uno.",
"title": "Taxpayer"
},
"type": {
"anyOf": [
{
"items": {
"enum": [
"I",
"E",
"P",
"T",
"N"
],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Tipos de CFDI: I ingreso, E egreso, P complemento de pago, T traslado, N nómina.",
"title": "Type"
},
"state": {
"anyOf": [
{
"enum": [
"prepared",
"stamping",
"stamped",
"cancel_pending",
"canceled"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Estado del documento.",
"title": "State"
},
"direction": {
"anyOf": [
{
"enum": [
"issued",
"received"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued son los emitidos y received los recibidos; ambos si se omite.",
"title": "Direction"
},
"origin": {
"anyOf": [
{
"enum": [
"cefidia",
"external"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "cefidia son los preparados o timbrados aquí; external los traídos del SAT, importados o de referencia.",
"title": "Origin"
},
"receiver": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Id de un receptor del directorio, o parte de su nombre sin distinguir mayúsculas ni acentos.",
"title": "Receiver"
},
"date_from": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fecha de emisión desde, inclusive, AAAA-MM-DD, hora de la Ciudad de México.",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fecha de emisión hasta, inclusive, AAAA-MM-DD, hora de la Ciudad de México.",
"title": "Date To"
},
"environment": {
"anyOf": [
{
"enum": [
"test",
"production"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ambiente del timbrado.",
"title": "Environment"
},
"uuid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Folio fiscal (UUID del SAT).",
"title": "Uuid"
},
"cursor": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "El next_cursor de la página anterior.",
"title": "Cursor"
},
"limit": {
"anyOf": [
{
"maximum": 100,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Documentos por página, de 1 a 100; 25 si se omite.",
"title": "Limit"
}
},
"title": "ListDocumentsInput",
"type": "object"
}