Listo llogaritë bankare (v1): fature.al API

GET /api/v1/bank-accounts 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.

Kthen llogaritë bankare aktive të kompanisë, me llogarinë e parazgjedhur të parën dhe pastaj nga më e reja te më e vjetra, me kërkim me tekst.

Përdoreni për të zgjedhur llogarinë që shkon në një faturë jo-cash ose në një e-faturë: ruani id-në për bank_account, ose iban-in për bank_account_iban. Lista ndryshon rrallë, ndaj mbajeni në cache.

Pagination me limit dhe offset. limit kufizohet në 100; një vlerë më e madhe ulet pa gabim. pagination kthen total, ndaj vazhdoni me offset += limit derisa offset të arrijë total.
query kërkon me përputhje të pjesshme në emrin e bankës, IBAN, SWIFT, mbajtësin dhe shënimet.
Një kërkesë e dytë nga i njëjti token, ndërsa e para nuk ka mbaruar, refuzohet menjëherë me 429.

Çdo llogari vjen me bank_name, iban, swift, holder, currency_code (ISO 4217), is_default, notes, valid_from dhe valid_to kur llogaria ka periudhë vlefshmërie, dhe created_at (ISO 8601).

URL-ja e plotë: https://fature.al/api/v1/bank-accounts

Query parameters

Name	Tipi	E detyrueshme	Përshkrimi
limit	integer	no	Sa llogari të kthehen në një faqe, deri në 100. Defaults to `20`.
offset	integer	no	Nga cila llogari të fillohet, duke numëruar nga 0. Defaults to `0`.
query	string	no	Kërkim në emrin e bankës, IBAN, SWIFT, mbajtësin ose shënimet.

Përgjigjet

200 Llogaritë bankare aktive të kompanisë, me të parazgjedhurën të parën, dhe `pagination` me `total`; `items` është bosh kur kompania nuk ka llogari.

Field	Tipi	Përshkrimi
status	boolean
data	object
data.items	array
data.items[].id	integer	Id-ja e llogarisë në fature.al; vlera për `bank_account` kur lëshoni një faturë jo-cash ose një e-faturë
data.items[].bank_name	string, nullable	Emri i bankës; `null` kur nuk është plotësuar
data.items[].iban	string, nullable	IBAN-i i llogarisë; vlera për `bank_account_iban` kur lëshoni një faturë jo-cash ose një e-faturë. `null` kur nuk është plotësuar
data.items[].swift	string, nullable	Kodi SWIFT (BIC) i bankës; kur nuk u plotësua për llogarinë, merret nga katalogu i bankave të fature.al. `null` kur nuk dihet
data.items[].holder	string, nullable	Mbajtësi i llogarisë, emri që del te informacioni i pagesës në e-faturë; kur mungon, e-fatura mban emrin e bankës. `null` kur nuk është plotësuar
data.items[].currency_code	string, nullable	Kodi ISO 4217 i monedhës së llogarisë; `null` kur llogaria nuk ka monedhë
data.items[].is_default	boolean	`true` te llogaria e parazgjedhur e kompanisë, ajo që del e para në listë
data.items[].notes	string, nullable	Shënime të lira për llogarinë; `null` kur nuk ka
data.items[].valid_from	string, nullable	Fillimi i periudhës së vlefshmërisë së llogarisë, `YYYY-MM-DD`, siç u caktua në panel; `null` kur nuk është caktuar
data.items[].valid_to	string, nullable	Mbarimi i periudhës së vlefshmërisë, `YYYY-MM-DD`; `null` kur nuk është caktuar. Lista nuk filtron sipas saj: një llogari me `valid_to` të kaluar vjen po njësoj
data.items[].created_at	string, nullable	Data dhe ora e krijimit të llogarisë, ISO 8601 me zonën orare; `null` te llogaritë e krijuara para se fature.al të ruante datën e krijimit
data.pagination	object
data.pagination.records	integer	Sa llogari mban `items` në këtë faqe
data.pagination.total	integer	Sa llogari përputhen gjithsej me kërkesën, në të gjitha faqet
data.pagination.limit	integer	Parametri `limit` i kërkesës, pas kufizimit mes 1 dhe 100
data.pagination.offset	integer	Parametri `offset` i kërkesës, pas rrumbullakimit në të paktën 0

401 Unauthenticated

Field	Tipi	Përshkrimi
message	string

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`

500 Gabim i papritur në server.

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/bank-accounts' \
  -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/bank-accounts');

$data = $response->json();

PHP (Guzzle)

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://fature.al/api/v1/bank-accounts', [
    '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/bank-accounts', {
  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": {
        "items": [
            {
                "id": 17,
                "bank_name": "Raiffeisen Bank Albania",
                "iban": "AL47212110090000000235698741",
                "swift": "SGSBALTX",
                "holder": "Drini Trade shpk",
                "currency_code": "ALL",
                "is_default": true,
                "notes": "Llogaria kryesore",
                "valid_from": "2024-01-01",
                "valid_to": "2026-12-31",
                "created_at": "2024-01-05T09:15:00+01:00"
            }
        ],
        "pagination": {
            "records": 3,
            "total": 3,
            "limit": 20,
            "offset": 0
        }
    }
}

401

{
    "message": "Unauthenticated."
}

429

{
    "status": false,
    "message": "Te dhenat jo te sakta.",
    "errors": [
        "errors"
    ]
}

500

{
    "status": false,
    "message": "Te dhenat jo te sakta.",
    "errors": [
        "errors"
    ]
}