Podklady na fakturáciu
Modul pre vytváranie a správu podkladov, z ktorých sa následne generujú faktúry pre klientov. Každý podklad obsahuje informácie o zákazke, položkách a odberateľovi.
Zoznam podkladov
GET /api/accounting-basis
Oprávnenie: AB_DOCUMENT_LIST
Bežní používatelia vidia len svoje podklady. Admini vidia všetky.
Filtre (query parametre):
| Parameter | Typ | Popis |
|---|---|---|
with_invoice |
boolean | Filtrovať podklady s/bez faktúry |
user_uuid |
string (uuid) | Filtrovať podľa autora |
ss |
integer | Filtrovať podľa špecifického symbolu |
is_processed |
boolean | Filtrovať podľa stavu spracovania |
created_at |
string (Y-m) | Filtrovať podľa mesiaca vytvorenia |
service_type |
string | Filtrovať podľa typu služby |
Detail podkladu
GET /api/accounting-basis/{uuid}/detail
Oprávnenie: AB_DOCUMENT_SHOW
Vráti kompletné údaje o podklade vrátane položiek, odmeny a histórie.
Vytvorenie podkladu
POST /api/accounting-basis
Oprávnenie: AB_DOCUMENT_CREATE
Parametre:
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
ico |
string | áno | IČO klienta (8 znakov) |
dic |
number | áno | DIČ klienta (10 číslic) |
ic_dph |
string | nie | IČ DPH (formát: SK + 10 číslic) |
company_name |
string | áno | Názov firmy (max. 100 znakov) |
company_address |
string | áno | Adresa firmy (max. 100 znakov) |
company_place |
string | nie | Miesto podnikania |
order_number |
string | podmienene* | Číslo objednávky |
delivery_at |
string | áno | Dátum dodania (formát: d.m.Y) |
document_delivery_at |
string | áno | Dátum doručenia dokladu (formát: d.m.Y) |
payment_term |
integer | áno | Lehota splatnosti v dňoch (1-100) |
sending_email |
string | áno | Email pre odoslanie faktúry |
signature |
string | nie | Podpis |
is_concept |
boolean | áno | Či ide o koncept (true) alebo finálny dokument (false) |
service_type |
string | áno | Typ služby (z enumu) |
use_yearlong_order_file |
boolean | nie | Použiť celoročnú objednávku z karty klienta |
Položky:
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
items |
array | áno | Zoznam položiek |
items.*.name |
string | áno | Názov položky |
items.*.unit |
string | áno | Jednotka |
items.*.quantity |
number | áno | Množstvo |
items.*.discount |
number | nie | Zľava v percentách |
items.*.price |
number | áno | Cena za jednotku |
Odpočítateľná položka:
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
deductible_item |
object | nie | Odpočítateľná položka |
deductible_item.name |
string | áno | Názov |
deductible_item.unit |
string | áno | Jednotka |
deductible_item.quantity |
number | áno | Množstvo |
deductible_item.price |
number | áno | Cena |
Prílohy (súbory):
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
order_file |
file | podmienene* | Objednávka (max. 25MB) |
service_file |
file | podmienene* | Servisný protokol (max. 25MB) |
course_protocol_file |
file | podmienene* | Protokol o školení (max. 25MB) |
delivery_protocol_file |
file | podmienene* | Dodací protokol (max. 25MB) |
*Povinnosť súborov závisí od toho, či ide o koncept a od nastavenia use_yearlong_order_file.
Úprava podkladu
POST /api/accounting-basis/{uuid}/update
Oprávnenie: AB_DOCUMENT_UPDATE
Parametre sú rovnaké ako pri vytvorení, navyše je možné označiť existujúce súbory na zmazanie pomocou parametrov:
order_file_deleted(boolean)service_file_deleted(boolean)course_protocol_file_deleted(boolean)delivery_protocol_file_deleted(boolean)
Zmena stavu podkladu
PUT /api/accounting-basis/{uuid}/update-status
Oprávnenie: AB_DOCUMENT_STATUS_UPDATE
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
status |
boolean | nie | true = spracovaný, false/null = nespracovaný |
Úprava odmeny na podklade
PUT /api/accounting-basis/{uuid}/update-reward
Oprávnenie: REWARD_UPDATE
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
reward_paid |
boolean | nie | Či bola odmena vyplatená |
reward_amount |
integer | áno | Percento odmeny (0-100) |
Zmazanie podkladu
DELETE /api/accounting-basis/{uuid}
Oprávnenie: AB_DOCUMENT_DELETE
Priradenie faktúry k podkladu
PUT /api/accounting-basis/invoice/{invoice_uuid}/document
Oprávnenie: BASIS_INVOICE_ASSIGN
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
document_uuid |
string (uuid) | áno | UUID podkladu |
Zrušenie faktúry z podkladu
DELETE /api/accounting-basis/{uuid}/document
Oprávnenie: BASIS_INVOICE_CANCEL
Export podkladov do Excelu
POST /api/accounting-basis/export
Oprávnenie: AB_DOCUMENT_EXPORT
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
items |
array | áno | Zoznam UUID podkladov na export |
items.* |
string (uuid) | áno | UUID podkladu |
Odpoveď: Stiahne sa Excel súbor.
Platby v module podkladov
Zoznam platieb
GET /api/accounting-basis/payment
Oprávnenie: AB_DOCUMENT_LIST
| Parameter | Typ | Popis |
|---|---|---|
date_from |
date | Dátum od |
date_to |
date | Dátum do |
Nahranie platobného súboru
POST /api/accounting-basis/upload
Oprávnenie: AB_DOCUMENT_PAYMENT_UPLOAD
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
file |
file | áno | CSV súbor s platbami |
Zoznam používateľov s podkladmi
GET /api/accounting-basis/users
Oprávnenie: AB_DOCUMENT_USER_FILTER
Vráti zoznam používateľov, ktorí majú podklady na fakturáciu (pre filter).
Číselníky
Položky číselníka
GET /api/accounting-basis/enum-items - Zoznam položiek
Oprávnenie: AB_ENUM_ITEM_LIST
POST /api/accounting-basis/enum-items - Vytvorenie položky
Oprávnenie: AB_ENUM_ITEM_CREATE
DELETE /api/accounting-basis/enum-items/{uuid} - Zmazanie položky
Oprávnenie: AB_ENUM_ITEM_DELETE
Jednotky číselníka
GET /api/accounting-basis/enum-units - Zoznam jednotiek
Oprávnenie: AB_ENUM_UNIT_LIST
POST /api/accounting-basis/enum-units - Vytvorenie jednotky
Oprávnenie: AB_ENUM_UNIT_CREATE
PUT /api/accounting-basis/enum-units/{uuid} - Úprava jednotky
Oprávnenie: AB_ENUM_UNIT_UPDATE
DELETE /api/accounting-basis/enum-units/{uuid} - Zmazanie jednotky
Oprávnenie: AB_ENUM_UNIT_DELETE