Ir al contenido

Referencia de la API

Esta referencia se genera del documento OpenAPI de la API (versión 0.1.0), el mismo que sirve https://api.emitay.com/openapi.json: lo que dice aquí es lo que la API valida.

Cómo se llama

Todas las rutas cuelgan de https://api.emitay.com.

  • Autenticación: Authorization: Bearer sk_test_… o sk_live_…. La llave decide la empresa y el modo: una de prueba envía al ambiente beta de SUNAT; una real, a producción.
  • Cuerpos: JSON (Content-Type: application/json), campos en snake_case. Un campo que la API no conoce se rechaza con 422, no se ignora.
  • Errores: application/problem+json (RFC 9457) con type, title, status, detail y, cuando el problema es de campos, errors[{field, message}]. Los mensajes están en español.
  • Idempotencia: todo POST que crea un recurso acepta Idempotency-Key; repetir la llave devuelve el recurso original con 200.
  • SUNAT es asíncrona: un comprobante nace pending y su veredicto llega por webhook o consultándolo. Prefer: wait=10 espera la respuesta hasta ese número de segundos.

Comprobantes

POST/v1/invoicesEmitir una factura
POST/v1/receiptsEmitir una boleta
POST/v1/credit_notesEmitir una nota de crédito
POST/v1/debit_notesEmitir una nota de débito
GET/v1/documentsListar comprobantes, del más nuevo al más antiguo
GET/v1/documents/{id}Consultar un comprobante
GET/v1/documents/{id}/xmlDescargar el XML firmado de un comprobante
GET/v1/documents/{id}/cdrDescargar el CDR de un comprobante
GET/v1/documents/{id}/pdfDescargar el PDF de un comprobante
POST/v1/documents/{id}/voidAnular un comprobante
POST/v1/despatch_advicesEmitir una guía de remisión
POST/v1/retentionsEmitir un comprobante de retención
POST/v1/perceptionsEmitir un comprobante de percepción

Correos

GET/v1/documents/{id}/emailsListar los correos de un comprobante, del más nuevo al más antiguo
POST/v1/documents/{id}/emailsEnviar un comprobante por correo

Eventos

GET/v1/eventsListar eventos, del más nuevo al más antiguo
GET/v1/events/streamSeguir los eventos en vivo (server-sent events)
GET/v1/events/{id}Consultar un evento

Webhooks

GET/v1/webhook_endpointsListar endpoints de webhook, del más nuevo al más antiguo
POST/v1/webhook_endpointsCrear un endpoint de webhook
GET/v1/webhook_endpoints/{id}Consultar un endpoint de webhook
PATCH/v1/webhook_endpoints/{id}Actualizar un endpoint de webhook
DELETE/v1/webhook_endpoints/{id}Eliminar un endpoint de webhook y sus entregas
POST/v1/webhook_endpoints/{id}/rotate_secretReemplazar el secreto de firma de un endpoint de webhook
GET/v1/webhook_endpoints/{id}/deliveriesListar las entregas de un endpoint de webhook, de la más nueva a la más antigua
POST/v1/webhook_deliveries/{id}/retryReenviar una entrega de webhook

Layouts

GET/v1/layoutsListar layouts, del más nuevo al más antiguo
POST/v1/layoutsCrear un layout
GET/v1/layouts/{id}Consultar un layout
PATCH/v1/layouts/{id}Actualizar un layout
DELETE/v1/layouts/{id}Eliminar un layout y sus versiones
POST/v1/layouts/{id}/previewPrevisualizar un layout como PDF

Empresa

GET/v1/companyConsultar la empresa de quien llama
GET/v1/seriesListar las series de numeración usadas en este modo
GET/v1/request_logsListar las peticiones hechas a la API, de la más nueva a la más antigua

Recursos

Lo que devuelven las operaciones, cada recurso una sola vez:Customer, Document, Email, Event, WebhookEndpoint, WebhookEndpointWithSecret, WebhookDelivery, Layout, Company, Series, RequestLog, Problem.