PHPackages                             hryvinskyi/billwerk-api - 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. [HTTP & Networking](/categories/http)
4. /
5. hryvinskyi/billwerk-api

ActiveLibrary[HTTP & Networking](/categories/http)

hryvinskyi/billwerk-api
=======================

1.0.0(1y ago)1104proprietaryPHPPHP ^7.4 || ^8.0

Since Feb 19Pushed 1y ago1 watchersCompare

[ Source](https://github.com/hryvinskyi/billwerk-api)[ Packagist](https://packagist.org/packages/hryvinskyi/billwerk-api)[ Docs](http://swagger.io)[ RSS](/packages/hryvinskyi-billwerk-api/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (4)Versions (2)Used By (0)

SwaggerClient-php
=================

[](#swaggerclient-php)

This document describes the endpoints of the billwerk REST API. You can find out more about billwerk [here](https://billwerk.com/).

**Swagger interactive usage / authentication:**
This documentation offers interactive features which will enable you to test how our system behaves. To use the interactive features you have to aquire a bearer token for your active billwerk sandbox account. This procedure is described [here](https://developer.billwerk.io/docs/restApi/authentication). OAuth token URL for sandbox is `https://sandbox.billwerk.com/oauth/token/`, for production `https://app.billwerk.com/oauth/token/`. Please be aware the URL does not include `[...]/api/v1/[...]`After aquiring the token you must go through the 'Authorize'-Form down below (green button). You're now able to use the interactive features.
Please be aware your sandbox account will be affected trying out the endpoints!

 **Updates to API**
We are constantly improving our API. We are trying to avoid breaking changes as much as possible. However, sometimes we have to make breaking changes. We will inform about breaking changes directly if these endpoints are used by your integration and grant sufficient time to react to the upcoming change. We will also inform about breaking changes in our changelog. Please be aware that we will not inform explicitly about non-breaking changes. We will **not inform** about changes in the following cases:

- Adding a new enum value to a published public API endpoint is not considered a breaking change.
- Adding new fields in API endpoint (request and response) is not considered a breaking change.

Integrations need to be built in a robust way that can deal with these sorts of changes by handling responses and objects in a generic way and ignoring unexpected types, enum values, fields.

Endpoints marked with \[FEATURE\] is an feature discriminated endpoint. Make sure your account has this feature enabled or contact <a href="">support.Return to [](https://developer.billwerk.io/)This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: v1
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements
------------

[](#requirements)

PHP 5.5 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```
{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/hryvinskyi/billwerk-api.git"
    }
  ],
  "require": {
    "hryvinskyi/billwerk-api": "*@dev"
  }
}

```

Then run `composer install`

### Manual Installation

[](#manual-installation)

Download the files and include `autoload.php`:

```
    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
```

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```