API BitFaktury

Díky rozhraní API lze BitFakturu snadno integrovat s jinými aplikacemi. V níže uvedených příkladech používáme nástroj CURL - snadno jej můžete změnit na libovolný programovací jazyk.

Kontaktujte nás pokud chcete další funkci rozhraní API - zkusíme je rychle přidat.

Všechny příklady pracují raké s JSON (jednoduše změňte rozšíření z xml na json)

POZNÁMKA: kompletní dokumentace je na stránce GitHub: https://github.com/InvoiceOcean/api

API token

Token API je nutné stáhnout z nastavení aplikace ("Nastavení -> Nastavení účtu -> Integrace -> Autorizační kód API")

Faktury

stáhnutí všech faktur za dané období

stáhnutí faktur z aktualního měsíce:

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.json?period=this_month&api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.xml?period=this_month&api_token=API_TOKEN" Můžete předat stejné parametry, které byly předány v aplikaci (na seznamu faktur)

Stažení vybrané faktury podle ID

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100.json?api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100.xml?api_token=API_TOKEN"

Stáhnout fakturu ve formátu PDF

curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100.pdf?api_token=API_TOKEN"

Zaslat fakturu klientovi e-mailem

JSON curl -X POST "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100/send_by_email.json?api_token=API_TOKEN" XML curl -X POST "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100/send_by_email.xml?api_token=API_TOKEN"

Stáhnout fakturu podle OID

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.json?oid=nr_zam&api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.xml?oid=nr_zam&api_token=API_TOKEN"

Stahování faktur podle ID dokladu, který byl vygenerován na jejich základě

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.json?invoice_id=id&api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.xml?invoice_id=id&api_token=API_TOKEN"

Stahování faktur podle ID dokladu, na jehož základě byly vygenerovány

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.json?from_invoice_id=id&api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/invoices.xml?from_invoice_id=id&api_token=API_TOKEN"

Přidání nové faktury

JSON (doporučený)

JSON (doporučený)

curl https://YOUR_DOMAIN.bitfaktura.cz/invoices.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "invoice": { "kind":"vat", "number": null, "sell_date": "2019-11-15", "issue_date": "2019-11-15", "payment_to": "2019-11-22", "seller_name": "Seller SA", "seller_tax_no": "5252445767", "buyer_name": "Client1 SA", "buyer_tax_no": "5252445767", "positions":[ {"name":"Produkt A1", "tax":23, "total_price_gross":10.23, "quantity":1}, {"name":"Produkt A2", "tax":0, "total_price_gross":50, "quantity":2} ] }}' stáhnout kód CURL


S údaji výchozího oddělení : curl https://YOUR_DOMAIN.bitfaktura.cz/invoices.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "invoice": { "kind":"vat", "number": null, "sell_date": "2019-11-15", "issue_date": "2019-11-15", "payment_to": "2019-11-22", "buyer_name": "Client1 SA", "buyer_tax_no": "5252445767", "positions":[ {"name":"Produkt A1", "tax":23, "total_price_gross":10.23, "quantity":1}, {"name":"Produkt A2", "tax":0, "total_price_gross":50, "quantity":2} ] }}' stáhnout kód CURL


XML

curl https://YOUR_DOMAIN.bitfaktura.cz/invoices.xml \ -u 'login:YOUR_PASSWORD' \ -H 'Accept: application/xml' \ -H 'Content-Type: application/xml' \ -d '<invoice> <kind>vat</kind> <sell_date>2019-11-15</sell_date> <issue_date>2019-11-15</issue_date> <payment_to>2019-11-22</payment_to> <seller_name>Seller SA</seller_name> <seller_tax_no>5252445767</seller_tax_no> <buyer_name>Client1 SA</buyer_name> <buyer_tax_no>5252445767</buyer_tax_no> <positions> <position> <name>Produkt X1</name> <tax>23</tax> <total_price_gross>20</total_price_gross> <quantity>1</quantity> </position> <position> <name>Produkt X2</name> <tax>0</tax> <total_price_gross>10</total_price_gross> <quantity>3</quantity> </position> </positions> </invoice>' stáhnout kód CURL

Příklad v Ruby

endpoint = 'https://YOUR_DOMAIN.bitfaktura.cz/invoices.json' uri = URI.parse(endpoint) json_params = { "api_token" => "API_TOKEN", "invoice" => { "kind" =>"vat", "number" => nil, "sell_date" => "2019-11-15", "issue_date" => "2019-11-15", "payment_to" => "2019-11-22", "buyer_name" => "Client1 SA", "buyer_tax_no" => "5252445767", "positions" =>[ {"name" =>"Produkt A1", "tax" =>23, "total_price_gross" =>10.23, "quantity" =>1}, {"name" =>"Produkt A2", "tax" =>0, "total_price_gross" =>50, "quantity" =>2} ] }} request = Net::HTTP::Post.new(uri.path) request.body = JSON.generate(json_params) request["Content-Type"] = "application/json" http = Net::HTTP.new(uri.host, uri.port) response = http.start {|h| h.request(request)} if response.code == '201' ret = JSON.parse(response.body) else ret = response.body end puts ret.to_json stáhnout kód Ruby



Javascript / Ajax jQuery

json_params = { "api_token": "API_TOKEN", "invoice": { "kind":"vat", "number": null, "sell_date": "2019-11-15", "issue_date": "2019-11-15", "payment_to": "2019-11-22", "buyer_name": "Client1 SA", "buyer_tax_no": "5252445767", "positions":[ {"name":"Produkt A1", "tax":23, "total_price_gross":10.23, "quantity":1}, {"name":"Produkt A2", "tax":0, "total_price_gross":50, "quantity":2} ] }} //alert(JSON.stringify(json_params)) endpoint = 'https://YOUR_DOMAIN.bitfaktura.cz/invoices.json' $.ajax({ type: "POST", url: endpoint, data: json_params, dataType: 'json', success: function(data) { alert('invoice created! ' + data['number'])}, }); stáhnout kód JavaScript

Přidat fakturu s procentní slevou

UPOZORNĚNÍ: před vystavením je potřeba zkontrolovat, zda v poli Nastavení účtu: "Jak vypočítat slevu" je nastaveno "procento z ceny netto za jednotku" curl https://YOUR_DOMAIN.bitfaktura.cz/invoices.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "invoice": { "kind":"vat", "number": null, "sell_date": "2019-11-15", "issue_date": "2019-11-15", "payment_to": "2019-11-22", "seller_name": "Seller SA", "seller_tax_no": "5252445767", "buyer_name": "Client1 SA", "buyer_tax_no": "5252445767", "show_discount": true, "discount_kind": "percent_unit", "positions":[ {"name":"Produkt A1", "tax":23, "total_price_gross":10.23, "quantity":1, "discount_percent": 50}, {"name":"Produkt A2", "tax":0, "total_price_gross":50, "quantity":2, "discount_percent": 10} ] }}' stáhnout kód CURL


Přidání faktury se slevou

UPOZORNĚNÍ: před vydáním je třeba zkontrolovat, zda v poli Nastavení účtu "Jak vypočítat slevu" je nastaveno na "částku"
curl https://YOUR_DOMAIN.bitfaktura.cz/invoices.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "invoice": { "kind":"vat", "number": null, "sell_date": "2019-11-15", "issue_date": "2019-11-15", "payment_to": "2019-11-22", "seller_name": "Seller SA", "seller_tax_no": "5252445767", "buyer_name": "Client1 SA", "buyer_tax_no": "5252445767", "show_discount": true, "discount_kind": "amount", "positions":[ {"name":"Produkt A1", "tax":23, "total_price_gross":10.23, "quantity":1, "discount": 5}, {"name":"Produkt A2", "tax":0, "total_price_gross":50, "quantity":2, "discount": 25} ] }}' stáhnout kód CURL

Přidání faktury pro existujícího zákazníka a produktu

Máte-li ID zákazníka (client_id), dodavatele (department_id) nebo produkt (product_id), nemusíte převádět více dat. Faktura bude vystavena v daném dni s pětidenní splatností.
curl https://YOUR_DOMAIN.bitfaktura.cz/invoices.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "invoice": { "payment_to_kind": 5, "department_id": 222, "client_id": 111, "positions":[ {"product_id": 333, "quantity":2} ] }}' stáhnout kód CURL

Aktualizace faktury


curl https://YOUR_DOMAIN.bitfaktura.cz/invoices/444.json \ -X PUT \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "invoice": { "buyer_name": "New buyer name SA" }}' stáhnout kód CURL


Odstranění faktury

JSON curl -X DELETE "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100.json?api_token=API_TOKEN" XML curl -X DELETE "https://YOUR_DOMAIN.bitfaktura.cz/invoices/100.xml?api_token=API_TOKEN"



Skladové doklady


Všechny skladové doklady


JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents.json?api_token=API_TOKEN" Můžete předat stejné parametry, které byly předány v aplikaci (na seznamu faktur)


Stažení vybraného dokladu podle ID

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents/555.json?api_token=API_TOKEN"


Přidat příjmový skladový doklad



JSON

curl https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "warehouse_document": { "kind":"pz", "number": null, "warehouse_id": "1", "issue_date": "2019-11-15", "department_name": "Department1 SA", "client_name": "Client1 SA", "warehouse_actions":[ {"product_name":"Produkt A1", "purchase_tax":23, "purchase_price_net":10.23, "quantity":1}, {"product_name":"Produkt A2", "purchase_tax":0, "purchase_price_net":50, "quantity":2} ] }}' stáhnout kód CURL


Přidat výdajový skladový doklad



JSON

curl https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "warehouse_document": { "kind":"wz", "number": null, "warehouse_id": "1", "issue_date": "2019-11-15", "department_name": "Department1 SA", "client_name": "Client1 SA", "warehouse_actions":[ {"product_id":"333", "tax":23, "price_net":10.23, "quantity":1}, {"product_id":"333", "tax":0, "price_net":50, "quantity":2} ] }}' stáhnout kód CURL


Přidání skladového dokladu PZ pro existujícího zákazníka, oddělení a výrobek

Pro nastavení výchozího oddělení vynechejte klíč: department_id (a department_name)

JSON

curl https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "warehouse_document": { "kind":"pz", "number": null, "warehouse_id": "1", "issue_date": "2019-11-15", "department_id": "222", "client_id": "111", "warehouse_actions":[ {"product_id":"333", "purchase_tax":23, "price_net":10.23, "quantity":1}, {"product_id":"333", "purchase_tax":0, "price_net":50, "quantity":2} ] }}' stáhnout kód CURL


Aktualizace dokladu


curl https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents/555.json \ -X PUT \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "warehouse_document": { "client_name": "New client name SA" }}' stáhnout kód CURL


Odstranění dokladu

JSON curl -X DELETE "https://YOUR_DOMAIN.bitfaktura.cz/warehouse_documents/100.json?api_token=API_TOKEN"





Produkty / služby

Všechny produkty

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/products.json?api_token=API_TOKEN&page=1" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/products.xml?api_token=API_TOKEN&page=1"

Stažení daného výrobku podle ID

curl "https://YOUR_DOMAIN.bitfaktura.cz/products/100.xml?api_token=API_TOKEN"

Přidání výrobku


curl https://YOUR_DOMAIN.bitfaktura.cz/products.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "product": { "name": "PoroductAA", "code": "A001", "price_net": "100", "tax": "23" }}' stáhnout kód CURL

Aktualizace výrobku


curl https://YOUR_DOMAIN.bitfaktura.cz/products/333.json \ -X PUT \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "product": { "name": "PoroductAA2", "code": "A0012", "price_gross": "102" }}' stáhnout kód CURL

Widget

Chcete-li stáhnout formát platby (ve formátu JS), zadejte adresu URL:

http://app.bitfaktura.cz/a/YOUR_DOMAIN/p/{{token}}.js

kde {{token}} je hodnotou pole tokenu z daného produktu



Zákazníci

Všichni klienti

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/clients.json?api_token=API_TOKEN&page=1" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/clients.xml?api_token=API_TOKEN&page=1"

Vyberte klienta pomocí jeho ID

curl "https://YOUR_DOMAIN.bitfaktura.cz/clients/100.xml?api_token=API_TOKEN"

Stažení vybraného záazníka podle externího ID

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/clients.json?external_id=100&api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/clients.xml?external_id=100&api_token=API_TOKEN"

Přidání klienta


curl https://YOUR_DOMAIN.bitfaktura.cz/clients.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "client": { "name": "Client1", "tax_no": "5252445767", "bank" : "bank1", "bank_account" : "bank_account1", "city" : "city1", "country" : "", "email" : "example@email.com", "person" : "person1", "post_code" : "post-code1", "phone" : "phone1", "street" : "street1", "street_no" : "street-no1" }}' stáhnout kód CURL

Aktualizace klienta

curl https://YOUR_DOMAIN.bitfaktura.cz/clients/111.json \ -X PUT \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{"api_token": "API_TOKEN", "client": { "name": "Klient2", "tax_no": "52524457672", "bank" : "bank2", "bank_account" : "bank_account2", "city" : "city2", "country" : "PL", "email" : "example2@email.com", "person" : "person2", "post_code" : "post-code2", "phone" : "phone2", "street" : "street2", "street_no" : "street-no2" }}' stáhnout kód CURL




Platby

Všechny platby


JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/banking/payments.json?api_token=API_TOKEN"
XML curl "https://YOUR_DOMAIN.bitfaktura.cz/banking/payments.xml?api_token=API_TOKEN"

Stažení dané platby podle ID


JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/banking/payment/100.json?api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/banking/payments/100.xml?api_token=API_TOKEN"

Přidání nové platby

minimal JSON (doporučený) curl https://YOUR_DOMAIN.bitfaktura.cz/banking/payments.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "banking_payment": { "name":"Payment 001", "price": 100.05, "invoice_id": null, "paid":true, "kind": "api" }}' stáhnout kód CURL
full JSON (doporučený) curl https://YOUR_DOMAIN.bitfaktura.cz/banking/payments.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "banking_payment": { "city": null, "client_id":null, "comment":null, "country":null, "currency":"PLN", "deleted":false, "department_id":null, "description":"abonament roczny", "email":"email@email.pl", "first_name":"Jan", "generate_invoice":true, "invoice_city":"Warszawa", "invoice_comment":"", "invoice_country":null, "invoice_id":null, "invoice_name":"Company name", "invoice_post_code":"00-112", "invoice_street":"street 52", "invoice_tax_no":"5252445767", "last_name":"Kowalski", "name":"Plantnosc za produkt1", "oid":"", "paid":true, "paid_date":null, "phone":null, "post_code":null, "price":"100.00", "product_id":1, "promocode":"", "provider":"transfer", "provider_response":null, "provider_status":null, "provider_title":null, "quantity":1, "street":null, "kind": "api" }}' stáhnout kód CURL



Systemové účty

Vytvoření nového účtu

JSON (doporučený) curl https://YOUR_DOMAIN.bitfaktura.cz/account.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "account": { "prefix": "prefix1" }, "user": { "login": "login1", "email": "email1@email.pl", "password": "password1", "from_partner": "PARTNER_CODE" }, "company": { "name": "Company1", "tax_no": "5252445700", "post_code": "00-112", "city": "Warsaw", "street": "Street 1/10", "person": "Jan Nowak", "bank": "Bank1", "bank_account": "111222333444555666111" } }' stáhnout kód CURL

More examples: https://github.com/fakturownia/api


Získejte informace o uživateli (spolu s přístupovým kódem API)

JSON (doporučený) curl https://app.bitfaktura.cz/login.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "login": "login_or_email1", "password": "password1" }' stáhnout kód CURL


Získejte informace o účtu

XML curl "https://YOUR_DOMAIN.bitfaktura.cz/account.xml?api_token=API_TOKEN" JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/account.json?api_token=API_TOKEN"



More examples: https://github.com/fakturownia/api



Kategorie

Vytvoření nové kategorie

JSON (doporučený) curl https://YOUR_DOMAIN.bitfaktura.cz/categories.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "category": { "name": "my_category", "description": null } }' stáhnout kód CURL


Seznam kategorií

XML curl "https://YOUR_DOMAIN.bitfaktura.cz/categories.xml?api_token=API_TOKEN" JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/categories.json?api_token=API_TOKEN"



Stažení informací o jednotlivé kategorii pro ID

XML curl "https://YOUR_DOMAIN.bitfaktura.cz/categories/100.xml?api_token=API_TOKEN" JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/categories/100.json?api_token=API_TOKEN"



More examples: https://github.com/fakturownia/api



Sklady

Vytvoření nového skladu

JSON (doporučený) curl https://YOUR_DOMAIN.bitfaktura.cz/warehouses.json \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "api_token": "API_TOKEN", "warehouse": { "name": "my_warehouse", "kind": null, "description": null } }' stáhnout kód CURL


Stažení seznamu skladů

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/warehouses.json?api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/warehouses.xml?api_token=API_TOKEN"



Stažení informací o skladu podle ID

JSON curl "https://YOUR_DOMAIN.bitfaktura.cz/warehouses/100.json?api_token=API_TOKEN" XML curl "https://YOUR_DOMAIN.bitfaktura.cz/warehouses/100.xml?api_token=API_TOKEN"



More examples: https://github.com/fakturownia/api