README

Cogs 是一套用于常见对象的接口，主要用于商业和电子商务（但不仅限于此范围）。

Cogs 仍在开发中。这些接口尚不完整或不稳定。还有更多接口有待定义。这些接口受到了 OASIS 建议的严重影响。

意图是通过让应用程序符合这些接口来实现一定程度的互操作性。

欢迎建议、评论和贡献。

安装

通过 composer

composer require abivia/cogs

枚举

InvoiceTransactionType

这定义了可以应用于发票的交易类型（借记、贷记或非平衡影响）

PartyType

这标识了两种基本类型的参与者：个人和组织。

接口

大多数接口都是设计用来表示存储在数据集中并由唯一标识符检索的对象。

AddressInterface

AddressInterface 表示存储在数据集中的地址。该接口来自 commerceguys/addressing，它反过来又来自开放标准。Cogs 使用国际地址命名法，因此有 locality() 访问器而不是 city()。

AddressProperties

AddressProperties 接口定义了对包含类似地址信息的对象的访问器，例如经纬度位置。

ChannelInterface

ChannelInterface 定义了一种通讯渠道，一种独立于介质的方式联系参与者。一个渠道可以定义通过电话、电子邮件、聊天等方式建立的联系。

HistoryInterface

HistoryInterface 表示与对象的交互。这是故意抽象的。历史记录可以记录服务的上下文转换或记录与参与者之间的对话历史。

InvoiceInterface

此接口提供了一种发票的标准定义，包括相关当事人、金额、税规则和状态。

InvoiceTransactionInterface

此接口表示影响发票余额或支付参数的任何事物。

PartyInterface

Party 接口表示个人或组织实体（公司、政府、学校等）。

PartyRelationshipInterface

Party 关系接口定义了两个参与者之间的链接。该接口用于表示商业关系（供应商、供应商）、人与人之间的关系（经理、员工）等。

税务项目接口

税务项目接口表示税率的适用。该比率可以应用于发票、发票中的单个项目或任何需要特定税额的点。

税率接口

税率是应用于交易的一定税额。

欢迎捐赠

如果您从 Cogs 中获得了一些东西，您可以使用 Liberapay 以您希望的任何金额赞助我们。Liberapay 本身也是由捐赠支持的，并且除了银行费用之外不收取任何费用。

abivia / cogs

维护者

详细信息