works/python_ifirma
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Dariusz Aniszewski 2015-06-14 00:20:58 +02:00
parent 33bd9b1e6d
commit c54fbb4da5
1 changed files with 23 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
readme.md
View File

@ -9,7 +9,7 @@ Extremely simple wrapper for iFirma API.
- generating invoice in iFirma service - generating invoice in iFirma service
**Planned** **Very soon**
- downloading invoice PDF - downloading invoice PDF
- generating proforma invoice - generating proforma invoice
@ -30,39 +30,37 @@ iFirma offers [demo account](https://www.ifirma.pl/cgi-bin/WebObjects/ifirma-dem
##Usage ##Usage
#####1. Create instance of iFirmaAPI
1. Create instance of iFirmaAPI
```python ```python
ifirma_client = iFirmaAPI(TEST_IFIRMA_USER, TEST_IFIRMA_INVOICE_KEY, TEST_IFIRMA_USER_KEY) ifirma_client = iFirmaAPI(TEST_IFIRMA_USER, TEST_IFIRMA_INVOICE_KEY, TEST_IFIRMA_USER_KEY)
``` ```
2. Create invoice parameters #####2. Create invoice parameters
```python ```python
client = Client(
"Dariusz Aniszewski's Company", # company name
"PL1231231212", # Tax ID
Address(
"Otwock", # City
"00-000" # Zip code
),
email="email@server.com",
)
client = Client( position = Position(
"Dariusz", VAT.VAT_23, # VAT rate
"1231231212", 1, # Quantity
Address( 1000, # Unit price
"Warszawa", "nazwa", # Position name
"03-185" "szt" # Position unit
), )
email="email@server.com",
)
position = Position(
VAT.VAT_23,
1,
1000,
"nazwa",
"szt"
)
``` ```
3. Create invoice in iFirma service and get it's id
#####3. Create invoice in iFirma service and get it's id
```python ```python
invoice = NewInvoiceParams(client, [position]) invoice = NewInvoiceParams(client, [position])
invoice_id = ifirma_client.generate_invoice(invoice) invoice_id = ifirma_client.generate_invoice(invoice)
``` ```
That's all folks In near futore you can use `invoice_id` to perform other actions like downloading PDF or getting details.
**That's all folks**