Net::Simplify::InvoiceItem

<<

- NAME
- SYNOPSIS
- DESCRIPTION
  - METHODS
    - create(%params, $auth)
    - delete()
    - list(%criteria, $auth)
    - find($id, $auth)
    - update()
- SEE ALSO
- VERSION
- LICENSE
- SEE ALSO

# 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 $invoiceItem = Net::Simplify::InvoiceItem->create{ {...});

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

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

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

      # Retrieve a list of objects
      my $invoiceItems = Net::Simplify::InvoiceItem->list({max => 10});
      foreach my $$invoiceItem ($invoiceItems->list) {
          # ...
      }

# 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 (minor units). Example: 1000 = 10.00 (required)

  currency

    Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account. (required) (default:USD)

  description

    Individual items of an invoice

  invoice

    Description of the invoice item (required)

`$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.

### list(%criteria, $auth)

Retrieve a list of `Net::Simplify::InvoiceItem` objects. The parameters are:

`%criteria`

  Hash map representing the criteria to limit the results of the list operation. Valid keys are:

  `filter`

    Filters to apply to the list.

  `max`

    Allows up to a max of 50 list items to return.

    (default: 20)

  `offset`

    Used in paging of the list. This is the start offset of the page.

    (default: 0)

  `sorting`

    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either `asc` for ascending or `desc` for descending). Sortable properties are:

    `id`
    `amount`
    `description`
    `invoice`

### 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`
`currency`
`description`

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

# SEE ALSO

Net::Simplify, Net::Simplify::Domain, Net::Simplify::DomainList, Net::Simplify::Authentication, Net::Simplify::ApiException, http://www.simplify.com

# VERSION

1.0.2

# LICENSE

Copyright (c) 2013, MasterCard International Incorporated 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 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.

# SEE ALSO

<<