Download the PHP package qbil-software/read-soft-online without Composer

On this page you can find all versions of the php package qbil-software/read-soft-online. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package read-soft-online

ReadSoftOnline (RSO) PHP Client

ReadSoftOnline PHP client (RSO PHP Client)

What is ReadSoft Online ?

From https://www.kofax.com/Products/Financial-Process-Automation/ReadSoft-Online/Overview/

ReadSoft Online leads the industry in capture, extraction and validation of invoices in the cloud. Process your invoices seamlessly and affordably and for free. Download your free trial version and experience how easy ReadSoft Online solution easily integrates into your existing ERP system.

This package uses Guzzle PHP Http Client to make API requests to services.readsoftonline.com and provides some easy methods for interacting with ReadSoftOnline.

Click here for more information about ReadSoftOnline API.

The package is fairly simple. All you need to do is install this package via composer, require autoload.php file and create instance of Qbil\ReadSoftOnline\Client class, it expects one parameter (API key).

Installation

  1. composer require qbil-software/read-soft-online
  2. require_once 'vendor/autoload.php';
  3. $client = new Qbil\ReadSoftOnline\Client('insert_api_key_here');
  4. Authenticate using $client->authenticate('rso username here', 'rso password here')

Qbil\ReadSoftOnline\Client has following public methods

  1. setHeaders(): Set additional headers or modify existing header information.
  2. isAuthenticated(): Check whether client is authenticated or not.
  3. authenticate($userName, $password): Authenticate client with username and password.
  4. getCustomers(): Return array of Models\Customer with all customers associated with current account
  5. getBuyers(Customer $customer): Return array of Models\Buyer with all buyers associated with passed customer.
  6. getOutputDocuments(Customer $customer): Return array of Models\OutputDocument with all processed documents associated with passed customer. The OutputDocument class contains mostly meta data about Document like DocumentId, BatchId, BuyerId, etc.
  7. getDocument(OutputDocument $document): Return whole processed document info (instance of Models\Document class) including meta data, buyer and customer info. etc.
  8. getProcessedInvoice(Document $document): Return instance of Models\Invoice containing only relevant data of processed invoice (without any meta data).
  9. setDocumentStatus(Document $document, $status): Set status of processed document (STATUS_SUCCESS or STATUS_REJECTED)
  10. setSuppliers($organizationId, array $suppliers): Upload suppliers to ReadSoftOnline. $organizationId is either Buyer Id or Customer Id (depends upon settings of RSO)

and one protected method:

request(string $method, string $route, array $options = []): This method is mostly internally used to make request via GuzzleHttp/Client. You may extend the class to implement more methods from RSO API and use this method for making proper requests.

See Qbil\ReadSoftOnline\Client for definition of each method

All versions of read-soft-online with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
guzzlehttp/guzzle Version ^6.3 || ^7.4
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package qbil-software/read-soft-online contains the following files

Loading the files please wait ....