{ "openapi": "3.1.0", "info": { "title": "fature.al API", "version": "1.0", "description": "# fature.al API\n\nAPI per integrimin me fature.al - sistemi i fiskalizimit dhe faturimit per bizneset ne Shqiperi.\n\n## Identifikimi\n\nCdo kerkese ka dy nivele identifikimi: **kush** e ben (perdoruesi, me Bearer token) dhe **cili software** e ben (aplikacioni juaj, me client id dhe client secret).\n\n```\nAuthorization: Bearer {api_token}\nX-Client-Id: ft_id_...\nX-Client-Secret: ft_sk_...\n```\n\nToken-in e gjeneroni nga **Konfigurime > API Tokens** ne panelin e fature.al, ose e merrni nga pergjigja e endpoint-it Register Company. Ai i perket klientit tuaj dhe ndryshon nga njeri klient te tjetri.\n\nClient id dhe client secret i perkasin **aplikacionit tuaj**, jo klientit: jane te njejtat per te gjithe bizneset qe perdorin software-in tuaj. Shihni \"Identifikoni aplikacionin tuaj\" me poshte per menyren se si i merrni dhe si i rigjeneroni.\n\n## Serverat\n\n| Mjedisi | URL |\n|---------|-----|\n| **Live** | `https:\/\/fature.al` |\n| **Sandbox\/Demo** | `https:\/\/demo.fature.al` |\n\n## Seksionet kryesore\n\n- **On Boarding** - regjistrimi i kompanise, certifikata elektronike, njesite e biznesit, perdoruesit, pajisjet fiskale (TCR), llogarite bankare\n- **Invoice** - krijimi i faturave Cash, NonCash, E-Invoice, Order, Summary. Listimi, detajet, anullimi, printimi PDF\n- **Arka Fiskale** - hapja dhe mbyllja e arkes per shitje me para ne dore\n- **Klienti** - kerkimi i kompanive ne regjistrin fiskal sipas NIPT\n\n## Rrjedha e integrimit (ne rastet kur behet onboarding e klienteve me api)\n\n1. **Regjistro kompanin\u00eb** (`POST \/register`) - merr token + branch ID\n2. **Ngarko certifikaten** (`POST \/on-boarding\/certificate`)\n3. **Konfiguro njesine e biznesit** (`POST \/on-boarding\/branch\/{id}`) - vendos businessUnitCode\n4. **Krijo pajisje fiskale** (`POST \/on-boarding\/fiscal-device`) - merr kodin TCR\n5. **Konfiguro perdoruesin** (`POST \/on-boarding\/user\/{id}`) - vendos operatorCode + fiscalTcrCode\n6. **Fillo leshimin e faturave** - perdor endpoint-et e Invoice\n\n## Formati i pergjigjes\n\nTe gjitha pergjigjjet kane formatin:\n```json\n{\"success\": true, \"data\": { ... }}\n```\n\nNe rast gabimi:\n```json\n{\"success\": false, \"errors\": [\"Mesazhi i gabimit\"]}\n```\n\n## Limitet (Rate limiting)\n\nAPI ka limit kerkesash per te mbrojtur sherbimin dhe per te garantuar performance per te gjithe perdoruesit. Kur arrihet limiti, server-i kthen statusin **HTTP 429 Too Many Requests** se bashku me header-in `Retry-After` (sekonda) qe tregon kohen e nevojshme per te ritestuar.\n\nLimitet jane **per perdorues** (te lidhura me API token-in tuaj), me perjashtim te limitit te pergjithshem qe eshte per IP.\n\n| Kategoria | Endpoint-et | Limit |\n|-----------|-------------|-------|\n| **I pergjithshem (per IP)** | te gjitha kerkesat e nivelit te API-t | 120\/minute |\n| **Default (per perdorues)** | te gjitha endpoint-et e mbrojtura me identifikim | 240\/minute |\n| **Fatura fiskale** | `POST \/invoice\/cash`, `\/invoice\/noncash`, `\/invoice\/e-invoice`, `\/invoice\/order`, `\/invoice\/summary`, `\/invoice\/cancel\/*`, `\/invoice\/wtn` | 30\/minute, 600\/ore |\n| **Bulk** | `POST \/invoice\/bulk-noncash` | 3\/minute, 30\/ore |\n| **Printim PDF** | `GET \/invoice\/print\/{id}`, `\/invoice\/print-eic\/{eic}`, `\/invoice\/wtn\/print\/{id}` | 30\/minute |\n| **Kerkim klientesh** | `GET \/client\/search` | 90\/minute |\n| **Onboarding** | `POST \/register`, `POST \/on-boarding\/*` | 30\/minute, 600\/ore (per perdorues) |\n\nKur perdorimi juaj eshte i larte ne menyre te qendrueshme dhe limitet bllokojne integrimin, na kontaktoni.\n\n### Pergjigja kur arrihet limiti\n\n```json\n{\n \"message\": \"Too Many Attempts.\"\n}\n```\n\nHeader-at e kthyer:\n- `Retry-After: 30` - numri i sekondave para se te ritestoni\n- `X-RateLimit-Limit` - limiti maksimal per dritaren aktuale\n- `X-RateLimit-Remaining` - kerkesat e mbetura ne kete dritare\n\n## Udhezime per implementimin\n\nDisa praktika qe e bejne integrimin me te qendrueshem dhe shmangin gabimet me te shpeshta:\n\n### Identifikoni aplikacionin tuaj\n\nAplikacioni juaj identifikohet me nje cift kredencialesh qe i dergoni ne cdo kerkese, krahas token-it te perdoruesit:\n\n```\nX-Client-Id: ft_id_a1b2c3d4e5f6g7h8i9j0k1l2\nX-Client-Secret: ft_sk_...\n```\n\n- **Client id** fillon me `ft_id_` dhe eshte publik. **Client secret** fillon me `ft_sk_` dhe eshte i fshehte: trajtojeni si fjalekalim.\n- Te dyja i perkasin aplikacionit tuaj, jo klientit. Nuk gjenerohen per cdo biznes dhe nuk duhet te perfundojne ne kod qe shperndahet dhe mund te lexohet nga te tjeret.\n- Kredencialet e para i merrni nga fature.al kur regjistrohet integrimi juaj. Me pas i shihni dhe i rigjeneroni vete nga **Konfigurime > Zhvillues** ne llogarine tuaj ne fature.al, ku shihni edhe sa perdorues dhe sa biznese kane punuar permes aplikacionit tuaj ne 24 oret e fundit.\n\nSecret-i shfaqet **vetem nje here**, ne momentin qe gjenerohet, dhe nuk mund te lexohet me pas. Ruajeni menjehere. Nese e humbisni ose dyshoni se eshte kompromentuar, rigjenerojeni nga i njejti ekran: secret-i i vjeter vazhdon te punoje edhe 7 dite, keshtu qe e perditesoni aplikacionin pa nderprerje sherbimi.\n\n#### Vazhdoni te dergoni edhe header-in User-Agent\n\nKrahas kredencialeve, ne cdo kerkese dergoni header-in `User-Agent` ne formatin `\/`:\n\n```\nUser-Agent: EmriIAplikacionit\/2.4.1\n```\n\n- **Emri i aplikacionit** duhet te jete gjithmone i njejti: ne cdo kerkese, per cdo klient tuajin dhe ne cdo version te aplikacionit. Ky emer eshte identifikuesi i integrimit tuaj, prandaj mos e ndryshoni dhe mos e varioni sipas kompanise, pajisjes apo mjedisit (Live\/Sandbox). Perdorni shkronja, numra ose shenjat `_ . + -`, filloni me nje shkronje dhe mos vendosni hapesira.\n- **Versioni i build-it** ndryshon me cdo publikim te aplikacionit tuaj, p.sh. `2.4.1` ose `2026.07.13`. Pa hapesira dhe pa `\/`.\n\nKredencialet tregojne cili aplikacion po flet, ndersa User-Agent-i tregon cili version i tij eshte ne perdorim. Kjo e fundit nuk nxirret dot nga kredencialet dhe na ndihmon te reagojme me shpejt kur raportoni nje problem. Nese kredencialet mungojne, User-Agent-i mbetet e vetmja menyre per te identifikuar integrimin tuaj.\n\n#### Kalimi ne detyrim\n\nNese header-at **nuk dergohen fare**, kerkesa vazhdon normalisht dhe integrimi identifikohet vetem nga User-Agent-i. Kjo eshte periudha e kalimit. Cdo ofrues software-i njoftohet paraprakisht per daten nga e cila kredencialet behen te detyrueshme per aplikacionin e tij, dhe vetem pas asaj date kerkesat pa kredenciale refuzohen me statusin **401 Unauthorized**.\n\nNese header-at **dergohen por nuk verifikohen**, kerkesa refuzohet menjehere me **401 Unauthorized**, pa pritur asnje date. Nje client id qe nuk njihet ose nje secret i gabuar do te thote qe aplikacioni juaj nuk eshte i identifikuar, prandaj preferojme te ju njoftojme ne cast se sa ta pranojme heshtazi. Nese ende nuk i keni kredencialet, mos i dergoni header-at bosh ose me vlera provizore.\n\nPergjigja e refuzimit ndjek te njejtin format si gabimet e tjera:\n\n```json\n{\n \"status\": false,\n \"message\": \"Kjo kerkese duhet te dergoje header-at X-Client-Id dhe X-Client-Secret.\"\n}\n```\n\n| Shkaku | Refuzohet | Mesazhi |\n|--------|-----------|---------|\n| Header-at mungojne | vetem pas dates se detyrimit | Kjo kerkese duhet te dergoje header-at X-Client-Id dhe X-Client-Secret. |\n| Client id nuk njihet | gjithmone | Client ID nuk njihet. |\n| Client secret i gabuar ose mungon | gjithmone | Client secret nuk eshte i sakte. |\n| Aplikacioni eshte pezulluar | gjithmone | Ky aplikacion integrimi eshte pezulluar. |\n\nFilloni ta dergoni ciftin qe tani. Kerkesat me kredenciale te sakta punojne njesoj si me pare, prandaj nuk ka pse te pritet data e detyrimit.\n\n### Testoni ne Sandbox para Live\n\nFilloni implementimin gjithmone kundrejt `https:\/\/demo.fature.al`. Faturat e leshuara atje nuk kane vlere fiskale dhe mund te perdoren lirisht per testim. Kaloni ne `https:\/\/fature.al` vetem pasi rrjedha juaj te jete e plote dhe e provuar.\n\n### Kontrolloni gjithmone fushen `success`\n\nMos u mbeshtetni vetem ne kodin HTTP. Para se te lexoni `data`, verifikoni qe `success` eshte `true`. Ne rast gabimi, mesazhet vijne ne vargun `errors` dhe duhet te shfaqen ose te logohen.\n\n### Riprovimi dhe respektimi i limiteve\n\nKur merrni statusin **429**, prisni aq sa tregon header-i `Retry-After` para se te riprovoni dhe mos riprovoni ne menyre te vazhdueshme brenda nje cikli. Per gabimet e perkohshme te rrjetit (timeout, 5xx), perdorni riprovim me vonese progresive, p.sh. 1s, 2s, 4s.\n\n### Fusha internalId\n\n`internalId` eshte identifikuesi i fatures ne sistemin tuaj, te cilin ia kaloni fature.al-it ne cdo kerkese leshimi. Eshte fushe **e detyrueshme** (string) per te gjitha endpoint-et qe leshojne fatura: `POST \/invoice\/cash`, `\/invoice\/noncash`, `\/invoice\/e-invoice`, `\/invoice\/order`, `\/invoice\/summary` dhe `\/invoice\/bulk-noncash`.\n\n- **Vlera:** cdo identifikues unik nga sistemi juaj, p.sh. numri juaj i fatures ose nje UUID. Shembull: `CASH-001`.\n- **Uniciteti:** duhet te jete unik brenda kompanise suaj. Mbrojtja kundrejt dublikatave vepron per vitin kalendarik aktual.\n- **Roli:** sherben si celes idempotence (shih me poshte) dhe ju lejon ta gjeni me vone faturen permes `POST \/invoice\/details\/{internalId}`.\n\nNese mungon, kerkesa refuzohet me statusin **422**. fature.al nuk e kthen `internalId` ne pergjigjen e leshimit, prandaj ruani vete lidhjen mes `internalId` tuaj dhe vlerave qe kthehen (`id`, `number`, `iic`).\n\n### Shmangni dyfishimin e faturave (idempotenca)\n\n`internalId` (shih fushen me siper) eshte njekohesisht celesi i idempotences. E perdorim per te mos krijuar fatura dublikate.\n\nNje timeout ose nderprerje e rrjetit gjate leshimit nuk do te thote domosdoshmerisht qe fatura deshtoi. Ajo mund te jete ruajtur ose fiskalizuar tashme ne server. Prandaj, kur riprovoni, dergoni **te njejtin `internalId`** dhe asnjehere mos gjeneroni nje te ri per riprovim. Gjenerimi i nje `internalId` te ri eshte pikerisht ajo qe krijon dublikate.\n\nKur merr nje `internalId` qe ekziston tashme per kete vit, server-i nuk krijon fature te dyte. Kthen faturen ekzistuese dhe, nese ajo ishte ruajtur por jo e fiskalizuar, perpiqet ta perfundoje fiskalizimin para se ta ktheje.\n\nNese riprovoni shume shpejt, ndersa kerkesa e pare eshte ende duke u procesuar (brenda rreth 5 minutash), mund te merrni statusin **409**. Ne kete rast prisni pak dhe riprovoni, ose verifikoni gjendjen e fatures permes `POST \/invoice\/details\/{internalId}`.\n\n### Trajtoni fiskalizimin offline\n\nKur sherbimi i Administrates Tatimore eshte i paarritshem, fatura ruhet dhe fiskalizohet automatikisht me vone. Ne kete rast fatura ekziston dhe eshte e vlefshme, por mund te mos kete ende numrin fiskal (NIVF). Mos e trajtoni si gabim dhe mos e leshoni perseri.\n\n### Ruajeni token-in te sigurt\n\nToken-i jep akses te plote ne llogarine tuaj. Ruajeni ne server, jo ne kodin e shfletuesit apo ne aplikacione publike. Mos e vendosni ne kontrollin e versioneve dhe rigjenerojeni menjehere nese dyshoni se eshte kompromentuar.\n\n### Ndiqni formatet e fushave nga specifikimi\n\nPer formatet e sakta te datave, numrave dhe fushave te detyrueshme per cdo endpoint, mbeshtetuni ne skemat e OpenAPI te `\/docs\/api.json`. Dergoni vetem fushat e dokumentuara dhe ruani tipat e tyre." }, "servers": [ { "url": "https:\/\/fature.al\/api\/v1", "description": "Live" }, { "url": "https:\/\/demo.fature.al\/api\/v1", "description": "Sandbox" } ], "tags": [ { "name": "On Boarding", "description": "Ne kete koleksion perfshihen endpoint-et qe ju lejojne te regjistroni nje kompani ne fature.al dhe te plotesoni te dhenat e nevojshme per ta bere gati per leshimin e faturave.\n\n**Workflow:**\n1. Regjistroni kompanin\u00eb (`POST \/register`).\n2. Perditesoni njesine e biznesit (branch) me `businessUnitCode`, i cili merret nga self-care dhe ruhet te njesia e biznesit.\n3. Perditesoni perdoruesin me `operatorCode`, i cili merret nga self-care.\n4. Ngarkoni certifikaten elektronike se bashku me fjalekalimin perkates, te cilin e merrni nga e-Albania.\n5. Ruani llogarite bankare qe kompania do te perdore per faturat pa para ne dore ose per faturat elektronike (eInvoice).\n\n**Nese kompania do te leshoje fatura me para ne dore:**\n6. Ruani pajisjen fiskale (fiscal device) dhe kodi i kthyer `fiscalTcrCode` duhet te ruhet te perdoruesi qe do te leshoje keto lloj faturash, nj\u00ebsoj si te pika 3.\n\n**Shtimi i perdoruesve te rinj:**\nMund te shtoni me shume perdorues nese eshte e nevojshme, por per secilin duhet te plotesohen:\n- Nje email unik, p.sh. `dicka-unike@domaini-juaj.com`\n- Pajisja fiskale, sipas pikes 6\n- Kodi i operatorit, sipas pikes 3\n\n> **Shenim:** Cdo perdorues do te operoje me `api_token`-in e vet, te cilin e merr pasi te regjistrohet.\n\n**Sandbox (vetem ne instancen DEMO):**\nPer te testuar te gjithe flow-in e onboarding-ut pa krijuar nje kompani te re, perdorni NIPT-in sandbox `L62221018T` ne thirrjen `POST \/register`. Sjellja:\n\n- Nuk krijohet kompani e re; perdoruesi dhe njesia e biznesit krijohen nen kompanine ekzistuese sandbox `L62221018T`.\n- Email-i qe dergoni shtohet me nje sufiks unik (`+sandbox-XXXXXXXX`) ne DB, keshtu qe mund ta riperseritni `POST \/register` me te njejtin email pa goditur unique-key.\n- `POST \/on-boarding\/certificate` ne DEMO kthen `success` per cdo certifikate (`.p12` ose `.pfx`) dhe cdo fjalekalim, pa e validuar fjalekalimin apo NIPT-in brenda certifikates. Data `expiresAt` qe kthehet eshte +1 vit nga sot.\n- Hapat e tjere (`branch`, `user`, `bank-account`, `fiscal-device`) ekzekutohen normalisht ne kompanine sandbox.\n\nNe `PRODUCTION` keto sjellje sandbox jane jo-aktive. NIPT `L62221018T` trajtohet si cdo NIPT tjeter." }, { "name": "Wolt Partner API" }, { "name": "Client v2", "description": "Versioni 2 i endpoint-eve te klientit. Perdor nje format te ri me objekte te ndara\n(`company`\/`person`\/`address`\/`contact`) dhe nje fushe diskriminuese `type` (company|person).\nIdentifikuesi jepet si objekt `id` me `type` dhe `value`. Lloji (`type`) eshte i pandryshueshem ne editim." } ], "security": [ { "bearerAuth": [], "clientId": [], "clientSecret": [] }, { "bearerAuth": [] } ], "paths": { "\/register": { "get": { "operationId": "v1.pong", "description": "Kontrollo nese API eshte aktiv per regjistrimin e kompanive.", "summary": "Ping (Register)", "tags": [ "On Boarding" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "pong": { "type": "integer" } }, "required": [ "pong" ] } }, "required": [ "status", "data" ] }, { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "string" } }, "required": [ "status", "message", "errors" ] } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.register", "description": "Regjistron nje kompani te re ne fature.al. Kerkon token special te autorizuar nga fature.al. Kthen token API per perdoruesin e krijuar dhe ID e njesise se biznesit.\n\n**Sandbox (DEMO):** ne instancen DEMO, dergimi i NIPT-it `L62221018T` aktivizon rrjedhen sandbox: nuk krijohet kompani e re, por krijohet nje perdorues + njesi biznesi nen kompanine ekzistuese sandbox dhe ju kthehet nje `api_token` real qe e perdorni per hapat e tjere te onboarding-ut. Email-i shtohet me sufiks `+sandbox-XXXXXXXX` qe te lejojme thirrje te perseritura me te njejtin email. Ne `PRODUCTION` ky NIPT trajtohet normalisht.", "summary": "Regjistro kompani te re", "tags": [ "On Boarding" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RegisterCompanyRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "token": { "type": "string" }, "id": { "type": "integer" } }, "required": [ "token", "id" ] }, "branch": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "required": [ "user", "branch" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/on-boarding\/certificate": { "post": { "operationId": "v1.on-boarding.certificate", "description": "Ngarkoni certifikaten elektronike (.p12 ose .pfx) per kompanin\u00eb. Fjalekalimi duhet te jete i sakte dhe NIPT-i ne certifikate duhet te perputhet me NIPT-in e kompanise.\n\n**Sandbox (DEMO):** ne instancen DEMO ky endpoint kthen `success` per cdo certifikate dhe cdo fjalekalim. `expiresAt` qe kthehet eshte +1 vit nga sot.", "summary": "Ngarko certifikaten elektronike", "tags": [ "On Boarding" ], "requestBody": { "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/CertificateRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "cert": { "type": "object", "properties": { "expiresAt": { "type": "string" } }, "required": [ "expiresAt" ] } }, "required": [ "cert" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/on-boarding\/branch\/{id}": { "post": { "operationId": "v1.on-boarding.branch", "description": "Perditesoni emrin, adresen, administratorin dhe kodin e biznesit per nje njesi biznesi ekzistuese. Kodi i biznesit (businessUnitCode) eshte i domosdshem per leshimin e faturave.", "summary": "Perditeso njesine e biznesit (Branch)", "tags": [ "On Boarding" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "businessUnitCode": { "type": "string" }, "administrator": { "type": "string" }, "address": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "branch": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "businessUnitCode": { "type": "string" } }, "required": [ "id", "name", "businessUnitCode" ] } }, "required": [ "branch" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/on-boarding\/user": { "post": { "operationId": "v1.on-boarding.user", "description": "Krijoni nje perdorues te ri per kompanin\u00eb me kodin e operatorit dhe pajisjen fiskale. Kthen token API per kete perdorues.", "summary": "Krijo perdorues te ri", "tags": [ "On Boarding" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "branchId": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string", "default": "0000" }, "fiscalTcrCode": { "type": "string" }, "operatorCode": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "operatorCode": { "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "name", "operatorCode", "token" ] } }, "required": [ "user" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/on-boarding\/user\/{id}": { "post": { "operationId": "v1.on-boarding.user-update", "description": "Perditesoni emrin, kodin e operatorit, pajisjen fiskale dhe njesine e biznesit per nje perdorues ekzistues. Kodi i operatorit eshte i domosdshem per leshimin e faturave.", "summary": "Perditeso perdoruesin", "tags": [ "On Boarding" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "fiscalTcrCode": { "type": "string" }, "name": { "type": "string" }, "branchId": { "type": "string" }, "operatorCode": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "operatorCode": { "type": "string" } }, "required": [ "id", "name", "operatorCode" ] } }, "required": [ "user" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/on-boarding\/fiscal-device": { "post": { "operationId": "v1.on-boarding.fiscal-device", "description": "Regjistron nje pajisje fiskale te re ne sistemin e tatimeve dhe kthen kodin TCR. Ky kod perdoret per faturat me para ne dore dhe duhet te lidhet me perdoruesin perkates.", "summary": "Krijo pajisje fiskale (TCR)", "tags": [ "On Boarding" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FiscalDeviceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "device": { "type": "object", "properties": { "fiscalTcrCode": { "type": "string" } }, "required": [ "fiscalTcrCode" ] } }, "required": [ "device" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/on-boarding\/bank-account": { "post": { "operationId": "v1.on-boarding.bank-account", "description": "Krijoni nje llogari bankare per kompanin\u00eb. Llogaria bankare shfaqet ne faturat elektronike dhe jo-cash si informacion pagese per klientin.", "summary": "Krijo llogari bankare", "tags": [ "On Boarding" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BankAccountRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "id": { "type": "integer" }, "iban": { "type": "string" } }, "required": [ "id", "iban" ] } }, "required": [ "bankAccount" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/api\/partner\/v1\/wolt\/ping": { "get": { "operationId": "partner.wolt.ping", "description": "Verify the token and return the single Wolt venue it is bound to. Call this\nfirst to confirm credentials and discover which company\/branch\/venue the\ntoken operates on.", "summary": "Ping", "tags": [ "Wolt Partner API" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "company": { "type": "string" }, "branch": { "type": "string" }, "venue_id": { "type": "string" }, "connection_status": { "type": "string" }, "server_time": { "type": "string" } }, "required": [ "company", "branch", "venue_id", "connection_status", "server_time" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/events": { "get": { "operationId": "partner.wolt.events", "description": "The spine of the integration. Poll this endpoint with the last next_cursor\nyou received to get the venue's order lifecycle events in order. The feed is\nappend-only, so nothing is missed across your downtime; delivery is\nat-least-once, so treat (order_id, type) as idempotent. Each event carries a\ncompact snapshot of the order at that moment in `order`.", "summary": "Event feed", "tags": [ "Wolt Partner API" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WoltOrderEvent" } }, "next_cursor": { "type": "string" }, "has_more": { "type": "boolean" } }, "required": [ "events", "next_cursor", "has_more" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders": { "get": { "operationId": "partner.wolt.orders.list", "description": "The venue's orders, newest first. Page backwards with ?cursor=.", "summary": "List orders", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WoltOrderCompact" } }, "next_cursor": { "type": "string" }, "has_more": { "type": "boolean" } }, "required": [ "orders", "next_cursor", "has_more" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}": { "get": { "operationId": "partner.wolt.orders.show", "description": "The authoritative snapshot of one order: header, parties, lines, totals and\nfiscal linkage.", "summary": "Get an order", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/invoice": { "get": { "operationId": "partner.wolt.orders.invoice", "description": "Returns the fiscal invoice issued for the order (identifiers IIC\/FIC\/EIC,\nverification via pdf_url, client, amounts and lines). The invoice object is\nidentical to the one from GET \/api\/v1\/invoice\/{id}\/details. It is null while\nthe order has not been fiscalised yet; poll fiscal_state (pending, deferred,\nfiscalised, failed) or watch the order.fiscalized feed event.", "summary": "Get the order's fiscal invoice", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "fiscal_state": { "type": "string" }, "invoice": { "anyOf": [ { "$ref": "#\/components\/schemas\/InvoiceDetail" }, { "type": "null" } ] } }, "required": [ "fiscal_state", "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/accept": { "post": { "operationId": "partner.wolt.orders.accept", "description": "Relays acceptance to Wolt. On a marketplace order, pickup_minutes tells Wolt\nwhen it will be ready so a courier is dispatched to match; on a self-delivery\norder it is the total delivery time committed to the customer.", "summary": "Accept an order", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "pickup_minutes": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/confirm-preorder": { "post": { "operationId": "partner.wolt.orders.confirm-preorder", "description": "Confirms a customer-scheduled pre-order. It is parked until Wolt releases it\ninto production near its due time, after which it can be marked ready.", "summary": "Confirm a pre-order", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/reject": { "post": { "operationId": "partner.wolt.orders.reject", "summary": "Reject an order", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WoltRejectRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/ready": { "post": { "operationId": "partner.wolt.orders.ready", "summary": "Mark an order ready for handover. Creates the fiscal invoice if it does not exist yet", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/pickup-completed": { "post": { "operationId": "partner.wolt.orders.pickup-completed", "summary": "Self-delivery step 1: the venue's own courier collected the order", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/courier-at-customer": { "post": { "operationId": "partner.wolt.orders.courier-at-customer", "summary": "Self-delivery step 2: the courier reached the customer", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/delivered": { "post": { "operationId": "partner.wolt.orders.delivered", "summary": "Close the order: customer pickup (takeaway) once ready, or self-delivery drop-off complete", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/partner\/v1\/wolt\/orders\/{id}\/retry-fiscalize": { "post": { "operationId": "partner.wolt.orders.retry-fiscalize", "summary": "Retry a deferred\/failed fiscalisation for this order", "tags": [ "Wolt Partner API" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "order": { "$ref": "#\/components\/schemas\/WoltOrderDetail" } }, "required": [ "order" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/api\/v2\/clients\/{id}": { "get": { "operationId": "v2.clients.show", "description": "Kthen klientin ne formatin e ri me objekte te ndara (company\/person\/address\/contact).", "summary": "Detajet e klientit (v2)", "tags": [ "Client v2" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "company": { "type": "string" }, "person": { "type": "string" }, "address": { "type": "object", "properties": { "line": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" } }, "required": [ "line", "city", "country" ] }, "contact": { "type": "object", "properties": { "phone": { "type": "string" }, "email": { "type": "string" } }, "required": [ "phone", "email" ] }, "customer_number": { "type": "string" }, "verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "company", "person", "address", "contact", "customer_number", "verified", "created_at", "updated_at" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "patch": { "operationId": "v2.clients.update", "description": "I njejti trup si POST. Lloji (`type`) eshte i pandryshueshem ne editim: nese dergohet nje\n`type` i ndryshem nga ai ekzistues, kerkesa refuzohet me 422.", "summary": "Perditeso klient (v2)", "tags": [ "Client v2" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClientRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "company": { "type": "string" }, "person": { "type": "string" }, "address": { "type": "object", "properties": { "line": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" } }, "required": [ "line", "city", "country" ] }, "contact": { "type": "object", "properties": { "phone": { "type": "string" }, "email": { "type": "string" } }, "required": [ "phone", "email" ] }, "customer_number": { "type": "string" }, "verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "company", "person", "address", "contact", "customer_number", "verified", "created_at", "updated_at" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/api\/v2\/clients": { "post": { "operationId": "v2.clients.create", "description": "Trupi i kerkeses eshte nje bashkim i diskriminuar nga fusha `type` (company|person).\nObjekti `company` plotesohet kur `type=company`, ndersa `person` kur `type=person`.\nIdentifikuesi jepet si objekt `id` me `type` (nuis|vat|tax per kompani, id|passport|social per person) dhe `value`.", "summary": "Krijo klient (v2)", "tags": [ "Client v2" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClientRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "company": { "type": "string" }, "person": { "type": "string" }, "address": { "type": "object", "properties": { "line": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" } }, "required": [ "line", "city", "country" ] }, "contact": { "type": "object", "properties": { "phone": { "type": "string" }, "email": { "type": "string" } }, "required": [ "phone", "email" ] }, "customer_number": { "type": "string" }, "verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "company", "person", "address", "contact", "customer_number", "verified", "created_at", "updated_at" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "get": { "operationId": "v2.clients.list", "description": "Merr listen e klienteve te kompanise me faqosje dhe filtrim me tekst.", "summary": "Lista e klienteve", "tags": [ "Client" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "client_type": { "type": "string" }, "company_name": { "type": "string" }, "company_type": { "type": "string" }, "nipt": { "type": "string" }, "first_name": { "type": "string" }, "surname": { "type": "string" }, "birthday": { "type": "string" }, "id_type": { "type": "string" }, "id_num": { "type": "string" }, "nationality_code": { "type": "string" }, "nationality_id": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "customer_number": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "client_type", "company_name", "company_type", "nipt", "first_name", "surname", "birthday", "id_type", "id_num", "nationality_code", "nationality_id", "telephone", "email", "address", "city", "customer_number", "created_at" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": [ "records", "total", "limit", "offset" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/account": { "get": { "operationId": "account.index", "description": "Kthen te dhenat e perdoruesit te autentifikuar: emri, email, kodi fiskal dhe kompania.", "summary": "Te dhenat e llogarise", "tags": [ "Account" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "fiscalCode": { "type": "string" }, "company": { "type": "string" }, "nipt": { "type": "string" }, "setupFinished": { "type": "boolean" }, "branch": { "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "required": [ "name", "address", "city" ] }, "companyBranches": { "type": "string" }, "permissions": { "type": "object", "properties": { "createArticles": { "type": "boolean" }, "createClients": { "type": "boolean" } }, "required": [ "createArticles", "createClients" ] }, "configs": { "type": "object", "properties": { "openDayAlways0": { "type": "string" } }, "required": [ "openDayAlways0" ] }, "vatConfigs": { "type": "object", "properties": { "issuerInVat": { "type": "string" }, "vat_rates": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "integer", "const": 20 }, { "type": "integer", "const": 10 }, { "type": "integer", "const": 6 }, { "type": "integer" } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "integer" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } ] }, "vat_exempts": { "type": "array", "items": {} } }, "required": [ "issuerInVat", "vat_rates", "vat_exempts" ] }, "subscription": { "type": "object", "properties": { "cash": { "type": "string" }, "noncash": { "type": "string" }, "einvoice": { "type": "string" }, "wtn": { "type": "string" } }, "required": [ "cash", "noncash", "einvoice", "wtn" ] } }, "required": [ "name", "email", "fiscalCode", "company", "nipt", "setupFinished", "branch", "companyBranches", "permissions", "configs", "vatConfigs", "subscription" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/bank-accounts": { "get": { "operationId": "v1.bank-accounts.list", "description": "Merr listen e llogarive bankare aktive te kompanise me faqosje dhe filtrim me tekst.", "summary": "Lista e llogarive bankare", "tags": [ "BankAccount" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "bank_name": { "type": "string" }, "iban": { "type": "string" }, "swift": { "type": "string" }, "holder": { "type": "string" }, "currency_code": { "type": "string" }, "is_default": { "type": "boolean" }, "notes": { "type": "string" }, "valid_from": { "type": "string" }, "valid_to": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "bank_name", "iban", "swift", "holder", "currency_code", "is_default", "notes", "valid_from", "valid_to", "created_at" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": [ "records", "total", "limit", "offset" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/cash-register\/open-balance": { "post": { "operationId": "v1.cash-register.open", "description": "Hapni balancen e arkes fiskale per te filluar shitjet me para ne dore. Perdoruesi duhet te kete pajisje fiskale (TCR) te lidhur.", "summary": "Hap balancen e arkes", "tags": [ "CashRegister" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "balance": { "type": "string", "default": 0 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "balance": { "type": "number" } }, "required": [ "balance" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/cash-register\/close-balance": { "post": { "operationId": "v1.cash-register.close", "description": "Mbyllni balancen e arkes fiskale ne fund te dites. Nese arka nuk eshte e hapur, hapet automatikisht me balance 0.", "summary": "Mbyll balancen e arkes", "tags": [ "CashRegister" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "balance": { "type": "number" } }, "required": [ "balance" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/cash-register\/deposit": { "post": { "operationId": "v1.cash-register.deposit", "description": "Bej nje hyrje parash ne arken fiskale (MONEY_IN). Kerkon qe perdoruesi te kete pajisje fiskale (TCR) te lidhur.", "summary": "Hyrje ne arke (Deposit)", "tags": [ "CashRegister" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "action_type": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "transaction_date": { "type": "string" }, "transaction_no": { "type": "integer" }, "cash_action_no": { "type": "string" }, "fiscal_status": { "type": "string" }, "fiscal_uuid": { "type": "string" }, "fiscal_fic": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "action_type", "amount", "currency", "transaction_date", "transaction_no", "cash_action_no", "fiscal_status", "fiscal_uuid", "fiscal_fic", "description" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/cash-register\/withdraw": { "post": { "operationId": "v1.cash-register.withdraw", "description": "Bej nje dalje parash nga arka fiskale (MONEY_OUT). Kerkon qe perdoruesi te kete pajisje fiskale (TCR) te lidhur.", "summary": "Dalje nga arka (Withdraw)", "tags": [ "CashRegister" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "action_type": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "transaction_date": { "type": "string" }, "transaction_no": { "type": "integer" }, "cash_action_no": { "type": "string" }, "fiscal_status": { "type": "string" }, "fiscal_uuid": { "type": "string" }, "fiscal_fic": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "action_type", "amount", "currency", "transaction_date", "transaction_no", "cash_action_no", "fiscal_status", "fiscal_uuid", "fiscal_fic", "description" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/cash-register\/actions": { "get": { "operationId": "v1.cash-register.list", "description": "Merrni listen e veprimeve me arken fiskale (hyrje, dalje, hapje\/mbyllje dite) me filtrim dhe faqosje.", "summary": "Lista e veprimeve me arken", "tags": [ "CashRegister" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "action_type": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "transaction_date": { "type": "string" }, "transaction_no": { "type": "integer" }, "cash_action_no": { "type": "string" }, "fiscal_status": { "type": "string" }, "fiscal_uuid": { "type": "string" }, "fiscal_fic": { "type": "string" }, "fiscal_tcr_code": { "type": "string" }, "description": { "type": "string" }, "third_party": { "type": "string" }, "id_client": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "action_type", "amount", "currency", "transaction_date", "transaction_no", "cash_action_no", "fiscal_status", "fiscal_uuid", "fiscal_fic", "fiscal_tcr_code", "description", "third_party", "id_client", "created_at" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "records", "limit", "offset", "type" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/cash-register\/balance": { "get": { "operationId": "v1.cash-register.balance", "description": "Merrni balancen aktuale ne ALL te arkes fiskale (TCR) te perdoruesit. Nese [toDate] nuk jepet, kthehet balanca e fundit.", "summary": "Balanca e arkes fiskale", "tags": [ "CashRegister" ], "parameters": [ { "name": "toDate", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "fiscal_tcr_code": { "type": "string" }, "currency": { "type": "string" }, "to_date": { "type": "string" }, "balance": { "type": "number" } }, "required": [ "fiscal_tcr_code", "currency", "to_date", "balance" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/clients": { "get": { "operationId": "v1.clients.list", "description": "Merr listen e klienteve te kompanise me faqosje dhe filtrim me tekst.", "summary": "Lista e klienteve", "tags": [ "Client" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "client_type": { "type": "string" }, "company_name": { "type": "string" }, "company_type": { "type": "string" }, "nipt": { "type": "string" }, "first_name": { "type": "string" }, "surname": { "type": "string" }, "birthday": { "type": "string" }, "id_type": { "type": "string" }, "id_num": { "type": "string" }, "nationality_code": { "type": "string" }, "nationality_id": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "customer_number": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "client_type", "company_name", "company_type", "nipt", "first_name", "surname", "birthday", "id_type", "id_num", "nationality_code", "nationality_id", "telephone", "email", "address", "city", "customer_number", "created_at" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": [ "records", "total", "limit", "offset" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.clients.create", "summary": "Krijo klient", "tags": [ "Client" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Requests.Api.ClientRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "client_type": { "type": "string" }, "company_name": { "type": "string" }, "company_type": { "type": "string" }, "nipt": { "type": "string" }, "first_name": { "type": "string" }, "surname": { "type": "string" }, "birthday": { "type": "string" }, "id_type": { "type": "string" }, "id_num": { "type": "string" }, "nationality_code": { "type": "string" }, "nationality_id": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "customer_number": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "client_type", "company_name", "company_type", "nipt", "first_name", "surname", "birthday", "id_type", "id_num", "nationality_code", "nationality_id", "telephone", "email", "address", "city", "customer_number", "created_at" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/clients\/{id}\/details": { "get": { "operationId": "v1.clients.details", "summary": "Detajet e klientit sipas ID", "tags": [ "Client" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "client_type": { "type": "string" }, "company_name": { "type": "string" }, "company_type": { "type": "string" }, "nipt": { "type": "string" }, "first_name": { "type": "string" }, "surname": { "type": "string" }, "birthday": { "type": "string" }, "id_type": { "type": "string" }, "id_num": { "type": "string" }, "nationality_code": { "type": "string" }, "nationality_id": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "customer_number": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "client_type", "company_name", "company_type", "nipt", "first_name", "surname", "birthday", "id_type", "id_num", "nationality_code", "nationality_id", "telephone", "email", "address", "city", "customer_number", "created_at" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/clients\/{id}": { "put": { "operationId": "v1.clients.update", "description": "Perditeson nje klient ekzistues. Trupi i kerkeses ka te njejtin format si POST \/clients.", "summary": "Perditeso klient", "tags": [ "Client" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Requests.Api.ClientRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "client_type": { "type": "string" }, "company_name": { "type": "string" }, "company_type": { "type": "string" }, "nipt": { "type": "string" }, "first_name": { "type": "string" }, "surname": { "type": "string" }, "birthday": { "type": "string" }, "id_type": { "type": "string" }, "id_num": { "type": "string" }, "nationality_code": { "type": "string" }, "nationality_id": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "customer_number": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "client_type", "company_name", "company_type", "nipt", "first_name", "surname", "birthday", "id_type", "id_num", "nationality_code", "nationality_id", "telephone", "email", "address", "city", "customer_number", "created_at" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/client\/search": { "get": { "operationId": "v1.client.search", "description": "Kerkoni nje kompani ne regjistrin fiskal duke perdorur NIPT\/NUIS. Kthen te dhenat e kompanise nese gjendet.", "summary": "Kerko klient sipas NIPT", "tags": [ "Client" ], "parameters": [ { "name": "nuis", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "client": { "type": "object", "properties": { "nuis": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "nuis", "name", "address", "city", "country", "verified" ] } }, "required": [ "client" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/currencies": { "get": { "operationId": "v1.currencies.list", "description": "Kthen monedhat e konfiguruara p\u00ebr kompanin\u00eb,\nme ALL gjithmon\u00eb n\u00eb fillim.", "summary": "Lista e monedhave", "tags": [ "Currencies" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "currencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "code", "name" ] } } }, "required": [ "currencies" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/exchange-rates": { "get": { "operationId": "v1.exchange-rates", "description": "Kthen kursin e shitjes s\u00eb dit\u00ebs p\u00ebr \u00e7do monedh\u00eb, sipas burimit t\u00eb\nzgjedhur. T\u00eb dh\u00ebnat vijn\u00eb nga `https:\/\/api.kursi.al\/api\/rates` dhe\nruhen ne cache per 1h n\u00eb server; klienti mund t\u00eb mbaj\u00eb snapshot-in e fundit\nlokalisht p\u00ebr p\u00ebrdorim offline.\n\nBurimet e mb\u00ebshtetura (vlera `source` n\u00eb k\u00ebrkes\u00eb):\n - `BOA` \u2192 Banka e Shqip\u00ebris\u00eb (kursi zyrtar)\n - `BKT` \u2192 Banka Komb\u00ebtare Tregtare\n - `Iliria98` \u2192 K\u00ebmbim Valutor \"Iliria '98\"\n - `ADON` \u2192 K\u00ebmbim Valutor \"Adon\"\n\nBurim i pa percaktuar kthehet automatikisht n\u00eb `BOA`. Fusha `source` n\u00eb\np\u00ebrgjigje \u00ebsht\u00eb gjithmon\u00eb vlera e normalizuar.", "summary": "Kursi i k\u00ebmbimit", "tags": [ "Currencies" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "rates": { "type": "object", "additionalProperties": { "type": "number" } }, "source": { "type": "string" }, "fetchedAt": { "type": "string" } }, "required": [ "rates", "source", "fetchedAt" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice": { "get": { "operationId": "invoice.invoicesList", "description": "Merrni listen e faturave me filtrim dhe faqosje.", "summary": "Lista e faturave", "tags": [ "Invoice" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "type": { "type": "string" }, "issue_date": { "type": "string" }, "due_date": { "type": "string" }, "delivery_date": { "type": "string" }, "client": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" } }, "required": [ "type", "id" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" } }, "required": [ "street", "city", "country" ] } }, "required": [ "name", "id", "address" ] }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "gross": { "type": "number" }, "net": { "type": "number" }, "vat": { "type": "number" } }, "required": [ "currency", "gross", "net", "vat" ] }, "notes": { "type": "string" }, "iic": { "type": "string" }, "self_issue_type": { "type": "string" }, "reversed_at": { "type": "string" }, "reversed_by": { "type": "string" } }, "required": [ "id", "number", "type", "issue_date", "due_date", "delivery_date", "client", "amount", "notes", "iic", "self_issue_type", "reversed_at", "reversed_by" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "records", "limit", "offset", "type" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/{id}\/details": { "get": { "operationId": "invoice.invoicesDetails", "description": "Merrni detajet e plota te nje fature sipas ID-se ne sistem.", "summary": "Detajet e fatures sipas ID", "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "anyOf": [ { "$ref": "#\/components\/schemas\/InvoiceDetail" }, { "type": "null" } ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/details\/{internalId}": { "post": { "operationId": "invoice.details", "description": "Merr detajet e nje fature duke perdorur ID-ne tuaj interne.", "summary": "Detajet e fatures sipas Internal ID", "tags": [ "Invoice" ], "parameters": [ { "name": "internalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "type": { "type": "string" }, "issue_date": { "type": "string" }, "due_date": { "type": "string" }, "delivery_date": { "type": "string" }, "client": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" } }, "required": [ "type", "id" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" } }, "required": [ "street", "city", "country" ] } }, "required": [ "name", "id", "address" ] }, "amount": { "type": "object", "properties": { "currency": { "type": "string" }, "gross": { "type": "number" }, "net": { "type": "number" }, "vat": { "type": "number" } }, "required": [ "currency", "gross", "net", "vat" ] }, "notes": { "type": "string" }, "iic": { "type": "string" }, "reversed_at": { "type": "string" }, "reversed_by": { "type": "string" } }, "required": [ "id", "number", "type", "issue_date", "due_date", "delivery_date", "client", "amount", "notes", "iic", "reversed_at", "reversed_by" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/e-invoice": { "post": { "operationId": "invoice.createEInvoice", "description": "Fatura dergohet automatikisht ne sistemin qendror te e-faturave. Klienti identifikohet me NIPT.", "summary": "Krijo fature elektronike (E-Invoice)", "tags": [ "Invoice" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EInvoiceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "iic": { "type": "string" }, "fic": { "type": "string" }, "tcrCode": { "type": "string" }, "businessCode": { "type": "string" }, "operatorCode": { "type": "string" }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" }, "eic": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalizedAt", "verifyURL", "pdf" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/noncash": { "post": { "operationId": "invoice.createNonCash", "description": "Perdoret per transaksione me transferte bankare, cek, etj.", "summary": "Krijo fature pa para ne dore (NonCash)", "tags": [ "Invoice" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonCashInvoiceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "iic": { "type": "string" }, "fic": { "type": "string" }, "tcrCode": { "type": "string" }, "businessCode": { "type": "string" }, "operatorCode": { "type": "string" }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalizedAt", "verifyURL", "pdf" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/cash": { "post": { "operationId": "invoice.createCash", "summary": "Krijo fature me para ne dore (Cash)", "tags": [ "Invoice" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashInvoice" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "iic": { "type": "string" }, "fic": { "type": "string" }, "tcrCode": { "type": "string" }, "businessCode": { "type": "string" }, "operatorCode": { "type": "string" }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalizedAt", "verifyURL", "pdf" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/order": { "post": { "operationId": "invoice.createOrder", "description": "Fatura regjistrohet por pagesa nuk perfundon - perdoret me summary invoice.\npayment_method vendoset automatikisht ne ORDER.", "summary": "Krijo fature porosi (Order)", "tags": [ "Invoice" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrderInvoice" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "iic": { "type": "string" }, "fic": { "type": "string" }, "tcrCode": { "type": "string" }, "businessCode": { "type": "string" }, "operatorCode": { "type": "string" }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" }, "isOrderInvoice": { "type": "boolean" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalizedAt", "verifyURL", "pdf", "isOrderInvoice" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/summary": { "post": { "operationId": "invoice.createSummary", "description": "Perfundon pagesen e nje ose me shume faturave Order. Duhet te specifikoni IIC-te e faturave order ne fushen order_invoices.", "summary": "Krijo fature permbledhese (Summary)", "tags": [ "Invoice" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SummaryInvoice" } } } }, "responses": { "500": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Ndodhi nje gabim, po e kontrollojme." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "string" } }, "required": [ "status", "message", "errors" ] }, { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": [ "string", "null" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "tcrCode": { "type": [ "string", "null" ] }, "businessCode": { "type": [ "string", "null" ] }, "operatorCode": { "type": [ "string", "null" ] }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" }, "eic": { "type": [ "string", "null" ] }, "isOrderInvoice": { "type": "boolean" }, "summaryInvoiceId": { "type": [ "integer", "null" ] }, "isSummaryInvoice": { "type": "boolean" }, "settledOrderInvoices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": [ "string", "null" ] }, "date": { "type": "string" }, "amountGross": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "required": [ "id", "number", "date", "amountGross", "currency" ] } } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalizedAt", "verifyURL", "pdf", "eic", "isOrderInvoice", "summaryInvoiceId", "isSummaryInvoice", "settledOrderInvoices" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } ] } } } }, "503": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Sherbimi i fiskalizimit eshte i pa arritshem." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] }, { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Ndodhi nje gabim, fatura nuk u ruajt." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "status", "message", "errors" ] }, { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "items": { "type": "string" } } }, "required": [ "status", "message", "errors" ] } ] } } } }, "409": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Eshte arritur numri maksimal i kerkesave te lejuara ne API." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/cancel\/{invoiceId}": { "post": { "operationId": "invoice.cancelInvoice", "description": "Anullon faturen dhe krijon regjistrim fiskal anullimi ne sistemin e tatimeve.\n\nPa body anullohet e gjithe fatura, si me pare.\n\nMe `lines` anullohet vetem nje pjese e fatures, e mundur vetem per faturat Cash. Cdo rresht i derguar\nduhet te ekzistoje ne faturen origjinale me te njejtin `product_code` dhe `product_name`, dhe sasia mund\nvetem te ulet ose te mbetet e njejte. Produktet qe nuk i dergoni mbeten te shitura. Kur i njejti produkt\neshte faturuar ne dy rreshta me cmime te ndryshme, shtoni `price` per te zgjedhur rreshtin.\n\nFatura origjinale mbetet e hapur per anullime te metejshme derisa anullimet e pjesshme ta mbulojne te\ngjithen, dhe vetem atehere shenohet si e anulluar.", "summary": "Anullo fature sipas ID", "tags": [ "Invoice" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CancelInvoiceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "iic": { "type": "string" }, "fic": { "type": "string" }, "tcrCode": { "type": "string" }, "businessCode": { "type": "string" }, "operatorCode": { "type": "string" }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalizedAt", "verifyURL", "pdf" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/cancel-by-internal-id\/{internalId}": { "post": { "operationId": "invoice.cancelInvoiceByInternalId", "description": "Anullon faturen duke perdorur ID-ne tuaj interne qe keni derguar kur keni krijuar faturen.\n\nPa body anullohet e gjithe fatura. Me `lines` anullohet vetem nje pjese e saj, me te njejtat rregulla\nsi tek anullimi sipas ID: vetem fatura Cash, produkt me te njejtin `product_code` dhe `product_name`,\ndhe sasi qe vetem ulet ose mbetet e njejte.", "summary": "Anullo fature sipas Internal ID", "tags": [ "Invoice" ], "parameters": [ { "name": "internalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CancelInvoiceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "iic": { "type": "string" }, "fic": { "type": "string" }, "fiscalizedAt": { "type": "string" }, "verifyURL": { "type": "string" }, "pdf": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "fiscalizedAt", "verifyURL", "pdf" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/bulk-noncash": { "post": { "operationId": "invoice.createNonCashBulk", "summary": "Krijo fatura pa para ne dore ne bllok (Bulk NonCash)", "tags": [ "Invoice" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "invoices": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" } }, "required": [ "id", "number" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/print\/{invoiceId}": { "get": { "operationId": "v1.invoice.pdf", "description": "Kthen dokumentin e fatures. Pa parametra kthehet formati i paracaktuar per tipin e fatures: kupon termik\nper faturat Cash (sipas gjeresise 58\/80mm te konfiguruar te perdoruesi), dokument A4 per faturat NonCash\ndhe Estimate, dhe PDF-ja zyrtare e marre nga sistemi qeveritar per faturat elektronike.\n\nMe parametrin `format` merrni te njejtat versione printimi qe ofron edhe paneli i fature.al:\n\n| `format` | Tipi i fatures | Rezultati | Content-Type |\n|----------|----------------|-----------|--------------|\n| `a4` | Cash | Dokument A4 i fatures | application\/pdf |\n| `thermal` | NonCash | Kupon termik | application\/pdf |\n| `v2` | NonCash, Estimate | Dokument A4, versioni i gjere | application\/pdf |\n| `receipt` | Estimate | Kupon termik | application\/pdf |\n| `local` | EInvoice | Dokument A4 i gjeneruar nga fature.al, pa e kerkuar PDF-ne zyrtare | application\/pdf |\n| `local-thermal` | EInvoice | Kupon termik i gjeneruar nga fature.al | application\/pdf |\n| `html` | Cash | Kuponi termik si HTML, per ta derguar vete ne printer | text\/html |\n| `json` | te gjitha | Te dhenat e dokumentit ne JSON, per ta formatuar vete faturen | application\/json |\n\nParametri `lang` (`en`, `it`, `de`) e perkthen dokumentin A4 te faturave NonCash, Estimate dhe EInvoice,\ndhe kombinohet me `format`. Pa te, dokumenti kthehet shqip. Kuponat termike dhe faturat Cash mbeten\ngjithmone shqip, sepse jane dokumente fiskale.\n\nPer faturat Cash, parametri `copy_only=1` kthen kopjen e kuponit ne HTML ne vend te origjinalit.\n\nNje `format` qe nuk vlen per tipin e fatures nuk kthen gabim: kthehet formati i paracaktuar i atij tipi.", "summary": "Shkarko PDF te fatures sipas ID", "tags": [ "Invoice" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/pdf": { "schema": { "type": "string" } }, "application\/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "invoices": { "type": "array", "items": { "type": "string" } } }, "required": [ "invoices" ] }, { "type": "object", "properties": { "logo": { "type": [ "string", "null" ] }, "title": { "type": "string", "enum": [ "Fatur\u00eb Tatimore", "Fatur\u00eb Tatimore Shitjeje", "Fatur\u00eb e thjesht\u00eb Tatimore", "Draft", "Fature Preventiv" ] }, "company": { "type": "object", "properties": { "name": { "type": "string" }, "nuis": { "type": "string" }, "address": { "type": "string" } }, "required": [ "name", "nuis", "address" ] }, "client": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] } }, "required": [ "type", "id" ] }, "addres": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "ALB" ] } ] } }, "required": [ "name", "id", "addres", "city", "country" ] }, "transporter": { "type": "object", "properties": { "name": { "type": "string" }, "plate": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "required": [ "name", "plate", "address", "city" ] }, "invoice": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "payment_method": { "type": [ "string", "null" ] }, "payment_method_label": { "type": "string" }, "bank_account": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "bank_name": { "type": [ "string", "null" ] }, "iban": { "type": [ "string", "null" ] }, "swift": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "required": [ "id", "bank_name", "iban", "swift", "currency", "notes" ] }, { "$ref": "#\/components\/schemas\/BankAccount" } ] }, "issueDate": { "type": [ "string", "null" ] }, "businessCode": { "type": [ "string", "null" ] }, "operatorCode": { "type": [ "string", "null" ] }, "operatorName": { "type": [ "string", "null" ] }, "deviceCode": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "exchangeRate": { "type": [ "object", "null" ] }, "number": { "type": [ "string", "null" ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "unit": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ] }, "unitPrice": { "type": "string" }, "total": { "type": [ "number", "null" ] } }, "required": [ "name", "unit", "quantity", "unitPrice", "total" ] } }, "amounts": { "type": "object", "properties": { "net": { "type": [ "number", "null" ] }, "gross": { "type": [ "number", "null" ] }, "vat": { "type": [ "number", "null" ] }, "discount": { "type": [ "number", "null" ] }, "net_all": { "type": "string" }, "gross_all": { "type": "string" }, "vat_all": { "type": "string" }, "discount_all": { "type": "string" } }, "required": [ "net", "gross", "vat", "discount", "net_all", "gross_all", "vat_all", "discount_all" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "eic": { "type": [ "string", "null" ] }, "process": { "type": [ "string", "null" ] }, "doc_type": { "type": [ "integer", "null" ] }, "notes": { "type": [ "string", "null" ] }, "verifyUrl": { "type": "string" }, "footer": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "payment_method", "payment_method_label", "bank_account", "issueDate", "businessCode", "operatorCode", "operatorName", "deviceCode", "currency", "exchangeRate", "number", "lines", "amounts", "iic", "fic", "eic", "process", "doc_type", "notes", "verifyUrl", "footer" ] } }, "required": [ "logo", "title", "company", "client", "transporter", "invoice" ] } ] } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/print-eic\/{eic}": { "get": { "operationId": "v1.einvoice.pdf", "description": "Kthen skedarin PDF te fatures duke perdorur kodin EIC (UUID).", "summary": "Shkarko PDF te fatures sipas EIC", "tags": [ "Invoice" ], "parameters": [ { "name": "eic", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/pdf": { "schema": { "type": "string" } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/ping": { "get": { "operationId": "ping.pong", "description": "Kontrollo nese API eshte aktiv. Kthen timestamp dhe IP.", "summary": "Ping", "tags": [ "Ping" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "pong": { "type": "integer" }, "ip": { "type": "array", "items": { "type": "string" } } }, "required": [ "pong", "ip" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/product\/categories": { "get": { "operationId": "products.categories", "description": "Merrni listen e kategorive te produkteve per kompanin\u00eb tuaj.", "summary": "Lista e kategorive", "tags": [ "Products" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "id", "name", "color" ] } } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/products": { "get": { "operationId": "products.products", "description": "Merrni listen e produkteve per kompanin\u00eb tuaj. Kthen id, kodin, emrin, njesine, cmimin e fundit, shkallen e TVSH, llojin e perjashtimit nga TVSH dhe kategorin\u00eb.", "summary": "Lista e produkteve", "tags": [ "Products" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "unit": { "type": "string" }, "unit_code": { "type": "string" }, "last_price": { "type": "number" }, "vat_rate": { "type": "integer" }, "vat_exempt_type": { "type": "string" }, "vat_exempt_description": { "type": "string" }, "currency": { "type": "string" }, "id_category": { "type": "string" } }, "required": [ "id", "code", "name", "description", "unit", "unit_code", "last_price", "vat_rate", "vat_exempt_type", "vat_exempt_description", "currency", "id_category" ] } } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.products.create", "description": "Krijon nje produkt te ri per kompanin\u00eb tuaj. Kodi gjenerohet automatikisht nese nuk jepet. Njesia matese derivohet nga unit_code.", "summary": "Krijo produkt", "tags": [ "Products" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "product": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "unit_code": { "type": "string" }, "last_price": { "type": "number" }, "cost_price": { "type": "string" }, "vat_rate": { "type": "integer" }, "vat_exempt_type": { "type": "string" }, "currency": { "type": "string" }, "service": { "type": "boolean" }, "id_category": { "type": "string" }, "category": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "code", "name", "description", "unit_code", "last_price", "cost_price", "vat_rate", "vat_exempt_type", "currency", "service", "id_category", "category", "created_at" ] } }, "required": [ "product" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/products\/{id}\/details": { "get": { "operationId": "v1.products.details", "description": "Merrni detajet e nje produkti sipas id-se per kompanin\u00eb tuaj.", "summary": "Detajet e produktit sipas ID", "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "product": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "unit": { "type": "string" }, "unit_code": { "type": "string" }, "last_price": { "type": "number" }, "cost_price": { "type": "string" }, "vat_rate": { "type": "number" }, "vat_exempt_type": { "type": "string" }, "vat_exempt_description": { "type": "string" }, "currency": { "type": "string" }, "service": { "type": "boolean" }, "id_category": { "type": "string" }, "category": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "code", "name", "description", "unit", "unit_code", "last_price", "cost_price", "vat_rate", "vat_exempt_type", "vat_exempt_description", "currency", "service", "id_category", "category", "created_at" ] } }, "required": [ "product" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/products\/{id}": { "put": { "operationId": "v1.products.update", "description": "Perditeson nje produkt ekzistues. Trupi i kerkeses ka te njejtin format si POST \/products.", "summary": "Perditeso produkt", "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProductRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "product": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "unit": { "type": "string" }, "unit_code": { "type": "string" }, "last_price": { "type": "number" }, "cost_price": { "type": "string" }, "vat_rate": { "type": "number" }, "vat_exempt_type": { "type": "string" }, "vat_exempt_description": { "type": "string" }, "currency": { "type": "string" }, "service": { "type": "boolean" }, "id_category": { "type": "string" }, "category": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "code", "name", "description", "unit", "unit_code", "last_price", "cost_price", "vat_rate", "vat_exempt_type", "vat_exempt_description", "currency", "service", "id_category", "category", "created_at" ] } }, "required": [ "product" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/purchase-invoices": { "get": { "operationId": "v1.purchase-invoices.list", "description": "Merrni faturat e blerjes nga fiskalizimi. Per cdo fature terhiqen te dhenat\ne plota (artikujt, shitesi, bleresi, menyrat e pageses).", "summary": "Lista e faturave te blerjes", "tags": [ "PurchaseInvoice" ], "parameters": [ { "name": "fic", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "iic": { "type": "string" }, "fic": { "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceOrderNumber": { "type": "integer" }, "dateTimeCreated": { "type": "string" }, "payDeadline": { "type": "string" }, "invoiceType": { "type": "string" }, "issuerTaxNumber": { "type": "string" }, "seller": { "type": "object", "properties": { "idType": { "type": "string" }, "idNum": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "town": { "type": "string" }, "country": { "type": "string" } }, "required": [ "idType", "idNum", "name", "address", "town", "country" ] }, "buyer": { "type": "object", "properties": { "idType": { "type": "string" }, "idNum": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "town": { "type": "string" }, "country": { "type": "string" } }, "required": [ "idType", "idNum", "name", "address", "town", "country" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "unit": { "type": "string" }, "quantity": { "type": "number" }, "unitPriceAfterVat": { "type": "number" }, "priceAfterVat": { "type": "number" }, "vatAmount": { "type": "number" }, "vatRate": { "type": "string" }, "exemptFromVat": { "type": "string" } }, "required": [ "name", "code", "unit", "quantity", "unitPriceAfterVat", "priceAfterVat", "vatAmount", "vatRate", "exemptFromVat" ] } }, "paymentMethod": { "type": "array", "items": { "type": "object", "properties": { "typeCode": { "type": "string" }, "compCard": { "type": "string" } }, "required": [ "typeCode", "compCard" ] } }, "currency": { "type": "string" }, "totalPrice": { "type": "number" }, "totalPriceWithoutVAT": { "type": "number" }, "reverseCharge": { "type": "boolean" }, "businessUnit": { "type": "string" }, "operatorCode": { "type": "string" }, "tcrCode": { "type": "string" }, "softwareCode": { "type": "string" }, "iicSignature": { "type": "string" } }, "required": [ "iic", "fic", "invoiceNumber", "invoiceOrderNumber", "dateTimeCreated", "payDeadline", "invoiceType", "issuerTaxNumber", "seller", "buyer", "items", "paymentMethod", "currency", "totalPrice", "totalPriceWithoutVAT", "reverseCharge", "businessUnit", "operatorCode", "tcrCode", "softwareCode", "iicSignature" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "page": { "type": "integer" } }, "required": [ "records", "page" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/wtn": { "get": { "operationId": "v1.invoice.wtn.list", "description": "Merr listen e faturave shoqeruese me faqosje dhe filtrim sipas datave.", "summary": "Lista e faturave shoqeruese (WTN)", "tags": [ "WtnInvoice" ], "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } } ], "responses": { "500": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Ndodhi nje gabim, po e kontrollojme." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Datat nuk jane ne formatin e duhur: Y-m-d." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "transaction": { "type": [ "string", "null" ] }, "issue_date": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "destination_date": { "type": [ "string", "null" ] }, "origin": { "type": "object", "properties": { "point": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] } }, "required": [ "point", "city", "address" ] }, "destination": { "type": "object", "properties": { "point": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] } }, "required": [ "point", "city", "address" ] }, "carrier": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "id_type": { "type": [ "string", "null" ] }, "id_num": { "type": [ "string", "null" ] }, "town": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "vehicle_ownership": { "type": [ "string", "null" ] }, "vehicle_plates": { "type": [ "string", "null" ] } }, "required": [ "name", "id_type", "id_num", "town", "address", "vehicle_ownership", "vehicle_plates" ] }, "value_of_goods": { "type": "number" }, "items_num": { "type": "integer" }, "fiscal": { "type": "object", "properties": { "status": { "type": [ "string", "null" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "tcr_code": { "type": [ "string", "null" ] }, "business_code": { "type": [ "string", "null" ] }, "operator_code": { "type": [ "string", "null" ] }, "fiscalized_at": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] } }, "required": [ "status", "iic", "fic", "tcr_code", "business_code", "operator_code", "fiscalized_at", "verify_url" ] }, "lines": { "type": "array", "items": {} }, "print": { "type": "string" } }, "required": [ "id", "number", "type", "transaction", "issue_date", "start_date", "destination_date", "origin", "destination", "carrier", "value_of_goods", "items_num", "fiscal", "lines", "print" ] } }, "pagination": { "type": "object", "properties": { "records": { "type": "integer" }, "limit": { "type": [ "object", "null" ] }, "offset": { "type": [ "object", "null" ] } }, "required": [ "records", "limit", "offset" ] } }, "required": [ "items", "pagination" ] } }, "required": [ "status", "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Eshte arritur numri maksimal i kerkesave te lejuara ne API." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.invoice.wtn.create", "summary": "Krijo fature shoqeruese (WTN)", "tags": [ "WtnInvoice" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WtnInvoiceRequest" } } } }, "responses": { "500": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "503": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "number": { "type": [ "string", "null" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "tcrCode": { "type": [ "string", "null" ] }, "businessCode": { "type": [ "string", "null" ] }, "operatorCode": { "type": [ "string", "null" ] }, "fiscalStatus": { "type": [ "string", "null" ] }, "fiscalizedAt": { "type": [ "string", "null" ] }, "verifyURL": { "type": [ "string", "null" ] }, "print": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalStatus", "fiscalizedAt", "verifyURL", "print" ] }, "message": { "type": "string" } }, "required": [ "invoice", "message" ] } }, "required": [ "status", "data" ] }, { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": [ "string", "null" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "tcrCode": { "type": [ "string", "null" ] }, "businessCode": { "type": [ "string", "null" ] }, "operatorCode": { "type": [ "string", "null" ] }, "fiscalStatus": { "type": [ "string", "null" ] }, "fiscalizedAt": { "type": [ "string", "null" ] }, "verifyURL": { "type": [ "string", "null" ] }, "print": { "type": "string" } }, "required": [ "id", "number", "iic", "fic", "tcrCode", "businessCode", "operatorCode", "fiscalStatus", "fiscalizedAt", "verifyURL", "print" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Kontrolloni ne Konfigurime > Abonimi i softit per te porositur nje abonim te ri." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Eshte arritur numri maksimal i kerkesave te lejuara ne API." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/invoice\/wtn\/{id}\/details": { "get": { "operationId": "v1.invoice.wtn.details", "summary": "Detajet e fatures shoqeruese sipas ID", "tags": [ "WtnInvoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string", "const": "Ndodhi nje gabim, po e kontrollojme." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "transaction": { "type": [ "string", "null" ] }, "issue_date": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ] }, "destination_date": { "type": [ "string", "null" ] }, "origin": { "type": "object", "properties": { "point": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] } }, "required": [ "point", "city", "address" ] }, "destination": { "type": "object", "properties": { "point": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] } }, "required": [ "point", "city", "address" ] }, "carrier": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "id_type": { "type": [ "string", "null" ] }, "id_num": { "type": [ "string", "null" ] }, "town": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "vehicle_ownership": { "type": [ "string", "null" ] }, "vehicle_plates": { "type": [ "string", "null" ] } }, "required": [ "name", "id_type", "id_num", "town", "address", "vehicle_ownership", "vehicle_plates" ] }, "value_of_goods": { "type": "number" }, "items_num": { "type": "integer" }, "fiscal": { "type": "object", "properties": { "status": { "type": [ "string", "null" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "tcr_code": { "type": [ "string", "null" ] }, "business_code": { "type": [ "string", "null" ] }, "operator_code": { "type": [ "string", "null" ] }, "fiscalized_at": { "type": [ "string", "null" ] }, "verify_url": { "type": [ "string", "null" ] } }, "required": [ "status", "iic", "fic", "tcr_code", "business_code", "operator_code", "fiscalized_at", "verify_url" ] }, "lines": { "type": "array", "items": {} }, "print": { "type": "string" } }, "required": [ "id", "number", "type", "transaction", "issue_date", "start_date", "destination_date", "origin", "destination", "carrier", "value_of_goods", "items_num", "fiscal", "lines", "print" ] } }, "required": [ "invoice" ] } }, "required": [ "status", "data" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/invoice\/wtn\/print\/{invoiceId}": { "get": { "operationId": "v1.invoice.wtn.print", "description": "Kthen nje strukture JSON me te gjitha te dhenat per nje \"print view\".", "summary": "Te dhenat e fatures shoqeruese ne format printimi (JSON)", "tags": [ "WtnInvoice" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "logo": { "type": [ "string", "null" ] }, "title": { "type": "string", "const": "Fatur\u00eb Shoq\u00ebruese" }, "company": { "type": "object", "properties": { "name": { "type": "string" }, "nuis": { "type": "string" }, "address": { "type": "string" } }, "required": [ "name", "nuis", "address" ] }, "carrier": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "idType": { "type": [ "string", "null" ] }, "idNum": { "type": [ "string", "null" ] }, "town": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "vehicleOwnership": { "type": [ "string", "null" ] }, "vehiclePlates": { "type": [ "string", "null" ] } }, "required": [ "name", "idType", "idNum", "town", "address", "vehicleOwnership", "vehiclePlates" ] }, "origin": { "type": "object", "properties": { "point": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "dateTime": { "type": [ "string", "null" ] } }, "required": [ "point", "city", "address", "dateTime" ] }, "destination": { "type": "object", "properties": { "point": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "dateTime": { "type": [ "string", "null" ] } }, "required": [ "point", "city", "address", "dateTime" ] }, "invoice": { "type": "object", "properties": { "issueDate": { "type": [ "string", "null" ] }, "businessCode": { "type": [ "string", "null" ] }, "operatorCode": { "type": [ "string", "null" ] }, "deviceCode": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "transaction": { "type": [ "string", "null" ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "unit": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "name", "code", "unit", "quantity" ] } }, "amounts": { "type": "object", "properties": { "valueOfGoods": { "type": "number" }, "currency": { "type": "string", "const": "ALL" }, "itemsNum": { "type": "integer" } }, "required": [ "valueOfGoods", "currency", "itemsNum" ] }, "iic": { "type": [ "string", "null" ] }, "fic": { "type": [ "string", "null" ] }, "fiscalStatus": { "type": [ "string", "null" ] }, "verifyUrl": { "type": [ "string", "null" ] }, "footer": { "type": "array", "items": { "type": "string" } } }, "required": [ "issueDate", "businessCode", "operatorCode", "deviceCode", "number", "type", "transaction", "lines", "amounts", "iic", "fic", "fiscalStatus", "verifyUrl", "footer" ] } }, "required": [ "logo", "title", "company", "carrier", "origin", "destination", "invoice" ] } }, "required": [ "status", "data" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "errors": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "status", "message", "errors" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "description": "Token-i i perdoruesit, nga Konfigurime > API Tokens.", "scheme": "bearer" }, "clientId": { "type": "apiKey", "description": "Client id i aplikacionit tuaj, fillon me ft_id_", "in": "header", "name": "X-Client-Id" }, "clientSecret": { "type": "apiKey", "description": "Client secret i aplikacionit tuaj, fillon me ft_sk_", "in": "header", "name": "X-Client-Secret" } }, "schemas": { "App.Http.Requests.Api.ClientRequest": { "type": "object", "properties": { "client_type": { "type": "string", "enum": [ "PERSON", "COMPANY" ] }, "company_name": { "type": [ "string", "null" ], "maxLength": 255 }, "nipt": { "type": [ "string", "null" ], "maxLength": 20 }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 50 }, "company_type": { "type": [ "string", "null" ], "enum": [ "BUSINESS", "BANK", "EXCHANGE" ] }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "surname": { "type": [ "string", "null" ], "maxLength": 255 }, "document_type": { "type": [ "string", "null" ], "enum": [ "NUIS", "ID", "PASS", "VAT", "TAX", "SOC" ] }, "document_number": { "type": [ "string", "null" ], "maxLength": 255 }, "nationality_code": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 }, "nationality_id": { "type": [ "integer", "null" ] }, "telephone": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "customer_number": { "type": [ "string", "null" ], "maxLength": 30 }, "gender": { "type": [ "string", "null" ], "maxLength": 10 }, "birthday": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "client_type" ], "title": "App.Http.Requests.Api.ClientRequest" }, "BankAccount": { "type": "object", "properties": { "id": { "type": "integer" }, "bank_name": { "type": [ "string", "null" ] }, "id_bank": { "type": [ "integer", "null" ] }, "iban": { "type": [ "string", "null" ] }, "swift": { "type": [ "string", "null" ] }, "id_currency": { "type": [ "integer", "null" ] }, "valid_from": { "type": [ "string", "null" ] }, "valid_to": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "status": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "id_company": { "type": [ "integer", "null" ] }, "default": { "type": "integer" }, "maintenance_monthly_costs": { "type": "number" }, "holder": { "type": [ "string", "null" ] } }, "required": [ "id", "bank_name", "id_bank", "iban", "swift", "id_currency", "valid_from", "valid_to", "notes", "status", "created_at", "updated_at", "id_company", "default", "maintenance_monthly_costs", "holder" ], "title": "BankAccount" }, "BankAccountRequest": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "holder": { "type": [ "string", "null" ] }, "iban": { "type": [ "string", "null" ] }, "swift": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "title": "BankAccountRequest" }, "CancelInvoiceRequest": { "type": "object", "properties": { "lines": { "type": "array", "description": "Leave `lines` out to cancel the whole invoice. Send it to give back only part of it.", "items": { "type": "object", "properties": { "product_name": { "type": "string" }, "product_code": { "type": "string" }, "quantity": { "type": "number" }, "price": { "type": [ "number", "null" ], "description": "Only needed when the same product was invoiced on two lines at different prices." } }, "required": [ "product_name", "product_code", "quantity" ] }, "minItems": 1 } }, "title": "CancelInvoiceRequest" }, "CashActionRequest": { "type": "object", "properties": { "amount": { "type": "number" }, "description": { "type": [ "string", "null" ], "maxLength": 255 }, "third_party": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "amount" ], "title": "CashActionRequest" }, "CashInvoice": { "type": "object", "properties": { "internalId": { "type": "string" }, "payment_method": { "type": "string", "enum": [ "BANKNOTE", "CARD", "CHECK", "SVOUCHER", "COMPANY", "ORDER" ] }, "invoice_discount_type": { "type": [ "string", "null" ], "enum": [ "percent", "amount" ] }, "invoice_discount_value": { "type": [ "number", "null" ], "minimum": 0 }, "currency": { "type": [ "string", "null" ] }, "exchange_rate": { "type": [ "number", "null" ] }, "due_date": { "type": [ "string", "null" ] }, "supply_start_date": { "type": [ "string", "null" ] }, "supply_end_date": { "type": [ "string", "null" ] }, "reverse_charge": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ] }, "periodic_invoice": { "type": [ "boolean", "null" ] }, "self_issue_type": { "type": [ "string", "null" ], "enum": [ "DOMESTIC", "ABROAD", "OTHER" ] }, "client": { "type": "object", "properties": { "internal_id": { "type": [ "integer", "null" ], "description": "Existing Fatureal client id; when present the client is resolved by it and the fields below are ignored." }, "name": { "type": [ "string", "null" ] }, "id": { "type": [ "object", "null" ], "properties": { "type": { "type": [ "string", "null" ], "description": "when client is Albanian Company (NUIS), when client is Non-AlbanCompany(VAT, TAX), when client is Person(ID, PASS, SOC)", "enum": [ "NUIS", "VAT", "TAX", "ID", "PASS", "SOC" ] }, "id": { "type": [ "string", "null" ] } } }, "address": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country code (e.g. RKS, ALB, USA)." } } }, "lines": { "type": "array", "items": { "type": "object", "properties": { "product_name": { "type": "string" }, "product_code": { "type": "string" }, "unit": { "type": "string" }, "quantity": { "type": "number" }, "price": { "type": "number" }, "total": { "type": "number" }, "vat": { "type": "integer", "enum": [ "0", "6", "10", "20" ] }, "vat_exempt_type": { "type": [ "string", "null" ], "enum": [ "TYPE_1", "TYPE_2", "EXPORT_OF_GOODS", "TAX_FREE" ] } }, "required": [ "product_name", "product_code", "unit", "quantity", "price", "total", "vat" ] }, "minItems": 1 } }, "required": [ "internalId", "payment_method", "lines" ], "title": "CashInvoice" }, "CertificateRequest": { "type": "object", "properties": { "certificate_file": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream" }, "password": { "type": [ "string", "null" ] } }, "title": "CertificateRequest" }, "ClientRequest": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "company", "person" ] }, "customer_number": { "type": [ "string", "null" ], "maxLength": 30 }, "company": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 255 }, "category": { "type": [ "string", "null" ], "enum": [ "business", "bank", "exchange" ] }, "id": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "nuis", "vat", "tax" ] }, "value": { "type": "string", "maxLength": 20 } } } } }, "person": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "maxLength": 255 }, "birthday": { "type": [ "string", "null" ], "format": "date-time" }, "id": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "id", "passport", "social" ] }, "value": { "type": "string", "maxLength": 255 } } } } }, "address": { "type": "object", "properties": { "line": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 50 }, "country": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 3 } } }, "contact": { "type": "object", "properties": { "phone": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 } } } }, "required": [ "type" ], "title": "ClientRequest" }, "EInvoiceRequest": { "type": "object", "properties": { "internalId": { "type": "string" }, "payment_method": { "type": [ "string", "null" ], "enum": [ "ACCOUNT", "COMPENSATION", "FACTORING", "KIND", "OTHER", "TRANSFER", "WAIVER" ] }, "invoice_discount_type": { "type": [ "string", "null" ], "enum": [ "percent", "amount" ] }, "invoice_discount_value": { "type": [ "number", "null" ], "minimum": 0 }, "bank_account": { "type": [ "integer", "null" ] }, "bank_account_iban": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "exchange_rate": { "type": [ "number", "null" ] }, "due_date": { "type": [ "string", "null" ] }, "supply_start_date": { "type": [ "string", "null" ] }, "supply_end_date": { "type": [ "string", "null" ] }, "reverse_charge": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ] }, "periodic_invoice": { "type": [ "boolean", "null" ] }, "doc_type": { "type": [ "string", "null" ], "enum": [ "80", "82", "84", "380", "381", "383", "384", "386", "388", "393", "394", "395", "575", "623", "780" ] }, "process": { "type": [ "string", "null" ], "enum": [ "P1", "P2", "P3", "P4", "P5", "P6", "P7", "P8", "P9", "P10", "P11" ] }, "client": { "type": "object", "properties": { "internal_id": { "type": [ "integer", "null" ], "description": "Existing Fatureal client id; when present the client is resolved by it and the fields below are ignored." }, "nuis": { "type": "string", "description": "Albanian company NUIS" }, "name": { "type": "string" }, "address": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "country": { "type": "string", "description": "ISO 3166-1 alpha-3 country code (e.g. RKS, ALB, USA)." } } }, "lines": { "type": "array", "items": { "type": "object", "properties": { "product_name": { "type": "string" }, "product_code": { "type": "string" }, "unit": { "type": "string" }, "unit_code": { "type": [ "string", "null" ], "enum": [ "C62", "XPP", "LTR", "SEC", "MIN", "HUR", "DAY", "MON", "ANN", "MTK", "E4", "58", "DT", "DTN", "GRM", "M4", "E54", "KMT", "D68", "QB", "H93", "MTQ", "MTK", "MSK", "LM", "KWH", "E49", "E55", "OT", "PR", "XBX", "XPK", "SET", "IE" ] }, "quantity": { "type": "number" }, "price": { "type": "number" }, "total": { "type": "number" }, "vat": { "type": [ "integer", "null" ], "enum": [ "0", "6", "10", "20" ] }, "vat_exempt_type": { "type": [ "string", "null" ], "enum": [ "TYPE_1", "TYPE_2", "EXPORT_OF_GOODS", "TAX_FREE" ] } }, "required": [ "product_name", "product_code", "unit", "quantity", "price", "total" ] }, "minItems": 1 } }, "required": [ "internalId", "client", "lines" ], "title": "EInvoiceRequest" }, "FiscalDeviceRequest": { "type": "object", "properties": { "branchId": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "fromDate": { "type": "string" }, "toDate": { "type": [ "string", "null" ] } }, "required": [ "branchId", "name", "fromDate" ], "title": "FiscalDeviceRequest" }, "InvoiceAddress": { "type": "object", "properties": { "street": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "country": { "type": "string", "description": "ISO 3166-1 alpha-3 country code, defaults to ALB." } }, "required": [ "street", "city", "country" ], "title": "InvoiceAddress" }, "InvoiceAmount": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code." }, "exchange_rate": { "type": [ "number", "null" ], "description": "Rate to the local currency, null when the invoice is already in ALL." }, "gross": { "type": "number" }, "net": { "type": "number" }, "vat": { "type": "number" }, "discount": { "type": "number" }, "net_all": { "type": "number", "description": "Net converted to the local currency (ALL)." }, "gross_all": { "type": "number", "description": "Gross converted to the local currency (ALL)." }, "vat_all": { "type": "number", "description": "VAT converted to the local currency (ALL)." }, "discount_all": { "type": "number", "description": "Discount converted to the local currency (ALL)." }, "local_currency": { "anyOf": [ { "description": "Present only on a foreign-currency invoice.", "$ref": "#\/components\/schemas\/InvoiceLocalAmount" }, { "type": "null" } ] } }, "required": [ "currency", "exchange_rate", "gross", "net", "vat", "discount", "net_all", "gross_all", "vat_all", "discount_all", "local_currency" ], "title": "InvoiceAmount" }, "InvoiceBankAccount": { "type": "object", "properties": { "id": { "type": "integer" }, "bank_name": { "type": [ "string", "null" ] }, "iban": { "type": [ "string", "null" ] }, "swift": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code." }, "notes": { "type": [ "string", "null" ] } }, "required": [ "id", "bank_name", "iban", "swift", "currency", "notes" ], "title": "InvoiceBankAccount" }, "InvoiceDetail": { "type": "object", "properties": { "id": { "type": "integer", "description": "Fatureal invoice id." }, "number": { "type": [ "string", "null" ], "description": "Fiscal invoice number." }, "type": { "type": "string", "description": "Invoice type, e.g. NONCASH." }, "issue_date": { "type": "string", "description": "Issue date (YYYY-MM-DD)." }, "due_date": { "type": "string", "description": "Payment due date (YYYY-MM-DD)." }, "delivery_date": { "type": "string", "description": "Delivery\/supply-end date (YYYY-MM-DD)." }, "created_at": { "type": [ "string", "null" ], "description": "Creation timestamp (YYYY-MM-DD HH:MM:SS)." }, "supply_start_date": { "type": [ "string", "null" ], "description": "Supply period start (YYYY-MM-DD)." }, "supply_end_date": { "type": [ "string", "null" ], "description": "Supply period end (YYYY-MM-DD)." }, "client": { "$ref": "#\/components\/schemas\/InvoiceParty" }, "amount": { "$ref": "#\/components\/schemas\/InvoiceAmount" }, "payment_method": { "type": [ "string", "null" ] }, "bank_account": { "anyOf": [ { "description": "Bank account printed on the invoice, or null.", "$ref": "#\/components\/schemas\/InvoiceBankAccount" }, { "type": "null" } ] }, "notes": { "type": [ "string", "null" ] }, "iic": { "type": [ "string", "null" ], "description": "IIC \/ NSLF." }, "fic": { "type": [ "string", "null" ], "description": "FIC \/ NIVF." }, "eic": { "type": [ "string", "null" ], "description": "EIC, for e-invoices." }, "doc_type": { "type": [ "string", "null" ] }, "process": { "type": [ "string", "null" ] }, "self_issue_type": { "type": [ "string", "null" ], "description": "Self-issuance type, when the invoice is self-issued." }, "reversed_at": { "type": [ "string", "null" ], "description": "When the invoice was reversed (YYYY-MM-DD HH:MM:SS), or null." }, "reversed_by": { "type": [ "integer", "null" ], "description": "Id of the invoice this one reverses, or null." }, "pdf_url": { "type": "string", "description": "Direct download URL for the invoice PDF." }, "reverse_charge": { "type": "boolean" }, "periodic_invoice": { "type": "boolean" }, "lines": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceLine" } } }, "required": [ "id", "number", "type", "issue_date", "due_date", "delivery_date", "created_at", "supply_start_date", "supply_end_date", "client", "amount", "payment_method", "bank_account", "notes", "iic", "fic", "eic", "doc_type", "process", "self_issue_type", "reversed_at", "reversed_by", "pdf_url", "reverse_charge", "periodic_invoice", "lines" ], "title": "InvoiceDetail" }, "InvoiceLine": { "type": "object", "properties": { "name": { "type": "string" }, "product_code": { "type": [ "string", "null" ], "description": "Internal product code, when the line is a mapped product." }, "unit": { "type": [ "string", "null" ] }, "unit_code": { "type": [ "string", "null" ] }, "quantity": { "type": "number" }, "unitPrice": { "type": "number", "description": "Unit price before discount, major units." }, "vat_rate": { "type": [ "number", "null" ], "description": "VAT rate percent." }, "vat_exempt_type": { "type": [ "string", "null" ], "description": "VAT exemption type, when the line is exempt." }, "discount_rate": { "type": [ "number", "null" ], "description": "Discount rate percent." }, "discount": { "type": [ "number", "null" ], "description": "Discount amount, major units." }, "amount_net": { "type": "number" }, "amount_vat": { "type": "number" }, "total": { "type": "number", "description": "Gross line total, major units." } }, "required": [ "name", "product_code", "unit", "unit_code", "quantity", "unitPrice", "vat_rate", "vat_exempt_type", "discount_rate", "discount", "amount_net", "amount_vat", "total" ], "title": "InvoiceLine" }, "InvoiceLocalAmount": { "type": "object", "properties": { "exchange_rate": { "type": "number" }, "gross": { "type": "number" }, "net": { "type": "number" }, "vat": { "type": "number" }, "discount": { "type": "number" } }, "required": [ "exchange_rate", "gross", "net", "vat", "discount" ], "title": "InvoiceLocalAmount" }, "InvoiceParty": { "type": "object", "properties": { "name": { "type": "string", "description": "Full name (or company name)." }, "id": { "$ref": "#\/components\/schemas\/InvoicePartyId" }, "address": { "$ref": "#\/components\/schemas\/InvoiceAddress" } }, "required": [ "name", "id", "address" ], "title": "InvoiceParty" }, "InvoicePartyId": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "description": "Identifier type, e.g. NUIS, ID, PASSPORT." }, "id": { "type": [ "string", "null" ], "description": "The identifier value." } }, "required": [ "type", "id" ], "title": "InvoicePartyId" }, "NonCashInvoiceRequest": { "type": "object", "properties": { "internalId": { "type": "string" }, "payment_method": { "type": [ "string", "null" ], "enum": [ "ACCOUNT", "COMPENSATION", "FACTORING", "KIND", "OTHER", "TRANSFER", "WAIVER" ] }, "invoice_discount_type": { "type": [ "string", "null" ], "enum": [ "percent", "amount" ] }, "invoice_discount_value": { "type": [ "number", "null" ], "minimum": 0 }, "bank_account": { "type": [ "integer", "null" ] }, "bank_account_iban": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "exchange_rate": { "type": [ "number", "null" ] }, "due_date": { "type": [ "string", "null" ] }, "supply_start_date": { "type": [ "string", "null" ] }, "supply_end_date": { "type": [ "string", "null" ] }, "reverse_charge": { "type": [ "boolean", "null" ] }, "notes": { "type": [ "string", "null" ] }, "periodic_invoice": { "type": [ "boolean", "null" ] }, "self_issue_type": { "type": [ "string", "null" ], "enum": [ "DOMESTIC", "ABROAD", "OTHER" ] }, "client": { "type": "object", "properties": { "internal_id": { "type": [ "integer", "null" ], "description": "Existing Fatureal client id; when present the client is resolved by it and the fields below are ignored." }, "name": { "type": "string" }, "id": { "type": [ "object", "null" ], "properties": { "type": { "type": [ "string", "null" ], "description": "values when client is Albanian Company (NUIS), values when client is Non-AlbanCompany(VAT, TAX), values when client is Person(ID, PASS, SOC)", "enum": [ "NUIS", "VAT", "TAX", "ID", "PASS", "SOC" ] }, "id": { "type": [ "string", "null" ] } } }, "address": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "country": { "type": "string", "description": "ISO 3166-1 alpha-3 country code (e.g. RKS, ALB, USA)." } } }, "bankAccount": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "iban": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "swift": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "holder": { "type": [ "string", "null" ] } } }, "fee": { "type": "object", "properties": { "fee_type": { "type": [ "string", "null" ] }, "fee_amount": { "type": [ "number", "null" ] } } }, "lines": { "type": "array", "items": { "type": "object", "properties": { "product_name": { "type": "string" }, "product_code": { "type": "string" }, "unit": { "type": "string" }, "quantity": { "type": "number" }, "price": { "type": "number" }, "total": { "type": "number" }, "vat": { "type": [ "integer", "null" ], "enum": [ "0", "6", "10", "20" ] }, "vat_exempt_type": { "type": [ "string", "null" ], "enum": [ "TYPE_1", "TYPE_2", "EXPORT_OF_GOODS", "TAX_FREE" ] } }, "required": [ "product_name", "product_code", "unit", "quantity", "price", "total" ] }, "minItems": 1 } }, "required": [ "internalId", "lines" ], "title": "NonCashInvoiceRequest" }, "OrderInvoice": { "type": "object", "properties": { "internalId": { "type": "string" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "product_name": { "type": "string" }, "product_code": { "type": "string" }, "unit": { "type": "string" }, "quantity": { "type": "number" }, "price": { "type": "number" }, "total": { "type": "number" }, "vat": { "type": "integer" }, "vat_exempt_type": { "type": [ "string", "null" ] } }, "required": [ "product_name", "product_code", "unit", "quantity", "price", "total", "vat" ] }, "minItems": 1 } }, "required": [ "internalId", "lines" ], "title": "OrderInvoice" }, "ProductRequest": { "type": "object", "properties": { "code": { "type": [ "string", "null" ], "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ], "maxLength": 255 }, "unit_code": { "type": "string", "enum": [ "C62", "XPP", "LTR", "SEC", "MIN", "HUR", "DAY", "MON", "ANN", "MTK", "E4", "58", "DT", "DTN", "GRM", "M4", "E54", "KMT", "D68", "QB", "H93", "MTQ", "MTK", "MSK", "LM", "KWH", "E49", "E55", "OT", "PR", "XBX", "XPK", "SET", "IE" ] }, "last_price": { "type": "number", "minimum": 0 }, "cost_price": { "type": [ "number", "null" ], "minimum": 0 }, "vat_rate": { "type": "string", "enum": [ "0", "6", "10", "20" ] }, "vat_exempt_type": { "type": [ "string", "null" ], "enum": [ "TYPE_1", "TYPE_2", "EXPORT_OF_GOODS", "TAX_FREE" ] }, "currency": { "type": [ "string", "null" ], "maxLength": 10 }, "service": { "type": "boolean" }, "id_category": { "type": [ "integer", "null" ] } }, "required": [ "name", "unit_code", "last_price", "vat_rate" ], "title": "ProductRequest" }, "RegisterCompanyRequest": { "type": "object", "properties": { "nuis": { "type": "string", "pattern": "^[A-Z]\\d{8}[A-Z]$" }, "name": { "type": "string", "maxLength": 255 }, "address": { "type": "string", "maxLength": 255 }, "administrator": { "type": "string", "maxLength": 255 }, "phone": { "type": "string", "maxLength": 50 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "issuerInVat": { "type": [ "boolean", "null" ] }, "lastNonCashEInvoiceNumber": { "type": [ "string", "null" ], "maxLength": 50 } }, "required": [ "nuis", "name", "address", "administrator", "phone", "email" ], "title": "RegisterCompanyRequest" }, "SummaryInvoice": { "type": "object", "properties": { "internalId": { "type": "string" }, "payment_method": { "type": "string", "enum": [ "BANKNOTE", "CARD" ] }, "currency": { "type": [ "string", "null" ] }, "exchange_rate": { "type": [ "number", "null" ] }, "supply_start_date": { "type": [ "string", "null" ] }, "supply_end_date": { "type": [ "string", "null" ] }, "order_invoices": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "internalId", "payment_method", "order_invoices" ], "title": "SummaryInvoice" }, "WoltCustomer": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ], "description": "Shared by Wolt only for self-delivery orders." }, "note": { "type": [ "string", "null" ], "description": "Customer note left with the order." } }, "required": [ "name", "phone", "note" ], "title": "WoltCustomer" }, "WoltInvoiceRef": { "type": "object", "properties": { "id": { "type": "integer", "description": "Fatureal invoice id." }, "number": { "type": [ "string", "null" ], "description": "Fiscal invoice number, once assigned." }, "state": { "type": "string", "description": "Fiscal state: pending, deferred, fiscalised or failed." }, "fiscal_iic": { "type": [ "string", "null" ], "description": "Fiscal IIC (NSLF), once fiscalised." }, "fiscal_fic": { "type": [ "string", "null" ], "description": "Fiscal FIC (NIVF), once fiscalised." } }, "required": [ "id", "number", "state", "fiscal_iic", "fiscal_fic" ], "title": "WoltInvoiceRef" }, "WoltOrderCompact": { "type": "object", "properties": { "id": { "type": "integer", "description": "Fatureal order id; use this as {id} in the order and action routes." }, "wolt_order_id": { "type": "string", "description": "Wolt's own order id." }, "display_number": { "type": [ "string", "null" ], "description": "Human order number shown to the customer." }, "status": { "type": "string", "description": "Raw Wolt lifecycle status: received, acknowledged, production, ready, picked_up, courier_at_customer, delivered, rejected, refunded, ..." }, "fiscal_state": { "type": "string", "description": "Fiscal state derived from the invoice: pending, deferred, fiscalised or failed." }, "total_amount": { "type": "number", "description": "Charged total in major currency units." }, "currency": { "type": "string", "description": "ISO 4217 currency code." }, "received_at": { "type": [ "string", "null" ], "description": "When Wolt handed the order to us (ISO-8601)." }, "pickup_at": { "type": [ "string", "null" ], "description": "Committed handover time (ISO-8601), set when a pickup time was chosen on accept." }, "delivery_type": { "type": [ "string", "null" ], "description": "Wolt delivery type: takeaway, eatin, homedelivery, ..." }, "self_delivery": { "type": "boolean", "description": "Whether the venue fulfils delivery with its own courier." }, "branch": { "type": [ "string", "null" ], "description": "Branch name." }, "invoice": { "anyOf": [ { "description": "Linked fiscal invoice reference, or null before fiscalisation.", "$ref": "#\/components\/schemas\/WoltInvoiceRef" }, { "type": "null" } ] } }, "required": [ "id", "wolt_order_id", "display_number", "status", "fiscal_state", "total_amount", "currency", "received_at", "pickup_at", "delivery_type", "self_delivery", "branch", "invoice" ], "title": "WoltOrderCompact" }, "WoltOrderCompany": { "type": "object", "properties": { "tax_id": { "type": "string", "description": "Tax id (NUIS\/NIPT) the customer asked to bill." }, "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] } }, "required": [ "tax_id", "name", "address" ], "title": "WoltOrderCompany" }, "WoltOrderDetail": { "type": "object", "properties": { "id": { "type": "integer", "description": "Fatureal order id; use this as {id} in the order and action routes." }, "wolt_order_id": { "type": "string", "description": "Wolt's own order id." }, "display_number": { "type": [ "string", "null" ], "description": "Human order number shown to the customer." }, "status": { "type": "string", "description": "Raw Wolt lifecycle status: received, acknowledged, production, ready, picked_up, courier_at_customer, delivered, rejected, refunded, ..." }, "fiscal_state": { "type": "string", "description": "Fiscal state derived from the invoice: pending, deferred, fiscalised or failed." }, "total_amount": { "type": "number", "description": "Charged total in major currency units." }, "currency": { "type": "string", "description": "ISO 4217 currency code." }, "received_at": { "type": [ "string", "null" ], "description": "When Wolt handed the order to us (ISO-8601)." }, "pickup_at": { "type": [ "string", "null" ], "description": "Committed handover time (ISO-8601), set when a pickup time was chosen on accept." }, "delivery_type": { "type": [ "string", "null" ], "description": "Wolt delivery type: takeaway, eatin, homedelivery, ..." }, "self_delivery": { "type": "boolean", "description": "Whether the venue fulfils delivery with its own courier." }, "branch": { "type": [ "string", "null" ], "description": "Branch name." }, "invoice": { "anyOf": [ { "description": "Linked fiscal invoice reference, or null before fiscalisation.", "$ref": "#\/components\/schemas\/WoltInvoiceRef" }, { "type": "null" } ] }, "customer": { "$ref": "#\/components\/schemas\/WoltCustomer" }, "company": { "anyOf": [ { "description": "B2B billing company, or null for a normal consumer order.", "$ref": "#\/components\/schemas\/WoltOrderCompany" }, { "type": "null" } ] }, "preorder": { "anyOf": [ { "description": "Scheduled pre-order info, or null for an instant order.", "$ref": "#\/components\/schemas\/WoltPreorder" }, { "type": "null" } ] }, "lines": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WoltOrderLine" } }, "totals": { "$ref": "#\/components\/schemas\/WoltOrderTotals" } }, "required": [ "id", "wolt_order_id", "display_number", "status", "fiscal_state", "total_amount", "currency", "received_at", "pickup_at", "delivery_type", "self_delivery", "branch", "invoice", "customer", "company", "preorder", "lines", "totals" ], "title": "WoltOrderDetail" }, "WoltOrderEvent": { "type": "object", "properties": { "id": { "type": "integer", "description": "Monotonic cursor id; pass the highest one you have seen as ?since=." }, "type": { "type": "string", "description": "Event type, e.g. order.received, order.accepted, order.ready, order.delivered, order.fiscalized, order.fiscalization_failed." }, "order_id": { "type": "integer", "description": "Fatureal order id the event is about." }, "wolt_order_id": { "type": "string", "description": "Wolt's order id." }, "status": { "type": [ "string", "null" ], "description": "Order status at the moment of the event." }, "occurred_at": { "type": [ "string", "null" ], "description": "When the event occurred (ISO-8601)." }, "order": { "description": "Compact snapshot of the order at that moment.", "$ref": "#\/components\/schemas\/WoltOrderCompact" } }, "required": [ "id", "type", "order_id", "wolt_order_id", "status", "occurred_at", "order" ], "title": "WoltOrderEvent" }, "WoltOrderLine": { "type": "object", "properties": { "name": { "type": "string", "description": "Item name." }, "quantity": { "type": "number" }, "unit_price": { "type": "number", "description": "Unit price in major units." }, "total": { "type": "number", "description": "Line total in major units, after discount." }, "discount": { "type": "number", "description": "Discount applied to the line, major units." }, "product": { "anyOf": [ { "description": "Linked internal product, or null when the Wolt item is unmapped.", "$ref": "#\/components\/schemas\/WoltProductRef" }, { "type": "null" } ] }, "options": { "type": "array", "description": "Chosen modifiers\/options for the line.", "items": {} } }, "required": [ "name", "quantity", "unit_price", "total", "discount", "product", "options" ], "title": "WoltOrderLine" }, "WoltOrderTotals": { "type": "object", "properties": { "subtotal_before_discount": { "type": "number", "description": "Basket total before any discount, major units." }, "discount": { "type": "number", "description": "Total discount applied, major units." }, "total": { "type": "number", "description": "Charged total, major units." }, "currency": { "type": "string", "description": "ISO 4217 currency code." }, "campaigns": { "type": "array", "description": "Applied promotion labels.", "items": {} } }, "required": [ "subtotal_before_discount", "discount", "total", "currency", "campaigns" ], "title": "WoltOrderTotals" }, "WoltPreorder": { "type": "object", "properties": { "time": { "type": "string", "description": "Scheduled time (ISO-8601)." }, "status": { "type": [ "string", "null" ], "description": "Wolt pre-order status." } }, "required": [ "time", "status" ], "title": "WoltPreorder" }, "WoltProductRef": { "type": "object", "properties": { "code": { "type": "string", "description": "Internal product code." }, "name": { "type": "string", "description": "Internal product name." } }, "required": [ "code", "name" ], "title": "WoltProductRef" }, "WoltRejectRequest": { "type": "object", "description": "Body of the reject action. Kept as a FormRequest so the allowed reject codes\nare documented as an enum in the API docs, while failedValidation still emits\nthe partner envelope { status, message, code, errors } on bad input.", "properties": { "reason": { "type": [ "string", "null" ], "maxLength": 255 }, "code": { "type": [ "string", "null" ], "enum": [ "GENERIC", "ITEMS_UNAVAILABLE", "VENUE_CLOSING_SOON" ] } }, "title": "WoltRejectRequest" }, "WtnInvoiceRequest": { "type": "object", "properties": { "vehPlates": { "type": "string" }, "valueOfGoods": { "type": "number" }, "type": { "type": [ "string", "null" ], "enum": [ "WTN", "SALE" ] }, "transaction": { "type": [ "string", "null" ], "enum": [ "TRANSFER", "EXAMINATION", "SALES", "DOOR" ] }, "vehOwnership": { "type": [ "string", "null" ], "enum": [ "OWNER", "THIRDPARTY" ] }, "startPoint": { "type": [ "string", "null" ], "enum": [ "ANOTHER", "CUSTOMS", "EXHIBITION", "OTHER", "SALE", "STORE", "WAREHOUSE" ] }, "destinPoint": { "type": [ "string", "null" ], "enum": [ "ANOTHER", "CUSTOMS", "EXHIBITION", "OTHER", "SALE", "STORE", "WAREHOUSE" ] }, "carrier_id_type": { "type": [ "string", "null" ], "enum": [ "NUIS", "ID" ] }, "startCity": { "type": [ "string", "null" ] }, "startAddr": { "type": [ "string", "null" ] }, "destinCity": { "type": [ "string", "null" ] }, "destinAddr": { "type": [ "string", "null" ] }, "carrier_id_num": { "type": [ "string", "null" ] }, "carrier_name": { "type": [ "string", "null" ] }, "carrier_town": { "type": [ "string", "null" ] }, "carrier_address": { "type": [ "string", "null" ] }, "startDateTime": { "type": [ "string", "null" ] }, "destinDateTime": { "type": [ "string", "null" ] }, "invoice_lines": { "type": "array", "items": { "type": "object", "properties": { "product_name": { "type": "string", "maxLength": 255 }, "product_code": { "type": "string", "maxLength": 50 }, "unit": { "type": "string", "maxLength": 50 }, "quantity": { "type": "number" } }, "required": [ "product_name", "product_code", "unit", "quantity" ] }, "minItems": 1 } }, "required": [ "vehPlates", "valueOfGoods", "invoice_lines" ], "title": "WtnInvoiceRequest" } }, "responses": { "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } } } } }