PHPackages                             alphaolomi/simplify-vfd - 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. alphaolomi/simplify-vfd

ActiveLibrary

alphaolomi/simplify-vfd
=======================

Simplify VFD

v0.1.0(1y ago)212[2 PRs](https://github.com/alphaolomi/php-simplify-vfd/pulls)MITPHPPHP ^8.1

Since Jun 13Pushed 1y ago1 watchersCompare

[ Source](https://github.com/alphaolomi/php-simplify-vfd)[ Packagist](https://packagist.org/packages/alphaolomi/simplify-vfd)[ Docs](https://github.com/alphaolomi/simplify-vfd)[ GitHub Sponsors](https://github.com/alphaolomi)[ RSS](/packages/alphaolomi-simplify-vfd/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (6)Used By (0)

Simplify VFD for PHP
====================

[](#simplify-vfd-for-php)

[![Latest Version on Packagist](https://camo.githubusercontent.com/ab684cbe0cac95b0938129a05614f812b97cd3d1efa06bdf0cfa17a7181b3a94/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c7068616f6c6f6d692f73696d706c6966792d7666642e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/alphaolomi/simplify-vfd)[![Tests](https://camo.githubusercontent.com/b8dbf0904147a83ec2349feb9d45b1a9ee4c83582fd197d18870d36c20b3139b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f616c7068616f6c6f6d692f7068702d73696d706c6966792d7666642f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/alphaolomi/php-simplify-vfd/actions/workflows/run-tests.yml)[![Total Downloads](https://camo.githubusercontent.com/6bc32cf5e87f2631c9758e11c3ea5f417f922771e51c3e46836f9138a0506abd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f616c7068616f6c6f6d692f73696d706c6966792d7666642e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/alphaolomi/simplify-vfd)[![codecov](https://camo.githubusercontent.com/fae2bab5add837ded85d63de5da0fb5930d5d678591c1e475cfa32fc3fd2b0de/68747470733a2f2f636f6465636f762e696f2f6769746875622f616c7068616f6c6f6d692f7068702d73696d706c6966792d7666642f67726170682f62616467652e7376673f746f6b656e3d5a435643477a6e726639)](https://codecov.io/github/alphaolomi/php-simplify-vfd)

Simplify VFD is a PHP library to interact with the Simplify VFD API. This library provides a simple and easy-to-use interface to integrate VFD services into your PHP applications.

Features
--------

[](#features)

- **User Authentication**: Authenticate users and obtain access tokens.
- **Invoice Management**: Create, retrieve, and manage invoices.
- **Environment Configuration**: Switch between live and stage environments.
- **HTTP Client Integration**: Uses Guzzle HTTP client for making API requests.
- **Custom GUID Generation**: Utility function for generating unique identifiers.

Installation
------------

[](#installation)

You can install the package via Composer:

```
composer require alphaolomi/simplify-vfd
```

Configuration
-------------

[](#configuration)

The `SimplifyVfd` class requires a configuration array with the following keys:

- `environment`: The environment to use (`live` or `stage`).
- `username`: Your Simplify VFD username.
- `password`: Your Simplify VFD password.

Usage
-----

[](#usage)

### Initializing the Service

[](#initializing-the-service)

```
use Alphaolomi\SimplifyVfd\SimplifyVfd;

$config = [
    'environment' => 'stage', // or 'live'
    'username' => 'your_username',
    'password' => 'your_password',
];
$service = new SimplifyVfd($config, $client);
```

### User Login

[](#user-login)

```
$data = [
    'username' => 'your_username',
    'password' => 'your_password'
];

$response = $service->userLogin($data);
print_r($response);
```

### Create Issued Invoice

[](#create-issued-invoice)

```
$data = [
    'dateTime' => date('Y-m-d'),
    'customer' => [
        'identificationType' => 'ID',
        'identificationNumber' => '1234567890',
        'vatRegistrationNumber' => '123456789',
        'name' => 'Customer Name',
        'mobileNumber' => '255123456789',
        'email' => 'customer@example.com',
    ],
    'invoiceAmountType' => 'GROSS',
    'items' => [
        [
            'itemName' => 'Product 1',
            'quantity' => 1,
            'price' => 100.00
        ]
    ],
    'payments' => [
        [
            'paymentType' => 'CASH',
            'amount' => 100.00
        ]
    ],
    'partnerInvoiceId' => 'unique-invoice-id'
];

$response = $service->createIssuedInvoice($data);
print_r($response);
```

### Get Invoice by Partner Invoice ID

[](#get-invoice-by-partner-invoice-id)

```
$partnerInvoiceId = 'unique-invoice-id';

$response = $service->getInvoiceByPartnerInvoiceId($partnerInvoiceId);
print_r($response);
```

Testing
-------

[](#testing)

Using PestPHP for testing, Code coverage is generated by PHPUnit. Codecov is used to generate code coverage reports and badges.

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Alpha Olomi](https://github.com/alphaolomi)
- Ernest Malcolm
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance36

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 88.9% 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 ~0 days

Total

3

Last Release

696d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7534dd7341d883267be41935354b56c27f94d6bbd6a7abd9f257bb2d494a3798?d=identicon)[alphao](/maintainers/alphao)

---

Top Contributors

[![alphaolomi](https://avatars.githubusercontent.com/u/10551599?v=4)](https://github.com/alphaolomi "alphaolomi (24 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")

---

Tags

php-simplify-vfdphp81alphaolomisimplify-vfd

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/alphaolomi-simplify-vfd/health.svg)

```
[![Health](https://phpackages.com/badges/alphaolomi-simplify-vfd/health.svg)](https://phpackages.com/packages/alphaolomi-simplify-vfd)
```

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k20](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[alphaolomi/laravel-azampay

Laravel Azampay

301.1k](/packages/alphaolomi-laravel-azampay)

PHPackages © 2026

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