Saltar a contenido

Ver documento

Devuelve un documento por su id o su folio fiscal: tipo, estado, emisor, receptor, moneda, totales, folio fiscal, content (el CFDI como JSON, en la misma notación de prepare_document), el rechazo del SAT de un documento preparado (rejection), el estado en el SAT y, si está timbrado, los enlaces al XML y al PDF; data_link, el enlace abierto de una factura (open, con expires_at) o que el cliente la timbró por su enlace (stamped_by_receiver). Con client, un distribuidor lee el documento de uno de sus clientes en solo lectura: con los enlaces al XML y al PDF, sin data_link, y la consulta queda anotada en la cuenta del cliente. Errores: not_found, invalid_input si la referencia no es un id ni un folio fiscal, 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.
document texto Sí Id del documento o su folio fiscal (UUID del SAT).

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"
    },
    "document": {
      "description": "Id del documento o su folio fiscal (UUID del SAT).",
      "title": "Document",
      "type": "string"
    }
  },
  "required": [
    "document"
  ],
  "title": "GetDocumentInput",
  "type": "object"
}