Conceptos Documento - AndresRamos/ARSoftware.Contpaqi.Comercial GitHub Wiki

Modelos

ConceptoDocumento

La clase ConceptoDocumento representa un modelo amigable de un concepto de documento.

public class ConceptoDocumento
{
    /// <summary>
    ///     Id del concepto de documento.
    /// </summary>
    public int Id { get; set; }

    /// <summary>
    ///     Código del concepto de documento.
    /// </summary>
    public string Codigo { get; set; } = string.Empty;

    /// <summary>
    ///     Nombre del concepto de documento.
    /// </summary>
    public string Nombre { get; set; } = string.Empty;

    /// <summary>
    ///     Datos extra del concepto de documento.
    /// </summary>
    public Dictionary<string, string> DatosExtra { get; set; } = new();
}

admConceptos

La clase admConceptos representa el modelo de SQL con el esquema completo de la tabla de conceptos de documento en la base de datos. Se utiliza principalmente para consultar el catalogo de conceptos de documento cuando se necesita obtener el esquema completo.

public partial class admConceptos
{
    public int CIDCONCEPTODOCUMENTO { get; set; }
    public string CCODIGOCONCEPTO { get; set; } = null!;
    public string CNOMBRECONCEPTO { get; set; } = null!;
    public int CIDDOCUMENTODE { get; set; }
    public int CNATURALEZA { get; set; }
    public int CDOCTOACREDITO { get; set; }
    public int CTIPOFOLIO { get; set; }
    public int CMAXIMOMOVTOS { get; set; }
    public int CCREACLIENTE { get; set; }
    public int CSUMARPROMOCIONES { get; set; }
    public string CFORMAPREIMPRESA { get; set; } = null!;
    public int CORDENCALCULO { get; set; }
    public int CUSANOMBRECTEPROV { get; set; }
    public int CUSARFC { get; set; }
    public int CUSAFECHAVENCIMIENTO { get; set; }
    public int CUSAFECHAENTREGARECEPCION { get; set; }
    public int CUSAMONEDA { get; set; }
    public int CUSATIPOCAMBIO { get; set; }
    public int CUSACODIGOAGENTE { get; set; }
    public int CUSANOMBREAGENTE { get; set; }
    public int CUSADIRECCION { get; set; }
    public int CUSAREFERENCIA { get; set; }
    public string CSERIEPOROMISION { get; set; } = null!;
    public int CANCHOCODIGOPRODUCTO { get; set; }
    public int CUSANOMBREPRODUCTO { get; set; }
    public int CANCHONOMBREPRODUCTO { get; set; }
    public int CUSAALMACEN { get; set; }
    public int CANCHOCODIGOALMACEN { get; set; }
    public int CANCHOIMPORTES { get; set; }
    public int CANCHOPORCENTAJES { get; set; }
    public int CANCHOUNIDADPESOMEDIDA { get; set; }
    public int CUSAPRECIO { get; set; }
    public int CIDFORMULAPRECIO { get; set; }
    public int CUSACOSTOCAPTURADO { get; set; }
    public int CIDFORMULACOSTOCAPTURADO { get; set; }
    public int CUSAEXISTENCIA { get; set; }
    public int CUSANETO { get; set; }
    public int CIDFORMULANETO { get; set; }
    public int CUSAPORCENTAJEIMPUESTO1 { get; set; }
    public int CIDFORMULAPORCIMPUESTO1 { get; set; }
    public int CUSAIMPUESTO1 { get; set; }
    public int CIDFORMULAIMPUESTO1 { get; set; }
    public int CUSAPORCENTAJEIMPUESTO2 { get; set; }
    public int CIDFORMULAPORCIMPUESTO2 { get; set; }
    public int CUSAIMPUESTO2 { get; set; }
    public int CIDFORMULAIMPUESTO2 { get; set; }
    public int CUSAPORCENTAJEIMPUESTO3 { get; set; }
    public int CIDFORMULAPORCIMPUESTO3 { get; set; }
    public int CUSAIMPUESTO3 { get; set; }
    public int CIDFORMULAIMPUESTO3 { get; set; }
    public int CUSAPORCENTAJERETENCION1 { get; set; }
    public int CIDFORMULAPORCRETENCION1 { get; set; }
    public int CUSARETENCION1 { get; set; }
    public int CIDFORMULARETENCION1 { get; set; }
    public int CUSAPORCENTAJERETENCION2 { get; set; }
    public int CIDFORMULAPORCRETENCION2 { get; set; }
    public int CUSARETENCION2 { get; set; }
    public int CIDFORMULARETENCION2 { get; set; }
    public int CUSAPORCENTAJEDESCUENTO1 { get; set; }
    public int CIDFORMULAPORCDESCUENTO1 { get; set; }
    public int CUSADESCUENTO1 { get; set; }
    public int CIDFORMULADESCUENTO1 { get; set; }
    public int CUSAPORCENTAJEDESCUENTO2 { get; set; }
    public int CIDFORMULAPORCDESCUENTO2 { get; set; }
    public int CUSADESCUENTO2 { get; set; }
    public int CIDFORMULADESCUENTO2 { get; set; }
    public int CUSAPORCENTAJEDESCUENTO3 { get; set; }
    public int CIDFORMULAPORCDESCUENTO3 { get; set; }
    public int CUSADESCUENTO3 { get; set; }
    public int CIDFORMULADESCUENTO3 { get; set; }
    public int CUSAPORCENTAJEDESCUENTO4 { get; set; }
    public int CIDFORMULAPORCDESCUENTO4 { get; set; }
    public int CUSADESCUENTO4 { get; set; }
    public int CIDFORMULADESCUENTO4 { get; set; }
    public int CUSAPORCENTAJEDESCUENTO5 { get; set; }
    public int CIDFORMULAPORCDESCUENTO5 { get; set; }
    public int CUSADESCUENTO5 { get; set; }
    public int CIDFORMULADESCUENTO5 { get; set; }
    public int CUSATOTAL { get; set; }
    public int CANCHOREFERENCIA { get; set; }
    public int CUSACLASIFICACIONMOVTO { get; set; }
    public int CANCHOVALORCLASIFICACION { get; set; }
    public int CIDFORMULATOTAL { get; set; }
    public int CUSADESCUENTODOC1 { get; set; }
    public int CIDFORMULADESDOC1 { get; set; }
    public int CUSADESCUENTODOC2 { get; set; }
    public int CIDFORMULADESDOC2 { get; set; }
    public int CUSAGASTO1 { get; set; }
    public int CIDFORMULAGASTO1 { get; set; }
    public int CUSAGASTO2 { get; set; }
    public int CIDFORMULAGASTO2 { get; set; }
    public int CUSAGASTO3 { get; set; }
    public int CIDFORMULAGASTO3 { get; set; }
    public int CUSATEXTOEXTRA1 { get; set; }
    public int CUSATEXTOEXTRA2 { get; set; }
    public int CUSATEXTOEXTRA3 { get; set; }
    public int CANCHOTEXTOEXTRA { get; set; }
    public int CUSAFECHAEXTRA { get; set; }
    public int CANCHOFECHAEXTRA { get; set; }
    public int CUSAIMPORTEEXTRA1 { get; set; }
    public int CIDFORMULAEXTRA1 { get; set; }
    public int CUSAIMPORTEEXTRA2 { get; set; }
    public int CIDFORMULAEXTRA2 { get; set; }
    public int CUSAIMPORTEEXTRA3 { get; set; }
    public int CIDFORMULAEXTRA3 { get; set; }
    public int CUSAIMPORTEEXTRA4 { get; set; }
    public int CIDFORMULAEXTRA4 { get; set; }
    public int CUSATEXTOEXTRA1DOC { get; set; }
    public int CUSATEXTOEXTRA2DOC { get; set; }
    public int CUSATEXTOEXTRA3DOC { get; set; }
    public int CUSAFECHAEXTRADOC { get; set; }
    public int CUSAIMPORTEEXTRA1DOC { get; set; }
    public int CUSAIMPORTEEXTRA2DOC { get; set; }
    public int CUSAIMPORTEEXTRA3DOC { get; set; }
    public int CUSAIMPORTEEXTRA4DOC { get; set; }
    public int CUSAEXTRACOMOGASTO { get; set; }
    public int CUSAOBSERVACIONES { get; set; }
    public int CPRESENTAFISCAL { get; set; }
    public int CPRESENTAREFERENCIA { get; set; }
    public int CPRESENTACONDICIONES { get; set; }
    public int CPRESENTAENVIO { get; set; }
    public int CPRESENTADETALLE { get; set; }
    public int CPRESENTAIMPRIMIR { get; set; }
    public int CPRESENTAPAGAR { get; set; }
    public int CPRESENTASALDAR { get; set; }
    public int CPRESENTADOCUMENTAR { get; set; }
    public int CPRESENTAGASTOSCOMPRA { get; set; }
    public string CSEGCONTCONCEPTO { get; set; } = null!;
    public int CBANENCABEZADO { get; set; }
    public int CBANMOVIMIENTO { get; set; }
    public int CBANDESCUENTO { get; set; }
    public int CBANIMPUESTO { get; set; }
    public int CBANACCIONAUTOMATICA { get; set; }
    public string CTIMESTAMP { get; set; } = null!;
    public double CNOFOLIO { get; set; }
    public int CIDPROCESOSEGURIDAD { get; set; }
    public int CUSAGTOMOV { get; set; }
    public int CUSASCMOV { get; set; }
    public int CIDASTOCON { get; set; }
    public string CSCCPTO2 { get; set; } = null!;
    public string CSCCPTO3 { get; set; } = null!;
    public string CSCMOVTO { get; set; } = null!;
    public int CIDCONAUTO { get; set; }
    public int CIDALMASUM { get; set; }
    public int CUSACOMVTA { get; set; }
    public int CIDPRSEG02 { get; set; }
    public int CIDPRSEG03 { get; set; }
    public int CIDPRSEG04 { get; set; }
    public int CIDPRSEG05 { get; set; }
    public int CFORMAAJ01 { get; set; }
    public int CIDPRSEG06 { get; set; }
    public int CAPFORMULA { get; set; }
    public int CESCFD { get; set; }
    public int CIDFIRMARL { get; set; }
    public int CGDAPASSW { get; set; }
    public int CEMITEYENT { get; set; }
    public int CBANCFD { get; set; }
    public string CREPIMPCFD { get; set; } = null!;
    public int CIDDIRSUCU { get; set; }
    public int CBANDIRSUC { get; set; }
    public int CVERFACELE { get; set; }
    public int CCALFECHAS { get; set; }
    public int CTIPCAMTR1 { get; set; }
    public int CTIPCAMTR2 { get; set; }
    public int CCONSOLIDA { get; set; }
    public int CENVIODIG { get; set; }
    public int CBANTRANS { get; set; }
    public int CCONFNOAPR { get; set; }
    public int CNOAPROB { get; set; }
    public int CAUTOIMPR { get; set; }
    public int CRECIBECFD { get; set; }
    public int CSISTORIG { get; set; }
    public int CIDCPTODE1 { get; set; }
    public int CIDCPTODE2 { get; set; }
    public int CIDCPTODE3 { get; set; }
    public string CPLAMIGCFD { get; set; } = null!;
    public int CIDPRSEG07 { get; set; }
    public int CRESERVADO { get; set; }
    public int CVERREFER { get; set; }
    public int CVERDOCORI { get; set; }
    public int CCBB { get; set; }
    public int CCARTAPOR { get; set; }
    public int CCOMPDONAT { get; set; }
    public int COBSXML { get; set; }
    public string CRUTAENTREGA { get; set; } = null!;
    public string CPREFIJOCONCEPTO { get; set; } = null!;
    public string CREGIMFISC { get; set; } = null!;
    public int CCOMPEDUCA { get; set; }
    public string CMETODOPAG { get; set; } = null!;
    public string CVERESQUE { get; set; } = null!;
    public string CIDFIRMADSL { get; set; } = null!;
    public string CORDENCAPTURA { get; set; } = null!;
    public int CESTATUS { get; set; }
    public int CIDMONEDA { get; set; }
    public int CIDCUENTA { get; set; }
    public string CCLAVESAT { get; set; } = null!;
    public int CIDPRSEG08 { get; set; }
    public int CUSAOBJIMP { get; set; }
}

ConceptoDocumentoDto

La clase ConceptoDocumentoDto representa un modelo de concepto de documento simplificado. Se utiliza principalmente para consultar el catalogo de conceptos de documento cuando solo se necesitan algunas propiedades. Las propiedades de este modelo tienen los los mismos nombres que las propiedades del modelo de SQL para facilitar la asignacion de valores cuando se utiliza con los repositorios genericos de conceptos de documento, como por ejemplo los que implementan IConceptoDocumentoRepository<T> de ConceptoDocumentoDto.

public class ConceptoDocumentoDto
{
    /// <summary>
    ///     Id del concepto de documento.
    /// </summary>
    public int CIDCONCEPTODOCUMENTO { get; set; }

    /// <summary>
    ///     Código del concepto de documento.
    /// </summary>
    public string CCODIGOCONCEPTO { get; set; } = string.Empty;

    /// <summary>
    ///     Nombre del concepto de documento.
    /// </summary>
    public string CNOMBRECONCEPTO { get; set; } = string.Empty;
}

Consultas

Repositorios

El proyecto incluye repositorios que implementan la interfaz IConceptoDocumentoRepository<T> que proporciona metodos que puedes utilizar para consultar el catalogo de conceptos de documento.

Los repositorios disponibles para SDK son:

  • ConceptoDocumentoSdkRepository<T> - Implementa IConceptoDocumentoRepository<T>.

El repositorio ConceptoDocumentoSdkRepository<T> utiliza reflection para buscar los valores de la propiedades del tipo T en el modelo de SQL admConceptos por lo que debes asegurarte que las propiedades del tipo T tengan el mismo nombre que las columnas de la tabla admConceptos en la base de datos. El proyecto ya incluye un tipo ConceptoDocumentoDto que cumple con este requisito.

Los repositorios disponibles para SQL son:

  • ConceptoDocumentoSqlRepository<T> - Implementa IConceptoDocumentoSqlRepository<T>. IConceptoDocumentoSqlRepository<T> hereda de IConceptoDocumentoRepository<T> y define las versiones asincronas de los metodos para beneficiarse del uso de Entity Framework Core.

El repositorio ConceptoDocumentoSqlRepository<T> utiliza AutoMapper para proyectar el modelo de SQL admConceptos al tipo del parametro T por lo debes crear una configuracion de mapeo con AutoMapper para que funcione. El proyecto ya incluye una configuracion de mapeo para el tipo ConceptoDocumentoDto.

IConceptoDocumentoRepository<T>

/// <summary>
///     Interfaz de repositorio que define métodos para consultar conceptos de documento.
/// </summary>
/// <typeparam name="T">
///     El tipo de concepto de documento utilizado por el repositorio.
/// </typeparam>
public interface IConceptoDocumentoRepository<T> where T : class, new()
{
    /// <summary>
    ///     Busca un concepto de documento por código.
    /// </summary>
    /// <param name="codigoConcepto">
    ///     Código del concepto de documento a buscar.
    /// </param>
    /// <returns>
    ///     Un concepto de documento, o <see langword="null" /> si no existe un concepto de documento con el código
    ///     proporcionado.
    /// </returns>
    T? BuscarPorCodigo(string codigoConcepto);

    /// <summary>
    ///     Busca un concepto de documento por id.
    /// </summary>
    /// <param name="idConcepto">
    ///     Id del concepto de documento a buscar.
    /// </param>
    /// <returns>
    ///     Un concepto de documento, o <see langword="null" /> si no existe un concepto de documento con el id proporcionado.
    /// </returns>
    T? BuscarPorId(int idConcepto);

    /// <summary>
    ///     Busca conceptos de documento por documento modelo.
    /// </summary>
    /// <param name="idDocumentoModelo">
    ///     Id del documento modelo de los conceptos de documento a buscar.
    /// </param>
    /// <returns>
    ///     Lista de conceptos de documento.
    /// </returns>
    List<T> TraerPorDocumentoModeloId(int idDocumentoModelo);

    /// <summary>
    ///     Busca todos los conceptos de documento.
    /// </summary>
    /// <returns>
    ///     Lista de conceptos de documento.
    /// </returns>
    List<T> TraerTodo();
}

IConceptoDocumentoSqlRepository<T>

/// <inheritdoc cref="IConceptoDocumentoRepository{T}" />
public interface IConceptoDocumentoSqlRepository<T> : IConceptoDocumentoRepository<T> where T : class, new()
{
    /// <summary>
    ///     Busca un concepto de documento por código.
    /// </summary>
    /// <param name="codigoConcepto">
    ///     Código del concepto de documento a buscar.
    /// </param>
    /// <param name="cancellationToken">
    ///     Token de cancelación.
    /// </param>
    /// <returns>
    ///     Un concepto de documento, o <see langword="null" /> si no existe un concepto de documento con el código
    ///     proporcionado.
    /// </returns>
    Task<T?> BuscarPorCodigoAsync(string codigoConcepto, CancellationToken cancellationToken);

    /// <summary>
    ///     Busca un concepto de documento por id.
    /// </summary>
    /// <param name="idConcepto">
    ///     Id del concepto de documento a buscar.
    /// </param>
    /// <param name="cancellationToken">
    ///     Token de cancelación.
    /// </param>
    /// <returns>
    ///     Un concepto de documento, o <see langword="null" /> si no existe un concepto de documento con el id proporcionado.
    /// </returns>
    Task<T?> BuscarPorIdAsync(int idConcepto, CancellationToken cancellationToken);

    /// <summary>
    ///     Busca conceptos de documento por documento modelo.
    /// </summary>
    /// <param name="idDocumentoModelo">
    ///     Id del documento modelo de los conceptos de documento a buscar.
    /// </param>
    /// <param name="cancellationToken">
    ///     Token de cancelación.
    /// </param>
    /// <returns>
    ///     Lista de conceptos de documento.
    /// </returns>
    Task<List<T>> TraerPorDocumentoModeloIdAsync(int idDocumentoModelo, CancellationToken cancellationToken);

    /// <summary>
    ///     Busca todos los conceptos de documento.
    /// </summary>
    /// <param name="cancellationToken">
    ///     Token de cancelación.
    /// </param>
    /// <returns>
    ///     Lista de conceptos de documento.
    /// </returns>
    Task<List<T>> TraerTodoAsync(CancellationToken cancellationToken);
}

Dependency Injection

public sealed class BuscarConceptosDocumentoConRepositorio
{
    private readonly IConceptoDocumentoRepository<admConceptos> _conceptoDocumentoRepository;
    // private readonly IConceptoDocumentoRepository<ConceptoDocumentoDto> _conceptoDocumentoRepository;
    // private readonly IConceptoDocumentoRepository<TuModelo> _conceptoDocumentoRepository;

    public BuscarConceptosDocumentoConRepositorio(IConceptoDocumentoRepository<admConceptos> conceptoDocumentoRepository)
    {
        _conceptoDocumentoRepository = conceptoDocumentoRepository;
    }
}

Buscar Por Codigo

public void BuscarPorCodigo()
{
    var codigoConcepto = "PRUEBA";

    admConceptos? concepto = _conceptoDocumentoRepository.BuscarPorCodigo(codigoConcepto);

    _logger.LogInformation("{@Concepto}", concepto);
}

Buscar Por Id

public void BuscarPorId()
{
    var idConcepto = 1;

    admConceptos? concepto = _conceptoDocumentoRepository.BuscarPorId(idConcepto);

    _logger.LogInformation("{@Concepto}", concepto);
}

Traer Por Documento Modelo Id

public void TraerPorDocumentoModeloId()
{
    int idDocumentoModelo = DocumentoModeloEnum.Factura.Value;

    List<admConceptos> conceptos = _conceptoDocumentoRepository.TraerPorDocumentoModeloId(idDocumentoModelo);

    _logger.LogInformation("{@Conceptos}", conceptos);
}

Traer Todo

public void TraerTodo()
{
    List<admConceptos> conceptos = _conceptoDocumentoRepository.TraerTodo();

    _logger.LogInformation("{@Conceptos}", conceptos);
}
⚠️ **GitHub.com Fallback** ⚠️