Ver saldo de un comprobante
GET /api/document-payments/document/{document_id}
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Devuelve el total, lo pagado y el saldo pendiente de un comprobante, para validar el monto antes de registrar un pago.
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Formato de respuesta: heredado sin envoltura: devuelve directamente el objeto o arreglo (sin success).
Parámetros de la URL:
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
document_id |
integer | Sí | Id del comprobante. |
total_difference = saldo pendiente (descuenta notas de crédito y retenciones; incluye propinas cobradas). is_voided = true si está anulado o rechazado.
Errores:
500si el comprobante no existe.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
document_id |
ruta | sí | 1 |
Respuestas
200 — Saldo
{
"number_full": "B001-1520",
"document_type_id": "03",
"total_paid": 30.0,
"total": 80.0,
"total_difference": 50.0,
"currency_type_id": "PEN",
"exchange_rate_sale": 1.0,
"credit_notes_total": 0.0,
"external_id": "5d6e7f80-91a2-4b3c-8d4e-5f6a7b8c9d0e",
"payment_condition_id": "02",
"is_voided": false
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.