README.md

Tu Ruc | Paraguay

Cliente Javascript para la API de TuRuc Paraguay

Esta biblioteca proporciona funciones para realizar consultas a una API de contribuyentes. Permite buscar contribuyentes por un término de búsqueda y paginación, así como obtener información detallada sobre un contribuyente específico a través de su número de RUC o CI.

Instalación

Para utilizar esta biblioteca en tu proyecto, sigue estos pasos:

npm install tu-ruc-js-client

Importa las funciones necesarias en tu código:

const {
  getContribuyenteBySearch,
  getContribuyenteByRucOrCI,
} = require('tu-ruc-js-client');

Uso

getContribuyenteBySearch(search, offset)

Esta función realiza una búsqueda de contribuyentes por un término específico y opcionalmente con un offset de paginación.

Parámetros:

• search (cadena): Término de búsqueda (entre 3 y 10 caracteres).
• offset (número opcional): Offset de paginación, por defecto es 0.

Ejemplo de Uso:

try {
  const contribuyentes = await getContribuyenteBySearch('término-de-búsqueda', 1);
  console.log(contribuyentes);
} catch (error) {
  console.error(error.message);
}

getContribuyenteByRucOrCI(ruc)

Esta función obtiene información detallada sobre un contribuyente específico a través de su número de RUC o CI.

Parámetros:

• ruc (cadena): Número de RUC o CI del contribuyente (entre 3 y 10 caracteres).

Ejemplo de Uso:

try {
  const contribuyente = await getContribuyenteByRucOrCI('1234567890');
  console.log(contribuyente);
} catch (error) {
  console.error(error.message);
}

Contribuciones

Si encuentras algún problema o tienes sugerencias de mejora, no dudes en contribuir al desarrollo de esta biblioteca. Abre un problema o envía una solicitud de extracción en GitHub.

¡Gracias por utilizar esta biblioteca!