Obtener lista de items de nota de crédito
Obtiene lista de items de la nota de crédito. Muestra detalles como cantidades, precios, IVA calculados.
Entorno
Sección titulada «Entorno»URL base: https://api.guarani.app
Endpoint
Sección titulada «Endpoint»GET /notas/credito/{id}/itemsEjemplo de solicitud
Sección titulada «Ejemplo de solicitud»curl -X GET "https://api.guarani.app/notas/credito/{id}/items" \ -H "x-api-key: Bearer <access_token>" \ -H "Accept: application/json" | jqNota: Asegúrate de reemplazar
{id}con el ID de la nota de crédito y<access_token>con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezadox-api-keypara autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.
Parámetros de ruta
Sección titulada «Parámetros de ruta»| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | uuid | Sí | Identificador único de la nota de crédito del cual se desea obtener los ítems. (ver notas de crédito) |
Encabezados de la solicitud
Sección titulada «Encabezados de la solicitud»| Encabezado | Valor | Descripción |
|---|---|---|
x-api-key | Bearer <access_token> | Token JWT necesario para autenticar al usuario que realiza la consulta. |
Accept | application/json | Define que la respuesta debe devolverse en formato JSON. |
Ejemplo de respuesta
Sección titulada «Ejemplo de respuesta»{ "success": true, "codigo": "200", "message": "Operación realizada correctamente.", "data": [ { "id": "ejemplo-uuid-item-123", "mercaderia": { "id": "ejemplo-uuid-mercaderia-123", "codigo_original": "CODIGO ORIGINAL DE EJEMPLO", "codigo_fabricante": "CODIGO FABRICANTE DE EJEMPLO", "codigo_interno": "01-1234567", "codigo_barra": "CODIGO DE BARRAS DE EJEMPLO", "descripcion": "DESCRIPCION DE EJEMPLO", "descripcion_larga": "DESCRIPCION LARGA DE EJEMPLO", "observacion": "OBSERVACION DE EJEMPLO", "mercaderia_clasificacion_id": "ejemplo-uuid-clasificacion-mercaderia-123", "mercaderia_marca_id": "ejemplo-uuid-marca-123", "imagen_url": null, "unidades": { "unidad_medida_compra": { "id": "5f49c6c1-d622-4f5b-9d8b-2d1636b584ab", "codigo_sifen": "77", "representacion": "UNI", "descripcion": "Unidad" }, "factor_conversion": 1, "unidad_medida_venta": { "id": "5f49c6c1-d622-4f5b-9d8b-2d1636b584ab", "codigo_sifen": "77", "representacion": "UNI", "descripcion": "Unidad" } }, "precios": [ { "precio_unitario": { "0": 0, "5": 0, "10": 100000 }, "moneda": "PYG", "establecimiento_id": "ejemplo-uuid-establecimiento-123" } ] }, "servicio": null, "precio_unitario": 100000, "precio_unitario_original": 100000, "total": 100000, "cantidad": 1, "iva": { "iva_tipo": 10, "importe_gravado": 100000, "monto": 10000, "afectacion": 100 } } ]}Descripción de Campos de Respuesta
Sección titulada «Descripción de Campos de Respuesta»Campos principales
Sección titulada «Campos principales»| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único del item (UUID). |
mercaderia | object | Datos de la mercadería (null si es un servicio). |
servicio | object | Datos del servicio (null si es una mercadería). |
precio_unitario | number | Precio unitario actual del item. |
precio_unitario_original | number | Precio unitario original sin descuentos aplicados. |
total | number | Monto total del item (precio_unitario × cantidad). |
cantidad | number | Cantidad de unidades del item. |
iva | object | Información del IVA aplicado al item. |
Estructura del objeto mercaderia
Sección titulada «Estructura del objeto mercaderia»| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único de la mercadería (UUID). |
codigo_original | string | Código original del producto. |
codigo_fabricante | string | Código asignado por el fabricante. |
codigo_interno | string | Código interno de la mercadería. Ver tabla de código interno |
codigo_barra | string | Código de barras del producto. |
descripcion | string | Descripción breve de la mercadería. |
descripcion_larga | string | Descripción detallada de la mercadería. |
observacion | string | Observaciones adicionales sobre la mercadería. |
mercaderia_clasificacion_id | string | UUID de la clasificación de la mercadería. |
mercaderia_marca_id | string | UUID de la marca de la mercadería. |
imagen_url | string | URL de la imagen del producto (null si no tiene). |
unidades | object | Objeto con información de las unidades de medida de compra y venta. |
precios | array | Array con los precios de la mercadería por establecimiento. |
Campos del objeto unidades
Sección titulada «Campos del objeto unidades»| Campo | Tipo | Descripción |
|---|---|---|
unidad_medida_compra | object | Objeto con información de la unidad de medida de compra (null si no tiene). |
factor_conversion | number | Factor de conversión entre unidad de compra y venta (ej: 1 caja = 12 unidades). |
unidad_medida_venta | object | Objeto con información de la unidad de medida de venta (null si no tiene). |
Campos de unidad_medida_compra y unidad_medida_venta
Sección titulada «Campos de unidad_medida_compra y unidad_medida_venta»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la unidad de medida. |
codigo_sifen | string | Código de la unidad según el catálogo SIFEN. |
representacion | string | Representación corta de la unidad (ej: “UNI”). |
descripcion | string | Descripción de la unidad de medida. |
Campos del array precios
Sección titulada «Campos del array precios»| Campo | Tipo | Descripción |
|---|---|---|
precio_unitario | object | Objeto con precios discriminados por tipo de IVA (0, 5, 10). |
moneda | string | Código de moneda ISO 4217. |
establecimiento_id | uuid | Identificador del establecimiento al que pertenece el precio. |
Estructura del objeto servicio
Sección titulada «Estructura del objeto servicio»| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único del servicio (UUID). |
descripcion | string | Descripción breve del servicio. |
descripcion_larga | string | Descripción detallada del servicio. |
observacion | string | Observaciones adicionales sobre el servicio. |
codigo_interno | string | Código interno del item para el servicio. Ver tabla de código interno |
servicio_clasificacion_id | string | UUID de la clasificación del servicio. |
imagen_url | string | URL de la imagen del servicio (null si no tiene). |
unidad_medida | object | Objeto con información de la unidad de medida del servicio (null si no tiene). |
precio_unitario | object | Objeto con precios discriminados por tipo de IVA (0, 5, 10). |
moneda | string | Código de moneda ISO 4217. |
establecimiento_id | uuid | Identificador del establecimiento al que pertenece el precio. |
Campos del objeto unidad_medida (servicio)
Sección titulada «Campos del objeto unidad_medida (servicio)»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la unidad de medida. |
codigo_sifen | string | Código de la unidad según el catálogo SIFEN. |
representacion | string | Representación corta de la unidad (ej: “UNI”). |
descripcion | string | Descripción de la unidad de medida. |
Estructura del objeto iva
Sección titulada «Estructura del objeto iva»| Campo | Tipo | Descripción |
|---|---|---|
iva_tipo | number | Tipo de IVA aplicado (0: exento, 5: 5%, 10: 10%). |
importe_gravado | number | Importe gravado por el IVA (base imponible). |
monto | number | Monto de IVA calculado para el item. |
afectacion | number | Porcentaje de afectación del IVA sobre el precio total. |
Recursos adicionales
Sección titulada «Recursos adicionales»Para más información sobre posibles errores de notas de crédito, consulta las siguientes secciones: errores.