apigatewaycl.api_client.sii package

Submodules

apigatewaycl.api_client.sii.actividades_economicas module

Módulo para obtener las actividades económicas del SII.

Para más información sobre la API, consulte la documentación completa de Actividades Económicas.

class apigatewaycl.api_client.sii.actividades_economicas.ActividadesEconomicas(api_token=None, api_url=None, api_version=None, api_raise_for_status=True, **kwargs)

Bases: ApiBase

Cliente específico para interactuar con los endpoints de actividades económicas de la API de API Gateway.

Provee métodos para obtener listados de actividades económicas, tanto de primera como de segunda categoría.

listado(categoria=None)

Obtiene un listado de actividades económicas. Puede filtrar por categoría.

Parámetros:

categoria (int) – Categoría de las actividades económicas (opcional).

Devuelve:

Respuesta JSON con el listado de actividades económicas.

Tipo del valor devuelto:

list[dict]

listado_primera_categoria()

Obtiene un listado de actividades económicas de primera categoría.

Devuelve:

Respuesta JSON con el listado de actividades económicas de primera categoría.

Tipo del valor devuelto:

list[dict]

listado_segunda_categoria()

Obtiene un listado de actividades económicas de segunda categoría.

Devuelve:

Respuesta JSON con el listado de actividades económicas de segunda categoría.

Tipo del valor devuelto:

list[dict]

apigatewaycl.api_client.sii.bhe module

Módulo para interactuar con Boletas de Honorarios Electrónicas, tanto emitidas como recibidas, del SII.

Para más información sobre la API, consulte la documentación completa de las BHE.

class apigatewaycl.api_client.sii.bhe.BheEmitidas(identificador, clave, **kwargs)

Bases: ApiBase

Cliente específico para gestionar Boletas de Honorarios Electrónicas (BHE) emitidas.

Provee métodos para emitir, anular, y consultar información relacionada con BHEs.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

ANULACION_CAUSA_ERROR_DIGITACION = 3
ANULACION_CAUSA_SIN_PAGO = 1
ANULACION_CAUSA_SIN_PRESTACION = 2
RETENCION_EMISOR = 2
RETENCION_RECEPTOR = 1
anular(emisor, folio, causa=3)

Anula una BHE emitida.

Parámetros:

  • emisor (str) – RUT del emisor de la boleta.

  • folio (str) – Número de folio de la boleta.

  • causa (int) – Motivo de anulación de la boleta.

Devuelve:

Respuesta JSON con la confirmación de la anulación de la BHE.

Tipo del valor devuelto:

dict

documentos(emisor, periodo, pagina=None, pagina_sig_codigo=None)

Obtiene los documentos de BHE emitidos por un emisor en un periodo específico.

Parámetros:

  • emisor (str) – RUT del emisor de las boletas.

  • periodo (str) – Período de tiempo de las boletas emitidas.

Devuelve:

Respuesta JSON con los documentos de BHE.

Tipo del valor devuelto:

list[dict]

email(codigo, email)

Envía por correo electrónico una BHE emitida.

Parámetros:

  • codigo (str) – Código único de la BHE a enviar.

  • email (str) – Dirección de correo electrónico a la cual enviar la BHE.

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 la confirmación de la emisión de la BHE.

Tipo del valor devuelto:

dict

pdf(codigo)

Obtiene el PDF de una BHE emitida.

Parámetros:

codigo (str) – Código único de la BHE.

Devuelve:

Contenido del PDF de la BHE.

Tipo del valor devuelto:

bytes

class apigatewaycl.api_client.sii.bhe.BheRecibidas(identificador, clave, **kwargs)

Bases: ApiBase

Cliente específico para gestionar Boletas de Honorarios Electrónicas (BHE) recibidas.

Provee métodos para obtener documentos, obtener PDF y observar BHE recibidas.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

documentos(receptor, periodo, pagina=None, pagina_sig_codigo=None)

Obtiene los documentos de BHE recibidos por un receptor en un periodo específico.

Parámetros:

  • receptor (str) – RUT del receptor de las boletas.

  • periodo (str) – Período de tiempo de las boletas recibidas.

  • pagina (int) – Número de página para paginación (opcional).

  • pagina_sig_codigo (str) – Código para la siguiente página (opcional).

Devuelve:

Respuesta JSON con los documentos de BHE.

Tipo del valor devuelto:

list[dict]

observar(emisor, numero, causa=1)

Marca una observación en una BHE recibida.

Parámetros:

  • emisor (str) – RUT del emisor de la boleta.

  • numero (str) – Número de la boleta.

  • causa (int) – Motivo de la observación.

Devuelve:

Respuesta JSON con la confirmación de la observación.

Tipo del valor devuelto:

dict

pdf(codigo)

Obtiene el PDF de una BHE recibida.

Parámetros:

codigo (str) – Código único de la BHE.

Devuelve:

Contenido del PDF de la BHE.

Tipo del valor devuelto:

bytes

apigatewaycl.api_client.sii.bte module

Módulo para la emisión de Boletas de Terceros Electrónicas del SII.

Para más información sobre la API, consulte la documentación completa de las BTE.

class apigatewaycl.api_client.sii.bte.BteEmitidas(identificador, clave, **kwargs)

Bases: ApiBase

Cliente específico para gestionar Boletas de Terceros Electrónicas (BTE) emitidas.

Provee métodos para emitir, anular, y consultar información relacionada con BTEs.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

anular(emisor, numero, causa=3, periodo=None)

Anula una BTE emitida.

Parámetros:

  • emisor (str) – RUT del emisor de la boleta.

  • numero (str) – Número de la boleta.

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

  • periodo (str) – Período de emisión de la boleta (opcional).

Devuelve:

Respuesta JSON con la confirmación de la anulación.

Tipo del valor devuelto:

dict

documentos(emisor, periodo, pagina=None)

Obtiene los documentos BTE emitidos por un emisor en un periodo específico.

Parámetros:

  • emisor (str) – RUT del emisor de las BTE.

  • periodo (str) – Período de las BTE emitidas.

Devuelve:

Respuesta JSON con los documentos BTE.

Tipo del valor devuelto:

list[dict]

emitir(datos)

Emite una nueva Boleta de Tercero Electrónica.

Parámetros:

datos (dict) – Datos de la boleta a emitir.

Devuelve:

Respuesta JSON con la confirmación de la emisión de la BTE.

Tipo del valor devuelto:

dict

html(codigo)

Obtiene la representación HTML de una BTE emitida.

Parámetros:

codigo (str) – Código único de la BTE.

Devuelve:

Contenido HTML de la BTE.

Tipo del valor devuelto:

str

receptor_tasa(emisor, receptor, periodo=None)

Obtiene la tasa de retención aplicada a un receptor por un emisor específico.

Parámetros:

  • emisor (str) – RUT del emisor de la boleta.

  • receptor (str) – RUT del receptor de la boleta.

  • periodo (str) – Período de emisión de la boleta (opcional).

Devuelve:

Respuesta JSON con la tasa de retención.

Tipo del valor devuelto:

dict

apigatewaycl.api_client.sii.contribuyentes module

Módulo para obtener datos de los contribuyentes a través del SII.

Para más información sobre la API, consulte la documentación completa de los Contribuyentes.

class apigatewaycl.api_client.sii.contribuyentes.Contribuyentes(api_token=None, api_url=None, api_version=None, api_raise_for_status=True, **kwargs)

Bases: ApiBase

Cliente específico para interactuar con los endpoints de contribuyentes de la API de API Gateway.

Hereda de ApiBase y utiliza su funcionalidad para realizar solicitudes a la API.

situacion_tributaria(rut)

Obtiene la situación tributaria de un contribuyente.

Parámetros:

rut (str) – RUT del contribuyente.

Devuelve:

Respuesta JSON con la situación tributaria del contribuyente.

Tipo del valor devuelto:

dict

verificar_rut(serie)

Verifica el RUT de un contribuyente.

Parámetros:

serie (str) – Serie del RUT a verificar.

Devuelve:

Respuesta JSON con la verificación del RUT.

Tipo del valor devuelto:

dict

apigatewaycl.api_client.sii.dte module

Módulo para interactuar con las opciones de Documentos Tributarios Electrónicos (DTE) del SII.

Para más información sobre la API, consulte la documentación completa de los DTE.

class apigatewaycl.api_client.sii.dte.Contribuyentes(api_token=None, api_url=None, api_version=None, api_raise_for_status=True, **kwargs)

Bases: ApiBase

Cliente específico para interactuar con los endpoints de contribuyentes de la API de API Gateway.

Proporciona métodos para consultar la autorización de emisión de DTE de un contribuyente.

autorizacion(rut, certificacion=None)

Verifica si un contribuyente está autorizado para emitir DTE.

Parámetros:

  • rut (str) – RUT del contribuyente a verificar.

  • certificacion (bool) – Indica si se consulta en ambiente de certificación (opcional).

Devuelve:

Respuesta JSON con el estado de autorización del contribuyente.

Tipo del valor devuelto:

dict

class apigatewaycl.api_client.sii.dte.Emitidos(identificador, clave, **kwargs)

Bases: ApiBase

Cliente específico para gestionar DTE emitidos.

Permite verificar la validez y autenticidad de un DTE emitido.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

verificar(emisor, receptor, dte, folio, fecha, total, firma=None, certificacion=None)

Verifica la validez de un DTE emitido.

Parámetros:

  • emisor (str) – RUT del emisor del DTE.

  • receptor (str) – RUT del receptor del DTE.

  • dte (int) – Tipo de DTE.

  • folio (int) – Número de folio del DTE.

  • fecha (str) – Fecha de emisión del DTE.

  • total (int) – Monto total del DTE.

  • firma (str) – Firma electrónica del DTE (opcional).

  • certificacion (bool) – Indica si la verificación es en ambiente de certificación (opcional).

Devuelve:

Respuesta JSON con el resultado de la verificación del DTE.

Tipo del valor devuelto:

dict

apigatewaycl.api_client.sii.indicadores module

Módulo para obtener indicadores desde el SII.

Para más información sobre la API, consulte la documentación completa de los Indicadores.

class apigatewaycl.api_client.sii.indicadores.Uf(api_token=None, api_url=None, api_version=None, api_raise_for_status=True, **kwargs)

Bases: ApiBase

Cliente específico para interactuar con los endpoints de valores de UF (Unidad de Fomento) de la API de API Gateway.

Provee métodos para obtener valores de UF anuales, mensuales y diarios.

anual(anio)

Obtiene los valores de la UF para un año específico.

Parámetros:

anio (int) – Año para el cual se quieren obtener los valores de la UF.

Devuelve:

Respuesta JSON con los valores de la UF del año especificado.

Tipo del valor devuelto:

dict

diario(dia)

Obtiene el valor de la UF para un día específico.

Parámetros:

dia (str) – Fecha en formato AAAA-MM-DD.

Devuelve:

Valor de la UF para el día especificado.

Tipo del valor devuelto:

float

mensual(periodo)

Obtiene los valores de la UF para un mes específico.

Parámetros:

periodo (str) – Período en formato AAAAMM (año y mes).

Devuelve:

Respuesta JSON con los valores de la UF del mes especificado.

Tipo del valor devuelto:

dict

apigatewaycl.api_client.sii.portal_mipyme module

Módulo para consultas al Portal MIPYME del SII.

Para más información sobre la API, consulte la documentación completa del Portal MIPYME.

class apigatewaycl.api_client.sii.portal_mipyme.Contribuyentes(identificador, clave, **kwargs)

Bases: PortalMipyme

Cliente específico para interactuar con los endpoints de contribuyentes del Portal Mipyme.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

info(contribuyente, emisor, dte=33)

Obtiene información de un contribuyente específico.

Parámetros:

  • contribuyente (str) – RUT del contribuyente.

  • emisor (str) – RUT del emisor del DTE.

  • dte (int) – Tipo de DTE.

Devuelve:

Datos del contribuyente.

Tipo del valor devuelto:

dict

class apigatewaycl.api_client.sii.portal_mipyme.Dte(identificador, clave, **kwargs)

Bases: PortalMipyme

Base para los clientes específicos de DTE del Portal Mipyme. Incluye constantes para diferentes estados de DTE.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

ESTADO_ACEPTADO = 'RAC'
ESTADO_ACEPTADO_LEY_19983 = 'RAL'
ESTADO_BORRADOR = 'PRV'
ESTADO_CERTIFICADO_RECHAZADO = 'DCD'
ESTADO_DISCREPANCIAS = 'RAD'
ESTADO_EMISOR_INVALIDO = 'DEI'
ESTADO_EMITIDO = 'EMI'
ESTADO_FIRMA_RECHAZADA = 'DRF'
ESTADO_FIRMA_SIN_PERMISO = 'DPF'
ESTADO_FOLIO_INVALIDO = 'DFI'
ESTADO_INCOMPLETO = 'DIN'
ESTADO_INICIALIZADO = 'INI'
ESTADO_NO_RECIBIDO = 'RNR'
ESTADO_RECEPTOR_INVALIDO = 'DRI'
ESTADO_RECHAZADO_RECEPTOR = 'RRH'
ESTADO_RECIBIDO = 'RRC'
ESTADO_REPETIDO = 'DRR'
ESTADO_SIN_REPAROS = 'RSR'
get_codigo_dte(tipo)

Obtiene el código correspondiente al tipo de DTE.

Parámetros:

tipo (str) – Tipo de DTE.

Devuelve:

Código del DTE.

Tipo del valor devuelto:

str

class apigatewaycl.api_client.sii.portal_mipyme.DteEmitidos(identificador, clave, **kwargs)

Bases: Dte

Cliente específico para gestionar DTE emitidos en el Portal Mipyme.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

documentos(emisor, filtros={})

Obtiene documentos de DTE emitidos por un emisor.

Parámetros:

  • emisor (str) – RUT del emisor.

  • filtros (dict) – Filtros adicionales para la consulta.

Devuelve:

Documentos de DTE emitidos.

Tipo del valor devuelto:

list[dict]

pdf(emisor, dte, folio=None)

Obtiene el PDF de un DTE emitido.

Parámetros:

  • emisor (str) – RUT del emisor.

  • dte (str) – Tipo de DTE o código del DTE emitido si no se pasa folio.

  • folio (str) – Número de folio del DTE (opcional).

Devuelve:

Contenido del PDF del DTE emitido.

Tipo del valor devuelto:

bytes

xml(emisor, dte, folio)

Obtiene el XML de un DTE emitido.

Parámetros:

  • emisor (str) – RUT del emisor.

  • dte (str) – Tipo de DTE.

  • folio (str) – Número de folio del DTE.

Devuelve:

Contenido del XML del DTE emitido.

Tipo del valor devuelto:

str

class apigatewaycl.api_client.sii.portal_mipyme.DteRecibidos(identificador, clave, **kwargs)

Bases: Dte

Cliente específico para gestionar DTE recibidos en el Portal Mipyme. Proporciona métodos para obtener documentos, PDF y XML de DTE recibidos.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

documentos(receptor, filtros={})

Obtiene documentos de DTE recibidos por un receptor.

Parámetros:

  • receptor (str) – RUT del receptor.

  • filtros (dict) – Filtros adicionales para la consulta.

Devuelve:

Documentos de DTE recibidos.

Tipo del valor devuelto:

list[dict]

pdf(receptor, emisor, dte, folio=None)

Obtiene el PDF de un DTE recibido.

Parámetros:

  • receptor (str) – RUT del receptor.

  • emisor (str) – RUT del emisor.

  • dte (str) – Tipo de DTE o código del DTE recibido si no se pasa folio.

  • folio (str) – Número de folio del DTE (opcional).

Devuelve:

Contenido del PDF del DTE recibido.

Tipo del valor devuelto:

bytes

xml(receptor, emisor, dte, folio)

Obtiene el XML de un DTE recibido.

Parámetros:

  • receptor (str) – RUT del receptor.

  • emisor (str) – RUT del emisor.

  • dte (str) – Tipo de DTE.

  • folio (str) – Número de folio del DTE.

Devuelve:

Contenido del XML del DTE recibido.

Tipo del valor devuelto:

str

class apigatewaycl.api_client.sii.portal_mipyme.PortalMipyme(identificador, clave, **kwargs)

Bases: ApiBase, ABC

Base para los clientes específicos del Portal Mipyme.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

apigatewaycl.api_client.sii.rcv module

Módulo para interactuar con el Registro de Compra y Venta del SII.

Para más información sobre la API, consulte la documentación completa del RCV.

class apigatewaycl.api_client.sii.rcv.Rcv(identificador, clave, **kwargs)

Bases: ApiBase

Cliente específico para interactuar con los endpoints de Registro de Compras y Ventas (RCV) de la API de API Gateway.

Proporciona métodos para obtener resúmenes y detalles de compras y ventas.

Parámetros:

  • identificador (str) – Identificador del contribuyente.

  • clave (str) – Clave del identificador.

  • kwargs – Argumentos adicionales.

compras_detalle(receptor, periodo, dte=0, estado='REGISTRO', tipo=None)

Obtiene detalles de las compras para un receptor en un periodo específico.

Parámetros:

  • receptor (str) – RUT del receptor de las compras.

  • periodo (str) – Período de tiempo de las compras.

  • dte (int) – Tipo de DTE.

  • estado (str) – Estado de las compras (“REGISTRO”, “PENDIENTE”, “NO_INCLUIR”, “RECLAMADO”).

  • tipo (str) – Tipo de formato de respuesta (“rcv_csv” o “rcv”).

Devuelve:

Respuesta JSON con detalles de las compras.

Tipo del valor devuelto:

list[dict]

compras_resumen(receptor, periodo, estado='REGISTRO')

Obtiene un resumen de las compras registradas para un receptor en un periodo específico.

Parámetros:

  • receptor (str) – RUT del receptor de las compras.

  • periodo (str) – Período de tiempo de las compras.

  • estado (str) – Estado de las compras (“REGISTRO”, “PENDIENTE”, “NO_INCLUIR”, “RECLAMADO”).

Devuelve:

Respuesta JSON con el resumen de compras.

Tipo del valor devuelto:

list[dict]

ventas_detalle(emisor, periodo, dte=0, tipo=None)

Obtiene detalles de las ventas para un emisor en un periodo específico.

Parámetros:

  • emisor (str) – RUT del emisor de las ventas.

  • periodo (str) – Período de tiempo de las ventas.

  • dte (int) – Tipo de DTE.

  • tipo (str) – Tipo de formato de respuesta (“rcv_csv” o “rcv”).

Devuelve:

Respuesta JSON con detalles de las ventas.

Tipo del valor devuelto:

list[dict]

ventas_resumen(emisor, periodo)

Obtiene un resumen de las ventas registradas para un emisor en un periodo específico.

Parámetros:

  • emisor (str) – RUT del emisor de las ventas.

  • periodo (str) – Período de tiempo de las ventas.

Devuelve:

Respuesta JSON con el resumen de ventas.

Tipo del valor devuelto:

list[dict]

Module contents