API > Listado facturas TicketBAI
Listado facturas TicketBAI
GET https://{entorno}.ticketbaiws.eus/tbai-list/
Este método devuelve el listado de facturas TicketBAI generadas entre dos fechas. El número máximo de resultados es de 250, en caso de que haya más se deberá usar el parámetro de paginado.
Los métodos GET permiten el envío de los parámetros en el body como payload JSON o mediante query string en la URL como se ve en el ejemplo cURL.
PARÁMETROS
| fecha_inicio string obligatorio Fecha inicio desde la cual realizar la consulta en formato DD/MM/YYYY | 01/10/2021 |
| fecha_fin string obligatorio Fecha fin hasta la cual realizar la consulta en formato DD/MM/YYYY | 31/12/2021 |
| serie string opcional Facturas de una serie concreta | A2023 |
| pagina integer opcional Página para ir recorriendo los resultados paginados. Los resultados están limitados a 250 por página. En el parámetro count se obtiene siempre el número total de resultados obtenidos en la búsqueda y con el parámetro pagina se pueden ir recorriendo y consultando todos los resultados | 1 |
| json_orig boolean opcional Incluir en los resultados el JSON de la solicitud de la factura | false |
| xml_request boolean opcional Incluir en los resultados el XML generado en la solicitud a la hacienda foral | false |
| pedido boolean opcional Incluir en los resultados el XML el número de pedido (variable: pedido) realizada en el envío del JSON la factura | false |
GET https://{entorno}.ticketbaiws.eus/tbai-list/
$ curl --request GET \
--url https://api-test.ticketbaiws.eus/tbai-list/ \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Token: xxx' \
--header 'Nif: 00000014Z'
--data '{"fecha_inicio": "01\/10\/2021","fecha_fin": "31\/12\/2021","pagina":1}'
$ curl --request GET \
--url 'https://api-test.ticketbaiws.eus/tbai-list/?fecha_inicio=01/10/2021&fecha_fin=31/12/2021&pagina=1' \
--header 'Accept: application/json' \
--header 'Token: xxx' \
--header 'Nif: 00000014Z'
$ composer require guzzlehttp/guzzle
<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api-test.ticketbaiws.eus/tbai-list/', [
'body' => '{"fecha_inicio": "01\/10\/2021","fecha_fin": "31\/12\/2021","pagina":1}',
'headers' => [
'Accept' => 'application/json',
'Content-Type' => 'application/json',
'Token' => 'xxx',
'Nif' => '00000014Z'
],
]);
echo $response->getBody();
$ python -m pip install requests
import requests
url = "https://api-test.ticketbaiws.eus/tbai-list/?fecha_inicio=01/01/2022&fecha_fin=31/12/2022&pagina=1"
headers = {"Accept": "application/json", "Token" : "xxx", "Nif" : "00000014Z"}
response = requests.request("GET", url, headers=headers)
print(response.text)
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-test.ticketbaiws.eus/tbai-list/?fecha_inicio=01/01/2022&fecha_fin=31/12/2022&pagina=1");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api-test.ticketbaiws.eus/tbai-list/?fecha_inicio=01/01/2022&fecha_fin=31/12/2022&pagina=1")
.get()
.addHeader("Accept", "application/json")
.addHeader("Token", "xxx")
.addHeader("Nif", "00000014Z")
.build();
Response response = client.newCall(request).execute();
{ } Response JSON
HTTP/1.1 200 OK
{
"result": "OK",
"return": [
{
"status" : "OK",
"serie" : "A",
"numero" : "2021000123",
"fecha" : "01\/10\/2021",
"fecha_factura" : "01\/10\/2021",
"nif" : "B01000012",
"importe" : 132.10,
"zuzendu" : false
},
{
"status" : "OK",
"serie" : "A",
"numero" : "2021000123",
"fecha" : "01\/10\/2021",
"fecha_factura" : "01\/10\/2021",
"nif" : "B01000012",
"importe" : 132.10,
"zuzendu" : false
},
{
"status" : "OK",
"serie" : "A",
"numero" : "2021000123",
"fecha" : "01\/10\/2021",
"fecha_factura" : "01\/10\/2021",
"nif" : "B01000012",
"importe" : 132.10,
"zuzendu" : false
},
{
"status" : "OK",
"serie" : "A",
"numero" : "2021000123",
"fecha" : "01\/10\/2021",
"fecha_factura" : "01\/10\/2021",
"nif" : "B01000012",
"importe" : 132.10,
"zuzendu" : false
}
],
"msg": "Showing 1 to 250 of 292",
"count": "292"
}
Métodos TicketBAI / Verifactu
- POST Nueva factura / subsanación (zuzendu) TicketBAI / Verifactu
- POST Completar factura simplificada
- GET Consulta factura TicketBAI / Verifactu
- GET Listado facturas TicketBAI / Verifactu
- GET Descarga XML TicketBAI / Verifactu
- GET Descarga factura en formato FacturaE
- GET Descarga factura en PDF
- GET Estado sistema
- DEL Anular factura TicketBAI / Verifactu
- PUT Forzar reenvío TicketBAI / Verifactu
- POST Validar NIF en la AEAT
- POST Validar NIF en el VIES
Métodos específicos para Verifactu
- GET Documento Representación Verifactu - Descargar modelo
- POST Documento Representación Verifactu - Enviar documento
- GET Documento Representación Verifactu - Descargar documento cargado
- DELETE Documento Representación Verifactu - Revocar documento cargado
Métodos específicos para BATUZ BIZKAIA
- GET Listado de epígrafes
- POST LROE - Facturas recibidas - Envío (BATUZ)
- PUT LROE - Facturas recibidas - Modificar (BATUZ)
- GET LROE - Facturas recibidas - Consulta (BATUZ)
- DEL LROE - Facturas recibidas - Anular (BATUZ)
- POST LROE - Criterio Caja COBROS - Envío (BATUZ)
- PUT LROE - Criterio Caja COBROS - Modificar (BATUZ)
- GET LROE - Criterio Caja COBROS - Consulta (BATUZ)
- DEL LROE - Criterio Caja COBROS - Anular (BATUZ)
- POST LROE - Criterio Caja PAGOS - Envío (BATUZ)
- PUT LROE - Criterio Caja PAGOS - Modificar (BATUZ)
- GET LROE - Criterio Caja PAGOS - Consulta (BATUZ)
- DEL LROE - Criterio Caja PAGOS - Anular (BATUZ)
