NAME

Net::Simplify::InvoiceItem - A Simplify Commerce InvoiceItem object

SYNOPSIS

  use Net::Simplify;


  $Net::Simplify::public_key = 'YOUR PUBLIC KEY';
  $Net::Simplify::private_key = 'YOUR PRIVATE KEY';

  # Create a new InvoiceItem.
  my $invoice_item = Net::Simplify::InvoiceItem->create{ {...});

  # Retrieve a InvoiceItem given its ID.
  my $invoice_item = Net::Simplify::InvoiceItem->find('a7e41');

  # Update existing InvoiceItem.
  my $invoice_item = Net::Simplify::InvoiceItem->find('a7e41');
  $invoice_item->{PROPERTY} = "NEW VALUE";
  $invoice_item->update();

  # Delete
  my $invoice_item = Net::Simplify::InvoiceItem->find('a7e41');
  $invoice_item->delete();

DESCRIPTION

METHODS

create(%params, $auth)

Creates a Net::Simplify::InvoiceItem object. The parameters are:

%params

Hash map containing initial values for the object. Valid keys are:

amount: Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 (required)
description: Individual items of an invoice [max length: 1024]
invoice: The ID of the invoice this item belongs to.
product: Product ID this item relates to.
quantity: Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
reference: User defined reference field. [max length: 255]
tax: The tax ID of the tax charge in the invoice item.

$auth

Authentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key and $Net::Simplify::private_key are used.

delete()

Deletes the Net::Simplify::InvoiceItem object. Authentication is done using the same credentials used when the AccessToken was created.

find($id, $auth)

Retrieve a Net::Simplify::InvoiceItem object from the API. Parameters are:

$id: Identifier of the object to retrieve.
$auth: Authentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key and $Net::Simplify::private_key are used.

update()

Update Net::Simplify::InvoiceItem object. The properties that can be updated are:

amount

Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 [min value: 1]

description

Individual items of an invoice

quantity

Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999]

reference

User defined reference field.

tax

The tax ID of the tax charge in the invoice item.

Authentication is done using the same credentials used when the AccessToken was created.

VERSION

1.6.0

LICENSE

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 the MasterCard International Incorporated 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 HOLDER 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.