Sifende
Referencia API

OpenAPI y JSON Schema

Spec OpenAPI 3.1 de la API de Sifende, URLs estables para fijar en tu build, validación local de solicitudes y generación de clientes.

Actualizado el

El contrato de la API está publicado como un documento OpenAPI 3.1. La disponibilidad de los tipos de documento se detalla abajo.

URLs

RecursoURL
Explorador interactivo/docs/referencia/api
Spec OpenAPI (URL estable, versionada)https://sifende.com.py/openapi/v1.json
JSON Schema de un modelohttps://sifende.com.py/schemas/v1/{Modelo}.json

Las tres son públicas: no hace falta API key para leerlas.

El Explorador de la API se genera desde este mismo spec: trae el schema completo de cada endpoint, ejemplos en cURL, JavaScript, Python y Java, y un playground para probar las llamadas con tu API key.

Para fijar en tu build usá https://sifende.com.py/openapi/v1.json. El v1 es la versión de la API — la misma del prefijo /api/v1/ — y no cambia mientras no haya una v2. Ver Versionado.

Nombres de JSON Schema

Reemplazá {Modelo} por el nombre exacto, respetando mayúsculas y sufijos. Estos identificadores forman parte de las URLs públicas:

ModeloNombre para la URL
Factura electrónicaFacturaElectronicaRequest
Nota de créditoNotaCreditoElectronicaRequest
Nota de débitoNotaDebitoElectronicaRequest
Nota de remisiónNotaRemisionElectronicaRequest
Receptor de emisiónReceptorDTO
Ítem de FE/NCE/NDEItemDTO
Ítem de NREItemRemisionDTO
Condición de pagoCondicionPagoDTO
Cuota y plazo estructuradoCuotaCreditoDTO, PlazoEstructuradoDTO
Compras públicasComprasPublicasDTO
Documento asociado de FE/NCE/NDEDocumentoAsociadoDTO
Documento asociado de NREDocumentoAsociadoRemisionDTO
Transporte y locales de NRETransporteRemisionDTO, LocalRemisionDTO
Vehículo, transportista y carga de NREVehiculoRemisionDTO, TransportistaRemisionDTO, CargaRemisionDTO
Nominación y su receptorEventoNominacionRequest, ReceptorNominadoRequest
CancelaciónCancelacionRequest
InutilizaciónEventoInutilizacionRequest
Respuesta de emisiónDocumentoElectronicoEmisionResponseDTO
Estado del documentoDocumentoElectronicoStatusDTO
Respuesta de eventoEventoSifenDTO

Por ejemplo, el schema de una FE está en https://sifende.com.py/schemas/v1/FacturaElectronicaRequest.json. Cada schema incluye sus dependencias en $defs; no necesitás descargar el receptor o los ítems por separado para resolver esas referencias.

Para obtener todos los nombres disponibles en la versión publicada:

curl --fail --silent --show-error https://sifende.com.py/openapi/v1.json \
  | jq -r '.components.schemas | keys[]'

Un nombre inexistente devuelve 404. La presencia de un schema no habilita por sí sola una operación: verificá la disponibilidad en el modelo correspondiente.

Validar una solicitud antes de mandarla

El spec expresa requisitos condicionales como if/then de JSON Schema, así que un validador puede verificarlos localmente sin llamar a la API. La validación local no sustituye las reglas de negocio de la API, como la elegibilidad de una nominación o la correspondencia entre el RUC fusionado y el CDC. El caso más común es el receptor:

{
  "allOf": [
    {
      "if": {
        "properties": { "tipoContribuyente": { "const": "CONTRIBUYENTE" } },
        "required": ["tipoContribuyente"]
      },
      "then": { "required": ["tipoContribuyenteReceptor", "digitoVerificador"] }
    },
    {
      "if": {
        "properties": { "tipoContribuyente": { "const": "NO_CONTRIBUYENTE" } },
        "required": ["tipoContribuyente"]
      },
      "then": { "required": ["tipoDocumento"] }
    }
  ]
}

La validación local permite detectar si mandás un receptor CONTRIBUYENTE sin tipoContribuyenteReceptor antes de llamar a la API. Ver Modelo Receptor.

Generar un cliente

npx @openapitools/openapi-generator-cli generate \
  -i https://sifende.com.py/openapi/v1.json \
  -g typescript-fetch \
  -o ./sifende-client

El spec usa OpenAPI 3.1 (JSON Schema 2020-12). Un generador que sólo soporte 3.0 puede ignorar if/then y const: la estructura sale bien, pero las reglas condicionales se pierden y hay que validarlas aparte.

Cómo está organizado

  • tipoDocumento es el discriminador. Se admiten FACTURA_ELECTRONICA, AUTOFACTURA_ELECTRONICA, NOTA_DE_CREDITO_ELECTRONICA, NOTA_DE_DEBITO_ELECTRONICA y NOTA_DE_REMISION_ELECTRONICA; no envíes otros tipos.
  • Los valores de enumeración son los que la API deserializa (CONTRIBUYENTE, no "CONTRIBUYENTE - Contribuyente"). El catálogo completo, con las descripciones, está en GET /api/v1/public/enums.
  • Cada operación incluye sus respuestas de error, con el formato Problem Details y ejemplos. Ver Errores.
  • El spec cubre la API de integración, la API integradora y los catálogos públicos. Para configurar tu cuenta, seguí las guías del panel.

Para agentes de IA

https://sifende.com.py/llms-full.txt sirve la documentación completa con el spec incluido en un solo archivo, pensado para cargarlo como contexto. Es el punto de partida recomendado si estás integrando con un agente: la prosa da el contexto y el spec da el contrato exacto, incluidos los campos condicionales.

En esta página

Usamos cookies necesarias para que el sitio funcione. Con tu permiso, también usamos herramientas de analítica para entender cómo se usa el sitio y para medir nuestras campañas publicitarias. Política de privacidad