Download the PHP package superfaktura/apiclient without Composer

On this page you can find all versions of the php package superfaktura/apiclient. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of superfaktura/apiclient

Informations about the package apiclient

SuperFaktúra PHP API Client 2

Overview

The SuperFaktúra API enables the integration of external applications, allowing the remote creation of documents and retrieval of data about them. It also enables the sending of invoices via email or regular mail.

Requirements

To use this package, you will need at least PHP 8.2.

Quickstart

In order to make it easier to integrate your application with SuperFaktúra, we've prepared a simple API client for you, which allows you to issue your invoices remotely with minimal effort.

However, if you wish to create your own API client, we also provide general documentation.

If you want to try out API integration, we have a testing environment (sandbox) for Slovak and Czech market available for you.

Installation

Simply run this composer command:

Examples

Starting with API

To use this API client, you need to first:

1. Create an account in SuperFaktúra

As an alternative, you can authorize through .env configuration.

3. Usage

Error handling

Use cases samples

Bank accounts

1. BankAccounts::getAll

Returns list of bank accounts.

For more information check API documentation.

2. BankAccounts::create

Creates a bank account and returns its data

For more information check API documentation.

3. BankAccounts::update

Updates an existing bank account and returns its data.

For more information check API documentation.

4. BankAccounts::delete

Deletes an existing bank account.

For more information check API documentation.

Cash registers

Returns list of cash registers.

1. CashRegisters::getAll

For more information check API documentation.

2. CashRegisters::getById

Returns details of cash register.

For more information check API documentation.

Cash register items

1. CashRegister\Items::create

Creates a new cash register item and returns its data.

For more information check API documentation.

Clients

1. Clients::getAll

Returns list of clients filtered by given query object.

For more information check API documentation.

2. Clients::getById

Returns details of client.

For more information check API documentation.

3. Clients::create

Creates a client record and returns its data.

For more information check API documentation.

4. Clients::update

Updates an existing client record and returns its data.

For more information check API documentation.

5. Clients::delete

Deletes an existing client.

For more information check API documentation.

Client's contact people

1. Client\Contact\Contacts::getAllByClientId

Returns list of contact people for a given client id.

For more information check API documentation.

2. Client\Contact\Contacts::create

Creates a contact person and returns its data.

For more information check API documentation.

3. Client\Contact\Contacts::delete

Deletes an existing contact person.

For more information check API documentation.

Countries

1. Countries::getAll

Returns list of available countries.

For more information check API documentation.

Expenses

1. Expenses::getAll

Returns list of expenses filtered by given query object.

For more information check API documentation.

2. Expenses::getById

Returns details of expense.

For more information check API documentation.

3. Expenses::getAllCategories

Returns available expense categories.

For more information check API documentation.

4. Expenses::create

Creates an expense and returns its data.

For more information check API documentation.

5. Expenses::update

Updates an existing expense and returns its data.

For more information check API documentation.

6. Expenses::delete

Deletes an existing expense.

For more information check API documentation.

Expense payments

1. Expense\Payment\Payments:create

Creates a new expense payment and returns its data.

For more information check API documentation.

2. Expense\Payment\Payments:delete

Deletes an existing expense payment.

For more information check API documentation.

Invoices

1. Invoices::getById

Returns details of invoice.

For more information check API documentation.

2. Invoices::getByIds

Returns details of multiple invoices.

For more information check API documentation.

3. Invoices::getAll

Returns list of invoices filtered by given query object.

For more information check API documentation.

4. Invoices::downloadPdf

Returns PDF export of invoice.

For more information check API documentation.

5. Invoices::create

Creates an invoice and returns its data.

For more information check API documentation.

6. Invoices::update

Updates an existing invoice and returns its data.

For more information check API documentation.

7. Invoices::delete

Deletes an existing invoice.

For more information check API documentation.

8. Invoices::changeLanguage

Changes language on an existing invoice.

For more information check API documentation.

9. Invoices::markAsSent

Toggles invoice mark as sent status.

For more information check API documentation.

10. Invoices::markAsSentViaEmail

Marks invoice as sent via email.

For more information check API documentation.

11. Invoices::sendViaEmail

Sends invoice via email.

For more information check API documentation.

12. Invoices::sendViaPostOffice

For more information check API documentation.

Invoice\Items

1. Invoice\Item::delete

Deletes invoice items with given ids.

For more information check API documentation.

Invoice\Payments

1. Invoice\Payment::markAsUnPayable

Marks invoice as "will not be paid".

For more information check API documentation.

2. Invoice\Payment::create

Adds payment to invoice.

For more information check API documentation.

3. Invoice\Payment::delete

Deletes payment from invoice.

For more information check API documentation.

Related documents

1. RelatedDocuments::link

Adds link between two documents.

For more information check API documentation.

2. RelatedDocuments::unlink

Removes link between two documents.

For more information check API documentation.

Exports

1. Exports::exportInvoices

Export multiple invoices with possible configuration.

2. Exports::getStatus

Returns progress of the export.

3. Exports::download

Download completed export.

Stock items

1. Stock\Items::create

Creates a new stock item.

For more information check API documentation.

2. Stock\Items::getById

Returns details of stock item.

For more information check API documentation.

3. Stock\Items::getAll

Returns list of stock items filtered by given query object.

For more information check API documentation.

4. Stock\Items::update

Updates an existing stock item.

For more information check API documentation.

5. Stock\Items::delete

Deletes an existing stock item.

For more information check API documentation.

Stock movements

1. Stock\Movements::create

Creates multiple stock logs for an existing stock item id.

For more information check API documentation.

2. Stock\Movements::createWithSku

Creates multiple stock logs for an existing stock item SKU.

For more information check API documentation.

Tag

1. Tags::getAll

Returns list of tags.

For more information check API documentation.

2. Tags::create

Creates a tag and returns its data

For more information check API documentation.

3. Tags::update

Updates an existing tag and returns its data.

For more information check API documentation.

4. Tags::delete

Deletes an existing tag.

For more information check API documentation.

Enumerations

Authorization with .env file

1. Create .env file:

And then use in your code:

All versions of apiclient with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
ext-json Version *
ext-zip Version *
ext-mbstring Version *
symfony/dotenv Version ^6.4
guzzlehttp/guzzle Version ^7.8
fig/http-message-util Version ^1.1
guzzlehttp/psr7 Version ^2.6
psr/http-factory Version ^1.0
psr/http-message Version ^2.0
psr/http-client Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package superfaktura/apiclient contains the following files

Loading the files please wait ....