search()

Metodo per effettuare una ricerca in base al tipo di azione, ID fattura, identificativo SdI, ricerca per range di date e per scaricare il Pacchetto di Distribuzione (PDD).

{info} Se disponibili, nel PDD prodotto verranno inclusi anche i PDF di cortesia e ministeriali.

Endpoint

Method URI
POST https://fatture.keliweb.it/api/search

Request Parameters

Parameter Type Description Required
HTTP headers: Authorization string Bearer + the token to access APIs Yes
action string Il tipo di azione richiesta, tra invoices, outcomes, notifications, inboxes Yes
invoiceId integer ID univoco della fattura (relativo al DB locale) optional
identificativoSdI integer ID univoco della fattura dato dal SDI optional; required_if:action = outcomes,notifications
search_by_date_range boolean attiva/disattiva ricerca per range di date optional
download_pdd boolean attiva/disattiva download PDD optional
start_date date data iniziale ricerca per range optional; required_with:search_by_date_range; date_format: "Y-m-d"
end_date date data finale ricerca per range optional; required_with:search_by_date_range; date_format: "Y-m-d"
is_read boolean se presente, filtra le fatture ricevute per lette/non lette optional

Response Parameters

Parameter Type Description
data array risultato dell'operazione, in formato JSON
pdd string pacchetto di distribuzione (PDD) da scaricare, codificato in base64

Example Request (BASH Curl)

curl --location --request POST 'https://fatture.keliweb.it/api/search' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImYxYTAzNzMzYzY5ZDQ3ZDUxZ' \
--form 'action="invoices"'

Example Request (PHP Curl)

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://fatture.keliweb.it/api/search',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('action' => 'invoices'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImYxYTAzNzMzYzY5ZDQ3ZDUxZDFiNTA2M'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example Request (jQuery AJAX)

var form = new FormData();
form.append("action", "invoices");

var settings = {
    url: "https://fatture.keliweb.it/api/search",
    method: "POST",
    timeout: 0,
    headers: {
        Authorization:
            "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImYxYTAzNzMzYzY5ZDQ3ZDUxZDF"
    },
    processData: false,
    mimeType: "multipart/form-data",
    contentType: false,
    data: form
};

$.ajax(settings).done(function(response) {
    console.log(response);
});

Example Request (Python - Requests)

import requests

url = "https://fatture.keliweb.it/api/search"

payload={'action': 'invoices'}
files=[

]
headers = {
  'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImYxYTAzNzMzYzY5ZDQ3ZDUx'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Example Response (JSON payload)

{
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 8,
                "user_id": 1,
                "client_id": null,
                "numero": "A-123",
                "base36": "00008",
                "sezionale": null,
                "version": "FPR12",
                "type": "TD01",
                "currency": "EUR",
                "causale": null,
                "date": "02/10/2021",
                "includedBollo": true,
                "importoBollo": 2,
                "totaleBeniServizi": null,
                "totaleDocumento": 212,
                "totaleImposta": null,
                "totalePagare": null,
                "visitor": "192.168.10.1",
                "package_path": "invoices/info@keliweb.it/2021/8",
                "filename": "IT03281320782_00008.xml",
                "cedente": "Azienda SRL di Mario Rossi",
                "cessionario": "Test srls",
                "codiceDestinatario": "KRR1234",
                "pecDestinatario": null,
                "identificativoSdI": 25704113,
                "dataOraRicezioneSdi": "2021-10-21T11:35:06.409+02:00",
                "erroreSdi": null,
                "created_at": "21/10/2021 (11:35)",
                "updated_at": "21/10/2021 (11:35)",
                "draft": false,
                "status": "INVIATA",
                "errors": null,
                "esito": null,
                "scarto": null,
                "production": false,
                "mode": "api",
                "notifications": [],
                "histories": [
                    {
                        "id": 27,
                        "invoice_id": 8,
                        "identificativoSdI": 25704113,
                        "xml": null,
                        "status": "INVIATA",
                        "created_at": "2021-10-21 11:35:06",
                        "updated_at": "2021-10-21 11:35:06",
                        "errors": null,
                        "descrizione": null,
                        "note": null,
                        "mode": "api"
                    }
                ],
                "outcomes": []
            }
        ],
        "first_page_url": "https://fatture.keliweb.it/api/search?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://fatture.keliweb.it/api/search?page=1",
        "next_page_url": null,
        "path": "https://fatture.keliweb.it/api/search",
        "per_page": 25,
        "prev_page_url": null,
        "to": 8,
        "total": 8
    },
    "version": "v2.0.0",
    "copyright": "2009-2021 - Keliweb Srl",
    "documentation": "https://fatture.keliweb.it/docs",
    "valid_as_of": "21/10/2021 (12:59)"
}