swipestripe/swipestripe-xero

SwipeStripe的Xero集成

2.1.x-dev 2014-07-05 01:40 UTC

This package is not auto-updated.

Last update: 2024-09-14 14:09:11 UTC


README

维护者联系方式

SwipeStripe
联系我们

需求

  • SilverStripe 3.1.*
  • SwipeStripe 2.1.*
  • SwipeStripe Addresses 2.1.*

文档

使用构建任务在Xero中为完成的订单创建发票和付款,它们不会发送到Xero超过一次。该任务可通过/dev/tasks访问,但可能此构建任务可以通过cron作业运行。根据每个项目的税则,可以使用依赖注入轻松地将Xero税种和税率应用于订单项和修改。

有关如何使用Xero的文档入门指南

安装说明

Composer

  1. composer require swipestripe/swipestripe-xero:dev-master

手动安装

  1. 将此目录放置在您的SilverStripe安装根目录中,将文件夹重命名为'swipestripe-xero'。
  2. 访问yoursite.com/dev/build?flush=all以重建数据库。

配置

此模块需要为每个安装进行大量的配置(和测试)。每个商店的税则可能不同,因此必须设置这些税则,以便Xero中的发票正确匹配订单。

API

您需要提供您的Xero账户的公钥/私钥对以及消费者和共享密钥。配置设置在xero.xml中,但应在您的mysite/ YAML配置文件中覆盖,例如

	---
	Name: mysite_swipestripe_xero
	After: '#swipestripe_xero'
	---
	CreateInvoicesTask:
	  appType: 'Private'
	  oauthCallback: 'oob'
	  userAgent: 'SwipeStripe Demo Site'
	  consumerKey: 'SOME KEY HERE'
	  sharedSecret: 'SECRET KEY HERE'
	  privateKeyPath: '/some/path/privatekey.pem'
	  publicKeyPath: '/some/path/publickey.cer'
	  invoicePrefix: 'WEB-'
	  defaultAccountCode: '200'
	  defaultAccountPurchasesCode: '090'

许多这些设置与Xero相关,例如默认账户代码、应用程序类型、回调等。

税设置

税率应用于Xero发票中的每一行项,不同的商店可能有不同的税要求,因此需要定义应用的税率。

注意
此模块内置了税模块,因此它不会与其他税模块(如Flat Fee Tax)一起工作。

要设置税率,首先需要子类化XeroTaxCalculator(例如:XeroTaxCalculator_NZ)。这是您决定如何将税率应用于订单中的每个项目和修改的地方。然后您需要在您的YAML配置文件中将新的税计算器设置为XeroTaxModification的依赖项,例如

	---
	Name: mysite_swipestripe_xero
	After: '#swipestripe_xero'
	---
	XeroTaxModification:
	  dependencies:
	    taxCalculator: %$XeroTaxCalculator_NZ

使用概述

  1. 运行构建任务将订单发送到Xero(这可能可以通过cron作业设置运行)

设置Xero开发者账户进行测试是个很好的主意。

贡献

感谢

许可证

Copyright (c) 2014, Frank Mullenger
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

		* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
		* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the 
			documentation and/or other materials provided with the distribution.
		* Neither the name of SilverStripe nor the names of its contributors may be used to endorse or promote products derived from this software 
			without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.