NAME
WebService::Xero::Item - Object encapulates Item data returned by API
VERSION
Version 0.11
SYNOPSIS
Object to describe an Item record as specified by Xero API and the associated DTD at https://github.com/XeroAPI/XeroAPI-Schemas/blob/master/src/main/resources/XeroSchemas/v2.00/Item.xsd.
Mostly a wrapper for Xero Item data structure.
use WebService::Xero::Item;
my $foo = WebService::Xero::Item->new();
...
METHODS
new()
create_new_through_agent()
not ready to use yet.
new_from_api_data()
creates a new instance from the data provided by querying the API organisation end point
( typically handled by WebService::Xero::Agent->do_xero_api_call() )
Example Contact Queries using Xero Agent that return Data consumable by this method:
https://api.xero.com/api.xro/2.0/Items
Returns undef, a single object instance or an array of object instances depending on the data input provided.
as_text()
AUTHOR
Peter Scott, <peter at computerpros.com.au>
REFERENCE
BUGS
Please report any bugs or feature requests to bug-ccp-xero at rt.cpan.org
, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CCP-Xero. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
API LIMITATIONS
Emailing Items - FROM Xero Developer Docs ( https://developer.xero.com/documentation/api/Items/ )
It is not possible to email an Item through the Xero application using the Xero accounting API. To track progress on this feature request, or to add your support to it, please vote here.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc WebService::Xero::Item
You can also look for information at:
Xero Developer API Docs
TODO
ACKNOWLEDGEMENTS
LICENSE AND COPYRIGHT
Copyright 2016 Peter Scott.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.