FACeConnection

Clase principal de conexión a FACe.

Constructor

Parameters:

Name	Type	Description	Default
client	FACeClient	Conector a usar	required

consultar_estados()

Obtiene los estados que maneja FACe para la gestión de una factura.

Existen dos flujos principales, el ordinario y el de anulación. El flujo ordinario corresponde al ciclo de vida de la factura, y el flujo de anulación corresponde al ciclo de solicitud de anulación.

Returns:

Type	Description
list[Estado]	lista de estados que maneja FACe

consultar_unidades()

Obtiene las relaciones OG-UT-OC asociadas al RCF.

Las relaciones OG-UT-OC obtenidas son las asociadas al RCF que firma la petición.

Returns:

Type	Description
list[Relacion]	lista de relaciones OG-UT-OC asociadas al RCF

solicitar_nuevas_facturas(oficina_contable='')

Obtiene las facturas que se encuentran en estado "Registrada".

El RCF debe usar periódicamente este método para obtener las facturas que luego deberá recuperar.

El resultado está limitado a un máximo de 500 facturas. Las facturas deben ser procesadas para que entren el resto de facturas encoladas.

Parameters:

Name	Type	Description	Default
oficina_contable	str	Código DIR3 de la Oficina Contable. Si no se pasa valor retornará un listado de las facturas del RCF	''

Returns:

Type	Description
list[NuevaFactura]	lista de facturas que se encuentran en estado "Registrada"

descargar_factura(numero_registro)

Descarga una factura.

Este método únicamente puede ser invocado para facturas en estado "Registrada". En otros casos el servicio web reportará un error. Después de llamar a este método, y una vez comprobada la correcta recepción de la factura, el RCF debe llamar al método confirmar_descarga_factura.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro, en el REC, de la factura a descargar	required

Returns:

Type	Description
DescargaFactura	estructura que contiene la factura descargada

confirmar_descarga_factura(oficina_contable, numero_registro, codigo_rcf)

Confirma la descarga de una factura.

Este método es complementario al método descargar_factura, es decir, el RCF deberá solicitar la confirmación de cada factura descargada que se haya completado con éxito, de forma que la plataforma FACe pueda realizar todas las acciones relacionadas con la descarga de factura por parte del RCF. Dicho método actualiza la factura al estado 1300 automáticamente.

Parameters:

Name	Type	Description	Default
oficina_contable	str	Código DIR3 de la Oficina Contable	required
numero_registro	str	Número de registro, en el REC, de la factura para la que se quiere confirmar su descarga	required
codigo_rcf	str	Código del RCF a asignar a la factura	required

Returns:

Type	Description
ConfirmaDescargaFactura	estructura que contiene los datos de la confirmación

consultar_factura(numero_registro)

Consulta el estado de una factura.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro, en el REC, de la factura para la que se quiere consultar su estado	required

Returns:

Type	Description
ConsultarFactura	estructura que contiene los datos del estado de una factura

consultar_listado_facturas(numeros_registro)

Consulta el estado de varias facturas.

El servicio web limita a un máximo de 500 facturas la consulta.

Parameters:

Name	Type	Description	Default
numeros_registro	list[str]	Lista de números de registro, en el REC, de las facturas para las que se quiere consultar su estado	required

Returns:

Type	Description
list[ConsultarFactura | FACeItemResult]	lista con el estado de cada factura o incidencia al consultar

cambiar_estado_factura(oficina_contable, numero_registro, codigo, comentario)

Cambia el estado de una factura.

Los estados 1300 y 3100 no pueden ser asignados mediante este método ya que estos estados son asignados de forma automática al realizar las operaciones de confirmación de descarga de la factura y gestión de la solicitud de anulación respectivamente. El estado inicial 1200 tampoco es gestionable mediante este método.

Parameters:

Name	Type	Description	Default
oficina_contable	str	Código DIR3 de la Oficina Contable	required
numero_registro	str	Número de registro, en el REC, de la factura para la que se quiere cambiar su estado	required
codigo	str	Identificador del estado a asignar	required
comentario	str	Comentario asociado al cambio de estado de la factura	required

Returns:

Type	Description
CambiarEstadoFactura	estructura que contiene los datos del cambio de estado de la factura

cambiar_estado_listado_facturas(facturas)

Cambia el estado de varias facturas.

Las restricciones que el servicio web presenta para esta operación son las mismas aplicadas al método cambiar_estado_factura.

El servicio web limita a un máximo de 100 facturas la petición.

Parameters:

Name	Type	Description	Default
facturas	list[PeticionCambiarEstadoFactura]	Lista de peticiones con los datos de las facturas a cambiar	required

Returns:

Type	Description
list[CambiarEstadoFactura | FACeItemResult]	lista con el cambio de estado de cada factura o incidencia al cambiar

consultar_codigo_rcf(numero_registro)

Obtiene el código RCF de una factura registrado en FACe.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro, en el REC, de la factura para la que se quiere consultar su código RCF	required

Returns:

Type	Description
str	código RCF registrado en FACe para la factura

cambiar_codigo_rcf(numero_registro, codigo_rcf)

Cambia el código RCF de una factura.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro, en el REC, de la factura para la que se quiere cambiar su código RCF	required
codigo_rcf	str	Código RCF a asignar a la factura	required

Returns:

Type	Description
str	código RCF asignado a la factura

solicitar_nuevas_anulaciones(oficina_contable='')

Obtiene las facturas que se encuentran en estado "Solicitada anulación".

El RCF debe usar periódicamente este método para conocer las solicitudes de anulación de facturas realizadas en FACe por parte de los proveedores.

El resultado está limitado a un máximo de 500 facturas. Las solicitudes deben ser procesadas para que entren el resto de solicitudes encoladas.

Parameters:

Name	Type	Description	Default
oficina_contable	str	Código DIR3 de la Oficina Contable. Si no se pasa valor retornará un listado de las facturas del RCF	''

Returns:

Type	Description
list[NuevaAnulacion]	lista de facturas que se encuentran en estado "Solicitada anulación"

gestionar_solicitud_anulacion_factura(oficina_contable, numero_registro, codigo, comentario)

Gestiona una solicitud de anulación, aceptando o rechazando dicha solicitud.

Parameters:

Name	Type	Description	Default
oficina_contable	str	Código DIR3 de la Oficina Contable	required
numero_registro	str	Número de registro, en el REC, de la factura para la que se quiere gestionar su solicitud de anulación	required
codigo	str	Identificador del estado a asignar	required
comentario	str	Comentario asociado a la gestión de la solicitud de anulación	required

Returns:

Type	Description
GestionarSolicitudAnulacionFactura	estructura que contiene los datos de la gestión de la anulación

gestionar_solicitud_anulacion_listado_facturas(facturas)

Gestiona la solicitud de anulación de varias facturas.

El servicio web limita a un máximo de 100 facturas la petición.

Parameters:

Name	Type	Description	Default
facturas	list[PeticionSolicitudAnulacionListadoFactura]	Lista de peticiones con los datos de las solicitudes de anulación a gestionar	required

Returns:

Type	Description
list[GestionarSolicitudAnulacionFactura | FACeItemResult]	lista con la gestión de la anulación o incidencia al realizarla

consultar_estado_cesion(numero_registro)

Obtiene el estado de la cesión de una factura.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro, en el REC, de la factura para la que quiere consultarse el estado de la cesión	required

Returns:

Type	Description
EstadoCesion	estructura que contiene el estado de la cesión

obtener_documento_cesion(csv, repositorio, solicitante)

Obtiene el documento de la cesión de una factura.

Este método permite obtener el documento de la cesión conectando al servicio de notarios.

Parameters:

Name	Type	Description	Default
csv	str	Identificador del documento	required
repositorio	str	Repositorio desde el que se obtiene el documento	required
solicitante	DatosSolicitante	Datos del solicitante (nif, nombre, apellidos)	required

Returns:

Type	Description
DocumentoCesion	estructura de datos que contiene el documento de la cesión

gestionar_cesion(numero_registro, codigo, comentario)

Gestiona una cesión de crédito, aceptando o rechazando dicha cesión.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro, en el REC, de la factura para la que quiere gestionarse la cesión de crédito	required
codigo	str	Identificador del estado a asignar	required
comentario	str	Comentario asociado a la gestión de la cesión de crédito	required

Returns:

Type	Description
GestionarCesion	estructura que contiene el resultado de la gestión de la cesión

notifica_factura(numero_registro, fecha_registro, path_factura, organo_gestor, unidad_tramitadora, oficina_contable, codigo_rcf, estado)

Notifica una factura recibida en otro PGEFe.

Este método permite notificar una factura recibida en otro PGEFe. El servicio retorna un número de registro y fecha de registro para poder consultar y operar la factura en FACe.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro del PGEFe	required
fecha_registro	str	Fecha de registro del PGEFe formato en 'YYYY-MM-DDThh:mm:ss'	required
path_factura	str	Ruta local del fichero con la factura, en formato facturae 3.2 o 3.2.1, a enviar	required
organo_gestor	str	Código DIR3 del Órgano Gestor	required
unidad_tramitadora	str	Código DIR3 de la Unidad Tramitadora	required
oficina_contable	str	Código DIR3 del Oficina Contable	required
codigo_rcf	str	Código asignado dentro del RCF	required
estado	str	Código del estado de la factura	required

Returns:

Type	Description
NotificaFactura	estructura de datos que contiene un número de registro y fecha de registro para poder consultar y operar la factura en FACe

notifica_factura_no_electronica(numero_registro, fecha_registro, emisor, receptor, tercero, numero, serie, importe, fecha_expedicion, organo_gestor, unidad_tramitadora, oficina_contable, codigo_rcf, estado, codigo_cnae)

Notifica una factura no electrónica recibida.

Este método permite notificar una factura no electrónica recibida en el registro administrativo de un Organismo. El servicio retorna un número de registro y fecha de registro para poder consultar y operar la factura en FACe.

Parameters:

Name	Type	Description	Default
numero_registro	str	Número de registro del PGEFe	required
fecha_registro	str	Fecha de registro del PGEFe en formato 'YYYY-MM-DDThh:mm:ss'	required
emisor	DatosPersonales	Datos del emisor	required
receptor	DatosPersonales	Datos del receptor	required
tercero	DatosPersonales	Datos del tercero	required
numero	str	Número de la factura	required
serie	str	Serie de la factura	required
importe	str	Importe de la factura	required
fecha_expedicion	str	Fecha de expedición de la factura en formato 'YYYY-MM-DDThh:mm:ss'	required
organo_gestor	str	Código DIR3 del Órgano Gestor	required
unidad_tramitadora	str	Código DIR3 de la Unidad Tramitadora	required
oficina_contable	str	Código DIR3 del Oficina Contable	required
codigo_rcf	str	Código asignado dentro de RCF	required
estado	str	Código del estado de la factura	required
codigo_cnae	str	Código de CNAE de la factura	required

Returns:

Type	Description
NotificaFactura	estructura de datos que contiene un número de registro y fecha de registro para poder consultar y operar la factura en FACe.