Permbledhje e shitjeve (v1)

GET /api/v1/reports/sales-summary Requires authentication Rate limited by the `api-global` limiter v1

Send a bearer token in the Authorization header.

Totalet e shitjeve per nje periudhe, te llogaritura ne baze te te dhenave. Vlerat jane ne ALL.

Ndarjet qe kthehen njeheresh:

sipas menyres se pageses;
sipas tipit te fatures;
sipas shkalles se TVSH;
sipas dites.

Perfshin edhe sa fatura u anulluan, keshtu qe nuk ju duhet nje thirrje e dyte per t'i zbritur. * from dhe to jane te detyrueshme, ne formatin YYYY-MM-DD, dhe periudha kthehet e konfirmuar ne period te pergjigjes.

Full URL: https://fature.al/api/v1/reports/sales-summary

Query parameters

Name	Type	Required	Description
from	string<date>	yes	Data e fillimit, e perfshire.
to	string<date>	yes	Data e perfundimit, e perfshire.

Responses

200 OK

Field	Type	Description
status	boolean
data	object
data.period	object
data.period.from	string	Start date (YYYY-MM-DD), inclusive
data.period.to	string	End date (YYYY-MM-DD), inclusive
data.totals	object
data.totals.invoices	integer
data.totals.gross	number
data.totals.net	number
data.totals.vat	number
data.totals.avg_invoice	number
data.totals.currency	string
data.by_payment_method	array
data.by_payment_method[].method	string
data.by_payment_method[].count	integer
data.by_payment_method[].gross	number
data.by_payment_method[].net	number
data.by_payment_method[].vat	number
data.by_type	array
data.by_type[].type	string
data.by_type[].count	integer
data.by_type[].gross	number
data.by_vat_rate	array
data.by_vat_rate[].rate	number
data.by_vat_rate[].net	number
data.by_vat_rate[].vat	number
data.by_vat_rate[].gross	number
data.by_day	array
data.by_day[].date	string
data.by_day[].count	integer
data.by_day[].gross	number
data.cancelled	object
data.cancelled.count	integer
data.cancelled.gross	number

422 Datat mungojne ose nuk jane ne formatin YYYY-MM-DD.

Field	Type	Description
success	boolean	Always false
message	string	A single summary line, the same for every validation failure
errors	object	The failing fields, each with the messages for it. Dotted keys point into nested objects and array items, e.g. `lines.0.quantity`

429 Kufiri i kerkesave u arrit: 30 raporte ne minute.

Field	Type	Description
status	boolean	Always false. A successful response carries `status: true` and a `data` object instead
message	string	The exception message. Empty when the failure carries no exception of its own
errors	array	Messages to show the operator or to log. Absent when the failure has nothing to add beyond `message`

Example request

cURL

curl -X GET 'https://fature.al/api/v1/reports/sales-summary?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/sales-summary?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/sales-summary?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/sales-summary?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();

Example response

200

{
    "status": true,
    "data": {
        "period": {
            "from": "from",
            "to": "to"
        },
        "totals": {
            "invoices": 1,
            "gross": 19.99,
            "net": 19.99,
            "vat": 19.99,
            "avg_invoice": 19.99,
            "currency": "USD"
        },
        "by_payment_method": [
            {
                "method": "method",
                "count": 3,
                "gross": 19.99,
                "net": 19.99,
                "vat": 19.99
            }
        ],
        "by_type": [
            {
                "type": "type",
                "count": 3,
                "gross": 19.99
            }
        ],
        "by_vat_rate": [
            {
                "rate": 19.99,
                "net": 19.99,
                "vat": 19.99,
                "gross": 19.99
            }
        ],
        "by_day": [
            {
                "date": "date",
                "count": 3,
                "gross": 19.99
            }
        ],
        "cancelled": {
            "count": 3,
            "gross": 19.99
        }
    }
}

422

{
    "success": true,
    "message": "Hello there",
    "errors": []
}

429

{
    "status": true,
    "message": "Hello there",
    "errors": [
        "errors"
    ]
}