Notas de un comprobante (saldo disponible)
GET /api/documents/{document_id}/notes
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Notas de crédito y débito emitidas sobre una factura o boleta, cuánto queda por acreditar y cuánto queda por devolver de cada línea. Úsalo antes de Emitir nota de crédito para armar una nota parcial.
Quién puede usarlo: cualquier usuario autenticado. Un administrador accede a todos los registros; un vendedor solo a los que registró él (o en los que figura como vendedor). Si el registro existe pero es de otro vendedor responde 403.
Formato de respuesta: estándar {success, data, message?} (registro único).
Parámetros de la ruta:
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
id |
integer | Sí | Id interno del comprobante ({document_id}). |
Campos de data:
| Campo | Descripción |
|---|---|
document |
Comprobante: id, number, state_type_id, currency_type_id, total. |
can_issue_notes / reason |
Si hoy admite notas y, si no, por qué (mismo mensaje que el 409). |
credit_notes_total |
Suma de las notas de crédito vigentes (no rechazadas ni anuladas). |
debit_notes_total |
Suma de las notas de débito vigentes. |
available_for_credit_note |
total − credit_notes_total: tope de una nueva nota de crédito. |
items[] |
Líneas del comprobante: line_id, item_id, description, quantity, returned_quantity (devuelto por notas que reingresan stock), available_quantity, unit_price (con IGV), total. |
notes[] |
Notas: id, number, document_type_id (07 crédito, 08 débito), note_type, note_type_description, description, date_of_issue, total, state_type_id, counts_for_balance (false si fue rechazada o anulada). |
Errores:
403si el comprobante es de otro vendedor.404si el comprobante no existe.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
document_id |
ruta | sí | 1 |
Respuestas
200 — Con una devolución parcial
{
"success": true,
"data": {
"document": {
"id": 1520,
"number": "F001-310",
"document_type_id": "01",
"state_type_id": "05",
"currency_type_id": "PEN",
"total": 60.0
},
"can_issue_notes": true,
"reason": null,
"credit_notes_total": 35.0,
"debit_notes_total": 0,
"available_for_credit_note": 25.0,
"items": [
{
"line_id": 4101,
"item_id": 88,
"description": "GASEOSA 500 ML",
"quantity": 2,
"returned_quantity": 1,
"available_quantity": 1,
"unit_price": 15.0,
"total": 30.0
},
{
"line_id": 4102,
"item_id": 91,
"description": "GALLETAS X 6",
"quantity": 3,
"returned_quantity": 2,
"available_quantity": 1,
"unit_price": 10.0,
"total": 30.0
}
],
"notes": [
{
"id": 1533,
"number": "FC01-12",
"document_type_id": "07",
"note_type": "07",
"note_type_description": "Devolución por ítem",
"description": "Devolución parcial",
"date_of_issue": "2026-11-07",
"total": 35.0,
"state_type_id": "05",
"state_type_description": "Aceptado",
"counts_for_balance": true
}
]
}
}
403 — Registro de otro vendedor
{
"success": false,
"message": "No tienes permiso para acceder a este registro."
}
404 — No existe
{
"success": false,
"message": "Registro no encontrado."
}
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.