Saltar a contenido

Buscar en catálogos del SAT

Busca en los catálogos del SAT incluidos en Cefidia (productos y servicios, unidades, formas de pago, usos del CFDI, regímenes fiscales, monedas, países, códigos postales, carta porte y nómina, entre otros). Recibe el catálogo y, opcionalmente, un texto, una clave exacta, un contexto y un límite. Devuelve el catálogo, el total de coincidencias y los elementos con su clave y descripción; las coincidencias exactas de clave van primero. No recibe contribuyente. Errores: invalid_input si el catálogo no existe o el límite está fuera de rango.

Alcance (scope): cefidia:read · Características: Solo lectura, Idempotente

Parámetros

Parámetro Tipo Obligatorio Descripción
catalog texto Sí Nombre del catálogo del SAT.
query texto No Texto a buscar: cada palabra coincide con el inicio de una clave o de una palabra de la descripción, sin distinguir mayúsculas ni acentos.
key texto No Clave exacta del catálogo.
context texto No Acota los catálogos dependientes: la clave del estado en municipios y localidades, el código postal en colonias.
limit entero No Cantidad máxima de elementos, de 1 a 50; 20 si se omite.

Esquema de entrada (JSON Schema)

{
  "additionalProperties": false,
  "properties": {
    "catalog": {
      "description": "Nombre del catálogo del SAT.",
      "enum": [
        "product_service",
        "unit",
        "payment_form",
        "cfdi_use",
        "fiscal_regime",
        "currency",
        "country",
        "postal_code",
        "state",
        "municipality",
        "locality",
        "neighborhood",
        "tax_object",
        "relation_type",
        "export",
        "cancellation_reason",
        "waybill_product",
        "hazardous_material",
        "packaging",
        "vehicle_config",
        "permit_type",
        "trailer_type",
        "transport_figure",
        "perception_type",
        "deduction_type",
        "other_payment_type",
        "disability_type",
        "contract_type",
        "workday_type",
        "regime_type",
        "job_risk",
        "payment_frequency",
        "bank",
        "overtime_type"
      ],
      "title": "Catalog",
      "type": "string"
    },
    "query": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Texto a buscar: cada palabra coincide con el inicio de una clave o de una palabra de la descripción, sin distinguir mayúsculas ni acentos.",
      "title": "Query"
    },
    "key": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Clave exacta del catálogo.",
      "title": "Key"
    },
    "context": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Acota los catálogos dependientes: la clave del estado en municipios y localidades, el código postal en colonias.",
      "title": "Context"
    },
    "limit": {
      "anyOf": [
        {
          "maximum": 50,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Cantidad máxima de elementos, de 1 a 50; 20 si se omite.",
      "title": "Limit"
    }
  },
  "required": [
    "catalog"
  ],
  "title": "SearchCatalogInput",
  "type": "object"
}