Class: Simplify::InvoiceItem

Inherits:
Hash
  • Object
show all
Defined in:
lib/simplify/invoiceitem.rb

Overview

A InvoiceItem object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#authentication ⇒ Object

Authentication object used to access the API (See Simplify::Authentication for details)



37
38
39
 
# File 'lib/simplify/invoiceitem.rb', line 37

def authentication
  @authentication
end

Class Method Details

.create(parms, *auth) ⇒ Object

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 [min value: -9999900, max value: 9999900] 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 keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns a InvoiceItem object.



72
73
74
75
76
77
78
79
80
 
# 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

.find(id, *auth) ⇒ Object

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 keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns a InvoiceItem object.



94
95
96
97
98
99
100
101
102
 
# 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

Instance Method Details

#delete ⇒ Object

Delete this object



83
84
85
86
87
 
# File 'lib/simplify/invoiceitem.rb', line 83

def delete()
    h = Simplify::PaymentsApi.execute("invoiceItem", 'delete', self, self.authentication)
    self.merge!(h)
    self
end

#private_key ⇒ Object

Returns the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.



50
51
52
 
# File 'lib/simplify/invoiceitem.rb', line 50

def private_key
    return self.authentication.private_key
end

#private_key=(k) ⇒ Object

Sets the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.



55
56
57
 
# File 'lib/simplify/invoiceitem.rb', line 55

def private_key=(k)
    return self.authentication.private_key = k
end

#public_key ⇒ Object

Returns the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.



40
41
42
 
# File 'lib/simplify/invoiceitem.rb', line 40

def public_key
    return self.authentication.public_key
end

#public_key=(k) ⇒ Object

Sets the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.



45
46
47
 
# File 'lib/simplify/invoiceitem.rb', line 45

def public_key=(k)
    return self.authentication.public_key = k
end

#update ⇒ Object

  • 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.



112
113
114
115
116
 
# File 'lib/simplify/invoiceitem.rb', line 112

def update()
      h = Simplify::PaymentsApi.execute("invoiceItem", 'update', self, self.authentication)
      self.merge!(h)
      self
end