API (jen pro Fakturačku Premium)

API (Application Programming Interface) Fakturačky slouží k automatickému vytváření faktury.
Např. po objednání zboží ve vašem e-shopu vytvoříte pomocí API proforma fakturu ve Fakturačce,
následně po zaplacení běžnou fakturu.

Parametr Typ Nutný Popis
company text (10)
Vaše firma ve tvaru: {země}{IČ} (např.: CZ01387553).
direction množina ('customer', 'supplier') Směr faktury (customer-odchozí, supplier-příchozí).
type množina ('standard', 'proforma', 'down payment', 'cancellation', 'correction of invoice')
Typ faktury.
standard_invoice text (20) Číslo bězné faktury. Jen pro proforma a zálohovou fakturu.
cancelled_invoice text (20) Číslo stornované faktury. Jen pro stornovací fakturu.
correction_of_invoice text (20) Číslo opravované faktury. Jen pro opravnou fakturu
reason_for_correction text Důvod opravy. Jen pro opravnou fakturu.
description text (255) Popis faktury.
ID text (20) Číslo faktury.
ID_format text (40) Formát čísla faktury (např.: {R}{M}{D}{PPPP}).
order_number text (12) Číslo objednávky.
form_of_payment množina ('bank transfer', 'cash', 'GoPay')
Forma úhrady.
BAN text (16) Číslo bankovního účtu.
BC text (4) Kód banky.
BIC text (8) Mezinárodní kód banky (BIC, SWIFT).
variable_symbol text (10) Variabilní symbol.
constant_symbol text (4) Konstantní symbol.
invoice_date datum Datum vystavení.
time_of_supply datum Datum uskutečnění zdanitelného plnění.
due_date datum Datum splatnosti.
paid logická hodnota Zaplacena.
price číslo Cena faktury. Platí pouze pro příchozí fakturu, která nemá položky či sazby.
rounding číslo Zaokrouhlení
note_before_items text Poznámka před položkami.
note_at_end text Poznámka na konci.
currency množina ('CZK', 'EUR', 'GBP', 'USD') Měna.
language množina ('CZ', 'EN') Jazyk.
automatically_send logická hodnota
Automatické odeslání faktury.
mail_address text (60) E-mailová adresa pro zaslání faktury příjemci.
mail_sender_address text (60) E-mailová adresa odesílatele.
mail_subject text (255) Předmět e-mailu.
mail_body text Tělo e-mailu.
webhook_URL text (255) URL, které bude zavoláno po odeslání faktury. Vhodné především pro e-shopy. Lze tak nastavit stav objednávky v e-shopu či odeslat z e-shopu zprávu o přijaté platbě.

Faktura musí obsahovat partnera s touto strukturou:

Parametr Typ Nutný Popis
name text (60)
Název firmy, případně jméno osoby.
street text (50) Ulice.
land_registry_number text (10)
Číslo domovní.
house_number text (5) Číslo orientační.
postal_code text (5)
PSČ.
city text (50)
Obec.
city_district text (30) Část obce.
country text (50)
Země.
ID text (8) IČ.
tax_ID text (20) DIČ.
VAT_payer logická hodnota Plátce DPH.

Položka (v poli items)

Parametr Typ Nutný Popis
description text (255)
Popis.
quantity číslo Počet.
unit text (30) Jednotka.
price číslo
Cena.
price_type množina ('without VAT', 'with VAT', 'only base') Typ ceny.
VAT_rate číslo Sazba DPH.

Sazba (v poli VAT_rates)

Parametr Typ Nutný Popis
rate číslo
Sazba DPH.
price číslo
Cena.
price_type text ('without VAT', 'with VAT')
Typ ceny.

Ukázka

<?php

header
("Content-Type: text/html; charset=utf-8");

require 
'fakturacka.php';

$fakturacka = new Fakturacka('muj@mejl.cz''heslo');

$data = array(
  
'company' => 'CZ01387553',
  
'direction' => 'customer',
  
'type' => 'standard',
  
'description' => 'Tvorba webových stránek',
  
'form_of_payment' => 'bank transfer',
  
'BAN' => '2300426432',
  
'BC' => '2010',
  
'variable_symbol' => '1709010001',
  
'partner' => array(
    
'name' => 'Microsoft s.r.o.',
    
'street' => 'Vyskočilova',
    
'land_registry_number' => 1461,
    
'house_number' => '2a',
    
'postal_code' => '14000',
    
'city' => 'Praha',
    
'city_district' => 'Michle',
    
'country' => 'Česká republika',
    
'ID' => '47123737',
    
'tax_ID' => 'CZ47123737',
    
'VAT_payer' => true
  
),
  
'invoice_date' => '2017-09-01',
  
'due_date' => '2017-09-15',
  
'items' => array(
    array(
      
'description' => 'Formulář',
      
'quantity' => 80,
      
'unit' => 'h',
      
'price' => 500
    
)
  ),
  
'automatically_send' => true,
);

$fakturacka->create_invoice($data);