README

连接到Quipu API的PHP类请参阅文档

要求

PHP 5.3或更高版本
cURL
Quipu账户

入门指南

创建连接

Quipu_Api_Connection类是一个单例类，将保持连接2小时开放。连接实例必须传递给每个类。

$api_connection = Quipu_Api_Connection::get_instance('YOUR_APP_KEY', 'YOUR_APP_SECRET');

创建编号系列

将连接类传递给编号类，然后调用"create_series"。如果系列已存在，则创建或加载该系列。

$quipu_num = new Quipu_Api_Numeration($api_connection);
$quipu_num->create_series('YOUR_PREFIX');

创建联系人

以下参数可以传递给创建联系人的操作。

唯一必填字段是"姓名"。
如果传递了"tax_id"，则类将尝试在Quipu中加载该联系人（如果它们已存在）。
"country_code"应使用[ISO 3166-1 alpha-2] (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)


$contact = array(
	    		"name" => "CONTACT_NAME",
	            "tax_id" => "CONTACT_VAT_ID",
	            "phone" => "CONTACT_PHONE ",
	            "email" => "CONTACT_EMAIL",
	            "address" => "CONTACT_ADDRESS",
	            "town" => "CONTACT_CITY",
	            "zip_code" => "CONTACT_ZIP_CODE",
	            "country_code" => "CONTACT_CODE"
			);

将连接类传递给联系人类，然后调用"create_contact"，使用上面的数组。如果联系人已存在，则创建或加载。

$quipu_contact = new Quipu_Api_Contact($api_connection);
$quipu_contact->create_contact($contact);

创建发票

以下参数可以传递给创建发票的操作。

"发行日期"是必填项
"项目"是必填项。 "项目"是一个包含至少一个值的数组，所有变量都是必填项
- "产品"是项目名称
- "成本"是以欧元计的值
- "数量"必须至少为1
- "vat_per"是增值税百分比（不是值）
"payment_method"的接受值在Quipu API文档中有详细说明


$order = array(
	    		"payment_method" => "PAYMENT_METHOD",
	            "issue_date" => "YYYY-mm-dd",
	            "items" => array(
				            	"product" => "PRODUCT_NAME",
				            	"cost" => "PRODUCT_PRICE",
				            	"quantity" => "PRODUCT_QUANTITY",
				            	"vat_per" => "VAT_PERCENTAGE"
				            );
	            );

将连接类传递给发票类

$quipu_invoice = new Quipu_Api_Invoice($api_connection);

如果存在，可以首先设置编号系列

$quipu_invoice->set_numeration($quipu_num);

需要一个联系人或发票无法创建

$quipu_invoice->set_contact($quipu_contact);

一旦将联系人传递给类，就可以创建发票

$quipu_invoice->create_invoice($order);

要获取Quipu发票的内部ID。存储在本地以用于退款。

$quipu_invoice->get_id()

创建退款

以下参数可以传递给创建退款的操作。

"退款日期"是必填项
"invoice_id"是必填项。这是创建发票后返回的Quipu发票ID
"items"不是必需的。如果没有传递"items"，则假定整个发票正在退款，否则假定是部分退款
- "产品"是项目名称
- "成本"是以欧元计的值
- "数量"必须至少为1
- "vat_per"是增值税百分比（不是值）


$order = array(
	    		"invoice_id" => "QUIPU_INVOICE_ID",
	            "refund_date" => "YYYY-mm-dd",
	            "items" => array(
				            	"product" => "PRODUCT_NAME",
				            	"cost" => "PRODUCT_PRICE",
				            	"quantity" => "PRODUCT_QUANTITY",
				            	"vat_per" => "VAT_PERCENTAGE"
				            );
	            );

将连接类传递给发票类

$quipu_invoice = new Quipu_Api_Invoice($api_connection);

如果存在，可以首先设置退款编号系列

$quipu_invoice->set_numeration($refund_num_series);

调用'refund_invoice'函数来退款发票

$quipu_invoice->refund_invoice($order);

变更日志

1.0

首次公开发布

quipu / quipu-api

维护者

详细信息