REST API dokumentácia :: TopFaktúra.sk

REST API dokumentácia

Funkcia show customers Funkcia show customers Funkcia show stock items Funkcia show invoices Funkcia create invoice Funkcia delete invoice Funkcia show proforma invoices Funkcia create proforma invoice Funkcia delete proforma invoice Funkcia show credit notes Funkcia show quotations Funkcia create quotation Funkcia delete quotation

Funkcia zobrazí všetkých zákazníkov spoločnosti.

Status response:

Typ	Popis
success	zákazníci boli zobrazení
error1	nevyplnené API kľúče
error2	nesprávne API kľúče
error	chyba je zobrazená v popise

Data response:

Názov	Formát	Popis
id	integer	ID zákazníka v systéme
customer	string	zákazník
ico	string	IČO zákazníka
dic	integer	DIČ zákazníka
ic_dph	string	IČ DPH zákazníka
address	text	Adresa zákazníka
delivery_address	text	Dodacia adresa zákazníka

show customers show customers show stock items show invoices create invoice delete invoice show proforma invoices create proforma invoice delete proforma invoice show credit notes show quotations create quotation delete quotation

$fields_string = null;

$time = time();
$method = 'POST';
$path = '/customers/show';
$api = 'https://api.topfaktura.sk';
$apiKey = 'YOUR_API_KEY';
$secret = 'YOUR_SECRET_KEY';
$string = $api.$path;
$signature = hash_hmac('sha256', $string, $secret);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, sprintf('%s:%s', $api, $path));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, $apiKey.':'.$signature);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Date: '.gmdate('Ymd\THis\Z', $time),
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);

return $response;

Názov	Formát	Popis
id	integer	ID skladovej položky v systéme
code	string	Kód skladovej položky
name	string	Názov skladovej položky
position	string	Pozícia na sklade
description	text	Popis skladovej položky
type	string	Typ skladovej položky
quantity	integer/double	Aktuálne množstvo na sklade
unit	string	Merná jednotka skladovej položky
sell_price	double	Predajná cena skladovej položky
dph	integer	DPH skladovej položky ⁽¹⁾
vlastna_produkcia	boolean	Položka je vlastnou produkciou
as_service	boolean	Položka ponúkaná ako služba

Názov	Formát	Popis
invoice_id	integer	ID faktúry
invoice_no	string	číslo faktúry
order_sheet_no	string	číslo objednávky
pd_number	string	číslo príjmového dokladu
payment_method	integer	forma úhrady 1 - prevodom na účet 2 - hotovosť 3 - kartou 4 - na dobierku 5 - zápočtom 6 - zálohou
invoice_date	date	dátum vystavenia faktúry
due_date	date	dátum splatnosti faktúry
delivery_date	date	dátum dodania faktúry
variable_symbol	integer	variabilný symbol
constant_symbol	integer	konštantný symbol
specific_symbol	integer	špecifický symbol
customer	string	zákazník
address	text	adresa zákazníka
delivery_address	text	dodacia adresa zákazníka
ico	integer	IČO zákazníka
dic	integer	DIČ zákazníka
ic_dph	string	IČ DPH zákazníka
invoice_text	text	text faktúry
author	string	autor faktúry
status	integer	status faktúry 0 - uhradená 1 - čakajúca na úhradu 2 - čiastočne uhradená 3 - po splatnosti 4 - nebude uhradená 5 - preplatená
as_delivery_note	boolean	faktúra slúži ako dodací list
as_warranty_note	boolean	faktúra slúži ako záručný list
send_by_email	boolean	faktúra bola odoslaná emailom
send_by_post	boolean	faktúra bola odoslaná poštou
send_by_sms	boolean	faktúra bola odoslaná prostredníctvom SMS
price	double	cena faktúry
total_price	double	celková cena faktúry ⁽¹⁾
price_eur	double	cena faktúry v domácej mene ⁽²⁾
total_price_eur	double	celková cena faktúry v domácej mene ⁽¹⁾ ⁽²⁾
currency	string	platobná mena EUR - euro (€) CZK - česká koruna (Kč) PLN - Poľský zloty (Zł) GBP - Britská libra (£) USD - Americký dolár ($) CHF - Švajčiarsky frank (Fr) HUF - Maďarský forint (Ft)

Typ	Popis
note	dodatočná informácia
odoslanie_email	výsledok odoslania faktúry emailom
odoslanie_sms	výsledok odoslania faktúry prostredníctvom SMS
odoslanie_posta	výsledok odoslania faktúry poštou

Názov	Formát	Popis
order_sheet_no	string	číslo objednávky ⁽¹⁾
payment_method	integer	spôsob úhrady 1 - prevodom na účet 2 - hotovosť 3 - kartou 4 - na dobierku 5 - zápočtom 6 - zálohou
delivery_method	integer	spôsob dodania ⁽¹⁾ 1 - poštou 2 - kuriérom 3 - osobný odber 4 - nákladná doprava 5 - odberné miesto
due_date	integer	dátum splatnosti (počet dní od vystavenia faktúry)
delivery_date	integer	dátum dodania 1 - rovnaký ako dátum vystavenia 2 - posledný deň predchádzajúceho mesiaca 3 - posledný deň tohto mesiaca 4 - prvý deň nasledujúceho mesiaca
variable_symbol	string	variabilný symbol ⁽¹⁾
constant_symbol	string	konštantný symbol ⁽¹⁾
specific_symbol	string	špecifický symbol ⁽¹⁾
customer[id]	integer	ID zákazníka ⁽¹⁾
customer[name]	string	zákazník ⁽²⁾
customer[street]	string	ulica ⁽²⁾
customer[city]	string	mesto ⁽²⁾
customer[zipcode]	string	PSČ ⁽²⁾
customer[state]	string	štát ^(1) (2)
customer[delivery_address]	text	dodacia adresa zákazníka ⁽¹⁾
customer[ico]	string	IČO zákazníka ⁽¹⁾
customer[dic]	integer	DIČ zákazníka ⁽¹⁾
customer[ic_dph]	string	IČ DPH zákazníka ⁽¹⁾
invoice_text	text	text faktúry ⁽¹⁾
intern_note	text	interná poznámka k faktúre ⁽¹⁾
status	integer	status úhrady ⁽¹⁾ 1 - čakajuca na úhradu 2 - uhradená
sluzba_mimo_sr	boolean	fakturujem službu mimo SR ⁽¹⁾
tovar_mimo_sr	boolean	fakturujem tovar mimo SR ⁽¹⁾
as_delivery	boolean	faktúra slúži ako dodací list ⁽¹⁾
as_warranty	boolean	faktúra slúži ako záručný list ⁽¹⁾
currency	string	platobná mena faktúry ⁽¹⁾ EUR - euro (€) CZK - česká koruna (Kč) PLN - Poľský zloty (Zł) GBP - Britská libra (£) USD - Americký dolár ($) CHF - Švajčiarsky frank (Fr) HUF - Maďarský forint (Ft)
send_by_email	boolean	ihneď po vystavení odoslať faktúru emailom ⁽¹⁾
send_by_sms	boolean	ihneď po vystavení odoslať faktúru prostredníctvom SMS ⁽¹⁾
send_by_post	boolean	po vystavení odoslať faktúru poštou ⁽¹⁾
sms_number	integer	telefónne číslo zákazníka (pr.: 900123456) odosiela iba na SK čísla ⁽¹⁾
post_email	string	emailová adresa, na ktorú bude odoslaná faktúra ⁽¹⁾
language	string	jazyk v akom bude faktúra odoslaná emailom ⁽¹⁾
items[model]	string	názov skladovej položky ⁽³⁾
items[unit]	string	merná jednotka položky ⁽³⁾
items[quantity]	integer/double	fakturované množstvo
items[unit_price]	double	jednotková cena položky ⁽³⁾
items[description]	text	popis položky ⁽³⁾
items[dph]	integer	DPH položky ⁽¹⁾
items[product_discount]	integer/double	hodnota zľavy na skladovú položku ⁽¹⁾
items[discount_type]	integer	typ zľavy na položku ⁽¹⁾ 0 - zľava v % 1 - zľava v sume
items[stock_item_no]	string	číslo skladovej položky ⁽¹⁾

Názov	Formát	Popis
invoice_id	integer	ID faktúry
invoice_no	string	číslo faktúry
order_sheet_no	string	číslo objednávky
payment_method	integer	forma úhrady 1 - prevodom na účet 2 - hotovosť 3 - kartou 4 - na dobierku 5 - zápočtom 6 - zálohou
invoice_date	date	dátum vystavenia faktúry
due_date	date	dátum splatnosti faktúry
delivery_date	date	dátum dodania faktúry
variable_symbol	integer	variabilný symbol
constant_symbol	integer	konštantný symbol
specific_symbol	integer	špecifický symbol
customer	string	zákazník
address	text	adresa zákazníka
delivery_address	text	dodacia adresa zákazníka
ico	integer	IČO zákazníka
dic	integer	DIČ zákazníka
ic_dph	string	IČ DPH zákazníka
invoice_text	text	text faktúry
author	string	autor faktúry
status	integer	status faktúry 0 - uhradená 1 - čakajúca na úhradu 2 - čiastočne uhradená 3 - po splatnosti 4 - nebude uhradená 5 - preplatená
as_delivery_note	boolean	faktúra slúži ako dodací list
send_by_email	boolean	faktúra bola odoslaná emailom
price	double	cena faktúry
total_price	double	celková cena faktúry ⁽¹⁾
price_eur	double	cena faktúry v domácej mene ⁽²⁾
total_price_eur	double	celková cena faktúry v domácej mene ⁽¹⁾ ⁽²⁾
currency	string	platobná mena EUR - euro (€) CZK - česká koruna (Kč) PLN - Poľský zloty (Zł) GBP - Britská libra (£) USD - Americký dolár ($) CHF - Švajčiarsky frank (Fr) HUF - Maďarský forint (Ft)

Názov	Formát	Popis
cenová ponuka	integer	ID cenovej ponuky