fature.al është platforma e faturimit dhe fiskalizimit për bizneset në Shqipëri. Hap një llogari
Skip to content
fature.al API Menu

Listo klientët kryesorë

GET /api/v1/reports/top-clients Requires authentication Rate limited by the `api-global` limiter v1

Send a bearer token, plus the X-Client-Id and X-Client-Secret headers in the Authorization header.

Klientët e periudhës të renditur sipas vlerës së faturuar, me numrin e faturave dhe bruton për secilin.

  • limit pranon nga 1 deri në 500, me 20 si parazgjedhje.
  • Klienti i rastit, pra faturat pa blerës të emëruar, nuk hyn në renditje.

URL-ja e plotë: https://fature.al/api/v1/reports/top-clients

Query parameters

Name Tipi E detyrueshme Përshkrimi
from string<date> yes Data e fillimit, `YYYY-MM-DD`, e përfshirë. E detyrueshme.
to string<date> yes Data e mbarimit, `YYYY-MM-DD`, e përfshirë. E detyrueshme. Kur është para `from`, të dyja ndërrohen vend.
limit integer, min 1, max 500, nullable no Sa rreshta të kthehen, nga 1 deri në 500.

Përgjigjet

200 Klientët e periudhës te `items`, nga vlera bruto më e madhe, deri në `limit`; `items` është bosh kur periudha nuk ka shitje.

Field Tipi Përshkrimi
status boolean
data object
data.period object Periudha e konfirmuar e raportit
data.period.from string Data e fillimit, `YYYY-MM-DD`, përfshirëse
data.period.to string Data e mbarimit, `YYYY-MM-DD`, përfshirëse
data.limit integer Numri më i madh i klientëve që kthehen, i konfirmuar
data.items array Klientët, nga vlera bruto më e madhe
data.items[].id_client integer, nullable Id-ja e klientit në fature.al, blerësi i faturave; `null` kur faturat e grupit nuk mbajnë blerës. Klienti i rastit, kur biznesi e ka të caktuar, është një klient i katalogut dhe del si rresht i vet
data.items[].name string Emri i biznesit të klientit, ose emri i personit kur klienti nuk është biznes; bosh kur klienti nuk gjendet më
data.items[].nipt string, nullable NIPT-i i klientit; `null` kur klienti nuk ka
data.items[].invoices integer Numri i faturave të paanuluara të klientit në periudhë
data.items[].gross number Vlera bruto e tyre, në lekë; lista renditet nga kjo shumë

401 Unauthenticated

Field Tipi Përshkrimi
message string

403 Përdoruesi nuk ka të drejtën e raporteve. Një operator merr në raport vetëm faturat e veta.

Field Tipi Përshkrimi
status boolean Gjithmonë false. Një përgjigje e suksesshme mban `status: true` dhe objektin `data`
message string Përshkrimi i gabimit. Bosh kur dështimi nuk mban ndonjë mesazh të vetin
errors array Mesazhe për t'u shfaqur te përdoruesi ose për t'u ruajtur në log. Mungon kur nuk ka gjë për të shtuar përtej `message`

422 `from` ose `to` mungon ose nuk është në formatin `YYYY-MM-DD`, ose `limit` është jashtë `1` deri në `500`. Kjo përgjigje përdor fushën `success`, jo `status`, dhe `errors` është objekt sipas fushës.

Field Tipi Përshkrimi
success boolean Gjithmonë false
message string Një rresht përmbledhës, i njëjtë për çdo dështim validimi
errors object Fushat që nuk kaluan validimin, secila me mesazhet e veta. Çelësat me pikë tregojnë brenda objekteve dhe elementëve të array-ve, p.sh. `lines.0.quantity`

429 Kufiri i kërkesave u arrit. Nga kufiri i përgjithshëm përgjigja mban vetëm `message` dhe header-in `Retry-After`; nga kufiri i endpoint-it mban formatin standard të gabimit.

Field Tipi Përshkrimi
status boolean Gjithmonë false. Një përgjigje e suksesshme mban `status: true` dhe objektin `data`
message string Përshkrimi i gabimit. Bosh kur dështimi nuk mban ndonjë mesazh të vetin
errors array Mesazhe për t'u shfaqur te përdoruesi ose për t'u ruajtur në log. Mungon kur nuk ka gjë për të shtuar përtej `message`

Shembull kërkese

cURL
curl -X GET 'https://fature.al/api/v1/reports/top-clients?from=2026-01-01&to=2026-01-31' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'X-Client-Id: YOUR_CLIENT_ID' \
  -H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
  -H 'Accept: application/json'
PHP (Laravel)
use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
    'Authorization' => 'Bearer YOUR_TOKEN',
    'X-Client-Id' => 'YOUR_CLIENT_ID',
    'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
    'Accept' => 'application/json',
])->get('https://fature.al/api/v1/reports/top-clients?from=2026-01-01&to=2026-01-31');

$data = $response->json();
PHP (Guzzle)
use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://fature.al/api/v1/reports/top-clients?from=2026-01-01&to=2026-01-31', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_TOKEN',
        'X-Client-Id' => 'YOUR_CLIENT_ID',
        'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true);
JavaScript
const response = await fetch('https://fature.al/api/v1/reports/top-clients?from=2026-01-01&to=2026-01-31', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'X-Client-Id': 'YOUR_CLIENT_ID',
    'X-Client-Secret': 'YOUR_CLIENT_SECRET',
    'Accept': 'application/json'
  }
});

const data = await response.json();

Shembull përgjigjeje

200
{
    "status": true,
    "data": {
        "period": {
            "from": "2026-09-01",
            "to": "2026-09-13"
        },
        "limit": 20,
        "items": [
            {
                "id_client": 3407,
                "name": "Alfa Market shpk",
                "nipt": "K91234567A",
                "invoices": 26,
                "gross": 412600
            }
        ]
    }
}
401
{
    "message": "Unauthenticated."
}
403
{
    "status": false,
    "message": "Te dhenat jo te sakta.",
    "errors": [
        "errors"
    ]
}
422
{
    "success": false,
    "message": "Te dhena jo te sakta",
    "errors": []
}
429
{
    "status": false,
    "message": "Te dhenat jo te sakta.",
    "errors": [
        "errors"
    ]
}

Regjistrimi është falas.

Regjistrohu në fature.al

This page as Markdown, or the whole API as OpenAPI.