Empresa y pagos

Recursos de configuración de la compañía, métodos de pago, CAI y sucursales. Todas las rutas requieren autenticación.

Empresa (Companies)

Método	Ruta	Descripción
GET	/companies	Obtiene datos de la compañía (según contexto)
PUT	/companies/:id	Actualiza la compañía

Con API key el ámbito es la compañía de la llave.

Métodos de pago

Método	Ruta	Descripción
GET	/payments/methods	Lista métodos de pago
POST	/payments/methods	Crea un método de pago
PUT	/payments/methods/:id	Actualiza un método

CAI / Rangos

Método	Ruta	Descripción
GET	/cai	Lista rangos CAI de la compañía

Sucursales

Método	Ruta	Descripción
GET	/branch	Lista sucursales

Facturas programadas

Método	Ruta	Descripción
GET	/scheduled-invoices	Lista facturas programadas
POST	/scheduled-invoices	Crea una factura programada

Pagos de documentos

Listar pagos de un documento

GET /payments/documents/:documentId/payments

Registrar pago

POST /payments/documents/:documentId/payments

{
  "paymentMethodId": 1,
  "amount": 1500.00,
  "reference": "TRF-001234",
  "paymentDate": "2026-04-16",
  "notes": "Pago parcial"
}

Condición de pago al contado

Si el documento tiene condición de pago tipo cash, el monto debe ser exactamente igual al total del documento y no puede haber pagos previos.

Confirmar pago pendiente

POST /payments/documents/:documentId/payments/:paymentId/confirm

Cancelar pago

POST /payments/documents/:documentId/payments/:paymentId/cancel

{
  "reason": "Motivo de anulación"
}

Al cancelar un pago confirmado, se reversa automáticamente el asiento contable y el movimiento bancario asociado.

Aplicar nota de crédito como pago

En el body de registrar pago, enviar creditNoteId en lugar de paymentMethodId:

{
  "creditNoteId": 456,
  "amount": 500.00
}

Aplicar comprobante de retención

{
  "withholdingDocumentId": 789,
  "amount": 150.00
}

---

Pasarelas de pago (N1co / PixelPay)

Configurar pasarela

GET /payments/gateways
POST /payments/gateways
PUT /payments/gateways/:id

Para eliminar una pasarela, use la aplicación web (las API keys no admiten DELETE).

Generar enlace de pago

POST /payments/generate-link

Notificaciones de pasarela

Endpoints que reciben notificaciones de pasarelas de pago (p. ej. N1co, PixelPay):

• POST /webhooks/n1co
• POST /webhooks/pixelpay

---

Condiciones de pago

GET /payment-conditions
POST /payment-conditions
PUT /payment-conditions/:id

Para eliminar una condición de pago, use la aplicación web.

Campo	Tipo	Descripción
name	string	Nombre (ej. "Al contado", "Crédito 30 días")
type	string	cash o credit
creditDays	number	Días de crédito (solo tipo credit)

---

Anticipos

Verificar disponibilidad de anticipo

GET /payments/source-documents/:sourceDocumentId/advance-availability

Aplicar anticipos

POST /payments/documents/:documentId/apply-advances-from-source

---

Errores comunes

• 401: Token o API key requeridos.
• 403: Sin permiso para el recurso.
• 400: Monto excede el total pendiente, método de pago inactivo, o condición al contado no cumplida.

Volver al índice de API