README

Overview

The ImpactFactoringManagementClient is a PHP client designed to interact with the Impact Factoring Management API. It simplifies managing resources like operating companies, funders, funder compartments, and bank accounts. The client offers methods to fetch and manipulate these resources and ensures seamless API communication with predefined request and response handling.

Contribution

Please keep this README up to date.

Installation

Use Composer to install the package:

composer require impact-factoring/management-client

Configuration

The client autoconfigures based on environment variables:

• APP_ENV: Determines if the client runs in production mode. Client will receive dummy data if APP_ENV is other than "production"
• IMPACT_FACTORING_MANAGEMENT_API_TOKEN: Authentication token for API requests.
• IMPACT_FACTORING_MANAGEMENT_API_BASE_URL: Base URL for the API.

Set these variables in your environment to streamline usage.

Features

• Fetch details of Operating Companies, Funders, Funder Compartments, and Bank Accounts.
• Reserve and release bank account reservations.
• Centralized configuration for API communication, including authentication and environment-specific settings.

Method Summary

Usage

Initializing the Client

Create a new instance of ImpactFactoringManagementClient:

use ImpactFactoring\Management\Client\ImpactFactoringManagementClient;

$client = new ImpactFactoringManagementClient();

Fetching Resources

Operating Companies:

Fetch all active operating companies

$operatingCompanies = $client->getOperatingCompanies();

Fetch a single operating company by ID

$operatingCompanie = $client->getOperatingCompanyById($operatingCompanyId);

Funders:

Fetch active funders assigned to a specific operating company.

$funders = $client->getFunders($operatingCompanyId);

Fetch a single funder by ID.

$funder = $client->getFunderById($funderId);

Funder Compartments:

Fetch active funder compartment assigned to a specific funder

$compartments = $client->getFunderCompartments($funderId);

Fetch a single funder compartment by ID

$compartment = $client->getFunderCompartmentById($funderCompartmentId);

Bank Accounts:

Fetch available bank accounts assigned to a specified funder compartment

$bankAccounts = $client->getAvailableBankAccounts($funderCompartmentId);

Fetch a single bank account by ID

$bankAccount = $client->getBankAccountById($bankAccountId);

Customer Numbers:

Fetch a single customer number by ID

$customerNumber = $client->getCustomerNumberById($customerNumberId);

Fetch all available customer numbers

$customerNumbers = $client->getAvailableCustomerNumbers();

Resources

OperatingCompanyResource

FunderResource

FunderCompartmentResource

BankAccountResource

CustomerNumberResource

Reserve and release bank accounts

It's mandatory to reserve a bank account after the bank account is picked. The bank account should be released if there is no use for it anymore.

Reserve:

$isReserved = $client->reserveBankAccount($bankAccountId);

Release:

$isReleased = $client->releaseBankAccountReservation($bankAccountId);

Reserve and release customer numbers

Once the request to reserve customer numbers has been completed, the given customer numbers are already reserved. If, for any reason, the customer number isn't used anymore, you can release the reservation of that customer number.

Reserve:

$customerNumbers = $client->reserveCustomerNumbers($amount);

Release:

$isReleased = $client->releaseCustomerNumberReservation($customerNumberId);

Development

This package contains a Docker Compose file. Use the following Composer scripts to run and debug in an isolated environment

Usage

Initial composer install

composer docker-install

To test the package (powered by: Orchestra Testbench)

composer test

Run a debug container

composer debug