Estas convenciones se mantienen consistentes a lo largo de toda la API. Si encuentras una excepción, es probable que esté documentada explícitamente en la página del endpoint correspondiente.
Rutas
- Plural para colecciones:
/businesses,/customers,/documents. - Identificadores numéricos en la ruta:
/customers/{id}. - Acciones no idempotentes sobre un recurso usan sufijo con dos puntos:
/documents/{id}/email:send,/businesses/{id}/signature:verify. - Sub-recursos cuando aplica:
/businesses/{id}/files. - Sin segmento de versión en la URL. Ver Versionado.
Métodos HTTP
| Método | Uso | Idempotente |
|---|---|---|
| GET | Leer una colección o un recurso. | Sí |
| POST | Crear un recurso o ejecutar una acción. | No |
| PUT | Reemplazar un recurso completo. Acepta actualizaciones parciales (solo campos enviados). | Sí |
| PATCH | Actualización parcial. En esta API es equivalente a PUT con payload parcial. | Sí |
| DELETE | Eliminar (soft-delete) un recurso. | Sí |
Nombres de campos
- Predomina
snake_caseen los bodies de comprobantes (business_id,document_type_id,payment_method_id). - Algunos endpoints usan
camelCase(businessId,userId,identificationTypeId) en query strings y bodies de configuración. Cada página de endpoint indica la forma exacta esperada. - Los identificadores son enteros, salvo el code de catálogos del SRI que es un
stringcorto ("01","03","04"…).
Fechas y horas
- Fechas: ISO-8601 corto —
YYYY-MM-DD(ej.2026-05-24). - Fechas con hora:
YYYY-MM-DD HH:MM:SSen hora local del emisor. - Las fechas de los comprobantes deben corresponder a fechas válidas dentro del calendario fiscal del SRI.
Números y montos
- Montos monetarios:
floatcon punto como separador decimal (1234.56). - La precisión recomendada es de 2 a 6 decimales según el campo. El backend redondea cuando corresponde.
- Porcentajes: enteros o decimales sin el símbolo
%(ej.12.00= 12 %).
Booleanos
Usa true / false JSON estricto. No envíes "true" ni 1/0.
Identificadores SRI
- RUC: 13 dígitos. Cédula: 10 dígitos.
- Número de comprobante:
EEE-PPP-NNNNNNNNN(establecimiento-punto de emisión-secuencial, 17 caracteres con guiones). - Códigos de tipo de comprobante:
01,03,04,05,06,07.