class Simplify::InvoiceItem
A InvoiceItem
object.
Attributes
Authentication
object used to access the API (See Simplify::Authentication
for details)
Public Class Methods
Creates an InvoiceItem
object
- parms
-
a hash of parameters; valid keys are:
-
amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD 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
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns a InvoiceItem
object.
# File lib/simplify/invoiceitem.rb, line 72 def self.create(parms, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("invoiceItem", 'create', parms, auth_obj) obj = InvoiceItem.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Retrieve a InvoiceItem
object from the API
- id
-
ID of object to retrieve
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns a InvoiceItem
object.
# File lib/simplify/invoiceitem.rb, line 94 def self.find(id, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("invoiceItem", 'show', {"id" => id}, auth_obj) obj = InvoiceItem.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Public Instance Methods
Delete this object
# File lib/simplify/invoiceitem.rb, line 83 def delete() h = Simplify::PaymentsApi.execute("invoiceItem", 'delete', self, self.authentication) self.merge!(h) self end
Returns the private key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/invoiceitem.rb, line 50 def private_key return self.authentication.private_key end
Sets the private key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/invoiceitem.rb, line 55 def private_key=(k) return self.authentication.private_key = k end
Returns the public key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/invoiceitem.rb, line 40 def public_key return self.authentication.public_key end
Sets the public key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/invoiceitem.rb, line 45 def public_key=(k) return self.authentication.public_key = k end
Updates this object
The properties that can be updated:
-
amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [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.
# File lib/simplify/invoiceitem.rb, line 112 def update() h = Simplify::PaymentsApi.execute("invoiceItem", 'update', self, self.authentication) self.merge!(h) self end