Download the PHP package tdev-agency/checkbox-ua without Composer

On this page you can find all versions of the php package tdev-agency/checkbox-ua. 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 tdev-agency/checkbox-ua

Informations about the package checkbox-ua

Checkbox.ua PHP SDK

PHP SDK for Checkbox.ua

  1. [Installation]()
  2. [Usage]()
  3. [Cashier]()
    1. [Completion of the session of a cashier with the current access token]()
    2. [Getting information about the current user (cashier)]()
    3. [Receiving information about an active change of user (cashier)]()
    4. [Check signature]()
  4. [Organization]()
    1. [Get current organization receipt settings]()
    2. [Get current organization logo]()
    3. [Get current organization text logo]()
  5. [Shifts]()
    1. [Creating a Z-Report and closing the current shift by the user (cashier)](Creating a Z-Report and closing the current shift by the user (cashier))
    2. [Opening a new shift by a cashier]()
    3. [Getting current cashier shifts]()
    4. [Receiving information about the current shift]()

Installation

The recommended way to install Guzzle is through Composer.

Usage

Create SignIn entity:

  1. SignIn with login and password:

  2. SignIn with pin code:

Initialize checkbox.ua instance

Tags of api endpoints

Tags based on the official documentation of the checkbox.ua

There are two ways to call required tag.

E.g.: or by using helper method $cashier = $client->make(\TDevAgency\CheckboxUa\Tags\Cashier::class);

Cashier

Completion of the session of a cashier with the current access token

Getting information about the current user (cashier)

Receiving information about an active change of user (cashier)

Check signature

Organization

Get current organization receipt settings

Get current organization logo

Get current organization text logo

Shifts

Creating a Z-Report and closing the current shift by the user (cashier)

Optionally, a Z-Report can be generated on the client side and passed in the body of this request

$data values:

Param Default type Description
skip_client_name_check false boolean Skip Client Name Check
fiscal_code null string Offline fiscal number
fiscal_date null string Offline fiscal number
report null \TDevAgency\CheckboxUa\Entities\Requests\ReportRequestEntity Offline shift close time (ignored when online shift close)

Opening a new shift by a cashier

Param Default type Description
id null string The shift id is generated on the client side
fiscal_code null string Offline fiscal number
fiscal_date null string Offline fiscal number

Getting current cashier shifts

Param Default type Description
statuses [] array Array of any (Shift Status) Items Enum: "CREATED" "OPENING" "OPENED" "CLOSING" "CLOSED" Shift status
limit 25 int Limit
offset 0 int Offset
desc false boolean Reverse sort order

Receiving information about the current shift

Param Default type Description
id int Required. Shift ID

Receipts

Obtaining a list of checks within the current shift or according to filter parameters

$data params for ReceiptQueryRequestEntity:

Param Default type Description
fiscal_code null string Fiscal number
serial null string Serial
desc false boolean Reverse sort order
limit 25 int Limit
offset 0 int Offset

TODO

  1. Create Receipt
  2. Get Receipt Html
  3. Webhooks

All versions of checkbox-ua with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8
guzzlehttp/guzzle Version ^7
ext-json Version *
illuminate/collections Version ^7|^8|^9
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 tdev-agency/checkbox-ua contains the following files

Loading the files please wait ....