Fiscalisto API docs

Start here when asked to add Fiscalisto or Mexican invoicing (CFDI 4.0) to an app. Empiece aquí: cómo integrar la API en una app de principio a fin (llave, SDK de su lenguaje, timbrar con Idempotency-Key, datos del cliente, errores del SAT, webhooks firmados, cancelar, probar sin costo y pasar a producción), en una página.

{
  "type": "object",
  "properties": {}
}

Busca en la documentación de la API de facturación de Fiscalisto (guías y referencia) y devuelve las páginas que más coinciden. Entiende español e inglés («cancelar factura», «verify webhook signature»). Úsela antes de escribir código contra la API.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Palabras a buscar, en español o inglés, por ejemplo «cancelar factura motivo 02» o «create invoice»."
    }
  },
  "required": [
    "query"
  ]
}

El texto completo (Markdown) de una página de la documentación, por su ruta, por ejemplo /docs/api/facturas o /docs/api/referencia/facturas/create-invoice.

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "La ruta de la página."
    }
  },
  "required": [
    "path"
  ]
}

Las operaciones de la API (operationId, método, ruta y qué hace), por sección. Úsela para encontrar la ruta correcta antes de describe_operation.

{
  "type": "object",
  "properties": {
    "tag": {
      "type": "string",
      "description": "Solo las de esta sección, por ejemplo «Facturas», «Webhooks» o en inglés «Invoices»."
    }
  }
}

Todo sobre una operación: parámetros, cada campo del cuerpo (tipo, si es obligatorio, límites), ejemplos, el código con el SDK del lenguaje que elija y qué objeto contesta (sus campos con describe_object, o aquí con full).

{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "description": "El operationId (createInvoice), el método del SDK (invoices.create), el método y la ruta («POST /v1/invoices», «GET /v1/invoices/inv_123») o en palabras («create invoice», «cancelar factura»)."
    },
    "language": {
      "type": "string",
      "enum": [
        "ts",
        "python",
        "php",
        "csharp",
        "go",
        "java",
        "all"
      ],
      "description": "El SDK del ejemplo de código. Por omisión ts."
    },
    "full": {
      "type": "boolean",
      "description": "true: también la tabla de cada campo de la respuesta (larga). Por omisión solo su nombre y un ejemplo."
    }
  },
  "required": [
    "operation"
  ]
}

Los campos de un objeto que contesta la API (Invoice, Customer, Event, Error…), con su tipo y significado, y un ejemplo. Sin nombre, la lista de objetos.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "El objeto, por ejemplo Invoice."
    }
  }
}

Qué significa un código de error de la API (el error.code de la respuesta, por ejemplo issuer_required) y cómo resolverlo.

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "El error.code de la respuesta."
    }
  },
  "required": [
    "code"
  ]
}

Hace una solicitud real a la API en modo de pruebas con la llave fk_test_ de la persona (nunca una fk_live_) y devuelve el código, el Request-Id y el JSON de la respuesta. Para probar un cuerpo antes de escribir el código. Timbra con el emisor de pruebas del SAT, sin costo.

{
  "type": "object",
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "DELETE"
      ]
    },
    "path": {
      "type": "string",
      "description": "La ruta con su consulta, por ejemplo /v1/invoices?limit=3."
    },
    "api_key": {
      "type": "string",
      "description": "La llave de pruebas (fk_test_…) de la persona, de Desarrolladores › Llaves. Pídasela; no la invente."
    },
    "body": {
      "type": "object",
      "description": "El cuerpo JSON, para POST."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Idempotency-Key del POST (por omisión una nueva): repetirla con lo mismo contesta lo de la primera vez."
    }
  },
  "required": [
    "method",
    "path",
    "api_key"
  ]
}

Todas las páginas de la documentación: guías y referencia, con su ruta y de qué tratan.

{
  "type": "object",
  "properties": {}
}