PHPackages                             thalent/acumulus - 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. thalent/acumulus

ActiveLibrary[API Development](/categories/api)

thalent/acumulus
================

PHP wrapper for the Acumulus API

2151[1 issues](https://github.com/thalent/acumulus/issues)PHP

Since Dec 11Pushed 8y ago2 watchersCompare

[ Source](https://github.com/thalent/acumulus)[ Packagist](https://packagist.org/packages/thalent/acumulus)[ RSS](/packages/thalent-acumulus/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Unofficial Acumulus PHP SDK
===========================

[](#unofficial-acumulus-php-sdk)

Official Acumulus documentation:

Forked of [siegerhansma/acumulus-php](https://github.com/siegerhansma/acumulus)

This package uses [Guzzle](https://github.com/guzzle/guzzle) to make the cUrl requests to Acumulus. Because of its dependency to Guzzle, this package requires PHP >= 5.6 to function.

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

[](#installation)

### Via composer

[](#via-composer)

Add the package to your composer.json file

```
    "require": {
        "thalent/acumulus": "~2.0"
    },

```

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

[](#configuration)

All of the provider classes take a config array as parameter.

```
    $config['contractcode'] = 123456;
    $config['username'] = "xxxxxxxxx";
    $config['password'] = "xxxxxxxxx";

```

You could put these variables in a specific config file.

### Request

[](#request)

The calls in the API can be called via specific classes corresponding to the categories on the official API docs. To start, create a new instance of the provider class you need.

```
    $client = new \Thalent\AcumulusPhp\Providers\ContactsProvider($config);

```

After that, all the calls in that class will be available via the $client variable.

```
    $client->getContactDetails(14036242)->sendRequest();

```

When the method is called, you can chain the sendRequest method to that. This method actually sends the request to the Acumulus API. The same principle stands for the other provider classes.

### Response

[](#response)

The sendRequest method returns the response given by Acumulus. The response is being cast to an array for multiple records or an instance of the model for a single record.

In the example below is the response of the getAvailableContacts method on the ContactsProvider.

#### Example response

[](#example-response)

```
array(3) {
  [0] =>
  class Thalent\AcumulusPhp\Models\Contact#68 (27) {
    protected $contactid =>
    string(7) "1234567"
    protected $contactname1 =>
    string(13) "Contactname 1"
    protected $contactname2 =>
    NULL
    protected $contacttypeid =>
    string(1) "3"
    protected $contacttypename =>
    string(7) "Relatie"
    protected $contactperson =>
    NULL
    protected $contactsalutation =>
    NULL
    protected $contactaddress1 =>
    string(9) "Address 1"
    protected $contactaddress2 =>
    NULL
    protected $contactpostalcode =>
    NULL
    protected $contactcity =>
    string(10) "Leeuwarden"
    protected $contactcountryid =>
    NULL
    protected $contactcountrycode =>
    NULL
    protected $contactcountryname =>
    NULL
    protected $contacttelephone =>
    NULL
    protected $contactfax =>
    NULL
    protected $contactemail =>
    NULL
    protected $contactwebsite =>
    NULL
    protected $contactbankaccountnumber =>
    NULL
    protected $contactiban =>
    NULL
    protected $contactbic =>
    NULL
    protected $contactmark =>
    NULL
    protected $contactvatnumber =>
    NULL
    protected $contactvatstandard =>
    NULL
    protected $contacttemplateid =>
    NULL
    protected $contactnotes =>
    NULL
    protected $contactstatus =>
    NULL
  }
  [1] =>
  class Thalent\AcumulusPhp\Models\Contact#91 (27) {
    protected $contactid =>
    string(7) "3216549"
    protected $contactname1 =>
    string(13) "Contactname 2"
    protected $contactname2 =>
    NULL
    protected $contacttypeid =>
    string(1) "3"
    protected $contacttypename =>
    string(7) "Relatie"
    protected $contactperson =>
    NULL
    protected $contactsalutation =>
    NULL
    protected $contactaddress1 =>
    string(9) "Address 2"
    protected $contactaddress2 =>
    NULL
    protected $contactpostalcode =>
    NULL
    protected $contactcity =>
    string(8) "Drachten"
    protected $contactcountryid =>
    NULL
    protected $contactcountrycode =>
    NULL
    protected $contactcountryname =>
    NULL
    protected $contacttelephone =>
    NULL
    protected $contactfax =>
    NULL
    protected $contactemail =>
    NULL
    protected $contactwebsite =>
    NULL
    protected $contactbankaccountnumber =>
    NULL
    protected $contactiban =>
    NULL
    protected $contactbic =>
    NULL
    protected $contactmark =>
    NULL
    protected $contactvatnumber =>
    NULL
    protected $contactvatstandard =>
    NULL
    protected $contacttemplateid =>
    NULL
    protected $contactnotes =>
    NULL
    protected $contactstatus =>
    NULL
  }
  [2] =>
  class Thalent\AcumulusPhp\Models\Contact#69 (27) {
    protected $contactid =>
    string(5) "00001"
    protected $contactname1 =>
    string(13) "Contactname 3"
    protected $contactname2 =>
    NULL
    protected $contacttypeid =>
    string(1) "3"
    protected $contacttypename =>
    string(7) "Relatie"
    protected $contactperson =>
    NULL
    protected $contactsalutation =>
    NULL
    protected $contactaddress1 =>
    string(9) "Address 3"
    protected $contactaddress2 =>
    NULL
    protected $contactpostalcode =>
    NULL
    protected $contactcity =>
    NULL
    protected $contactcountryid =>
    NULL
    protected $contactcountrycode =>
    string(2) "NL"
    protected $contactcountryname =>
    NULL
    protected $contacttelephone =>
    NULL
    protected $contactfax =>
    NULL
    protected $contactemail =>
    NULL
    protected $contactwebsite =>
    NULL
    protected $contactbankaccountnumber =>
    NULL
    protected $contactiban =>
    NULL
    protected $contactbic =>
    NULL
    protected $contactmark =>
    NULL
    protected $contactvatnumber =>
    NULL
    protected $contactvatstandard =>
    NULL
    protected $contacttemplateid =>
    NULL
    protected $contactnotes =>
    NULL
    protected $contactstatus =>
    NULL
  }
}

```

### Models

[](#models)

For the responses you get from Acumulus, there are several models being used. There models are integral copies of the responses and have their own getters and setters. For a list of all the models and the methods that you can use on them, check out the API documentation [here](http://trixoict.nl/acumulus/namespaces/Siegerhansma.AcumulusPhp.Models.html)

### Adding an invoice

[](#adding-an-invoice)

By far the most difficult task this package does is adding an invoice to Acumulus. I've tried to create this as easy as possible, but the call being made is pretty complex. One thing to note is that Acumulus looks at the customer emailadress as being the unique identifier of a customer. So if a customer doesn't have an email yet, this package will automatically create a unique emailaddress for that customer to prevent creating multiple customers. However, before you make this call it's recommended that you make sure that the customer has an email. To (hopefully) make this a little bit easier for you, I made an InvoiceBuilder class. Here's an example of how to use this.

```

    // Instantiate a new InvoiceBuilder object
    $invoiceBuilder = new InvoiceBuilder;

    // Create a new contact by instantiating a new Contact model or get it from the API
    $builder = new \Thalent\AcumulusPhp\ContactsProvider($config);
    $contact = $builder->getContactDetails(123456)->sendRequest();

    // Set the customer by passing in the Contact model
    $invoiceBuilder->setCustomer($contact);

    // Instantiate a new Invoice model and set Invoice specific settings
    $invoice = new Invoice;
    $invoice
        ->setTemplate('Standaard');

    // Pass in the Invoice model
    $invoiceBuilder->setInvoiceData($invoice);

    // Create a new InvoiceLine object and set the fields
    // Use this in a loop for multiple lines
    $invoiceLine = new InvoiceLine;
    $invoiceLine
        ->setItemnumber(102)
        ->setProduct("Awesome product")
        ->setUnitprice(19.95)
        ->setQuantity(3);
    $invoiceBuilder->addLine($invoiceLine);

    // Pass the InvoiceBuilder into the addInvoice method on the InvoicesProvider and call the build method on it
    $invoiceSender = new \Thalent\AcumulusPhp\InvoicesProvider($config);
    $response = $invoiceSender->addInvoice($invoiceBuilder->build())->sendRequest();

```

In the response from Acumulus you will get an array with the following fields:

- invoicenumber
- token
- entryid

TODO
----

[](#todo)

A lot still to do, here's what:

- Write more tests
- Make documentation
- Support [Picklists](https://apidoc.sielsystems.nl/acumulus-api/picklists)

If you have any questions, feedback or if you encounter a bug, please leave an issue or a pull request.

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance10

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 80% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/8ace74569ec70335313faa8ce86968fe27daad615e6a59c016a08df0c82b42a7?d=identicon)[thalent](/maintainers/thalent)

---

Top Contributors

[![chielsen](https://avatars.githubusercontent.com/u/1233933?v=4)](https://github.com/chielsen "chielsen (4 commits)")[![othillo](https://avatars.githubusercontent.com/u/2786663?v=4)](https://github.com/othillo "othillo (1 commits)")

### Embed Badge

![Health badge](/badges/thalent-acumulus/health.svg)

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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