/api/v1/account
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 përdoruesin e token-it dhe kontekstin fiskal që merr çdo faturë e lëshuar me të: kompaninë, njësinë e biznesit, pajisjen fiskale, të drejtat dhe modulet e abonimit.
Përdoreni pas GET /ping për të konfirmuar me cilin biznes punoni, dhe para faturës së parë
cash për të parë nëse përdoruesi ka pajisje fiskale. Asnjë nga këto vlera nuk dërgohet në
kërkesat e faturimit; ato zgjidhen nga token-i.
| Fusha | Çfarë është |
|---|---|
name, email |
Përdoruesi që mban token-in |
company, nipt |
Emri dhe NIPT-i i kompanisë që lëshon faturat |
fiscalCode |
Kodi TCR i pajisjes fiskale të përdoruesit. String bosh kur nuk ka; atëherë faturat cash dhe veprimet e arkës refuzohen |
branch |
Njësia e biznesit e përdoruesit: name, address dhe city |
companyBranches |
Të gjitha njësitë e kompanisë, si objekt me adresën si çelës dhe emrin si vlerë |
setupFinished |
true kur kompania i ka mbyllur hapat e konfigurimit dhe mund të lëshojë fatura |
permissions |
createArticles dhe createClients: nëse përdoruesi mund të krijojë produkte dhe klientë. Pa to POST /products dhe POST /clients refuzohen me 403 |
configs.openDayAlways0 |
true kur kompania e hap ditën në arkë gjithmonë me gjendje 0 |
vatConfigs |
issuerInVat thotë nëse kompania është në skemën e TVSH-së. vat_rates janë normat që pranohen në rreshtat e faturës: 20, 10, 6 dhe 0 në skemë, vetëm 0 jashtë saj. vat_exempts janë llojet e përjashtimit që pranohen, me code dhe label |
subscription |
cash, noncash, einvoice dhe wtn: cilat module ka abonimi. Endpoint-i i një moduli që mungon përgjigjet 401 me status: false |
Ruani nipt dhe fiscalCode pranë konfigurimit të integrimit, që një token i ndërruar
gabimisht të kapet para se të lëshojë fatura në emër të një biznesi tjetër.
URL-ja e plotë: https://fature.al/api/v1/account
Përgjigjet
200 Përdoruesi i token-it dhe konteksti fiskal i tij: kompania, njësia e biznesit, pajisja fiskale, të drejtat dhe modulet e abonimit.
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | |
| data | object | |
| data.name | string | Emri i plotë i përdoruesit që mban token-in |
| data.email | string | Email-i i përdoruesit |
| data.fiscalCode | string | Kodi TCR i pajisjes fiskale të përdoruesit. String bosh kur përdoruesi nuk ka pajisje; atëherë faturat cash dhe veprimet e arkës refuzohen |
| data.company | string | Emri i kompanisë që lëshon faturat |
| data.nipt | string | NIPT-i i kompanisë |
| data.setupFinished | boolean | true kur kompania e ka mbyllur konfigurimin fillestar dhe mund të lëshojë fatura. Bëhet true kur ngarkohet certifikata elektronike |
| data.branch | object | Njësia e biznesit ku punon përdoruesi |
| data.branch.name | string | Emri i njësisë së biznesit |
| data.branch.address | string | Adresa e njësisë |
| data.branch.city | string | Qyteti. Sot merret nga të dhënat e kompanisë, jo nga njësia |
| data.companyBranches | object | Të gjitha njësitë e biznesit të kompanisë, si objekt me adresën e njësisë si çelës dhe emrin e saj si vlerë |
| data.permissions | object | Të drejtat e përdoruesit që prekin API-në |
| data.permissions.createArticles | boolean | true kur përdoruesi ka të drejtën e menaxhimit të produkteve. Pa të `POST /products` refuzohet me `403` |
| data.permissions.createClients | boolean | true kur përdoruesi ka të drejtën e krijimit të klientëve. Pa të `POST /clients` refuzohet me `403` |
| data.configs | object | Zgjedhjet e kompanisë për arkën |
| data.configs.openDayAlways0 | boolean | true kur kompania e hap ditën në arkë gjithmonë me gjendje `0`, pa e pyetur operatorin për gjendjen fillestare |
| data.vatConfigs | object | Skema e TVSH-së dhe vlerat që pranohen në rreshtat e faturës |
| data.vatConfigs.issuerInVat | boolean | true kur kompania është në skemën e TVSH-së |
| data.vatConfigs.vat_rates | array | Normat e TVSH-së në përqind që pranohen si `vat_rate` në rreshtat e faturës: `20`, `10`, `6` dhe `0` në skemën e TVSH-së; vetëm `0` jashtë saj |
| data.vatConfigs.vat_exempts | array | Llojet e përjashtimit nga TVSH-ja që pranohen si `vat_exempt_type` në rreshtat e faturës: në skemën e TVSH-së `TAX_FREE`, `TYPE_1`, `TYPE_2` dhe `EXPORT_OF_GOODS`; jashtë saj `TAX_FREE` dhe `EXPORT_OF_GOODS` |
| data.vatConfigs.vat_exempts[].code | string | Kodi i përjashtimit, ai që dërgohet si `vat_exempt_type`: `TAX_FREE`, `TYPE_1`, `TYPE_2` ose `EXPORT_OF_GOODS` |
| data.vatConfigs.vat_exempts[].label | string | Përshkrimi i përjashtimit, në gjuhën e llogarisë |
| data.subscription | object | Modulet e faturimit që abonimi i hap këtij përdoruesi |
| data.subscription.cash | boolean | true kur përdoruesi mund të lëshojë fatura cash dhe të bëjë veprime arke |
| data.subscription.noncash | boolean | true kur përdoruesi mund të lëshojë fatura jo-cash |
| data.subscription.einvoice | boolean | true kur përdoruesi mund të lëshojë e-fatura |
| data.subscription.wtn | boolean | true kur përdoruesi mund të lëshojë fletë shoqëruese (WTN) |
401 Unauthenticated
| Field | Tipi | Përshkrimi |
|---|---|---|
| message | string |
Shembull kërkese
curl -X GET 'https://fature.al/api/v1/account' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'X-Client-Id: YOUR_CLIENT_ID' \
-H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
-H 'Accept: application/json'
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/account');
$data = $response->json();
use GuzzleHttp\Client;
$client = new Client();
$response = $client->request('GET', 'https://fature.al/api/v1/account', [
'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);
const response = await fetch('https://fature.al/api/v1/account', {
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
{
"status": true,
"data": {
"name": "Ana Hoxha",
"email": "[email protected]",
"fiscalCode": "ab123ab123",
"company": "Alpha SHPK",
"nipt": "L91806031A",
"setupFinished": true,
"branch": {
"name": "Dyqani Qendër",
"address": "Rruga e Kavajës 12, Tiranë",
"city": "Tiranë"
},
"companyBranches": {
"Rruga e Kavajës 12, Tiranë": "Dyqani Qendër"
},
"permissions": {
"createArticles": true,
"createClients": true
},
"configs": {
"openDayAlways0": false
},
"vatConfigs": {
"issuerInVat": true,
"vat_rates": [
20,
10,
6,
0
],
"vat_exempts": [
{
"code": "TYPE_1",
"label": "Përjashtim i llojit 1. (Përjashtim në bazë të nenit 51 të Ligjit për TVSH-në.)"
}
]
},
"subscription": {
"cash": true,
"noncash": true,
"einvoice": true,
"wtn": false
}
}
}
{
"message": "Unauthenticated."
}