API: getPassive

Descrizione

Il metodo getPassive permette di recuperare le fatture passive ricevute per un utente API. L'API supporta la possibilità di filtrare le fatture in base a un intervallo di tempo e, per gli Utenti API di tipo Intermediario, anche in base a un cliente specifico.

Se viene specificato il parametro cliente, verranno restituite solo le fatture passive associate alla partita IVA del cliente indicato. Se il parametro cliente non viene specificato, verranno restituite tutte le fatture passive per le partite IVA gestite dall'utente API, sia per un utente normale che per un intermediario.

Parametri

  • dal (obbligatorio): UnixTimeStamp che indica l'inizio dell'intervallo di tempo da cui iniziare a cercare le fatture.
  • al (obbligatorio): UnixTimeStamp che indica la fine dell'intervallo di tempo entro cui cercare le fatture.
  • cliente (opzionale): Partita IVA del cliente per filtrare le fatture passive associate solo a quel cliente (applicabile solo agli Utenti API di tipo Intermediario).

Chiamata API

La chiamata deve essere effettuata tramite POST all'endpoint:

https://www.fattureweb.com/api/

Esempio di Chiamata POST

{
    "action":"call",
    "key": "95415ceca602e867e573f65a50c9b70bd6906828",
    "code": "abcdef",
    "payload": {
        "api_name": "Fattura",
        "method": "getPassive",
        "input": {
            "dal": 1722519256,
            "al": 1725197656,
            "cliente": "IT01234567890"
        }
    }
}

Esempi di Codice



$url = 'https://www.fattureweb.com/api/';
$data = array(
    'action' => 'call',
    'key' => '95415ceca602e867e573f65a50c9b70bd6906828',
    'code' => 'abcdef',
    'payload' => array(
        'api_name' => 'Fattura',
        'method' => 'getPassive',
        'input' => array(
            'dal' => 1722519256,
            'al' => 1725197656,
            'cliente' => 'IT01234567890'
        )
    )
);
$options = array(
    'http' => array(
        'header'  => "Content-Type: application/json\r\n",
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */ }

var_dump($result);

                    

import requests

url = 'https://www.fattureweb.com/api/'
data = {
    'action': 'call',
    'key': '95415ceca602e867e573f65a50c9b70bd6906828',
    'code': 'abcdef',
    'payload': {
        'api_name': 'Fattura',
        'method': 'getPassive',
        'input': {
            'dal': 1722519256,
            'al': 1725197656,
            'cliente': 'IT01234567890'
        }
    }
}

response = requests.post(url, json=data)
print(response.text)
                    

import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;

public class Main {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://www.fattureweb.com/api/");
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("POST");
            conn.setRequestProperty("Content-Type", "application/json; utf-8");
            conn.setDoOutput(true);

            String jsonInputString = "{\"action\" => \"call\",\"key\": \"95415ceca602e867e573f65a50c9b70bd6906828\", \"code\": \"abcdef\", \"payload\": {\"api_name\": \"Fattura\", \"method\": \"getPassive\", \"input\": {\"dal\": 1722519256, \"al\": 1725197656, \"cliente\": \"IT01234567890\"}}}";

            try (OutputStream os = conn.getOutputStream()) {
                byte[] input = jsonInputString.getBytes("utf-8");
                os.write(input, 0, input.length);
            }

            int responseCode = conn.getResponseCode();
            System.out.println("Response Code: " + responseCode);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
                    

Risposta di Successo

Se la chiamata ha successo, riceverai una risposta come la seguente:

{
    "code": "200",
    "result": [
        {
            "piva_mittente": "IT12345678901",
            "piva_destinatario": "IT01234567890",
            "nome_fattura": "IT01234567890_001.XML",
            "file_fattura": "base64 encoded XML content",
            "timestamp_invio": "2024-08-25 14:23:45",
            "timestamp_aggiornamento": "2024-08-25 15:45:30",
            "statoFattura": "Consegnata",
            "tipoFattura": "Passiva"
        }
    ]
}

Risposta di Errore

Se si verifica un errore, riceverai una risposta come questa:

{
    "code": "404.1",
    "error": "Manca il parametro 'dal' (UnixTimeStamp da cui iniziare a cercare)"
}