README

ReadSoftOnline PHP 客户端 (RSO PHP 客户端)

什么是 ReadSoft Online ?

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

ReadSoft Online 在云端的发票捕获、提取和验证方面处于行业领先地位。无缝且经济高效地处理您的发票，并且免费。下载免费试用版，体验 ReadSoft Online 解决方案如何轻松集成到您现有的 ERP 系统中。

此软件包使用 Guzzle PHP Http Client 向 services.readsoftonline.com 发送 API 请求，并为与 ReadSoftOnline 交互提供了一些简单的方法。

点击此处 了解有关 ReadSoftOnline API 的更多信息。

该软件包相当简单。您只需要通过 composer 安装此软件包，要求 autoload.php 文件，并创建 Qbil\ReadSoftOnline\Client 类的实例，它期望一个参数（API 密钥）。

安装

1. composer require qbil-software/read-soft-online
2. require_once 'vendor/autoload.php';
3. $client = new Qbil\ReadSoftOnline\Client('在此处插入 API 密钥');
4. 使用 $client->authenticate('rso 用户名这里', 'rso 密码这里') 进行认证

Qbil\ReadSoftOnline\Client 具有以下公共方法

1. setHeaders(): 设置额外的标题或修改现有的标题信息。
2. isAuthenticated(): 检查客户端是否已认证。
3. authenticate($userName, $password): 使用用户名和密码认证客户端。
4. getCustomers(): 返回与当前帐户相关联的所有客户的 Models\Customer 数组。
5. getBuyers(Customer $customer): 返回与传入的客户相关联的所有买家的 Models\Buyer 数组。
6. getOutputDocuments(Customer $customer): 返回与传入的客户相关联的所有已处理文档的 Models\OutputDocument 数组。该 OutputDocument 类主要包含有关文档的元数据，如 DocumentId、BatchId、BuyerId 等。
7. getDocument(OutputDocument $document): 返回整个已处理文档信息（Models\Document 类的实例），包括元数据、买家和客户信息等。
8. getProcessedInvoice(Document $document): 返回包含已处理发票相关数据的 Models\Invoice 实例（不包含任何元数据）。
9. setDocumentStatus(Document $document, $status): 设置已处理文档的状态（STATUS_SUCCESS 或 STATUS_REJECTED）
10. setSuppliers($organizationId, array $suppliers): 将供应商上传到 ReadSoftOnline。 $organizationId 是买家 ID 或客户 ID（取决于 RSO 的设置）

以及一个受保护的方法

request(string $method, string $route, array $options = []): 此方法主要用于通过 GuzzleHttp/Client 发送请求。您可以扩展类以实现 RSO API 的更多方法，并使用此方法进行适当的请求。

请参阅 Qbil\ReadSoftOnline\Client 了解每个方法的定义