Obtener nota de crédito por su ID

Obtiene información completa de una nota de crédito específica, incluyendo todos los items, cliente asociado y detalles de la transacción.

---

Entorno

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

Endpoint

GET /notas/credito/{id}

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/notas/credito/{id}" \
  -H "x-api-key: Bearer <access_token>" \
  -H "Accept: application/json" | jq

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 Guarani. 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ámetros de ruta

Parámetro	Tipo	Requerido	Descripción
id	uuid	Sí	Identificador único de la nota de crédito a consultar. (ver notas de crédito)

Encabezados de la solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.
Accept	application/json	Indica que la respuesta debe devolverse en formato JSON.

Ejemplo de respuesta

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": {
    "id": "ejemplo-uuid-nota-credito-123",
    "motivo_codigo": 2,
    "motivo_descripcion": "Error de emision",
    "total": 100000,
    "moneda": "PYG",
    "cotizacion": 1,
    "carrito_id": null,
    "fecha_emision": null,
    "estado_nota_credito": 1,
    "numero_documento": null,
    "tipo_origen": 1,
    "cliente": {
      "id": "ejemplo-uuid-cliente-123",
      "tipo_persona": 1,
      "tipo_documento": 1,
      "documento": "1234567890",
      "nombre": "Cliente Ejemplo",
      "nombre_fantasia": "Cliente Ejemplo",
      "nacionalidad": "PRY",
      "fecha_nacimiento": "01/01/1990",
      "whatsapp": "",
      "email": "[email protected]",
      "numero_casa": "0",
      "direccion": "Dirección de ejemplo",
      "barrio": "Barrio de ejemplo",
      "ciudad": {
        "id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341",
        "codigo_sifen": "3556",
        "nombre": "SANTA RITA",
        "distrito": {
          "id": "78d49201-91f9-4e6c-aadb-4927f56767c0",
          "codigo_sifen": "209",
          "nombre": "SANTA RITA",
          "departamento": {
            "id": "750d3163-6a53-45df-b349-e8139d1ff3a9",
            "codigo_sifen": "11",
            "nombre": "ALTO PARANA"
          }
        }
      }
    },
    "documentos_asociados_electronicos": {
      "cdc": "01234567890123456589012345678901234567890122"
    },
    "documentos_asociados_manuales": null,
    "items": [
      {
        "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",
          "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

Campos Principales

Campo	Tipo	Descripción
id	uuid	Identificador único de la nota de crédito.
motivo_codigo	number	Código del motivo de emisión de la nota de crédito.
motivo_descripcion	string	Descripción literal del motivo asignado al código anterior.
total	number	Monto total de la nota de crédito en la moneda especificada, incluyendo todos los items e impuestos.
moneda	string	Código de moneda en formato ISO 4217 (ej: PYG, USD, BRL, ARS).
cotizacion	number	Cotización de la moneda respecto a Guaraníes.
carrito_id	uuid	ID del carrito asociado (si la nota de crédito está asociada a un carrito). Es null si no hay carrito asociado.
fecha_emision	string	Fecha y hora de emisión de la nota de crédito. Es null hasta que la nota de crédito se finalice.
estado_nota_credito	number	Estado actual de la nota de crédito. (ver tablas-referencias)
numero_documento	string	Número del documento de la nota de crédito. Es null hasta que la nota de crédito se finalice.
tipo_origen	number	Tipo de origen de la nota de crédito.
cliente	object	Objeto con la información completa del cliente asociado a la nota de crédito.
documentos_asociados_electronicos	object	Documento electrónico asociado (si aplica). Es null si no hay documento electrónico asociado.
documentos_asociados_manuales	object	Documento manual asociado (si aplica). Es null si no hay documento manual asociado.
items	array	Lista de productos/servicios agregados a la nota de crédito con todos sus detalles.

Campos del Cliente

Campo	Tipo	Descripción
id	uuid	Identificador único del cliente.
tipo_persona	number	Tipo de persona. ver tipos de personas
tipo_documento	number	Tipo de documento de identidad. ver tipos de documentos
documento	string	Número del documento de identidad del cliente.
nombre	string	Nombre completo del cliente (razón social para personas jurídicas).
nombre_fantasia	string	Nombre comercial o fantasía del cliente.
nacionalidad	string	Código de nacionalidad en formato ISO 3166-1 alpha-3.
fecha_nacimiento	string	Fecha de nacimiento del cliente en formato DD/MM/YYYY.
whatsapp	string	Número de WhatsApp del cliente en formato internacional.
email	string	Dirección de correo electrónico del cliente.
numero_casa	string	Número de casa o edificio de la dirección del cliente.
direccion	string	Dirección completa del cliente.
barrio	string	Nombre del barrio donde reside el cliente.
ciudad	object	Objeto con información de la ciudad del cliente.

Campos de Ciudad

Campo	Tipo	Descripción
id	uuid	Identificador único de la ciudad.
codigo_sifen	string	Código de la ciudad según el catálogo SIFEN.
nombre	string	Nombre de la ciudad.
distrito	object	Objeto con información del distrito al que pertenece la ciudad.
departamento	object	Objeto con información del departamento al que pertenece la ciudad.

Campos de Distrito

Campo	Tipo	Descripción
id	uuid	Identificador único del distrito.
nombre	string	Nombre del distrito.
codigo_sifen	string	Código del distrito según el catálogo SIFEN.

Campos de Departamento

Campo	Tipo	Descripción
id	uuid	Identificador único del departamento.
nombre	string	Nombre del departamento.
codigo_sifen	string	Código del departamento según el catálogo SIFEN.

Campos de Items

Campo	Tipo	Descripción
id	uuid	Identificador único del item en la nota de crédito.
mercaderia	object	Objeto con información de la mercadería. Es null si el item es un servicio.
servicio	object	Objeto con información del servicio. Es null si el item es una mercadería.
precio_unitario	number	Precio unitario final del item en la moneda de la nota de crédito (puede incluir ajustes o descuentos).
precio_unitario_original	number	Precio unitario original del item sin ajustes.
total	number	Monto total de la línea (precio unitario × cantidad) en la moneda de la nota de crédito.
cantidad	number	Cantidad de unidades del producto o servicio.
iva	object	Objeto con información del IVA aplicado al item.

Campos de Mercadería

Campo	Tipo	Descripción
id	uuid	Identificador único de la mercadería.
codigo_original	string	Código original del proveedor o fabricante.
codigo_fabricante	string	Código asignado por el fabricante.
codigo_interno	string	Código interno generado por el sistema para identificación única.
codigo_barra	string	Código de barras (EAN/UPC) del producto.
descripcion	string	Descripción corta de la mercadería.
descripcion_larga	string	Descripción detallada de la mercadería.
observacion	string	Observaciones adicionales sobre la mercadería.
imagen_url	string	URL de la imagen del producto. Es null si no tiene imagen.
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

Campo	Tipo	Descripción
unidad_medida_compra	object	Objeto con información de la unidad de medida de compra.
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.

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

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.

Campos de Servicio

Campo	Tipo	Descripción
id	uuid	Identificador único del servicio.
descripcion	string	Descripción corta del servicio.
descripcion_larga	string	Descripción detallada del servicio.
observacion	string	Observaciones adicionales sobre el servicio.
codigo_interno	string	Código interno del servicio. ver código interno
servicio_clasificacion_id	uuid	UUID de la clasificación del servicio.
imagen_url	string	URL de la imagen del servicio. Es null si no tiene imagen.
unidad_medida	object	Objeto con información de la unidad de medida del servicio.
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)

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 de IVA

Campo	Tipo	Descripción
iva_tipo	number	Tipo de IVA aplicado. 0, 5, 10.
importe_gravado	number	Importe gravado por el IVA (base imponible).
monto	number	Monto del IVA en la moneda de la nota de crédito.
afectacion	number	Porcentaje de afectación del IVA sobre el precio base.

Recursos adicionales

Para más información sobre posibles errores y cómo manejarlos, consulta errores.