PHPackages                             xero-apimatic/xero-apimatic-sdk - 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. xero-apimatic/xero-apimatic-sdk

ActiveLibrary[API Development](/categories/api)

xero-apimatic/xero-apimatic-sdk
===============================

Xero APIMatic SDKs

1.0.0(2mo ago)00MITPHPPHP ^7.2 || ^8.0

Since Mar 6Pushed 2mo agoCompare

[ Source](https://github.com/sdks-io/xero-apimatic-php-sdk)[ Packagist](https://packagist.org/packages/xero-apimatic/xero-apimatic-sdk)[ Docs](https://developer.xero.com/)[ RSS](/packages/xero-apimatic-xero-apimatic-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (5)Versions (2)Used By (0)

Getting Started with XERO APIs
==============================

[](#getting-started-with-xero-apis)

Introduction
------------

[](#introduction)

The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc., The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you're an existing financial services partner that wants access, contact your local Partner Manager. If you're a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner., These endpoints are related to managing authentication tokens and identity for Xero API, This is the Xero Projects API

Install the Package
-------------------

[](#install-the-package)

Run the following command to install the package and automatically add the dependency to your composer.json file:

```
composer require "xero-apimatic/xero-apimatic-sdk:1.0.0"
```

Or add it to the composer.json file manually as given below:

```
"require": {
    "xero-apimatic/xero-apimatic-sdk": "1.0.0"
}
```

You can also view the package at:

Initialize the API Client
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptionenvironment[`Environment`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/README.md#environments)The API environment.
 **Default: `Environment.PRODUCTION`**timeout`int`Timeout for API calls in seconds.
*Default*: `30`enableRetries`bool`Whether to enable retries and backoff feature.
*Default*: `false`numberOfRetries`int`The number of retries to make.
*Default*: `0`retryInterval`float`The retry time interval between the endpoint calls.
*Default*: `1`backOffFactor`float`Exponential backoff factor to increase interval between retries.
*Default*: `2`maximumRetryWaitTime`int`The maximum wait time in seconds for overall retrying requests.
*Default*: `0`retryOnTimeout`bool`Whether to retry on request timeout.
*Default*: `true`httpStatusCodesToRetry`array`Http status codes to retry against.
*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`httpMethodsToRetry`array`Http methods to retry against.
*Default*: `'GET', 'PUT'`loggingConfiguration[`LoggingConfigurationBuilder`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/logging-configuration-builder.md)Represents the logging configurations for API callsproxyConfiguration[`ProxyConfigurationBuilder`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callsoauth2Credentials[`Oauth2Credentials`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)The Credentials Setter for OAuth 2 Authorization Code GrantbasicAuthCredentials[`BasicAuthCredentials`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/auth/basic-authentication.md)The Credentials Setter for Basic AuthenticationThe API client can be initialized as follows:

```
use XeroApIsLib\Logging\LoggingConfigurationBuilder;
use XeroApIsLib\Logging\RequestLoggingConfigurationBuilder;
use XeroApIsLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use XeroApIsLib\Environment;
use XeroApIsLib\Authentication\Oauth2CredentialsBuilder;
use XeroApIsLib\Models\OauthScopeOauth2;
use XeroApIsLib\Authentication\BasicAuthCredentialsBuilder;
use XeroApIsLib\XeroApIsClientBuilder;

$client = XeroApIsClientBuilder::init()
    ->oauth2Credentials(
        Oauth2CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret',
            'OAuthRedirectUri'
        )
            ->oauthScopes(
                [
                    OauthScopeOauth2::EMAIL,
                    OauthScopeOauth2::OPENID
                ]
            )
    )
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();
```

Environments
------------

[](#environments)

The SDK can be configured to use a different environment for making API calls. Available environments are:

### Fields

[](#fields)

NameDescriptionPRODUCTION**Default** The Xero Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint., Xero API servers, Xero Bank Feeds API base url, Xero Identity service API, Xero API server for projectsAuthorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`OAuth2 (OAuth 2 Authorization Code Grant)`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)
- [`BasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/auth/basic-authentication.md)

List of APIs
------------

[](#list-of-apis)

- [Accounting](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/controllers/accounting.md)
- [Asset](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/controllers/asset.md)
- [Bank Feeds](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/controllers/bank-feeds.md)
- [Identity](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/controllers/identity.md)
- [Project](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/controllers/project.md)

SDK Infrastructure
------------------

[](#sdk-infrastructure)

### Configuration

[](#configuration)

- [ProxyConfigurationBuilder](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/proxy-configuration-builder.md)
- [LoggingConfigurationBuilder](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/logging-configuration-builder.md)
- [RequestLoggingConfigurationBuilder](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/request-logging-configuration-builder.md)
- [ResponseLoggingConfigurationBuilder](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/response-logging-configuration-builder.md)

### HTTP

[](#http)

- [HttpRequest](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/http-request.md)

### Utilities

[](#utilities)

- [FileWrapper](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/file-wrapper.md)
- [ApiResponse](https://www.github.com/sdks-io/xero-apimatic-php-sdk/tree/1.0.0/doc/api-response.md)

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance86

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

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

###  Release Activity

Cadence

Unknown

Total

1

Last Release

67d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef06f97b4ff5db714f2a124525216538f97338487cd4e2bca22baa32c0bf90cd?d=identicon)[developer-sdksio](/maintainers/developer-sdksio)

---

Top Contributors

[![developer-sdksio](https://avatars.githubusercontent.com/u/135820708?v=4)](https://github.com/developer-sdksio "developer-sdksio (1 commits)")

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/xero-apimatic-xero-apimatic-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/xero-apimatic-xero-apimatic-sdk/health.svg)](https://phpackages.com/packages/xero-apimatic-xero-apimatic-sdk)
```

###  Alternatives

[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

793.4M21](/packages/square-square)[paypal/paypal-server-sdk

PayPal's SDK for interacting with the REST APIs

53456.5k3](/packages/paypal-paypal-server-sdk)

PHPackages © 2026

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