DEVSDESIGN — DEVELOPERS & DESIGN

API v1 · contrato 1.0.0

Referencia de la API

Todas las operaciones de la versión 1, generadas desde el contrato OpenAPI.

Esta referencia se genera a partir del contrato OpenAPI versión 1.0.0, el mismo que valida las pruebas automáticas de la API. Todas las rutas son relativas a https://api.devsdesign.cloud/v1.

Salvo GET /health, todas las operaciones requieren autenticación.

Empresas

GET /companies

Lista las empresas emisoras de la cuenta.

Permiso:
companies:read
Idempotency-Key:
no aplica

POST /companies

Registra una empresa emisora.

Permiso:
companies:write
Idempotency-Key:
obligatoria
Campos del cuerpo (7)
CampoTipoObligatorio
rnc string Sí
legal_name string Sí
trade_name string No
slug string Sí
address string No
email string No
phone string No

GET /companies/{company}

Devuelve una empresa emisora.

Permiso:
companies:read
Idempotency-Key:
no aplica

PUT /companies/{company}

Reemplaza los datos de una empresa emisora.

Permiso:
companies:write
Idempotency-Key:
no aplica
Campos del cuerpo (7)
CampoTipoObligatorio
rnc string No
legal_name string No
trade_name string No
slug string No
address string No
email string No
phone string No

PATCH /companies/{company}

Modifica parcialmente una empresa emisora.

Permiso:
companies:write
Idempotency-Key:
no aplica
Campos del cuerpo (7)
CampoTipoObligatorio
rnc string No
legal_name string No
trade_name string No
slug string No
address string No
email string No
phone string No

DELETE /companies/{company}

Elimina una empresa emisora.

Permiso:
companies:write
Idempotency-Key:
no aplica

GET /companies/{company}/receiver-endpoints

Devuelve las URL de recepción de e-CF de la empresa.

Permiso:
companies:read
Idempotency-Key:
no aplica

Comprobantes

POST /documents

Emite un comprobante fiscal electrónico.

Permiso:
documents:write
Idempotency-Key:
obligatoria
Campos del cuerpo (15)
CampoTipoObligatorio
company_id string Sí
type EcfType Sí
encf string No
issue_date string Sí
payment object Sí
income_type string Sí
buyer object Sí
currency object No
items array Sí
references array No
delivery object No
external_reference string No
metadata object No
extensions object No
totals object No

GET /documents

Lista los comprobantes más recientes de la cuenta.

Permiso:
documents:read
Idempotency-Key:
no aplica

GET /documents/{id}

Devuelve un comprobante.

Permiso:
documents:read
Idempotency-Key:
no aplica

GET /documents/{id}/events

Devuelve el historial de eventos del comprobante.

Permiso:
documents:read
Idempotency-Key:
no aplica

GET /documents/{id}/pdf

Descarga la representación impresa. Parámetro format: a4 o pos.

Permiso:
documents:read
Idempotency-Key:
no aplica

GET /documents/{id}/status

Devuelve el estado de procesamiento y el estado fiscal.

Permiso:
documents:read
Idempotency-Key:
no aplica

GET /documents/{id}/xml

Descarga el XML firmado.

Permiso:
documents:read
Idempotency-Key:
no aplica

Comprobantes recibidos

POST /received-documents/{id}/commercial-response

Registra la aprobación o el rechazo comercial de un e-CF recibido.

Permiso:
received:write
Idempotency-Key:
obligatoria
Campos del cuerpo (2)
CampoTipoObligatorio
decision string Sí
reason string No

Webhooks

GET /webhook-deliveries

Lista las entregas de webhooks con su resultado.

Permiso:
webhooks:manage
Idempotency-Key:
no aplica

POST /webhook-deliveries/{id}/redeliver

Reenvía una entrega.

Permiso:
webhooks:manage
Idempotency-Key:
obligatoria

GET /webhook-endpoints

Lista los endpoints de webhooks.

Permiso:
webhooks:manage
Idempotency-Key:
no aplica

POST /webhook-endpoints

Registra un endpoint y devuelve su secreto.

Permiso:
webhooks:manage
Idempotency-Key:
obligatoria
Campos del cuerpo (3)
CampoTipoObligatorio
url string Sí
events array Sí
company_ids array | null No

GET /webhook-endpoints/{id}

Devuelve un endpoint.

Permiso:
webhooks:manage
Idempotency-Key:
no aplica

PATCH /webhook-endpoints/{id}

Modifica un endpoint: URL, eventos, empresas o estado.

Permiso:
webhooks:manage
Idempotency-Key:
no aplica
Campos del cuerpo (4)
CampoTipoObligatorio
url string No
events array No
company_ids array | null No
status string No

DELETE /webhook-endpoints/{id}

Elimina un endpoint.

Permiso:
webhooks:manage
Idempotency-Key:
no aplica

POST /webhook-endpoints/{id}/test

Envía un evento de prueba al endpoint.

Permiso:
webhooks:manage
Idempotency-Key:
obligatoria

Estado

GET /health

Comprueba que la API responde. No requiere autenticación.

Permiso:
ninguno
Idempotency-Key:
no aplica

Respuestas comunes

Las operaciones comparten los mismos códigos de error: 400, 401, 403, 404, 409, 422 y 429, todos con el formato descrito en Errores. Las escrituras responden 200, 201 o 202 según la operación; la emisión de comprobantes responde 202.

Eventos de webhook

El contrato define 16 eventos. Su descripción está en Webhooks.

  • document.queued
  • document.invalid
  • document.accepted
  • document.accepted_conditional
  • document.rejected
  • document.delivery.acknowledged
  • document.delivery.failed
  • document.commercial.approved
  • document.commercial.rejected
  • received_document.created
  • cancellation.completed
  • dgii.status_changed
  • contingency.started
  • contingency.ended
  • certificate.expiring
  • certificate.expired

¿Algo no está claro o falta en esta página? Escríbenos por el centro de soporte.