Espansione Risultati

Alcuni endpoint dell'API di Sibill supportano il parametro opzionale expand, che consente al client di richiedere risorse collegate direttamente all'interno della risposta. Questo riduce la necessità di effettuare più chiamate all'API.

Come si fa

Le espansioni devono essere passate come parametri nella query string utilizzando la seguente sintassi:

expand=risorsa1 oppure expand=risorsa1,risorsa2 (codificato in URL se incluso in URL raw, es. category,subcategory → expand=category%2Csubcategory)

Dove risorsa1, per esempio, è il nome della risorsa che si vuole espandere.

Nota: Nella documentazione di ogni singolo endpoint troverai l'elenco delle risorse che possono essere espanse insieme al loro schema.

Esempio pratico

Consideriamo una richiesta per ottenere le transazioni con le relative categorie e sottocategorie espanse:

GET /api/v1/companies/:company_id/transactions?expand=category%2Csubcategory

HTTP/1.1 200 OK
Content-Type: application/json

{
   "data":[
     {
       "id": "82e1845f-14ac-927b-99a6-3cffc6109456",
       "date": "2025-05-06T13:20:45.589000Z",
       "description": "Transfer payment: Fattura n. 1 del 01/05/2025",
       "category": {
         "id": "cb00f116-e2bb-4824-81ab-ac3fa3a801eb",
         "name": "Uscita"
       },
       "amount": {
         "currency": "EUR",
         "amount": "-220.72"
       },
       "created_at": "2025-05-02T17:34:57.432389Z",
       "account_id": "1f1276at-74ea-48de-a0d4-ea2538e284bt",
       "counterpart_name": "COUNTERPART SRL",
       "booking_date_time": "2025-05-06T13:20:45.589000Z",
       "clean_description": "Fattura N. 101 Del 05/05/2025",
       "value_date_time": "2025-05-12T13:20:48.276000Z",
       "subcategory": {
         "id": "cb00f116-e2bb-4824-81ab-ac3fa3a801eb",
         "name": "Uscita Fatture"
       }
     },
      ...
   ],
   "page":{
      "cursor":"g3QAAAACdwJpZG0AAAAkYzg3ZTNiYmMtYzNhZi00ZmFjLThkNzYtNmE1MTgzMDRhYdw1pY3JvkYXJ3E0NQRjEyAA==",
      "size":25
   }
}