README

A simple and elegant Laravel wrapper for the Bokio API. This package allows you to interact with Bokio programmatically using clean, Laravel-friendly syntax.

Features

Handles authentication using integration token and company ID
Easily fetch customers, create invoices, and more
Extensible and testable design using Laravel's HTTP client

Installation

Install the package via Composer:

composer require mattitjaab/bokio-api-laravel

Publish the configuration file:

php artisan vendor:publish --tag="bokio-api-laravel-config"

This will create a config/bokio.php file where you can define:

return [
    'token' => env('BOKIO_TOKEN'),
    'company_id' => env('BOKIO_COMPANY_ID'),
];

Make sure to set your .env file accordingly:

BOKIO_TOKEN=your-token-here
BOKIO_COMPANY_ID=your-company-id

Usage

You can resolve the Bokio client using the service container:

$bokio = app(\Mattitja\BokioApiLaravel\Bokio::class);

// Fetch all customers
$customers = $bokio->customers()->all();

// Create a customer
$bokio->customers()->create([
    'name' => 'New Company AB',
    'type' => 'company',
    'address' => [
        'line1' => 'Main Street 1',
        'city' => 'Stockholm',
        'postalCode' => '11122',
        'country' => 'SE',
    ],
]);

Testing

Run the test suite with:

composer test

Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

Security

If you discover a security vulnerability, please follow our security policy.

License

This package is open-sourced software licensed under the MIT license.

mattitjaab / bokio-api-laravel

Maintainers

Details