ktr/business-central-sdk

This package will connect you to your Microsoft Business Central web services

dev-main 2025-04-15 21:19 UTC

Requires

• php: ^8.2
• laravel/framework: ^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0

MIT

• John Eystein Johannesen

• ktr
• business-central-sdk

README

Microsoft Business Central SDK for Laravel.

Installation

You can install the package via composer:

composer require ktr/business-central-sdk dev-main

Usage

// Add to .env
BUSINESS_CENTRAL_CLIENT_ID=
BUSINESS_CENTRAL_CLIENT_SECRET=
BUSINESS_CENTRAL_TENANT=
BUSINESS_CENTRAL_ENVIRONMENT=
BUSINESS_CENTRAL_COMPANY=

// Use Http Client
$order = Http::businessCentral()->post('salesOrders', [
    'customerId' => 'id',
    'shipToName' => 'Customer Name',
    'salesOrderLines' => [
        [
            'lineType' => 'Item',
            'itemId' => 'id',
            'quantity' => 10,
            'unitPrice' => 20.0
        ]
    ]
]);

// Use Facade
$order = BusinessCentral::post('salesOrders', [
    'customerId' => 'id',
    'shipToName' => 'Customer Name',
    'salesOrderLines' => [
        [
            'lineType' => 'Item',
            'itemId' => 'id',
            'quantity' => 10,
            'unitPrice' => 20.0
        ]
    ]
]);
    
// Usr Model    
$order = SalesOrders::create([
    'customerId' => 'id',
    'shipToName' => 'Customer Name',
    'salesOrderLines' => [
        [
            'lineType' => 'Item',
            'itemId' => 'id',
            'quantity' => 10,
            'unitPrice' => 20.0
        ]
    ]
]);

// Get Sales Order
$order = SalesOrders::select('customerId', 'shipToName','email')
    ->where('number', '{no}')
    ->expand(SalesOrderLines::class)
    ->first();

// Update Sales Order
$order->email = "[e-mail]";
$order->save();
    
// Delete Sales Order
$order->delete();

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• John Eystein Johannesen
• All Contributors

License

The MIT License (MIT). Please see License File for more information.