PHPackages                             rshop/superfaktura - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. rshop/superfaktura

ActiveLibrary

rshop/superfaktura
==================

Superfaktura API client

v1.0.1(11y ago)428MITPHP

Since Jan 30Pushed 10y ago1 watchersCompare

[ Source](https://github.com/riesenia/superfaktura)[ Packagist](https://packagist.org/packages/rshop/superfaktura)[ RSS](/packages/rshop-superfaktura/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (3)Used By (0)

Superfaktura API PHP klient
===========================

[](#superfaktura-api-php-klient)

[![Latest Version](https://camo.githubusercontent.com/9ca311871680f3d49f035950d2551f005a8af08ed74e0ac04d647d3782e25cdc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7273686f702f737570657266616b747572612e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/rshop/superfaktura)[![Total Downloads](https://camo.githubusercontent.com/640d04420252e2202a462561e848db46aeead0efb50890899e70d9fde6de5efd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7273686f702f737570657266616b747572612e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/rshop/superfaktura)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)

PHP klient k API rozhraniu online ekonomického systému [SuperFaktúra](http://www.superfaktura.sk/o-nas/).

Inštalácia
----------

[](#inštalácia)

Jednoducho cez command line: `composer require rshop/superfaktura`

Alebo pridaním do *composer.json*:

```
{
    "require": {
        "rshop/superfaktura": "~1.0"
    }
}
```

Úvodom
------

[](#úvodom)

Jednotlivé entity je možné vytvárať prostredníctvom triedy Superfaktura.

```
use Rshop\Synchronization\Superfaktura;

$superfaktura = new Superfaktura('EMAIL', 'API_KEY');
```

Vytvorenie faktúry
------------------

[](#vytvorenie-faktúry)

Novú faktúru je možné vytvoriť metódou *createInvoice*.

```
$invoice = $superfaktura->createInvoice([
    'name' => 'Názov faktúry',
    'invoice_no_formatted' => '12345'
]);

// parametre je možné nastaviť aj zadaním požadovaného atribútu
$invoice['already_paid'] = true;
```

Dostupné atribúty:

- **already\_paid** - bola už faktúra uhradená? *true/false*
- **created** - dátum vystavenia
- **comment** - komentár
- **constant** - konštantný symbol
- **delivery** - dátum dodania
- **delivery\_type** - spôsob dodania, číselník hodnôt
- **deposit** - uhradená záloha
- **discount** - zľava v %
- **due** - dátum splatnosti
- **estimate\_id** - ID cenovej ponuky, na základe ktorej je faktúra vystavená
- **header\_comment** - text nad položkami faktúry
- **internal\_comment** - interná poznánka, nezobrazuje sa klientovi
- **invoice\_currency** - mena, v ktorej je faktúra vystavená. Možnosti: *EUR, USD, GBP, HUF, CZK, PLN, CHF, RUB*
- **invoice\_no\_formatted** - číslo faktúry
- **issued\_by** - faktúru vystavil
- **issued\_by\_phone** - faktúru vystavil telefón
- **issued\_by\_email** - faktúru vystavil email
- **name** - názov faktúry
- **payment\_type** - spôsob úhrady, číselník hodnôt
- **proforma\_id** - ID proforma faktúry, na základe ktorej sa vystavuje ostrá faktúra (ostrá faktúra tak preberie údaje o uhradenej zálohe)
- **rounding** - spôsob zaokrúhľovania DPH: *document* - za celý dokument, *item* - po položkaćh (predvolená hodnota)
- **specific** - špecifický symbol
- **sequence\_id** - ID číselníka
- **tax\_document** - jedná sa o daňový doklad k prijatej platbe? *true/false*
- **type** - typ faktúry: *regular* - bežná faktúra, *proforma* - zálohová faktúra, *cancel* - dobropis, *estimate* - cenová ponuka, *order* - prijatá objednávka
- **variable** - variabilný symbol

### Nastavenie zákazníka

[](#nastavenie-zákazníka)

Zákazníka na faktúru je možné pridať metódou *setClient*.

```
$invoice->setClient([
    'name' => 'Meno zákazníka'
]);

// parametre je možné nastaviť aj zadaním požadovaného atribútu
$client = $invoice->getClient();
$client['city'] = 'Mesto';
```

Dostupné atribúty:

- **address** - adresa
- **bank\_account** - bankový účet
- **city** - mesto
- **comment** - komentár
- **country\_id** - ID krajiny, číselník krajín
- **country** - vlastný názov krajiny
- **delivery\_address** - dodacia adresa
- **delivery\_city** - dodacie mesto
- **delivery\_country** - vlastná dodacia krajina
- **delivery\_country\_id** - ID dodacej krajiny
- **delivery\_name** - názov klienta pre dodanie
- **delivery\_zip** - dodacie PSČ
- **dic** - DIČ
- **email** - email
- **fax** - fax
- **ic\_dph** - IČ DPH
- **ico** - IČO
- **name** - názov klienta
- **phone** - telefón
- **zip** - PSČ

### Pridanie položky

[](#pridanie-položky)

Položku na faktúru je možné pridať metódou *addItem*.

```
$invoice->addItem([
    'name' => 'Názov položky',
    'quantity' => 1,
    'unit_price' => 40.83,
    'tax' => 20
]);
```

Dostupné atribúty:

- **name** - názov položky
- **description** - popis
- **quantity** - množstvo
- **unit** - jednotka
- **unit\_price** - cena bez DPH
- **tax** - sadzba DPH v %
- **stock\_item\_id** - ID skladovej polozky
- **sku** - skladove oznacenie

### Uloženie

[](#uloženie)

```
try {
    $invoice->save();

    // $invoice obsahuje všetky parametre uloženej faktúry
    var_dump($invoice['token'], $invoice->getSummary());
}
catch (Exception $e) {
    // chyby, ktoré nastali pri komunikácii, je možné získať metódou getErrors
    var_dump($e->getErrors());
}
```

Získanie existujúcej faktúry
----------------------------

[](#získanie-existujúcej-faktúry)

Existujúcu faktúru je možné stiahnuť prostredníctvom jej ID metódou *getInvoice*.

```
$invoice = $superfaktura->getInvoice(616575);
```

### Editácia faktúry

[](#editácia-faktúry)

Pri editácii načítanej faktúry je možné postupovať rovnako, ako pri vytváraní novej.

```
// zmena variabilného symbolu faktúry
$invoice['variable'] = '12345';

// pridanie položky
$invoice->addItem([
    'name' => 'Názov pridávanej položky',
    'quantity' => 2,
    'unit_price' => 5.11,
    'tax' => 20
]);

try {
    $invoice->save();

    // $invoice obsahuje všetky parametre uloženej faktúry
    var_dump($invoice['token'], $invoice->getSummary());
}
catch (Exception $e) {
    // chyby, ktoré nastali pri komunikácii, je možné získať metódou getErrors
    var_dump($e->getErrors());
}
```

### Označenie faktúry ako odoslanej

[](#označenie-faktúry-ako-odoslanej)

Označenie metódou *markAsSent*. Užitočné, pokiaľ vytvorené faktúry odosielate vlastným systémom, avšak chcete toto odoslanie evidovať aj v SuperFaktúre.

```
$invoice->markAsSent([
    'email' => 'email@zakaznika.sk'
]);
```

Dostupné atribúty:

- **email** - mailová adresa, kam bola faktúra odoslaná
- **subject** - predmet emailu
- **body** - text emailu

### Odoslanie faktúry emailom

[](#odoslanie-faktúry-emailom)

Odoslanie metódou *sendByEmail*. Nenastavené atribúty sa nastavia automaticky podľa nastavení v SuperFaktúre.

```
$invoice->sendByEmail([
    'to' => 'email@zakaznika.sk'
]);
```

Dostupné atribúty:

- **to** - na akú emailovú adresu sa má faktúra odoslať (povinné)
- **cc** - otvorená kópia (*array*)
- **bcc** - skrytá kópia (*array*)
- **subject** - predmet emailu
- **body** - text emailu

### Zaplatenie faktúry

[](#zaplatenie-faktúry)

Pridanie úhrady k faktúre metódou *pay*.

```
$invoice->pay([
    amount' => 10.34
]);
```

Dostupné atribúty:

- **amount** - uhradená suma (povinné)
- **currency** - mena úhrady, predvolené EUR
- **date** - dátum úhrady, predvolený aktuálny dátum
- **payment\_type** - spôsob úhrady, predvolený typ transfer, možné hodnoty *cash, transfer, credit, paypal, cod*

### Získanie linky k PDF

[](#získanie-linky-k-pdf)

Adresu, na ktorej je možné stiahnuť PDF faktúru, je možné získať metódou *getPdf*.

```
$invoice->getPdf();
```

### Zmazanie faktúry

[](#zmazanie-faktúry)

Odstránenie faktúry je možné metódou *delete*.

```
$invoice->delete();
```

Spustenie testov
----------------

[](#spustenie-testov)

Pre testovanie je potrebné najprv skopírovať súbor *TestConfig.php.tpl* na *TestConfig.php* a vyplniť testovací *email* a *API kľúč*. Následne cez command line:

```
$ cd path/to/rshop/superfaktura
$ composer install
$ vendor/bin/phpspec run

```

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

2

Last Release

4117d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/40c7ed7cfaebeddae57ac4a376c8f21df56dd2f38821b7ba92ea1312ef8020c8?d=identicon)[riesenia](/maintainers/riesenia)

---

Top Contributors

[![segy](https://avatars.githubusercontent.com/u/1355459?v=4)](https://github.com/segy "segy (6 commits)")[![newPOPE](https://avatars.githubusercontent.com/u/484382?v=4)](https://github.com/newPOPE "newPOPE (1 commits)")

### Embed Badge

![Health badge](/badges/rshop-superfaktura/health.svg)

```
[![Health](https://phpackages.com/badges/rshop-superfaktura/health.svg)](https://phpackages.com/packages/rshop-superfaktura)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k21](/packages/neuron-core-neuron-ai)[guanguans/notify

Push notification SDK(AnPush、Bark、Chanify、DingTalk、Discord、Gitter、GoogleChat、IGot、Lark、Mattermost、MicrosoftTeams、NowPush、Ntfy、Push、Pushback、PushBullet、PushDeer、PushMe、Pushover、PushPlus、QQ、RocketChat、ServerChan、ShowdocPush、SimplePush、Slack、Telegram、WeWork、WPush、XiZhi、YiFengChuanHua、ZohoCliq、ZohoCliqWebHook、Zulip).

682104.9k7](/packages/guanguans-notify)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)