epicbit/bill-php-sdk

简单使用 bill.pt SDK 的方法

v1.25.11 2018-07-23 17:32 UTC

This package is not auto-updated.

Last update: 2024-09-18 04:43:49 UTC


README

bill.pt 网站API的 PHP 开发 SDK。Bill 是经税务当局认证的账单软件。要获取开发账户,请联系支持。

使用 bill.pt API 的简单助手

文档:https://api.bill.pt

命名空间

use EpicBit\BillPhpSdk\Api;

实例

$api = new Api();

可选参数(字符串)定义 API 将尝试连接的服务器。默认情况下,API 将尝试连接到葡萄牙服务器。但如果您有一个国际账户,您会这样做

Example : $api = new Api('world');

有效:standard,portugal,world,dev

开启 LOG

开启 LOG。类型可以是:file 或 memory

$api->setlog(true, $type);

从内存返回 LOG

$api->getLogFromMemory();

如何登录并获取令牌

$user = $api->getToken([
	'email' => "johndoe@example.com",
	'password' => 'XXXXX'
	]);

$api->setToken($user->api_token);

如果您已经有了令牌,您只需设置 setToken

$api->setToken($user->api_token);

货币

获取所有有效货币的列表

$api->getCurrencyList();

国家

获取所有有效国家的列表

$api->getCountriesList();

验证

验证是否为有效的货币代码 示例:EUR_€ 是有效的。只需列出所有有效选项。

$api->isValidCurrency($currency); 

验证用户令牌(将返回一个布尔值)

$api->validToken();

验证日期时间(或任何格式)

$api->isValidDateTime($date_time, $format); (by default if you dont pass $format will be : Y-m-d H:i:s")

验证葡萄牙邮政编码

$api->isValidZipCode($zip);

成功

此方法将返回一个布尔值。您可以检查您的最后一个请求是否有效。

$api->success();

DocumentType 请求

$api->getDocumentAllTypes();
$api->getDocumentTypesOf($category);

PaymentMethods 请求

$api->getPaymentMethods();

DeliveryMethods 请求

$api->getDeliveryMethods();
$api->createDeliveryMethod($params);
$api->updateDeliveryMethod($id, $params);
$api->deleteDeliveryMethod($id);

MeasurementUnits 请求

$api->getMeasurementUnits();
$api->createMeasurementUnit($params);
$api->updateMeasurementUnit($id, $params);
$api->deleteMeasurementUnit($id);

Vehicles 请求

$api->getVehicles();
$api->createVehicle($params);
$api->updateVehicle($id, $params);
$api->deleteVehicle($id);

DocumentSets 请求

$api->getDocumentSets();
$api->createDocumentSet($params);
$api->updateDocumentSet($id, $params);
$api->deleteDocumentSet($id);

Taxs 请求

$api->getTaxs();
$api->createTax($params);
$api->updateTax($id, $params);
$api->deleteTax($id);

TaxExemptions 请求

$api->getTaxExemptions();

Warehouses 请求

$api->getWarehouses();
$api->createWarehouse($params);
$api->updateWarehouse($id, $params);
$api->deleteWarehouse($id);

Contacts(客户、供应商等)请求

$api->getContacts($params);
$api->getContactWithID($id, $params);
$api->createContact($params);
$api->updateContact($id, $params);
$api->deleteContact($id);

Items 请求

$api->getItems($params);
$api->getItemWithID($id, $params);
$api->createItem($params);
$api->updateItem($id, $params);
$api->deleteItem($id);

Documents 请求

$api->getDocuments($params);
$api->getDocumentWithID($id, $params);
$api->createDocument($params);
$api->deleteDocument($id);
$api->createDocumentOpeningBalance($params);
$api->communicateBillOfLanding($id);
$api->addTransportationCodeManually($params);
$api->emailDocument($params);
$api->addPrivateNoteToDocument($params);
$api->convertDocumentWithID($document_id, $convert_to, $data, $date_shipping, $date_delivery);

Stock 请求

$api->getStock($params);
$api->getStockSingleItem($params);
$api->getStockMovements($params);

PendingMovements 请求

$api->documentsWithPendingMovementsFromContact($params);
$api->pendingMovementsOfMultipleDocuments($params);
$api->pendingMovementsOfSingleDocument($id);

Receipts 请求

$api->createReceipt($params);
$api->createReceiptToDocumentWithID($id, $params);

Tax Authority 请求

$api->setTaxAuthorityLoginInformation($params);
$api->testTaxAuthorityLogin();
$api->taxAuthorityLoginState();
$api->taxAuthortiyCommunicationLog();

Contact Type 请求

$api->getContactTypes($params);
$api->createContactType($params);
$api->updateContactType($id,$params);

Document States 请求

$api->getDocumentStates($params);
$api->createDocumentState($params);
$api->updateDocumentState($id, $params);
$api->deleteDocumentState($id);
$api->changeDocumentState($params);

SMTP 请求

$api->getSmtp();
$api->createSmtp($params);
$api->deleteSmtp();
$api->sendSmtpEmailTest($params);

如果您不确定每个请求可以使用哪些参数,请访问我们的 API 文档。

https://api.bill.pt