Api Fakturowni

Dzięki API system fakturownia można łatwo zintegrować z innymi aplikacjami. W przykładach podajemy wywołania za pomocą narzędzia CURL, które można łatwo zastąpić wywołaniem dowolnego języka programowania.

Jeśli do Waszej integracji potrzebne będą dodatkowe funkcje wywoływane przez API to prosimy o kontakt - postaramy się szybko je dodać.

Wszystkie przykłady działają z JSON lub XML (wystarczy zmienić rozszerzenie xml na json). Wszystkie wywołania API działają z SSL, warto więc w wersji produkcyjnej zamienić HTTP na HTTPS.

Faktury

Pobranie wszystkich faktur z danego okresu

pobranie faktur z aktualnego miesiąca:

XML curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/invoices.xml?period=this_month JSON curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/invoices.json?period=this_month można przekazywać takie same parametry jakie są przekazywane w aplikacji (na stronie listy faktur)

Pobranie wybranej faktury po ID

XML curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/invoices/100.xml JSON curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/invoices/100.json

Pobranie faktury o Id zamówienia

XML curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/invoices?oid=nr_zam JSON curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/invoices?oid=nr_zam

Dodanie nowej faktury

JSON (zalecany)

curl http://twojaDomena.fakturownia.pl/invoices.json 
	-u 'login:twoje-haslo' 
	-H 'Accept: application/json'  
	-H 'Content-Type: application/json'  
	-d '{"invoice": {
			"kind":"vat", 
			"number": null, 
			"sell_date": "2012-05-17", 
			"issue_date": "2012-05-17", 
			"payment_to": "2012-05-24",
			"seller_name": "Wystawca Sp. z o.o.", 
			"seller_tax_no": "5252445767", 
			"buyer_name": "Klient1 Sp. z o.o.",
			"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":3}
			]
	    }}'

pobierz kod...

XML

curl http://twojaDomena.fakturownia.pl/invoices.xml 
	-u 'login:twoje-haslo' 
	-H 'Accept: application/xml'  
	-H 'Content-Type: application/xml'  
	-d '<invoice>
			<kind>vat</kind>
			<sell_date>2012-05-17</sell_date>
			<issue_date>2012-05-17</issue_date>
			<payment_to>2012-05-24</payment_to>
			<seller_name>Wystawca Sp. z o.o.</seller_name>
			<seller_tax_no>5252445767</seller_tax_no>
			<buyer_name>Klient1 Sp. z o.o.</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>'

pobierz kod...

Produkty / usługi

Wszystkie produkty

curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/products.xml

Pobranie wybranego produktu po ID

curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/products/100.xml

Widget

Aby pobrać formatkę płatności (w postaci JS) należy wywołać URL:

http://app.fakturownia.dev/a/twojaDomena/p/{{token}}.js

gdzie {{token}} to wartość pola token z danego produktu

Klienci

Wszyscy klienci

curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/clients.xml

Pobranie wybranego klienta po ID

curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/clients/100.xml

Pobranie klienta po e-mailu/haśle

jest to przydatne jeśli w fakturowni masz aktywny panel Twoich klientów, gdzie klienci mogą się logować podając swój e-mail/hasło curl -u 'login:twoje-haslo' "http://twojaDomena.fakturownia.pl/clients/check?email=marcin@email.com&password=haslo_przykladowe" uwaga: ważne objęcie url-a w apostrofy

Płatności

Wszystkie płatności

XML curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/payments.xml JSON curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/payments.json

Pobranie wybranej płatności po ID

XML curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/payments/100.xml JSON curl -u 'login:twoje-haslo' http://twojaDomena.fakturownia.pl/payment/100.json

Dodawanie nowej płatności

JSON (zalecany)

curl http://twojaDomena.fakturownia.pl/payments.json 
	-u 'login:twoje-haslo' 
	-H 'Accept: application/json'  
	-H 'Content-Type: application/json'  
	-d '{"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
	    }}'

pobierz kod...