Përditëso një njësi biznesi (v1): fature.al API

Përditëso një njësi biznesi

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

Vendos ose ndryshon emrin, adresën, administratorin dhe kodin e një njësie biznesi. Hapi i zakonshëm është businessUnitCode, kodi i njësisë që merret nga self-care: pa të njësia nuk lëshon fatura.

name, businessUnitCode, administrator dhe address janë të gjitha opsionale; fusha që nuk dërgohet mbetet siç është.
Body nuk validohet veçmas, prandaj nuk ka përgjigje 422.

Një njësi që nuk gjendet, ose nuk i përket kompanisë suaj, kthehet me 200 dhe status: false.

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

Path parameters

Name	Tipi	E detyrueshme	Përshkrimi
id	integer	yes	Id-ja e njësisë së biznesit.

Body parameters

Name	Tipi	E detyrueshme	Përshkrimi
name	string	no	Emri i njësisë së biznesit. Pa të mbetet ai ekzistues.
businessUnitCode	string	no	Kodi i njësisë së biznesit, i marrë nga self-care. I domosdoshëm për lëshimin e faturave nga kjo njësi.
administrator	string	no	Administratori i njësisë. Pa të mbetet ai ekzistues.
address	string	no	Adresa e njësisë. Pa të mbetet ajo ekzistuese.

Përgjigjet

200 Kur njësia nuk gjendet, nuk i përket kompanisë suaj, ose ruajtja dështon, 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
data.branch.name	string	Emri i njësisë pas ruajtjes
data.branch.businessUnitCode	string	Kodi i njësisë së biznesit pas ruajtjes

401 Unauthenticated

Field	Tipi	Përshkrimi
message	string

Shembull kërkese

cURL

curl -X POST 'https://fature.al/api/v1/on-boarding/branch/12' \
  -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": "Dyqani Qendër",
    "businessUnitCode": "bb123bb123",
    "administrator": "Arben Hoxha",
    "address": "Rruga e Kavajës 12, Tiranë"
}'

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/12', [
    'name' => 'Dyqani Qendër',
    'businessUnitCode' => 'bb123bb123',
    'administrator' => 'Arben Hoxha',
    'address' => 'Rruga e Kavajës 12, Tiranë',
]);

$data = $response->json();

PHP (Guzzle)

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('POST', 'https://fature.al/api/v1/on-boarding/branch/12', [
    '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' => 'Dyqani Qendër',
        'businessUnitCode' => 'bb123bb123',
        'administrator' => 'Arben Hoxha',
        'address' => 'Rruga e Kavajës 12, Tiranë',
    ],
]);

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

JavaScript

const response = await fetch('https://fature.al/api/v1/on-boarding/branch/12', {
  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": "Dyqani Qendër",
      "businessUnitCode": "bb123bb123",
      "administrator": "Arben Hoxha",
      "address": "Rruga e Kavajës 12, Tiranë"
  })
});

const data = await response.json();

Shembull përgjigjeje

200

{
    "status": true,
    "data": {
        "branch": {
            "id": 12,
            "name": "Dyqani Qendër",
            "businessUnitCode": "bb123bb123"
        }
    }
}

401

{
    "message": "Unauthenticated."
}

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