Download the PHP package ktr/business-central-sdk without Composer

Microsoft Business Central SDK for Laravel

A modern Laravel SDK for Microsoft Dynamics 365 Business Central. Connect to Business Central's web services with an elegant, Laravel-style API that feels right at home in your Laravel application.

Why This Package?

Building integrations with Microsoft Business Central can be complex and time-consuming. This SDK simplifies the entire process by providing:

• Laravel-Native Integration - Feels like native Laravel code with familiar query builder patterns
• Three Flexible APIs - Choose between HTTP Client macros, Facades, or Eloquent-style Models
• Comprehensive Coverage - Access 85+ Business Central entities (Customers, Sales Orders, Items, Invoices, and more)
• Modern PHP - Built for PHP 8.2+ and Laravel 11+
• Type-Safe - Full PHPDoc annotations for IDE autocompletion
• OAuth2 Authentication - Handles token management and caching automatically
• OData Query Builder - Powerful filtering, sorting, expanding, and pagination

Features

✅ Model-Based API - Eloquent-like models for all Business Central entities ✅ Query Builder - Intuitive filtering with where(), whereIn(), whereContains(), and more ✅ Relationship Expansion - Eager load related data with expand() ✅ Pagination Support - Built-in take(), skip(), lazy(), and all() methods ✅ HTTP Client Macro - Use Http::businessCentral() for quick API calls ✅ Facade Support - Simple BusinessCentral::get() / ::post() interface ✅ Automatic Token Management - OAuth2 tokens cached and refreshed automatically ✅ Laravel 11 & 12 Support - Tested on PHP 8.2 and 8.3

Requirements

• PHP 8.2 or higher
• Laravel 11.0 or higher

Installation

Install the package via Composer:

Configuration

Add your Business Central credentials to your .env file:

Getting Your Credentials

1. Register your app in Azure Portal
2. Create an App Registration with API permissions for Business Central
3. Generate a client secret
4. Note your Tenant ID from Azure AD
5. Find your Company ID and Environment from Business Central

Tip: For sandbox testing, set BUSINESS_CENTRAL_ENVIRONMENT=sandbox

Usage

This SDK provides three different APIs to fit your coding style. All examples below accomplish the same task - choose the one that feels best for your project.

1. Model-Based API (Recommended)

The Model API provides an Eloquent-like experience with full IDE autocompletion:

2. HTTP Client Macro

For quick, one-off API calls without models:

3. Facade API

Clean and simple for straightforward API interactions:

Query Builder Examples

The Model API includes a powerful query builder with OData support:

Basic Filtering

Advanced Filtering

Selecting Fields

Expanding Relationships

Sorting

Pagination

Finding Records

Data Type Handling

The query builder intelligently handles different data types to ensure correct OData formatting:

Important Notes:

• Numeric 0 is correctly handled as integer, not string '0'
• Boolean false is distinct from integer 0
• String values are automatically URL-encoded for OData compatibility
• DateTime objects are automatically detected and formatted correctly

Available Models

This SDK provides access to 85+ Business Central entities. Here are the most commonly used:

Sales & Customers

• Customers - Customer master data
• SalesOrders - Sales orders
• SalesOrderLines - Sales order line items
• SalesInvoices - Posted sales invoices
• SalesInvoiceLines - Sales invoice line items
• SalesQuotes - Sales quotes
• SalesShipments - Posted sales shipments
• SalesCreditMemos - Sales credit memos

Purchasing & Vendors

• Vendors - Vendor master data
• PurchaseOrders - Purchase orders
• PurchaseOrderLines - Purchase order line items
• PurchaseInvoices - Posted purchase invoices
• PurchaseInvoiceLines - Purchase invoice line items
• PurchaseCreditMemos - Purchase credit memos

Inventory & Items

• Items - Item master data
• ItemCategories - Item categories
• UnitsOfMeasure - Units of measure
• InventoryPostingGroups - Inventory posting groups

Financial

• Accounts - Chart of accounts
• GeneralLedgerEntries - G/L entries
• Currencies - Currency master data
• CurrencyExchangeRates - Exchange rates
• PaymentTerms - Payment terms
• PaymentMethods - Payment methods
• Dimensions - Financial dimensions
• BankAccounts - Bank account master data

Journals

• Journals - General journals
• ItemJournals - Item journals
• CustomerPaymentJournals - Payment journals
• VendorPaymentJournals - Vendor payment journals

Reporting & Analysis

• BalanceSheets - Balance sheet reports
• IncomeStatements - Income statement reports
• CashFlowStatements - Cash flow reports
• AgedAccountsReceivables - AR aging reports
• AgedAccountsPayables - AP aging reports
• TrialBalances - Trial balance reports

Master Data

• Employees - Employee records
• Projects - Project/job cards
• CountriesRegions - Countries and regions
• TaxGroups - Tax groups
• TaxAreas - Tax areas
• Contacts - Contact information
• CompanyInformation - Company details

Tip: All models are located in Ktr\BusinessCentral\Models\ApiV20 namespace and include full PHPDoc type hints for IDE autocompletion.

API Reference

For detailed information about available fields, filters, and operations for each entity, refer to the official Microsoft Business Central API v2.0 Documentation.

Real-World Examples

Example 1: Create a Complete Sales Order

Example 2: Generate Sales Report

Example 3: Sync Inventory Levels

Example 4: Customer Management

Troubleshooting

Authentication Errors

If you receive authentication errors:

1. Verify your credentials in .env
2. Check that your Azure app has the correct API permissions
3. Ensure your client secret hasn't expired
4. Clear the token cache: php artisan cache:clear

API Limitations

• Business Central API has rate limits - implement appropriate throttling
• Some entities are read-only (e.g., Posted Invoices)
• Complex calculations may need to be done in Business Central AL code first

OData Query Syntax

This SDK uses OData v4 query conventions. If you encounter filter errors:

• Use single quotes for string values: where('city', 'Boston')
• Use proper operators: eq, ne, gt, ge, lt, le
• Check the OData documentation for advanced syntax

Getting Help

• Review the Business Central API Documentation
• Check existing GitHub Issues
• Create a new issue with details about your problem

Testing

Run the test suite:

Run tests with coverage:

Check code style:

Fix code style:

Changelog

Please see CHANGELOG for recent changes and version history.

Contributing

We welcome contributions! Please see CONTRIBUTING for details on how to contribute to this project.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

• John Eystein Johannesen - Creator and maintainer
• All Contributors

License

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

Built with ❤️ for the Laravel community