Saltearse al contenido

Agregar item a nota de crédito

Agrega una nueva mercadería o servicio a la nota de crédito. Permite incluir mercaderías o servicios con sus respectivos precios y cantidades.


URL base: https://api.guarani.app

POST /notas/credito/{id}/items
Ventana de terminal
# USD
curl -X POST "https://api.guarani.app/notas/credito/{id}/items" \
-H "Content-Type: application/json" \
-H "x-api-key: Bearer <access_token>" \
-d '{
"mercaderia_id": "ejemplo-uuid-mercaderia-123",
"precio_unitario": {
"0": 9.59,
"5": 0,
"10": 4.10
},
"precio_unitario_original": 13.69,
"cantidad": 1,
}' | jq
# PYG
curl -X POST "https://api.guarani.app/notas/credito/{id}/items" \
-H "Content-Type: application/json" \
-H "x-api-key: Bearer <access_token>" \
-d '{
"mercaderia_id": "ejemplo-uuid-mercaderia-123",
"precio_unitario": {
"0": 70000,
"5": 0,
"10": 30000
},
"precio_unitario_original": 100000,
"cantidad": 1,
}' | jq

Nota: Se envía mercaderia_id o servicio_id, pero no ambos. Nota: 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 Guaraní.
Importante:
Es imprescindible incluir un token de acceso válido en el encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.


ParámetroTipoRequeridoDescripción
iduuidID de la nota de crédito a la que se desea agregar el item. (ver notas de crédito)
EncabezadoValorDescripción
Content-Typeapplication/jsonIndica que los datos se envían en formato JSON.
x-api-keyBearer <access_token>Token de autenticación necesario para acceder al recurso.
CampoTipoRequeridoTamañoDescripción
mercaderia_iduuidCondicional36ID de la mercadería, si el ítem corresponde a un producto. Se debe enviar mercaderia_id o servicio_id, pero no ambos. (ver mercaderias)
servicio_iduuidCondicional36ID del servicio, si el ítem corresponde a un servicio. Se debe enviar mercaderia_id o servicio_id, pero no ambos. (ver servicios)
precio_unitarioobjeto-Precio por unidad del producto o servicio discriminado por tipo de IVA.
precio_unitario_originalnumberNo-Precio original del producto o servicio. Si no se envía, se usa el precio calculado del objeto precio_unitario.
cantidadnumber-Cantidad de unidades del producto o servicio. Debe ser mayor a 0.
CampoTipoRequeridoTamañoDescripción
0numberNo-Precio con IVA 0%
5numberNo-Precio con IVA 5%
10numberNo-Precio con IVA 10%
{
"success": true,
"codigo": "201",
"message": "Recurso creado con éxito.",
"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": 30000,
"monto": 10000,
"afectacion": 100
}
}
}
CampoTipoDescripción
iduuidUUID único del item creado en la nota de crédito.
mercaderiaobjetoInformación completa de la mercadería (null si es servicio).
servicioobjetoInformación completa del servicio (null si es mercadería).
precio_unitarionumberPrecio final por unidad aplicado.
precio_unitario_originalnumberPrecio original por unidad antes de descuentos o ajustes.
totalnumberMonto total del item (precio_unitario × cantidad).
cantidadnumberCantidad de unidades del producto o servicio.
ivaobjetoInformación del cálculo del IVA aplicado.
CampoTipoDescripción
iduuidUUID de la mercadería.
codigo_originalstringCódigo original del fabricante o proveedor.
codigo_fabricantestringCódigo del fabricante.
codigo_internostringCódigo interno de la mercadería.
codigo_barrastringCódigo de barras del producto.
descripcionstringNombre o descripción corta de la mercadería.
descripcion_largastringDescripción extendida de la mercadería.
observacionstringObservaciones o notas adicionales.
mercaderia_clasificacion_iduuidUUID de la clasificación o categoría de la mercadería.
mercaderia_marca_iduuidUUID de la marca de la mercadería.
imagen_urlstringURL de la imagen del producto (null si no tiene imagen).
unidadesobjetoObjeto con información de unidades de medida.
preciosarrayArray con información de precios por establecimiento.
CampoTipoDescripción
unidad_medida_compraobjectObjeto con información de la unidad de medida de compra (null si no tiene).
factor_conversionnumberFactor de conversión entre unidad de compra y venta (ej: 1 caja = 12 unidades).
unidad_medida_ventaobjectObjeto 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»
CampoTipoDescripción
iduuidIdentificador único de la unidad de medida.
codigo_sifenstringCódigo de la unidad según el catálogo SIFEN.
representacionstringRepresentación corta de la unidad (ej: “UNI”).
descripcionstringDescripción de la unidad de medida.
CampoTipoDescripción
precio_unitarioobjectObjeto con precios discriminados por tipo de IVA (0, 5, 10).
monedastringCódigo de moneda ISO 4217.
establecimiento_iduuidIdentificador del establecimiento al que pertenece el precio.
CampoTipoDescripción
iva_tiponumberTipo de IVA aplicado: 0%, 5% o 10%.
importe_gravadonumberImporte gravado por el IVA.
montonumberMonto del IVA calculado en la moneda correspondiente.
afectacionnumberPorcentaje de afectación del IVA sobre el precio total.

Para más información sobre posibles errores de notas de crédito, consulta las siguientes secciones: errores.