Simplify::Tax

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

Creates an Tax object

• label The label of the tax object. [max length: 255] required

• rate The tax rate. Decimal value up three decimal places. e.g 12.501. [max length: 6] required

Returns a Tax object.

# File lib/simplify/tax.rb, line 67
def self.create(parms, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("tax", 'create', parms, auth_obj)
    obj = Tax.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

Retrieve a Tax object from the API

Returns a Tax object.

# File lib/simplify/tax.rb, line 109
def self.find(id, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("tax", 'show', {"id" => id}, auth_obj)
    obj = Tax.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

Retrieve Tax objects.

• filter <table class="filter_list"><tr><td>filter.id</td><td>Filter by the Id of the tax</td></tr><tr><td>filter.label</td><td>Filter by the label(name) of the tax</td></tr></table>

• max Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

• offset Used in paging of the list. This is the start offset of the page. [min value: 0, 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 label.

Returns an object where the list property contains the list of Tax objects and the total property contains the total number of Tax objects available for the given criteria.

# File lib/simplify/tax.rb, line 93
def self.list(criteria = nil, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("tax", 'list', criteria, auth_obj)
    obj = Tax.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj

end

Delete this object

# File lib/simplify/tax.rb, line 78
def delete()
    h = Simplify::PaymentsApi.execute("tax", '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/tax.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/tax.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/tax.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/tax.rb, line 45
def public_key=(k)
    return self.authentication.public_key = k
end