Objetos

objects.py

Módulo de clases para estructuras de datos.

FACeResult dataclass

Clase para resultados devueltos por FACe.

Attributes:

Name	Type	Description
codigo	str	Código de resultado devuelto por FACe
descripcion	str	Descripción asociada al resultado devuelto por FACe
codigo_seguimiento	str	Código asociado al registro de la llamada. Este código puede ser solicitado para resolución de incidencias

Estado dataclass

Clase para respuesta FACe con datos de cada uno de los estados que maneja

Attributes:

Name	Type	Description
flujo	str	Flujo al que pertenece el estado
nombre	str	Nombre interno del estado
nombre_publico	str	Nombre externo del estado
codigo	str	Identificador del estado
descripcion	str	Descripción del estado

UnidadDir3 dataclass

Clase para respuesta FACe con datos de una unidad DIR3

Attributes:

Name	Type	Description
nombre	str	Nombre de la unidad
codigo	str	Código DIR3 de la unidad

Relacion dataclass

Clase para respuesta FACe con datos de una relación OG-UT-OC

Attributes:

Name	Type	Description
organo_gestor	UnidadDir3	Identificación del Órgano Gestor
unidad_tramitadora	UnidadDir3	Identificación de la Unidad Tramitadora
oficina_contable	UnidadDir3	Identificación de la Oficina Contable

NuevaFactura dataclass

Clase para respuestas FACe al consultar nuevas facturas.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
oficina_contable	str	Código DIR3 de la Oficina Contable
organo_gestor	str	Código DIR3 del Órgano Gestor
unidad_tramitadora	str	Código DIR3 de la Unidad Tramitadora
fecha_hora_registro	str	Fecha y hora de registro de la factura

AnexoFactura dataclass

Clase para respuesta FACe con anexo a una factura

Attributes:

Name	Type	Description
anexo	str	Documento del anexo en base64
nombre	str	Nombre del archivo del anexo
mime	str	Formato del archivo

guardar(path=None, force=False)

Crea un archivo con el anexo decodificado.

Parameters:

Name	Type	Description	Default
path	str, optional	Ruta donde se guardará el anexo decodificada	None
force	bool, optional	Sobrescribe el archivo si existe. En caso contrario lanza una excepción. Por defecto False	False

DescargaFactura dataclass

Clase para respuesta FACe con una factura descargada

Attributes:

Name	Type	Description
numero	str	Número de la factura
serie	str	Serie de la factura
importe	str	Importe de la factura
proveedor	str	Nombre del proveedor
nombre	str	Nombre del archivo de la factura
factura	str	Documento de la factura en base64
mime	str	Formato del archivo
anexos	list[AnexoFactura]	Lista de anexos de la factura

guardar(path=None, force=False)

Crea un archivo con la factura decodificada.

Parameters:

Name	Type	Description	Default
path	str, optional	Ruta donde se guardará la factura decodificada	None
force	bool, optional	Sobrescribe el archivo si existe. En caso contrario lanza una excepción. Por defecto False	False

ConfirmaDescargaFactura dataclass

Clase para respuesta FACe al confirmar descarga de una factura.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
oficina_contable	str	Código DIR3 de la Oficina Contable
codigo	str	Identificador del estado asignado

ConsultarEstadoFactura dataclass

Clase para estado de una factura en FACe dentro de un flujo de tramitación.

Attributes:

Name	Type	Description
codigo	str	Identificador del estado de una factura
descripcion	str	Descripción del código de estado
motivo	str	Comentario que se indicó al asignar el estado

ConsultarFactura dataclass

Clase para respuesta FACe al consultar estado de una factura.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
tramitacion	ConsultarEstadoFactura	Estado de la factura en el flujo ordinario
anulacion	ConsultarEstadoFactura	Estado de la factura en el flujo de anulación

FACeItemResult dataclass

Clase para resultados por elemento en arrays devueltos por FACe.

Attributes:

Name	Type	Description
codigo	str	Código de resultado devuelto por FACe
descripcion	str	Descripción asociada al resultado devuelto por FACe
id	str	Identificador de referencia en la operación que provocó el resultado. Por ejemplo un número de registro de una factura

CambiarEstadoFactura dataclass

Clase para respuesta FACe al cambiar estado de una factura.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
codigo	str	Identificador del estado asignado

PeticionCambiarEstadoFactura dataclass

Clase para peticiones FACe al cambiar estado de un listado de facturas.

Attributes:

Name	Type	Description
oficina_contable	str	Código DIR3 de la Oficina Contable.
numero_registro	str	Número de registro de la factura dentro de FACe.
codigo	str	Identificador del estado a asignar.
comentario	str	Comentario asociado al cambio de estado de la factura.

NuevaAnulacion dataclass

Clase para respuestas FACe al consultar las solicitudes de anulación.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
oficina_contable	str	Código DIR3 de la Oficina Contable
organo_gestor	str	Código DIR3 del Órgano Gestor
unidad_tramitadora	str	Código DIR3 de la Unidad Tramitadora
fecha_hora_solicitud	str	Fecha y hora de la solicitud de anulación
motivo	str	Motivo de la solicitud de anulación indicada por el proveedor

GestionarSolicitudAnulacionFactura dataclass

Clase para respuesta FACe al gestionar solicitud anulación de una factura.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
codigo	str	Identificador del estado asignado

PeticionSolicitudAnulacionListadoFactura dataclass

Clase para peticiones FACe al gestionar la solicitud de anulación de un listado de facturas.

Attributes:

Name	Type	Description
oficina_contable	str	Código DIR3 de la Oficina Contable
numero_registro	str	Número de registro de la factura dentro de FACe
codigo	str	Identificador del estado a asignar
comentario	str	Comentario asociado a la gestión de la solicitud de anulación

EstadoCesion dataclass

Clase para repuesta FACe al consultar el estado de una cesión de crédito.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
codigo	str	Identificador del estado de la cesión de crédito
comentario	str	Comentario asociado al estado de cesión de crédito

DatosSolicitante dataclass

Clase para datos solicitante en peticiones FACe para obtener documento de cesión.

Attributes:

Name	Type	Description
nif	str	NIF del solicitante para obtener documento de cesión
nombre	str	Nombre del solicitante para obtener documento de cesión
apellidos	str	Apellidos del solicitante para obtener documento de cesión

DocumentoCesion dataclass

Clase para respuesta FACe con el documento de una cesión de crédito

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
documento	str	Documento de la cesión en base64
nombre	str	Nombre del documento
mime	str	Formato del documento

guardar(path=None, force=False)

Crea un archivo con el documento de la cesión.

Parameters:

Name	Type	Description	Default
path	str, optional	Ruta donde se guardará el documento decodificado	None
force	bool, optional	Sobrescribe el archivo si existe. En caso contrario lanza una excepción. Por defecto False	False

GestionarCesion dataclass

Clase para respuesta FACe al gestionar una cesión de crédito.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
codigo	str	Identificador del estado de la cesión
comentario	str	Comentario asociado al estado de la cesión de crédito

NotificaFactura dataclass

Clase para respuesta FACe al notificar una factura recibida en otro PGEFe.

Attributes:

Name	Type	Description
numero_registro	str	Número de registro de la factura dentro de FACe
fecha_hora_registro	str	Fecha de registro en el REC

DatosPersonales dataclass

Clase para petición FACe al notificar una factura no electrónica.

Attributes:

Name	Type	Description
tipo	str	Tipo de persona Física o Jurídica. Valores posibles ("F", "J")
nombre_razon_social	str	Nombre de la persona física o razón social
apellido1	str	Apellido 1 de la persona jurídica si procede
apellido2	str	Apellido 2 de la persona jurídica si procede
documento_nacional	str	DNI de la persona física o jurídica