mirror of
https://github.com/Eledio/superfaktura-client.git
synced 2025-10-31 16:11:20 +01:00
157 lines
7.3 KiB
HTML
157 lines
7.3 KiB
HTML
|
|
|
|
<!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 — 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>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>© 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> |