revotale/checkbox-ua

A library to interact with https://checkbox.ua API.

v0.1.1 2026-08-14 19:22 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^8.0
• jane-php/open-api-runtime: ^7.6

Requires (Dev)

• jane-php/open-api-3: ^7.6
• php-cs-fixer/shim: ^3.51
• phpstan/phpstan: ^1.10 || ^2.0

MIT

• l-you

Published on Packagist.org on 2026-08-14 19:23 UTC

README

Checkbox.ua has an OpenAPI specification (https://api.checkbox.in.ua/api/openapi.json) that is incorrectly described in many places. For example, lack of nullable union types and different datetime formats for semantically same fields. This causes generated client libraries to throw unexpected errors.

Initial library code was generated by JanePHP. That code was modified manually to add nullables and handle specific date formats for different fields.

General logic is still handled by JanePHP runtime.

Warning

This repository is archived and no longer maintained. For new Checkbox integrations, we recommend using oapi-codegen to generate a Go client from the Checkbox OpenAPI schema. It is more actively maintained and has proven to be more stable than JanePHP: we encountered almost no issues with it while developing the new Go-based fiscalization service, which replaces the fiscalization logic previously integrated directly into the Symfony-based shop.

Installation

composer require revotale/checkbox-ua

Usage

Example with signing in cashier with pin code and licence key:

<?php

declare(strict_types=1);

use RevoTale\CheckboxUA\ClientFactory;
use RevoTale\CheckboxUA\Model\CashierSignInPinCode;

$client = ClientFactory::createClient(
    clientName: 'MyApp',
    clientVersion: '1.0.0',
    token: $token // optional, for secure API endpoints
);

$payload = new CashierSignInPinCode();
$payload->setPinCode($pinCode);

$response = $client->signInCashierApiV1CashierSigninPost($payload);