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

ActiveLibrary[API Development](/categories/api)

sdksio/apimatic-tql-sdk
=======================

this is a sample SDK generated by APIMatic

0.0.1(1mo ago)00MITPHPPHP ^7.2 || ^8.0

Since Jun 11Pushed 1mo agoCompare

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

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

Getting Started with TQL <> OTR — Factoring Data Exchange
===============================================================

[](#getting-started-with-tql--otr--factoring-data-exchange)

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

[](#introduction)

### Overview

[](#overview)

The **TQL <> OTR Factoring Data Exchange** API enables factoring clients to submit carrier invoices against loads managed by TQL, upload supporting documentation, search for invoices, and check processing status including any outstanding exceptions.

#### Key Capabilities

[](#key-capabilities)

- **Invoice Submission** — `POST /api/invoices` — Submit a factoring company invoice referencing a TQL load, including carrier details, stops, charges, and reference numbers.
- **Invoice Search** — `POST /api/invoices/search` — Search and retrieve a paginated list of invoices with status and last-updated timestamps.
- **Invoice Status** — `GET /api/invoices/{invoiceNumber}` — Retrieve the current processing status of an invoice, including any outstanding exceptions.
- **Document Upload** — `POST /api/documents` — Upload a supporting document (BOL, rate confirmation, proof of delivery, etc.) via `multipart/form-data` and link it to an invoice. Supports arbitrary key-value tags for metadata.
- **Carrier Assignment** — `PUT /api/assignments` — Notify TQL that a factoring company has been assigned to (or unassigned from) a carrier, including the effective date.
- **Load Lookup** — `GET /api/loads/{loadNumber}` — Verify a load exists in TQL's system and retrieve basic details (carrier, status, dates).
- **Load Search** — `POST /api/loads/search` — Search for TQL loads by carrier, date range, or status.

#### Authentication

[](#authentication)

This API uses **[OAuth 2.0 Client Credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4)** for authentication. TQL will provision each factoring partner with a unique **Client ID** and **Client Secret** during onboarding.

**How it works:**

1. **Obtain an access token** — Make a `POST` request to the TQL token endpoint with your Client ID and Client Secret using the `client_credentials` grant type.
2. **Include the token** — Pass the access token as a Bearer token in the `Authorization` header on every API request: `Authorization: Bearer `
3. **Token expiry** — Access tokens have a limited lifetime (typically 1 hour). When the token expires, request a new one from the token endpoint. Do **not** request a new token on every API call — cache and reuse the token until it expires.

**Required scopes:**

- **`Factoring.Write`** — Submit invoices, upload documents, manage assignments
- **`Factoring.Read`** — Query invoice status, search invoices The scopes your client is allowed to request are configured during onboarding. Include the required scope(s) in the `scope` parameter when requesting a token.

**Example token request:**

POST /oauth2/token HTTP/1.1 Content-Type: application/x-www-form-urlencoded

```
grant_type=client_credentials
&client_id=
&client_secret=
&scope=Factoring.Write Factoring.Read

```

TQL will provide the exact token endpoint URL, Client ID, and Client Secret during partner onboarding.

#### Philosophy

[](#philosophy)

- **Authentication** — All endpoints require a valid OAuth 2.0 Bearer token in the `Authorization` header. See the **Authentication** section above for details.
- **Asynchronous processing** — Write endpoints return `202 Accepted` immediately; poll `GET /api/invoices/{invoiceNumber}` for completion and exceptions.
- **Error handling** — Non-2xx responses follow [RFC 7807 Problem Details](https://datatracker.ietf.org/doc/html/rfc7807) with `title`, `status`, and `detail` fields.

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 "sdksio/apimatic-tql-sdk:0.0.1"
```

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

```
"require": {
    "sdksio/apimatic-tql-sdk": "0.0.1"
}
```

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/apimatic-tql-php-sdk/tree/0.0.1/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptiontimeout`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/apimatic-tql-php-sdk/tree/0.0.1/doc/logging-configuration-builder.md)Represents the logging configurations for API callsproxyConfiguration[`ProxyConfigurationBuilder`](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callsclientCredentialsAuth[`ClientCredentialsAuth`](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)The Credentials Setter for OAuth 2 Client Credentials GrantThe API client can be initialized as follows:

```
use TqlOtrFactoringDataExchangeLib\Logging\LoggingConfigurationBuilder;
use TqlOtrFactoringDataExchangeLib\Logging\RequestLoggingConfigurationBuilder;
use TqlOtrFactoringDataExchangeLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use TqlOtrFactoringDataExchangeLib\Authentication\ClientCredentialsAuthCredentialsBuilder;
use TqlOtrFactoringDataExchangeLib\Models\OauthScope;
use TqlOtrFactoringDataExchangeLib\TqlOtrFactoringDataExchangeClientBuilder;

$client = TqlOtrFactoringDataExchangeClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScope::FACTORING_WRITE,
                    OauthScope::FACTORING_READ
                ]
            )
    )
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();
```

Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`bearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)

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

[](#list-of-apis)

- [Invoices](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/controllers/invoices.md)
- [Documents](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/controllers/documents.md)
- [Assignments](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/controllers/assignments.md)
- [Loads](https://www.github.com/sdks-io/apimatic-tql-php-sdk/tree/0.0.1/doc/controllers/loads.md)

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

[](#sdk-infrastructure)

### Configuration

[](#configuration)

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

### HTTP

[](#http)

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

### Utilities

[](#utilities)

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

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance90

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity28

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

46d 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)")

---

Tags

apimaticsdksio

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

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

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

###  Alternatives

[square/square

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

773.9M29](/packages/square-square)[paypal/paypal-server-sdk

PayPal's SDK for interacting with the REST APIs

62833.4k16](/packages/paypal-paypal-server-sdk)

PHPackages © 2026

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