Krijo një njësi biznesi (v1): fature.al API

POST /api/v1/on-boarding/branch 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.

Krijon një njësi biznesi të re për kompaninë. Përdoret kur kompania ka më shumë se një pikë shitjeje: njësinë e parë e krijon vetë POST /register, dhe asaj i vendosni vetëm kodin me POST /on-boarding/branch/{id}.

name, type, administrator dhe address janë të detyrueshme.
type është main për selinë qendrore ose secondary për një njësi dytësore. Kompania ka një seli të vetme, prandaj main refuzohet me 409 kur ajo ekziston tashmë.
Numri i njësive varet nga abonimi; kur kufiri është arritur, kërkesa refuzohet me 403.
businessUnitCode mund të dërgohet tani ose më vonë me POST /on-boarding/branch/{id}, por pa të njësia nuk lëshon fatura.

Ruani id-në që kthehet: me të lidhen përdoruesit dhe pajisjet fiskale të njësisë.

URL-ja e plotë: https://fature.al/api/v1/on-boarding/branch

Body parameters

Name	Tipi	E detyrueshme	Përshkrimi
name	string, maxLength 255	yes	Emri i njësisë së biznesit, ai që del në faturë. I detyrueshëm.
type	string	yes	Lloji i njësisë: `main` për selinë qendrore, `secondary` për një seli dytësore. I detyrueshëm. Një kompani ka vetëm një `main`.
administrator	string, maxLength 255	yes	Administratori: personi përgjegjës për njësinë. I detyrueshëm.
address	string, maxLength 255	yes	Adresa e njësisë; shkon te CIS-i. E detyrueshme.
businessUnitCode	string, maxLength 50, nullable	no	Kodi i njësisë së biznesit, i marrë nga tatimet. Mund ta dërgoni edhe më vonë me `POST /on-boarding/branch/{id}`, por pa të njësia nuk lëshon dot fatura.

Përgjigjet

200 Kur ruajtja dështon për një arsye tjetër, përgjigja kthehet me HTTP 200 dhe `status: false`; arsyeja është te `message` ose te `errors`.

Field	Tipi	Përshkrimi
status	boolean
data	object
data.branch	object
data.branch.id	integer	Id-ja e njësisë së biznesit; me të lidhen përdoruesit dhe pajisjet fiskale të njësisë
data.branch.name	string	Emri i njësisë
data.branch.type	string	`main` për selinë qendrore, `secondary` për një njësi dytësore, siç u dërgua
data.branch.administrator	string	Administratori i njësisë
data.branch.address	string	Adresa e njësisë
data.branch.businessUnitCode	string	Kodi i njësisë së biznesit; string bosh kur nuk u dërgua dhe pritet me `POST /on-boarding/branch/{id}`

401 Unauthenticated

Field	Tipi	Përshkrimi
message	string

403 Abonimi ka mbaruar, ose veprimi nuk lejohet për këtë llogari.

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`

409 Kompania ka tashmë një seli qendrore.

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 Të dhënat nuk kaluan validimin. 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`

Shembull kërkese

cURL

curl -X POST 'https://fature.al/api/v1/on-boarding/branch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'X-Client-Id: YOUR_CLIENT_ID' \
  -H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Dega Tirane",
    "type": "main",
    "administrator": "Festim Peposhi",
    "address": "Rruga e Kavajes 12, Tirane",
    "businessUnitCode": "bb123bb123"
}'

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',
    'Content-Type' => 'application/json',
])->post('https://fature.al/api/v1/on-boarding/branch', [
    'name' => 'Dega Tirane',
    'type' => 'main',
    'administrator' => 'Festim Peposhi',
    'address' => 'Rruga e Kavajes 12, Tirane',
    'businessUnitCode' => 'bb123bb123',
]);

$data = $response->json();

PHP (Guzzle)

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('POST', 'https://fature.al/api/v1/on-boarding/branch', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_TOKEN',
        'X-Client-Id' => 'YOUR_CLIENT_ID',
        'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
        'name' => 'Dega Tirane',
        'type' => 'main',
        'administrator' => 'Festim Peposhi',
        'address' => 'Rruga e Kavajes 12, Tirane',
        'businessUnitCode' => 'bb123bb123',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

JavaScript

const response = await fetch('https://fature.al/api/v1/on-boarding/branch', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'X-Client-Id': 'YOUR_CLIENT_ID',
    'X-Client-Secret': 'YOUR_CLIENT_SECRET',
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "name": "Dega Tirane",
      "type": "main",
      "administrator": "Festim Peposhi",
      "address": "Rruga e Kavajes 12, Tirane",
      "businessUnitCode": "bb123bb123"
  })
});

const data = await response.json();

Shembull përgjigjeje

200

{
    "status": true,
    "data": {
        "branch": {
            "id": 13,
            "name": "Dyqani Qendër",
            "type": "secondary",
            "administrator": "Arben Hoxha",
            "address": "Rruga e Kavajës 12, Tiranë",
            "businessUnitCode": "bb123bb123"
        }
    }
}

401

{
    "message": "Unauthenticated."
}

403

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

409

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

422

{
    "success": false,
    "message": "Te dhena jo te sakta",
    "errors": []
}