Deploying to gh-pages from @ Eledio/superfaktura-client@30f0e36643 🚀

This commit is contained in:
rici4kubicek
2025-03-03 19:46:18 +00:00
parent 12db5ff3ed
commit 6d1807c4b0
5 changed files with 185 additions and 205 deletions

File diff suppressed because one or more lines are too long

View File

@@ -89,16 +89,18 @@ It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<li><p>(none)</p></li> <li><p>(none)</p></li>
</ul> </ul>
</dd> </dd>
<dt>Usage:</dt><dd><p>import superfaktura.bank_account</p> <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">superfaktura.bank_account</span>
<p># Create an instance of BankAccount <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an instance of BankAccount</span>
bank = superfaktura.bank_account.BankAccount()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span> <span class="o">=</span> <span class="n">superfaktura</span><span class="o">.</span><span class="n">bank_account</span><span class="o">.</span><span class="n">BankAccount</span><span class="p">()</span>
<p># Retrieve a list of bank accounts <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Retrieve a list of bank accounts</span>
accounts = bank.list()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">accounts</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
<p># Get the default bank account <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Get the default bank account</span>
default_account = bank.default()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">default_account</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">default</span><span class="p">()</span>
<p># Create or update a bank account <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create or update a bank account</span>
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True} <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;account&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;bank_code&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
bank.post(data)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</dd> </dd>
</dl> </dl>
<dl class="py class"> <dl class="py class">
@@ -126,12 +128,14 @@ It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<dd><p>Creates or updates a bank account.</p> <dd><p>Creates or updates a bank account.</p>
</dd></dl> </dd></dl>
<dl class="simple"> <dl>
<dt>Usage:</dt><dd><p>bank = BankAccount() <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span> <span class="o">=</span> <span class="n">BankAccount</span><span class="p">()</span>
accounts = bank.list() <span class="gp">&gt;&gt;&gt; </span><span class="n">accounts</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
default_account = bank.default() <span class="gp">&gt;&gt;&gt; </span><span class="n">default_account</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">default</span><span class="p">()</span>
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True} <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;account&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;bank_code&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
bank.post(data)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</dd> </dd>
</dl> </dl>
<dl class="py method"> <dl class="py method">

View File

@@ -267,16 +267,18 @@ It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<li><p>(none)</p></li> <li><p>(none)</p></li>
</ul> </ul>
</dd> </dd>
<dt>Usage:</dt><dd><p>import superfaktura.bank_account</p> <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">superfaktura.bank_account</span>
<p># Create an instance of BankAccount <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an instance of BankAccount</span>
bank = superfaktura.bank_account.BankAccount()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span> <span class="o">=</span> <span class="n">superfaktura</span><span class="o">.</span><span class="n">bank_account</span><span class="o">.</span><span class="n">BankAccount</span><span class="p">()</span>
<p># Retrieve a list of bank accounts <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Retrieve a list of bank accounts</span>
accounts = bank.list()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">accounts</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
<p># Get the default bank account <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Get the default bank account</span>
default_account = bank.default()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">default_account</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">default</span><span class="p">()</span>
<p># Create or update a bank account <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create or update a bank account</span>
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True} <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;account&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;bank_code&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
bank.post(data)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</dd> </dd>
</dl> </dl>
<dl class="py class"> <dl class="py class">
@@ -304,12 +306,14 @@ It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<dd><p>Creates or updates a bank account.</p> <dd><p>Creates or updates a bank account.</p>
</dd></dl> </dd></dl>
<dl class="simple"> <dl>
<dt>Usage:</dt><dd><p>bank = BankAccount() <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span> <span class="o">=</span> <span class="n">BankAccount</span><span class="p">()</span>
accounts = bank.list() <span class="gp">&gt;&gt;&gt; </span><span class="n">accounts</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">list</span><span class="p">()</span>
default_account = bank.default() <span class="gp">&gt;&gt;&gt; </span><span class="n">default_account</span> <span class="o">=</span> <span class="n">bank</span><span class="o">.</span><span class="n">default</span><span class="p">()</span>
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True} <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;account&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;bank_code&quot;</span><span class="p">:</span> <span class="s2">&quot;1234567890&quot;</span><span class="p">,</span> <span class="s2">&quot;default&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
bank.post(data)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">bank</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</dd> </dd>
</dl> </dl>
<dl class="py method"> <dl class="py method">
@@ -647,48 +651,39 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
<li><p>(none)</p></li> <li><p>(none)</p></li>
</ul> </ul>
</dd> </dd>
<dt>Usage:</dt><dd><p>import superfaktura.invoice</p> <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">superfaktura.invoice</span>
<p># Create an instance of Invoice <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an instance of Invoice</span>
invoice = superfaktura.invoice.Invoice()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">superfaktura</span><span class="o">.</span><span class="n">invoice</span><span class="o">.</span><span class="n">Invoice</span><span class="p">()</span>
<p># Create an invoice <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an invoice</span>
invoice.add(</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
<blockquote> <span class="go"> invoice_model=InvoiceModel(</span>
<div><dl class="simple"> <span class="go"> type=InvoiceType.INVOICE,</span>
<dt>invoice=superfaktura.invoice.InvoiceModel(</dt><dd><p>type=superfaktura.invoice.InvoiceType.PROFORMA, <span class="go"> name=&quot;My First Invoice&quot;,</span>
name=”Invoice 3”, <span class="go"> due=Date(&quot;2025-04-01&quot;),</span>
due=superfaktura.invoice.Date(“2025-02-01”), <span class="go"> invoice_currency=Currencies.EUR,</span>
invoice_currency=superfaktura.invoice.Currencies.CZK, <span class="go"> header_comment=&quot;We invoice you for services&quot;,</span>
header_comment=”We invoice you for services”, <span class="go"> bank_accounts=[bank.default().as_dict()],</span>
bank_accounts=[bank.default().as_dict()],</p> <span class="go"> ),</span>
</dd> <span class="go"> items=[</span>
</dl> <span class="go"> InvoiceItem(</span>
<p>), <span class="go"> name=&quot;Website Development&quot;, unit_price=1000.0, quantity=1, tax=20</span>
items=[</p> <span class="go"> ),</span>
<blockquote> <span class="go"> InvoiceItem(</span>
<div><dl class="simple"> <span class="go"> name=&quot;Hosting Service (1 year)&quot;, unit_price=500.0, quantity=1, tax=20</span>
<dt>superfaktura.invoice.InvoiceItem(name=”Services”, unit_price=100, quantity=1,</dt><dd><p>unit=”ks”, tax=21),</p> <span class="go"> ),</span>
</dd> <span class="go"> ],</span>
<dt>superfaktura.invoice.InvoiceItem(name=”SIM card”, unit_price=50, quantity=1,</dt><dd><p>tax=21, unit=”ks”),</p> <span class="go"> contact=ClientContactModel(</span>
</dd> <span class="go"> name=&quot;John Doe&quot;,</span>
<dt>superfaktura.invoice.InvoiceItem(</dt><dd><p>name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”</p> <span class="go"> email=&quot;john.doe@examle.com&quot;,</span>
</dd> <span class="go"> phone=&quot;+1 555-1234&quot;,</span>
</dl> <span class="go"> address=&quot;123 Main Street, New York&quot;,</span>
<p>),</p> <span class="go"> ico=&quot;987654321&quot;,</span>
</div></blockquote> <span class="go"> update=True,</span>
<p>], <span class="go"> country_id=225,</span>
contact=superfaktura.client_contacts.ClientContactModel(</p> <span class="go"> ),</span>
<blockquote> <span class="go">)</span>
<div><p>name=”Richard Kubíček”, </pre></div>
email=”<a class="reference external" href="mailto:kubicekr&#37;&#52;&#48;eledio&#46;com">kubicekr<span>&#64;</span>eledio<span>&#46;</span>com</a>”, </div>
phone=”+420 123 456 789”,
address=”Jaroslava Foglara 861/1”,
ico=”123”,
update=True,
country_id=57,</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>)</p>
</dd> </dd>
</dl> </dl>
<dl class="py class"> <dl class="py class">
@@ -723,43 +718,36 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
</dd></dl> </dd></dl>
<dl> <dl>
<dt>Usage:</dt><dd><p>invoice = Invoice() <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">Invoice</span><span class="p">()</span>
invoice.add(</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
<blockquote> <span class="go"> invoice_model=InvoiceModel(</span>
<div><dl class="simple"> <span class="go"> type=InvoiceType.INVOICE,</span>
<dt>invoice=InvoiceModel(</dt><dd><p>type=InvoiceType.PROFORMA, <span class="go"> name=&quot;My First Invoice&quot;,</span>
name=”Invoice 3”, <span class="go"> due=Date(&quot;2025-04-01&quot;),</span>
due=Date(“2025-02-01”), <span class="go"> invoice_currency=Currencies.EUR,</span>
invoice_currency=Currencies.CZK, <span class="go"> header_comment=&quot;We invoice you for services&quot;,</span>
header_comment=”We invoice you for services”, <span class="go"> bank_accounts=[bank.default().as_dict()],</span>
bank_accounts=[bank.default().as_dict()],</p> <span class="go"> ),</span>
</dd> <span class="go"> items=[</span>
</dl> <span class="go"> InvoiceItem(</span>
<p>), <span class="go"> name=&quot;Website Development&quot;, unit_price=1000.0, quantity=1, tax=20</span>
items=[</p> <span class="go"> ),</span>
<blockquote> <span class="go"> InvoiceItem(</span>
<div><p>InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21), <span class="go"> name=&quot;Hosting Service (1 year)&quot;, unit_price=500.0, quantity=1, tax=20</span>
InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”), <span class="go"> ),</span>
InvoiceItem(</p> <span class="go"> ],</span>
<blockquote> <span class="go"> contact=ClientContactModel(</span>
<div><p>name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”</p> <span class="go"> name=&quot;John Doe&quot;,</span>
</div></blockquote> <span class="go"> email=&quot;john.doe@examle.com&quot;,</span>
<p>),</p> <span class="go"> phone=&quot;+1 555-1234&quot;,</span>
</div></blockquote> <span class="go"> address=&quot;123 Main Street, New York&quot;,</span>
<p>], <span class="go"> ico=&quot;987654321&quot;,</span>
contact=ClientContactModel(</p> <span class="go"> update=True,</span>
<blockquote> <span class="go"> country_id=225,</span>
<div><p>name=”Richard Kubíček”, <span class="go"> ),</span>
email=”<a class="reference external" href="mailto:kubicekr&#37;&#52;&#48;eledio&#46;com">kubicekr<span>&#64;</span>eledio<span>&#46;</span>com</a>”, <span class="go">)</span>
phone=”+420 123 456 789”, </pre></div>
address=”Jaroslava Foglara 861/1”, </div>
ico=”123”,
update=True,
country_id=57,</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>)</p>
</dd> </dd>
</dl> </dl>
<dl class="py method"> <dl class="py method">
@@ -1261,13 +1249,15 @@ It allows for reading, creating, updating, and deleting data in SuperFaktura.</p
<li><p>post: Creates or updates data in the SuperFaktura API.</p></li> <li><p>post: Creates or updates data in the SuperFaktura API.</p></li>
</ul> </ul>
</dd> </dd>
<dt>Usage:</dt><dd><p>import superfaktura.superfaktura_api</p> <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">superfaktura.superfaktura_api</span>
<p># Create an instance of SuperFakturaAPI <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an instance of SuperFakturaAPI</span>
api = superfaktura.superfaktura_api.SuperFakturaAPI()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">api</span> <span class="o">=</span> <span class="n">superfaktura</span><span class="o">.</span><span class="n">superfaktura_api</span><span class="o">.</span><span class="n">SuperFakturaAPI</span><span class="p">()</span>
<p># Retrieve data from the SuperFaktura API <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Retrieve data from the SuperFaktura API</span>
data = api.get(endpoint)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">incoming_data</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;endpoint&#39;</span><span class="p">)</span>
<p># Create or update data in the SuperFaktura API <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create or update data in the SuperFaktura API</span>
api.post(endpoint, data)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">&#39;endpoint&#39;</span><span class="p">,</span> <span class="n">outgoing_data</span><span class="p">)</span>
</pre></div>
</div>
</dd> </dd>
</dl> </dl>
<dl class="py class"> <dl class="py class">

View File

@@ -90,48 +90,39 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
<li><p>(none)</p></li> <li><p>(none)</p></li>
</ul> </ul>
</dd> </dd>
<dt>Usage:</dt><dd><p>import superfaktura.invoice</p> <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">superfaktura.invoice</span>
<p># Create an instance of Invoice <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an instance of Invoice</span>
invoice = superfaktura.invoice.Invoice()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">superfaktura</span><span class="o">.</span><span class="n">invoice</span><span class="o">.</span><span class="n">Invoice</span><span class="p">()</span>
<p># Create an invoice <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an invoice</span>
invoice.add(</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
<blockquote> <span class="go"> invoice_model=InvoiceModel(</span>
<div><dl class="simple"> <span class="go"> type=InvoiceType.INVOICE,</span>
<dt>invoice=superfaktura.invoice.InvoiceModel(</dt><dd><p>type=superfaktura.invoice.InvoiceType.PROFORMA, <span class="go"> name=&quot;My First Invoice&quot;,</span>
name=”Invoice 3”, <span class="go"> due=Date(&quot;2025-04-01&quot;),</span>
due=superfaktura.invoice.Date(“2025-02-01”), <span class="go"> invoice_currency=Currencies.EUR,</span>
invoice_currency=superfaktura.invoice.Currencies.CZK, <span class="go"> header_comment=&quot;We invoice you for services&quot;,</span>
header_comment=”We invoice you for services”, <span class="go"> bank_accounts=[bank.default().as_dict()],</span>
bank_accounts=[bank.default().as_dict()],</p> <span class="go"> ),</span>
</dd> <span class="go"> items=[</span>
</dl> <span class="go"> InvoiceItem(</span>
<p>), <span class="go"> name=&quot;Website Development&quot;, unit_price=1000.0, quantity=1, tax=20</span>
items=[</p> <span class="go"> ),</span>
<blockquote> <span class="go"> InvoiceItem(</span>
<div><dl class="simple"> <span class="go"> name=&quot;Hosting Service (1 year)&quot;, unit_price=500.0, quantity=1, tax=20</span>
<dt>superfaktura.invoice.InvoiceItem(name=”Services”, unit_price=100, quantity=1,</dt><dd><p>unit=”ks”, tax=21),</p> <span class="go"> ),</span>
</dd> <span class="go"> ],</span>
<dt>superfaktura.invoice.InvoiceItem(name=”SIM card”, unit_price=50, quantity=1,</dt><dd><p>tax=21, unit=”ks”),</p> <span class="go"> contact=ClientContactModel(</span>
</dd> <span class="go"> name=&quot;John Doe&quot;,</span>
<dt>superfaktura.invoice.InvoiceItem(</dt><dd><p>name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”</p> <span class="go"> email=&quot;john.doe@examle.com&quot;,</span>
</dd> <span class="go"> phone=&quot;+1 555-1234&quot;,</span>
</dl> <span class="go"> address=&quot;123 Main Street, New York&quot;,</span>
<p>),</p> <span class="go"> ico=&quot;987654321&quot;,</span>
</div></blockquote> <span class="go"> update=True,</span>
<p>], <span class="go"> country_id=225,</span>
contact=superfaktura.client_contacts.ClientContactModel(</p> <span class="go"> ),</span>
<blockquote> <span class="go">)</span>
<div><p>name=”Richard Kubíček”, </pre></div>
email=”<a class="reference external" href="mailto:kubicekr&#37;&#52;&#48;eledio&#46;com">kubicekr<span>&#64;</span>eledio<span>&#46;</span>com</a>”, </div>
phone=”+420 123 456 789”,
address=”Jaroslava Foglara 861/1”,
ico=”123”,
update=True,
country_id=57,</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>)</p>
</dd> </dd>
</dl> </dl>
<dl class="py class"> <dl class="py class">
@@ -166,43 +157,36 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
</dd></dl> </dd></dl>
<dl> <dl>
<dt>Usage:</dt><dd><p>invoice = Invoice() <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">Invoice</span><span class="p">()</span>
invoice.add(</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
<blockquote> <span class="go"> invoice_model=InvoiceModel(</span>
<div><dl class="simple"> <span class="go"> type=InvoiceType.INVOICE,</span>
<dt>invoice=InvoiceModel(</dt><dd><p>type=InvoiceType.PROFORMA, <span class="go"> name=&quot;My First Invoice&quot;,</span>
name=”Invoice 3”, <span class="go"> due=Date(&quot;2025-04-01&quot;),</span>
due=Date(“2025-02-01”), <span class="go"> invoice_currency=Currencies.EUR,</span>
invoice_currency=Currencies.CZK, <span class="go"> header_comment=&quot;We invoice you for services&quot;,</span>
header_comment=”We invoice you for services”, <span class="go"> bank_accounts=[bank.default().as_dict()],</span>
bank_accounts=[bank.default().as_dict()],</p> <span class="go"> ),</span>
</dd> <span class="go"> items=[</span>
</dl> <span class="go"> InvoiceItem(</span>
<p>), <span class="go"> name=&quot;Website Development&quot;, unit_price=1000.0, quantity=1, tax=20</span>
items=[</p> <span class="go"> ),</span>
<blockquote> <span class="go"> InvoiceItem(</span>
<div><p>InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21), <span class="go"> name=&quot;Hosting Service (1 year)&quot;, unit_price=500.0, quantity=1, tax=20</span>
InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”), <span class="go"> ),</span>
InvoiceItem(</p> <span class="go"> ],</span>
<blockquote> <span class="go"> contact=ClientContactModel(</span>
<div><p>name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”</p> <span class="go"> name=&quot;John Doe&quot;,</span>
</div></blockquote> <span class="go"> email=&quot;john.doe@examle.com&quot;,</span>
<p>),</p> <span class="go"> phone=&quot;+1 555-1234&quot;,</span>
</div></blockquote> <span class="go"> address=&quot;123 Main Street, New York&quot;,</span>
<p>], <span class="go"> ico=&quot;987654321&quot;,</span>
contact=ClientContactModel(</p> <span class="go"> update=True,</span>
<blockquote> <span class="go"> country_id=225,</span>
<div><p>name=”Richard Kubíček”, <span class="go"> ),</span>
email=”<a class="reference external" href="mailto:kubicekr&#37;&#52;&#48;eledio&#46;com">kubicekr<span>&#64;</span>eledio<span>&#46;</span>com</a>”, <span class="go">)</span>
phone=”+420 123 456 789”, </pre></div>
address=”Jaroslava Foglara 861/1”, </div>
ico=”123”,
update=True,
country_id=57,</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>)</p>
</dd> </dd>
</dl> </dl>
<dl class="py method"> <dl class="py method">

View File

@@ -87,13 +87,15 @@ It allows for reading, creating, updating, and deleting data in SuperFaktura.</p
<li><p>post: Creates or updates data in the SuperFaktura API.</p></li> <li><p>post: Creates or updates data in the SuperFaktura API.</p></li>
</ul> </ul>
</dd> </dd>
<dt>Usage:</dt><dd><p>import superfaktura.superfaktura_api</p> <dt>Usage:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">superfaktura.superfaktura_api</span>
<p># Create an instance of SuperFakturaAPI <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create an instance of SuperFakturaAPI</span>
api = superfaktura.superfaktura_api.SuperFakturaAPI()</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">api</span> <span class="o">=</span> <span class="n">superfaktura</span><span class="o">.</span><span class="n">superfaktura_api</span><span class="o">.</span><span class="n">SuperFakturaAPI</span><span class="p">()</span>
<p># Retrieve data from the SuperFaktura API <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Retrieve data from the SuperFaktura API</span>
data = api.get(endpoint)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">incoming_data</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;endpoint&#39;</span><span class="p">)</span>
<p># Create or update data in the SuperFaktura API <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Create or update data in the SuperFaktura API</span>
api.post(endpoint, data)</p> <span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">&#39;endpoint&#39;</span><span class="p">,</span> <span class="n">outgoing_data</span><span class="p">)</span>
</pre></div>
</div>
</dd> </dd>
</dl> </dl>
<dl class="py class"> <dl class="py class">