github-mirrors/superfaktura-client
1
0
Fork 0
mirror of https://github.com/Eledio/superfaktura-client.git synced 2025-10-31 16:11:20 +01:00
Code Issues Packages Projects Releases 2 Wiki Activity

Deploying to gh-pages from @ eledio-helpers/superfaktura-client@288b19124d 🚀

Browse Source
This commit is contained in:
rici4kubicek
2025-02-28 18:27:11 +00:00
parent 16046c56b2
commit 26694f6987
20 changed files with 29 additions and 666 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
_sources/examples.rst.txt
View File

@@ -1,19 +0,0 @@
Examples of SuperFaktura API client usage
====================
Add Invoice
---------------------------------
.. automodule:: examples.add_invoice
:members:
:undoc-members:
:show-inheritance:
Get country list
------------------------------------
.. automodule:: examples.get_country_list
:members:
:undoc-members:
:show-inheritance:

1
_sources/index.rst.txt
View File

@@ -6,4 +6,3 @@ Welcome to SuperFaktura Client's documentation
superfaktura
installation
examples

158
examples.html
View File

@@ -1,158 +0,0 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Examples of SuperFaktura API client usage &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Installation" href="installation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Examples of SuperFaktura API client usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-examples.add_invoice">Add Invoice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#examples.add_invoice.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-examples.get_country_list">Get country list</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#examples.get_country_list.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Examples of SuperFaktura API client usage</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/examples.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="examples-of-superfaktura-api-client-usage">
<h1>Examples of SuperFaktura API client usage<a class="headerlink" href="#examples-of-superfaktura-api-client-usage" title="Link to this heading"></a></h1>
<section id="module-examples.add_invoice">
<span id="add-invoice"></span><h2>Add Invoice<a class="headerlink" href="#module-examples.add_invoice" title="Link to this heading"></a></h2>
<p>Main script to add an invoice and save it as a PDF using the SuperFaktura API.</p>
<p>This script demonstrates how to create an invoice with multiple items,
retrieve the invoice as a PDF, and save the PDF to a file.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>Run this script directly to create and save an invoice PDF.</p>
</dd>
<dt>Dependencies:</dt><dd><ul class="simple">
<li><p>examples.tools.save_file_as_pdf</p></li>
<li><p>superfaktura.bank_account.BankAccount</p></li>
<li><p>superfaktura.client_contacts.ClientContactModel</p></li>
<li><p>superfaktura.enumerations.currency.Currencies</p></li>
<li><p>superfaktura.enumerations.language.Language</p></li>
<li><p>superfaktura.invoice.Invoice</p></li>
<li><p>superfaktura.invoice.InvoiceModel</p></li>
<li><p>superfaktura.invoice.InvoiceType</p></li>
<li><p>superfaktura.invoice.InvoiceItem</p></li>
<li><p>superfaktura.invoice.InvoiceSettings</p></li>
<li><p>superfaktura.utils.data_types.Date</p></li>
</ul>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="examples.add_invoice.main">
<span class="sig-prename descclassname"><span class="pre">examples.add_invoice.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#examples.add_invoice.main" title="Link to this definition"></a></dt>
<dd><p>Main function to add Invoice and save it as a pdf using the SuperFaktura API.</p>
</dd></dl>
</section>
<section id="module-examples.get_country_list">
<span id="get-country-list"></span><h2>Get country list<a class="headerlink" href="#module-examples.get_country_list" title="Link to this heading"></a></h2>
<p>This script retrieves and prints the list of countries using the SuperFaktura API.</p>
<dl class="py function">
<dt class="sig sig-object py" id="examples.get_country_list.main">
<span class="sig-prename descclassname"><span class="pre">examples.get_country_list.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#examples.get_country_list.main" title="Link to this definition"></a></dt>
<dd><p>Main function to retrieve and print the list of countries using the SuperFaktura API.</p>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

77
genindex.html
View File

@@ -42,7 +42,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -120,8 +119,6 @@
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.as_dict">(superfaktura.invoice.InvoiceItem method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.as_dict">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.as_dict">(superfaktura.invoice.InvoiceModel method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.as_dict">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.as_dict">(superfaktura.invoice.InvoiceSettings method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.as_dict">[1]</a>
</li>
</ul></li>
</ul></td>
@@ -147,8 +144,6 @@
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccount">BankAccount (class in superfaktura.bank_account)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccount">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel">BankAccountModel (class in superfaktura.bank_account)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.bysquare">bysquare (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.bysquare">[1]</a>
</li>
</ul></td>
</tr></table>
@@ -156,8 +151,6 @@
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.callback_payment">callback_payment (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.callback_payment">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.city">city (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.city">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContact">ClientContact (class in superfaktura.client_contacts)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContact">[1]</a>
@@ -172,10 +165,10 @@
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.comment">(superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.comment">[1]</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.constant">constant (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.constant">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.country">country (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.country">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.country_id">country_id (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.country_id">[1]</a>
@@ -259,31 +252,13 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.email">email (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.email">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.error">error (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.error">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.error_message">error_message (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.error_message">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.estimate_id">estimate_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.estimate_id">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.estimate_id">estimate_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.estimate_id">[1]</a>
</li>
<li><a href="superfaktura.enumerations.currency.html#superfaktura.enumerations.currency.Currencies.EUR">EUR (superfaktura.enumerations.currency.Currencies attribute)</a>, <a href="superfaktura.enumerations.html#superfaktura.enumerations.currency.Currencies.EUR">[1]</a>
</li>
<li>
examples.add_invoice
<ul>
<li><a href="examples.html#module-examples.add_invoice">module</a>
</li>
</ul></li>
<li>
examples.get_country_list
<ul>
<li><a href="examples.html#module-examples.get_country_list">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>
@@ -311,8 +286,6 @@
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContact.get_client">get_client() (superfaktura.client_contacts.ClientContact method)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContact.get_client">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.Invoice.get_pdf">get_pdf() (superfaktura.invoice.Invoice method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.Invoice.get_pdf">[1]</a>
</li>
</ul></td>
</tr></table>
@@ -349,24 +322,16 @@
<li><a href="superfaktura.html#superfaktura.invoice.Invoice">Invoice (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.Invoice">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceType.INVOICE">INVOICE (superfaktura.invoice.InvoiceType attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceType.INVOICE">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.invoice_currency">invoice_currency (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.invoice_currency">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.invoice_id">invoice_id (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.invoice_id">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.invoice_no_formatted">invoice_no_formatted (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.invoice_no_formatted">[1]</a>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.invoice_currency">invoice_currency (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.invoice_currency">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.invoice_token">invoice_token (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.invoice_token">[1]</a>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.invoice_no_formatted">invoice_no_formatted (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.invoice_no_formatted">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem">InvoiceItem (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel">InvoiceModel (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel">InvoiceRespModel (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings">InvoiceSettings (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceType">InvoiceType (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceType">[1]</a>
</li>
@@ -386,8 +351,6 @@
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.language">language (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.language">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccount.list">list() (superfaktura.bank_account.BankAccount method)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccount.list">[1]</a>
<ul>
@@ -406,12 +369,6 @@
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="examples.html#examples.add_invoice.main">main() (in module examples.add_invoice)</a>
<ul>
<li><a href="examples.html#examples.get_country_list.main">(in module examples.get_country_list)</a>
</li>
</ul></li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.mark_sent">mark_sent (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.mark_sent">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.mark_sent_message">mark_sent_message (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.mark_sent_message">[1]</a>
@@ -424,10 +381,6 @@
module
<ul>
<li><a href="examples.html#module-examples.add_invoice">examples.add_invoice</a>
</li>
<li><a href="examples.html#module-examples.get_country_list">examples.get_country_list</a>
</li>
<li><a href="superfaktura.bank_account.html#module-superfaktura.bank_account">superfaktura.bank_account</a>, <a href="superfaktura.html#module-superfaktura.bank_account">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#module-superfaktura.client_contacts">superfaktura.client_contacts</a>, <a href="superfaktura.html#module-superfaktura.client_contacts">[1]</a>
@@ -470,10 +423,6 @@
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.online_payment">online_payment (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.online_payment">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.order_no">order_no (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.order_no">[1]</a>
</li>
@@ -486,15 +435,11 @@
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.parent_id">parent_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.parent_id">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.paydate">paydate (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.paydate">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.payment_info">payment_info (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.payment_info">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.payment_type">payment_type (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.payment_type">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.paypal">paypal (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.paypal">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.phone">phone (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.phone">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPI.post">post() (superfaktura.superfaktura_api.SuperFakturaAPI method)</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI.post">[1]</a>
@@ -528,18 +473,12 @@
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.sequence_id">sequence_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.sequence_id">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.show">show (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.show">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.show_prices">show_prices (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.show_prices">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.signature">signature (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.signature">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.sku">sku (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.sku">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.specific">specific (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.specific">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.stock_item_id">stock_item_id (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.stock_item_id">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.summary_bg_color">summary_bg_color (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.summary_bg_color">[1]</a>
</li>
<li>
superfaktura.bank_account
@@ -569,8 +508,6 @@
<li><a href="superfaktura.enumerations.currency.html#module-superfaktura.enumerations.currency">module</a>, <a href="superfaktura.enumerations.html#module-superfaktura.enumerations.currency">[1]</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
superfaktura.invoice
@@ -578,6 +515,8 @@
<li><a href="superfaktura.html#module-superfaktura.invoice">module</a>, <a href="superfaktura.invoice.html#module-superfaktura.invoice">[1]</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
superfaktura.superfaktura_api

6
index.html
View File

@@ -44,7 +44,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -83,11 +82,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#module-examples.add_invoice">Add Invoice</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#module-examples.get_country_list">Get country list</a></li>
</ul>
</li>
</ul>
</div>
</section>

3
installation.html
View File

@@ -19,7 +19,6 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Examples of SuperFaktura API client usage" href="examples.html" />
<link rel="prev" title="SuperFaktura API client" href="superfaktura.html" />
</head>
@@ -45,7 +44,6 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -85,7 +83,6 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="superfaktura.html" class="btn btn-neutral float-left" title="SuperFaktura API client" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="examples.html" class="btn btn-neutral float-right" title="Examples of SuperFaktura API client usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

BIN
objects.inv
View File

Binary file not shown.

41
py-modindex.html
View File

@@ -45,7 +45,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -75,80 +74,60 @@
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-e"><strong>e</strong></a> |
<a href="#cap-s"><strong>s</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-e"><td></td><td>
<strong>e</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<code class="xref">examples</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="examples.html#module-examples.add_invoice"><code class="xref">examples.add_invoice</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="examples.html#module-examples.get_country_list"><code class="xref">examples.get_country_list</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-s"><td></td><td>
<strong>s</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-2" style="display: none" alt="-" /></td>
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<code class="xref">superfaktura</code></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.bank_account.html#module-superfaktura.bank_account"><code class="xref">superfaktura.bank_account</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.client_contacts.html#module-superfaktura.client_contacts"><code class="xref">superfaktura.client_contacts</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.enumerations.html#module-superfaktura.enumerations"><code class="xref">superfaktura.enumerations</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.enumerations.currency.html#module-superfaktura.enumerations.currency"><code class="xref">superfaktura.enumerations.currency</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.invoice.html#module-superfaktura.invoice"><code class="xref">superfaktura.invoice</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.superfaktura_api.html#module-superfaktura.superfaktura_api"><code class="xref">superfaktura.superfaktura_api</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.utils.html#module-superfaktura.utils"><code class="xref">superfaktura.utils</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.utils.country.html#module-superfaktura.utils.country"><code class="xref">superfaktura.utils.country</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.utils.data_types.html#module-superfaktura.utils.data_types"><code class="xref">superfaktura.utils.data_types</code></a></td><td>

1
search.html
View File

@@ -45,7 +45,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long

1
superfaktura.bank_account.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

1
superfaktura.client_contacts.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

1
superfaktura.enumerations.currency.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

1
superfaktura.enumerations.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

200
superfaktura.html
View File

@@ -117,7 +117,6 @@
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.invoice">Invoice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.Invoice"><code class="docutils literal notranslate"><span class="pre">Invoice</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.Invoice.add"><code class="docutils literal notranslate"><span class="pre">Invoice.add()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.Invoice.get_pdf"><code class="docutils literal notranslate"><span class="pre">Invoice.get_pdf()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem"><code class="docutils literal notranslate"><span class="pre">InvoiceItem</span></code></a><ul>
@@ -179,26 +178,6 @@
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.vat_transfer"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.vat_transfer</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.error"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.error</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.error_message"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.error_message</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.invoice_id"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.invoice_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.invoice_token"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.invoice_token</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.as_dict"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.bysquare"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.bysquare</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.callback_payment"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.callback_payment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.language"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.language</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.online_payment"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.online_payment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.payment_info"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.payment_info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.paypal"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.paypal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.show_prices"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.show_prices</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.signature"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.signature</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.summary_bg_color"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.summary_bg_color</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceType"><code class="docutils literal notranslate"><span class="pre">InvoiceType</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceType.INVOICE"><code class="docutils literal notranslate"><span class="pre">InvoiceType.INVOICE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceType.PROFORMA"><code class="docutils literal notranslate"><span class="pre">InvoiceType.PROFORMA</span></code></a></li>
@@ -219,7 +198,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -764,48 +742,8 @@ country_id=57,</p>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings" title="superfaktura.invoice.InvoiceSettings"><span class="pre">InvoiceSettings</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
<dd><p>Adds a new invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>invoice_model</strong> (<a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><em>InvoiceModel</em></a>) – The invoice model.</p></li>
<li><p><strong>items</strong> (<em>List</em><em>[</em><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><em>InvoiceItem</em></a><em>]</em>) – List of invoice items.</p></li>
<li><p><strong>contact</strong> (<a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><em>ClientContactModel</em></a>) – The client contact model.</p></li>
<li><p><strong>invoice_settings</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings" title="superfaktura.invoice.InvoiceSettings"><em>InvoiceSettings</em></a><em>]</em>) – The invoice settings.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The response model for the invoice.
:param invoice_settings:
:param contact:
:param items:
:param invoice_model:</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.get_pdf">
<span class="sig-name descname"><span class="pre">get_pdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cze'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.get_pdf" title="Link to this definition"></a></dt>
<dd><p>Retrieves the PDF of the invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>invoice</strong> (<a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><em>InvoiceRespModel</em></a>) – The response model for the invoice.</p></li>
<li><p><strong>language</strong> (<em>str</em>) – The language for the PDF.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A bytes containing the PDF data.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
<dd><p>Creates a new invoice.</p>
</dd></dl>
</dd></dl>
@@ -1092,140 +1030,12 @@ country_id=57,</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceRespModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents the response model for an invoice in the SuperFaktura API.</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">error</span></span></dt>
<dd><p>The error code.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">error_message</span></span></dt>
<dd><p>The error message.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_id</span></span></dt>
<dd><p>The ID of the invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt>
<dd><p>The token of</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[str]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error">
<span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error_message">
<span class="sig-name descname"><span class="pre">error_message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error_message" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_id">
<span class="sig-name descname"><span class="pre">invoice_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_token">
<span class="sig-name descname"><span class="pre">invoice_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_token" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bysquare</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_payment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">online_payment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payment_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paypal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_prices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary_bg_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents the settings for an invoice in the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the ClientContactModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.bysquare">
<span class="sig-name descname"><span class="pre">bysquare</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.bysquare" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.callback_payment">
<span class="sig-name descname"><span class="pre">callback_payment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.callback_payment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.language">
<span class="sig-name descname"><span class="pre">language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.language" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.online_payment">
<span class="sig-name descname"><span class="pre">online_payment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.online_payment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.payment_info">
<span class="sig-name descname"><span class="pre">payment_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.payment_info" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.paypal">
<span class="sig-name descname"><span class="pre">paypal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.paypal" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.show_prices">
<span class="sig-name descname"><span class="pre">show_prices</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.show_prices" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.signature">
<span class="sig-name descname"><span class="pre">signature</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.signature" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.summary_bg_color">
<span class="sig-name descname"><span class="pre">summary_bg_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.summary_bg_color" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceType</span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceType" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Invoice Type Enumeration.</p>
<p>”
Invoice Type Enumeration.</p>
<p>This enumeration represents the different types of invoices that can be created.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>invoice_type = InvoiceType.PROFORMA</p>
@@ -1277,7 +1087,7 @@ api.post(‘endpoint’, data)</p>
<p>Base class for working with the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFormat</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">DataFormat.JSON</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
<dd><p>Retrieves data from the SuperFaktura API.</p>
<p>Retrieves data from the specified endpoint in the SuperFaktura API.</p>
<dl class="field-list simple">

177
superfaktura.invoice.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -207,48 +206,8 @@ country_id=57,</p>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings" title="superfaktura.invoice.InvoiceSettings"><span class="pre">InvoiceSettings</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
<dd><p>Adds a new invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>invoice_model</strong> (<a class="reference internal" href="#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><em>InvoiceModel</em></a>) – The invoice model.</p></li>
<li><p><strong>items</strong> (<em>List</em><em>[</em><a class="reference internal" href="#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><em>InvoiceItem</em></a><em>]</em>) – List of invoice items.</p></li>
<li><p><strong>contact</strong> (<a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><em>ClientContactModel</em></a>) – The client contact model.</p></li>
<li><p><strong>invoice_settings</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings" title="superfaktura.invoice.InvoiceSettings"><em>InvoiceSettings</em></a><em>]</em>) – The invoice settings.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The response model for the invoice.
:param invoice_settings:
:param contact:
:param items:
:param invoice_model:</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.get_pdf">
<span class="sig-name descname"><span class="pre">get_pdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cze'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.get_pdf" title="Link to this definition"></a></dt>
<dd><p>Retrieves the PDF of the invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>invoice</strong> (<a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><em>InvoiceRespModel</em></a>) – The response model for the invoice.</p></li>
<li><p><strong>language</strong> (<em>str</em>) – The language for the PDF.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A bytes containing the PDF data.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
<dd><p>Creates a new invoice.</p>
</dd></dl>
</dd></dl>
@@ -535,140 +494,12 @@ country_id=57,</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceRespModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents the response model for an invoice in the SuperFaktura API.</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">error</span></span></dt>
<dd><p>The error code.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">error_message</span></span></dt>
<dd><p>The error message.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_id</span></span></dt>
<dd><p>The ID of the invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt>
<dd><p>The token of</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[str]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error">
<span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error_message">
<span class="sig-name descname"><span class="pre">error_message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error_message" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_id">
<span class="sig-name descname"><span class="pre">invoice_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_token">
<span class="sig-name descname"><span class="pre">invoice_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_token" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bysquare</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_payment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">online_payment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payment_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paypal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_prices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary_bg_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents the settings for an invoice in the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the ClientContactModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.bysquare">
<span class="sig-name descname"><span class="pre">bysquare</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.bysquare" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.callback_payment">
<span class="sig-name descname"><span class="pre">callback_payment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.callback_payment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.language">
<span class="sig-name descname"><span class="pre">language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.language" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.online_payment">
<span class="sig-name descname"><span class="pre">online_payment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.online_payment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.payment_info">
<span class="sig-name descname"><span class="pre">payment_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.payment_info" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.paypal">
<span class="sig-name descname"><span class="pre">paypal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.paypal" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.show_prices">
<span class="sig-name descname"><span class="pre">show_prices</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.show_prices" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.signature">
<span class="sig-name descname"><span class="pre">signature</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.signature" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.summary_bg_color">
<span class="sig-name descname"><span class="pre">summary_bg_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.summary_bg_color" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceType</span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceType" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Invoice Type Enumeration.</p>
<p>”
Invoice Type Enumeration.</p>
<p>This enumeration represents the different types of invoices that can be created.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>invoice_type = InvoiceType.PROFORMA</p>

3
superfaktura.superfaktura_api.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
@@ -103,7 +102,7 @@ api.post(‘endpoint’, data)</p>
<p>Base class for working with the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFormat</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">DataFormat.JSON</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
<dd><p>Retrieves data from the SuperFaktura API.</p>
<p>Retrieves data from the specified endpoint in the SuperFaktura API.</p>
<dl class="field-list simple">

1
superfaktura.utils.country.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

1
superfaktura.utils.data_types.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>

1
superfaktura.utils.html
View File

@@ -43,7 +43,6 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>