seedcode-facturacion-electronica

Seedcode-Facturación-Electrónica

Seedcode-Facturación-Electrónica es una biblioteca diseñada para la generación de facturas electrónicas según los estándares aplicables.

Instalación

Para instalar la biblioteca, ejecuta el siguiente comando:

npm install seedcode-facturacion-electronica

Uso

Factura comercial

Importa la función principal generate_factura y utiliza los parámetros requeridos para generar una factura electrónica.

import { generate_factura } from "seedcode-facturacion-electronica";

const factura = generate_factura(
  transmitter, // Datos del emisor de la factura
  codEstable, // Código del establecimiento del emisor
  codPuntoVenta, // Código del punto de venta del emisor
  codEstableMH, // Código del establecimiento MH (Ministerio de Hacienda)
  codPuntoVentaMH, // Código del punto de venta MH (Ministerio de Hacienda)
  tipoEstablecimiento, // Tipo de establecimiento del emisor
  nextCorrelative, // Número correlativo de la factura
  products, // Lista de productos o servicios
  customer, // Datos del cliente
  condition, // Condiciones de pago (ej. crédito, contado)
  tipo_pago, // Tipo de pago (ej. efectivo, transferencia)
  ivaRete1, // Retención de IVA aplicada
  ambiente // Ambiente en que se genera la factura (ej. pruebas, producción)
);

Parámetros

1. transmitter

El objeto transmitter contiene los datos del emisor de la factura. Este objeto incluye información esencial como claves, identificación, nombre, contacto y datos de la dirección.

export interface ITransmitter {
  clavePrivada: string; // Clave privada del emisor
  clavePublica: string; // Clave pública del emisor
  claveApi: string; // Clave API del emisor
  nit: string; // Número de Identificación Tributaria (NIT)
  nrc: string; // Número de Registro de Contribuyente (NRC)
  nombre: string; // Nombre del emisor
  telefono: string; // Teléfono de contacto del emisor
  correo: string; // Correo electrónico del emisor
  descActividad: string; // Descripción de la actividad comercial
  codActividad: string; // Código de la actividad económica
  nombreComercial: string; // Nombre comercial del emisor
  direccion: IAddress; // Dirección del establecimiento
}

2. direccion

La dirección (direccion) del emisor es un objeto que contiene información detallada sobre la ubicación del establecimiento.

export interface IAddress {
  departamento: string; // Departamento o región del emisor
  municipio: string; // Municipio del emisor
  complemento: string; // Detalles adicionales de la dirección
}

3. codEstable y codPuntoVenta

• codEstable: Código único del establecimiento que identifica dónde se emite la factura.
• codPuntoVenta: Código único que identifica el punto de venta específico desde donde se realiza la operación.

4. codEstableMH y codPuntoVentaMH

• codEstableMH: Código del establecimiento registrado ante el Ministerio de Hacienda.
• codPuntoVentaMH: Código del punto de venta registrado ante el Ministerio de Hacienda.

5. tipoEstablecimiento

El tipo de establecimiento es una cadena de texto que describe el tipo de ubicación desde donde se emite la factura. Puede ser, por ejemplo, un local físico o una tienda en línea.

6. products

Un array que contiene los productos o servicios que forman parte de la factura. Debe incluir detalles como el nombre, la cantidad, el precio unitario y otros datos relevantes.

7. customer

El objeto customer contiene la información del cliente al que se le emite la factura, tales como nombre, identificación fiscal, y detalles de contacto.

export interface Customer {
  nombre: string; //Nombre del receptor
  nombreComercial: string; //Nombre comercial del receptor
  nrc: string; // NIT del receptor
  nit: string; //NRC del receptor
  tipoDocumento: string; // Tipo de documento de identificación del receptor
  numDocumento: string; // Numero de documento de identificación del receptor
  codActividad: string; // Código de actividad económica (si es un receptor contribuyente) del receptor
  descActividad: string; // Descripción de actividad económica (si es un receptor contribuyente)  del receptor
  telefono: string; //Teléfono del receptor
  correo: string; //Correo electrónico del receptor
  direccion: IAddress; // Dirección del receptor
}

8. condition y tipo_pago

• condition: Condiciones de pago de la factura (ej. crédito, contado).
• tipo_pago: Tipo de pago empleado para la transacción (ej. efectivo, tarjeta, transferencia).

export interface FC_PagosItems {
  codigo: string; //Código del tipo de pago a aplicar
  montoPago: number; //Monto del pago a aplicar
  referencia: string | null; //Referencia del pago a aplicar
  plazo: string | null; // Plazo del pago en caso de ser al crédito
  periodo: number | null; //Periodo del pago en caso de ser al crédito
}

9. ivaRete1

Porcentaje de retención de IVA aplicado a la transacción, en caso de que aplique.

10. ambiente

El ambiente en el que se emite la factura: puede ser de pruebas o producción, dependiendo del contexto de uso.

Crédito Fiscal

La función generate_credito_fiscal se utiliza para generar un Crédito Fiscal Electrónico. A continuación se describen los parámetros requeridos y un ejemplo de cómo usar esta función.

import { generate_credito_fiscal } from "seedcode-facturacion-electronica";

const creditoFiscal = generate_credito_fiscal(
  transmitter, // Datos del emisor de crédito fiscal
  codEstable, // Código del establecimiento del emisor
  codPuntoVenta, // Código del punto de venta del emisor
  codEstableMH, // Código del establecimiento en el sistema MH
  codPuntoVentaMH, // Código del punto de venta en el sistema MH
  tipoEstablecimiento, // Tipo de establecimiento
  nextCorrelative, // Número correlativo del crédito fiscal
  receptor, // Datos del receptor (cliente)
  products_carts, // Productos incluidos en el crédito fiscal
  tipo_pago, // Tipos de pago
  retencion, // Porcentaje de retención de IVA
  condition, // Condición de la operación
  ambiente, // Ambiente (producción o pruebas)
  tributo // Tipo de tributo (por defecto, IVA)
);

Parámetros

• transmitter: El objeto del emisor del crédito fiscal. Incluye los siguientes campos:
  • clavePrivada: Clave privada del emisor.
  • clavePublica: Clave pública del emisor.
  • claveApi: Clave API del emisor.
  • nit: NIT del emisor.
  • nrc: NRC del emisor.
  • nombre: Nombre del emisor.
  • telefono: Teléfono del emisor.
  • correo: Correo del emisor.
  • descActividad: Descripción de la actividad del emisor.
  • codActividad: Código de la actividad del emisor.
  • nombreComercial: Nombre comercial del emisor.
  • tipoEstablecimiento: Tipo de establecimiento.
  • codEstableMH: Código del establecimiento en el sistema MH.
  • codEstable: Código del establecimiento.
  • codPuntoVentaMH: Código del punto de venta en el sistema MH.
  • codPuntoVenta: Código del punto de venta.
  • direccion: Dirección del emisor (ver más detalles en la sección direccion).
• codEstable: Código del establecimiento del emisor.
• codPuntoVenta: Código del punto de venta del emisor.
• codEstableMH: Código del establecimiento en el sistema MH.
• codPuntoVentaMH: Código del punto de venta en el sistema MH.
• tipoEstablecimiento: Tipo de establecimiento del emisor.
• nextCorrelative: El siguiente número correlativo para el crédito fiscal.
• receptor: Datos del receptor (cliente). Incluye:
  • nombre: Nombre del receptor.
  • nit: NIT del receptor.
  • direccion: Dirección del receptor.
• products_carts: Arreglo de productos o servicios incluidos en el crédito fiscal.
• tipo_pago: Métodos de pago utilizados en la operación.
• retencion: Porcentaje de retención de IVA aplicado.
• condition: Condición de la operación.
• ambiente: El ambiente de emisión (por defecto "00").
• tributo: Tipo de tributo aplicable (por defecto IVA).

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.