PHPackages                             ocolin/billmaxapi - 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. [API Development](/categories/api)
4. /
5. ocolin/billmaxapi

ActiveLibrary[API Development](/categories/api)

ocolin/billmaxapi
=================

Basic PHP Rest Client for Billmax API

1.1(6mo ago)01MITPHP

Since Nov 12Pushed 6mo agoCompare

[ Source](https://github.com/ocolin/BillmaxAPI)[ Packagist](https://packagist.org/packages/ocolin/billmaxapi)[ RSS](/packages/ocolin-billmaxapi/feed)WikiDiscussions main Synced 1mo ago

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

Description
===========

[](#description)

A small PHP REST client for the Billmax REST API.

Future updates
==============

[](#future-updates)

Right now this client does not handle user logins. That will be added in next version.

Instantiation
=============

[](#instantiation)

First we must create a client. It will require knowing the URL of the Billmax server as well as the API key for the server. The API key is the session ID of the Billmax remote application for the REST service.

Constructor parameters:

- base\_uri - (env) The URL of the API server, the root of the end points.
- api\_key - (env) Billmax server API key from Remote Application.
- timeout - (optional) Set the HTTP timeout as needed. Defaults to 20 seconds.
- verify - (optional) Verify SSL credentials. Defaults to off.
- errors - (optional) Display HTTP errors. Default is off.

Environment variables
---------------------

[](#environment-variables)

Instead of using constructor arguments, environment variables can be used for the base URL and API key.

- BILLMAX\_API\_URL
- BILLMAX\_API\_KEY

Example - Environment variables
-------------------------------

[](#example---environment-variables)

```
$_ENV['BILLMAX_API_URL'] = 'https://server.com:3100/api/billmaxCoreApi/v1/';
$_ENV['BILLMAX_API_KEY'] = 'ABCDEFG';

$client = new Ocolin\BillmaxAPI\Client();
```

Example - Environment with optional parameters
----------------------------------------------

[](#example---environment-with-optional-parameters)

```
$_ENV['BILLMAX_API_URL'] = 'https://server.com:3100/api/billmaxCoreApi/v1/';
$_ENV['BILLMAX_API_KEY'] = 'ABCDEFG';

$client = new Ocolin\BillmaxAPI\Client(
    timeout: 100,
     verify: true,
     errors: true
);
```

Example - Using constructor arguments
-------------------------------------

[](#example---using-constructor-arguments)

```
$client = new Ocolin\BillmaxAPI\Client(
    base_uri: 'https://server.com:3100/api/billmaxCoreApi/v1/',
    api_key: 'ABCDEFG'
);
```

Making an API call
==================

[](#making-an-api-call)

Swagger reference
-----------------

[](#swagger-reference)

Call Parameters
---------------

[](#call-parameters)

- path - The endpoint path, which can be copy/pasted from the swagger API docs. This includes the curly brace variables.
- method - The HTTP methods from the API docs. Defaults to GET.
- query - Array or object with the parameters and values to be used in the path as well as the URI. Any path parameters in curly braces will be replaced with a value from this array/object.
- body - Parameters for the HTTP body. Used for POST and PATCH methods.

Example GET
-----------

[](#example-get)

```
$output = $client->call(
    path: '/accounts/{id}'
    query: [ 'id' => '1' ]
);
```

Example POST
------------

[](#example-post)

```
$output = $client->call(
    path: '/pops/',
    method: 'POST',
    query: [
        'name' => 'My new POP',
        'virtualCompany' => 'My Company'
    ]
);
```

Example PATCH
-------------

[](#example-patch)

```
$output = self::$api->call(
    path: '/pops/{id}',
    method: 'PATCH',
    query: [ 'id' => 1 ],
    body: [
        'name' => 'Updated POP name',
        'generation' => '2025-11-11 00:00:00'
    ]
);
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance68

Regular maintenance activity

Popularity1

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

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

2

Last Release

187d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e97ac0aa452b872ddc3f7f4c56c83852574a27bb74622f8c054d11ca20008fc9?d=identicon)[Ocolin](/maintainers/Ocolin)

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/ocolin-billmaxapi/health.svg)

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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