Documentación de la API TicketBai

  Aquí encontraras la documentación de la API de TicketBai, el sistema análogo a Verifactu para el País Vasco.

Other

`GET` /ticketbai/health

Estado API

Este endpoint devuelve el estado de la API key.

Responses

Status	Description
`200`	Estado de la API

`GET` /ticketbai/status

Estado registro

Este endpoint permite conocer el estado actual de un registro de facturación efectuado anteriormente.

Responses

Status	Description
`200`	Estado registro
`404`	Registro no encontrado
`500`	Error de servidor

`POST` /ticketbai/status

Estado factura

Este endpoint permite consultar el estado de una factura tal y como está registrada en nuestro sistema.

Request body

Field	Type	Required	Description
`serie`	string	yes	Serie de la factura.
`numero`	string	yes	Número de la factura.
`fecha_expedicion`	string	yes	Fecha de emisión de la factura.

Responses

Status	Description
`200`	Estado factura
`500`	Error de servidor

`POST` /ticketbai/create

Crear factura nueva

Mediante este endpoint se crea un registro de facturación nuevo.

Request body

Field	Type	Required	Description
`serie`	string	yes	Serie de la factura.
`numero`	string	yes	Número de la factura.
`fecha_expedicion`	string	yes	Fecha de emisión de la factura que <span style="color: red">debe ser la fecha actual</span>.
`descripcion`	string	yes	Descripción de la factura.
`simplificada`	boolean	no	Indica si la factura es simplificada.
`nif`	string	no	NIF del cliente al que se le emite la factura.
`id_otro`	object	no	Identificador de persona física o jurídica distinto del NIF.
`nombre`	string	no	Nombre y apellidos o razón social del cliente al que se le emite la factura.
`validar_destinatario`	boolean	no	Si se incluye el campo `nif` validamos por defecto que está censado en la AEAT ya que si no lo está, la Hacienda Foral Vasca rechazará el envío.
`cp`	string	no	Código postal del cliente al que se le emite la factura.
`direccion`	string	no	Dirección del cliente al que se le emite la factura.
`sustitucion_simplificada`	boolean	no	Indica si la factura es emitida en sustitución de una factura simplificada.
`tipo_operacion`	string	no	Tipo de operación. Los diferentes tipos de operación son: <ol style="list-style: disc;"> <li>servicios: prestación de servicios</li> <li>bienes: entrega de bienes</li>
`lineas`	array	yes	Líneas de la factura.
`desglose_iva`	array	no	Desglose del IVA.
`detalle_renta`	array	no	Permitido y obligatorio únicamente para personas físicas en Vizcaya.
`importe_total`	string	yes	Importe total de la factura.
`fecha_operacion`	string	no	Fecha de la operación.
`rectificativa`	object	no	Campo que incluye los datos necesarios en caso de que la factura sea rectificativa.
`rectificadas_sustituidas`	array	no	Facturas rectificadas o sustituidas.
`no_sujeta`	object	no	Indica si la factura es no sujeta.
`exenta`	object	no	Indica si la factura es exenta.
`especial`	object	no	Aquí se recogen campos opcionales adicionales.

Responses

Status	Description
`200`	Factura creada
`500`	Error de servidor

`PUT` /ticketbai/modify

Modificar o subsanar factura

Este endpoint ha sido habilitado por las haciendas vascas de Álava y Guipúzcoa para el envío de la información correspondiente al fichero TicketBAI que ha sido rechazado y/o recibido con aviso de errores por no cumplir con los requisitos y condiciones establecidos en la normativa que regula la obligación TicketBAI.

Request body

Field	Type	Required	Description
`accion`	string	yes	Acción a realizar. Los posibles valores son: <ol style="list-style: disc;"> <li> SUBSANAR: en caso de necesitar corregir una factura que no ha sido recibida por la hacienda correspondiente previamente en el sistema debido a un error en la creación.
`serie`	string	yes	Serie de la factura.
`numero`	string	yes	Número de la factura.
`fecha_expedicion`	string	yes	Fecha de emisión de la factura.
`descripcion`	string	yes	Descripción de la factura.
`simplificada`	boolean	no	Indica si la factura es simplificada.
`nif`	string	no	NIF del cliente al que se le emite la factura.
`id_otro`	object	no	Identificador de persona física o jurídica distinto del NIF.
`nombre`	string	no	Nombre y apellidos o razón social del cliente al que se le emite la factura.
`validar_destinatario`	boolean	no	Si se incluye el campo `nif` validamos por defecto que está censado en la AEAT ya que si no lo está, la Hacienda Foral Vasca rechazará el envío.
`cp`	string	no	Código postal del cliente al que se le emite la factura.
`direccion`	string	no	Dirección del cliente al que se le emite la factura.
`sustitucion_simplificada`	boolean	no	Indica si la factura es emitida en sustitución de una factura simplificada.
`tipo_operacion`	string	no	Tipo de operación. Los diferentes tipos de operación son: <ol style="list-style: disc;"> <li>servicios: prestación de servicios</li> <li>bienes: entrega de bienes</li>
`lineas`	array	yes	Líneas de la factura.
`desglose_iva`	array	no	Desglose del IVA.
`importe_total`	string	yes	Importe total de la factura.
`fecha_operacion`	string	no	Fecha de la operación.
`rectificativa`	object	no	Campo que incluye los datos necesarios en caso de que la factura sea rectificativa.
`rectificadas_sustituidas`	array	no	Facturas rectificadas o sustituidas.
`no_sujeta`	object	no	Indica si la factura es no sujeta.
`exenta`	object	no	Indica si la factura es exenta.
`especial`	object	no	Aquí se recogen campos opcionales adicionales.

Responses

Status	Description
`200`	Factura modificada
`500`	Error de servidor

`POST` /ticketbai/cancel

Anular factura

Este endpoint permite anular facturas existentes.

Request body

Field	Type	Required	Description
`serie`	string	yes	Serie de la factura.
`numero`	string	yes	Número de la factura.
`fecha_expedicion`	string	yes	Fecha de emisión de la factura.
`rechazo_previo`	boolean	no	Parámetro únicamente disponible en Álava y Guipúzcoa que indica si la factura que se quiere anular fue rechazada previamente.

Responses

Status	Description
`200`	Factura anulada
`500`	Error de servidor

`POST` /ticketbai/list

Listar facturas

Las Haciendas del País Vasco no han habilitado un servicio de consulta de facturas via API, por lo tanto, mediante este endpoint se pueden consultar las facturas presentadas en la hacienda correspondiente tal y como se encuentran en nuestro sistema.

Request body

Field	Type	Required	Description
`rango_fecha_expedicion`	object	yes	Rango de fechas de expedición de las facturas que se desean consultar.
`serie`	string	no	Serie de la factura.
`pagina`	integer	no	Este endpoint devuelve un máximo de 200 facturas por página.

Responses

Status	Description
`200`	Listado facturas

`POST` /ticketbai/export

Exportar XMLs

Este endpoint permite exportar los ficheros XML en lotes, tanto de petición como de respuesta, de las facturas presentadas a Hacienda.

Request body

Field	Type	Required	Description
`ejercicio`	string	yes	Ejercicio de la fecha en que se generó el registro de facturación.
`periodo`	string	yes	Período de la fecha en que se generó el registro de facturación.
`token`	string	no	Token de paginación.

Responses

Status	Description
`200`	Listado de ficheros XML.

`POST` /ticketbai/downloadXML

Descargar XML

Mediante este endpoint se pueden descargar los ficheros XML de las facturas presentadas en TicketBai.

Request body

Field	Type	Required	Description
`serie`	string	yes	Serie de la factura.
`numero`	string	yes	Número de la factura.

Responses

Status	Description
`200`	Ficheros XML
`500`	Error de servidor

Documentación de la API TicketBai

Other

GET /ticketbai/health

Responses

GET /ticketbai/status

Responses

POST /ticketbai/status

Request body

Responses

POST /ticketbai/create

Request body

Responses

PUT /ticketbai/modify

Request body

Responses

POST /ticketbai/cancel

Request body

Responses

POST /ticketbai/list

Request body

Responses

POST /ticketbai/export

Request body

Responses

POST /ticketbai/downloadXML

Request body

Responses

`GET` /ticketbai/health

`GET` /ticketbai/status

`POST` /ticketbai/status

`POST` /ticketbai/create

`PUT` /ticketbai/modify

`POST` /ticketbai/cancel

`POST` /ticketbai/list

`POST` /ticketbai/export

`POST` /ticketbai/downloadXML