bhexpress.api_client.bhe package

Submodules

bhexpress.api_client.bhe.boletas module

class bhexpress.api_client.bhe.boletas.Boleta

Bases: ApiBase

Módulo que permite gestionar BHEs emitidas y calcular montos brutos y líquidos.

Parámetros:

api_token (str) – Token de autenticación del usuario. Si no se proporciona,

se intentará obtener de una variable de entorno. :param str api_url: URL base de la API. Si no se proporciona, se usará una URL por defecto. :param str api_version: Versión de la API. Si no se proporciona, se usará una versión por defecto. :param bool api_raise_for_status: Si se debe lanzar una excepción automáticamente para respuestas de error HTTP. Por defecto es True.

anular(numero_bhe, causa)

Anula una BHE específica.

Parámetros:

• numero_bhe (str) – Número de la BHE registrada en BHExpress.

• causa (int) – Causa de la anulación de la BHE.

Devuelve:

Respuesta JSON con el encabezado de la boleta anulada.

Tipo del valor devuelto:

dict

detalle(numeroBhe)

Recurso que permite obtener el detalle de una boleta de honorarios electrónica emitida.

Parámetros:

numeroBhe (int) – Número de BHE a consultar.

Devuelve:

Respuesta JSON con el detalle de la boleta emitida.

Tipo del valor devuelto:

dict

email(numero_bhe, email)

Envía por correo electrónico una BHE.

Parámetros:

• numero_bhe (str) – Número de la BHE registrada en BHExpress.

• email (str) – Correo del destinatario.

Devuelve:

Respuesta JSON con la confirmación del envío del email.

Tipo del valor devuelto:

dict

emitir(boleta)

Emite una nueva Boleta de Honorarios Electrónica.

Parámetros:

boleta (dict) – Información detallada de la boleta a emitir.

Devuelve:

Respuesta JSON con el encabezado y detalle de la boleta emitida.

Tipo del valor devuelto:

dict

listar(filtros={})

Recurso que permite obtener el listado paginado de boletas de honorarios electrónicas emitidas.

Parámetros:

filtros (dict) – Filtros de búsqueda.

Devuelve:

Respuesta JSON con el listado de boletas emitidas.

Tipo del valor devuelto:

dict

Muestra:

ApiException – Arroja un error cuando los filtros son incorrectos,

o cuando hay error de conexión.

montoBruto(liquido, periodo)

Recurso que permite calcular el monto bruto a partir de un monto líquido.

Parámetros:

• liquido (int) – Monto liquido a convertir.

• periodo (str) – Periodo donde buscar. Formato «AAAAMM».

Devuelve:

Respuesta JSON con los montos calculados, retenciones, tasas y periodos.

Tipo del valor devuelto:

dict

montoLiquido(bruto, periodo)

Recurso que permite calcular el monto líquido a partir de un monto bruto.

Parámetros:

• bruto (int) – Monto bruto a convertir.

• periodo (str) – Periodo donde buscar. Formato «AAAAMM».

Devuelve:

Respuesta JSON con los montos calculados, retenciones, tasas y periodos.

Tipo del valor devuelto:

dict

pdf(numero_bhe)

Obtiene el PDF de una BHE emitida.

Parámetros:

numero_bhe (int) – Número de la BHE registrada en BHExpress.

Devuelve:

Contenido del PDF de la BHE.

Tipo del valor devuelto:

bytes

Module contents