Class: Conexa::ReceivingMethod

Inherits:

Model

• Object
• ConexaObject
• Model
• Conexa::ReceivingMethod

Defined in:

lib/conexa/resources/receiving_method.rb

Overview

ReceivingMethod resource (Meio de Recebimento)

Examples:

Find a receiving method

method = Conexa::ReceivingMethod.find(11)
method.name  # => "Cartão de Crédito"

List receiving methods

methods = Conexa::ReceivingMethod.all(limit: 50)

Constant Summary

Constants inherited from ConexaObject

ConexaObject::RESOURCES

Instance Attribute Summary

• #account_id ⇒ Integer^? readonly

  Associated account ID.

• #bill_category_id ⇒ Integer^? readonly

  Bill category ID.

• #bill_subcategory_id ⇒ Integer^? readonly

  Bill subcategory ID.

• #cost_center_id ⇒ Integer^? readonly

  Cost center ID.

• #credit_days ⇒ Integer readonly

  Days until credit.

• #is_active ⇒ Boolean readonly

  Whether the receiving method is active.

• #is_installment_fee ⇒ Boolean readonly

  Whether fee is per installment.

• #max_installments ⇒ Integer readonly

  Maximum number of installments.

• #name ⇒ String readonly

  Name.

• #payment_method_id ⇒ Integer^? readonly

  Payment method ID.

• #receiving_method_id ⇒ Integer readonly

  Receiving method ID (also accessible as #id).

• #supplier_id ⇒ Integer^? readonly

  Supplier ID.

• #transaction_fee ⇒ Float readonly

  Fee per transaction.

• #transaction_rate ⇒ Float readonly

  Rate percentage per transaction.

Attributes inherited from ConexaObject

#attributes

Class Method Summary

• .show_url(*params) ⇒ Object
• .url(*params) ⇒ Object

Methods inherited from Model

all, #class_name, class_name, #create, create, #destroy, destroy, extract_page_size_or_params, #fetch, find_by, find_by_id, #id, #primary_key, primary_key_attribute, #primary_key_name, #save, #set_primary_key, underscored_class_name

Methods included from Deprecatable

#deprecate

Methods inherited from ConexaObject

#==, #[]=, convert, #empty?, #initialize, #respond_to_missing?, #to_hash, #unsaved_attributes

Constructor Details

This class inherits a constructor from Conexa::ConexaObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Conexa::ConexaObject

Instance Attribute Details

#account_id ⇒ Integer^? (readonly)

Returns Associated account ID.

Returns:

• (Integer, nil) —

  Associated account ID

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#bill_category_id ⇒ Integer^? (readonly)

Returns Bill category ID.

Returns:

• (Integer, nil) —

  Bill category ID

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#bill_subcategory_id ⇒ Integer^? (readonly)

Returns Bill subcategory ID.

Returns:

• (Integer, nil) —

  Bill subcategory ID

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#cost_center_id ⇒ Integer^? (readonly)

Returns Cost center ID.

Returns:

• (Integer, nil) —

  Cost center ID

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#credit_days ⇒ Integer (readonly)

Returns Days until credit.

Returns:

• (Integer) —

  Days until credit

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#is_active ⇒ Boolean (readonly)

Returns Whether the receiving method is active.

Returns:

• (Boolean) —

  Whether the receiving method is active

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#is_installment_fee ⇒ Boolean (readonly)

Returns Whether fee is per installment.

Returns:

• (Boolean) —

  Whether fee is per installment

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#max_installments ⇒ Integer (readonly)

Returns Maximum number of installments.

Returns:

• (Integer) —

  Maximum number of installments

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#name ⇒ String (readonly)

Returns Name.

Returns:

• (String) —

  Name

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#payment_method_id ⇒ Integer^? (readonly)

Returns Payment method ID.

Returns:

• (Integer, nil) —

  Payment method ID

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#receiving_method_id ⇒ Integer (readonly)

Returns Receiving method ID (also accessible as #id).

Returns:

• (Integer) —

  Receiving method ID (also accessible as #id)

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#supplier_id ⇒ Integer^? (readonly)

Returns Supplier ID.

Returns:

• (Integer, nil) —

  Supplier ID

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#transaction_fee ⇒ Float (readonly)

Returns Fee per transaction.

Returns:

• (Float) —

  Fee per transaction

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

#transaction_rate ⇒ Float (readonly)

Returns Rate percentage per transaction.

Returns:

• (Float) —

  Rate percentage per transaction

# File 'lib/conexa/resources/receiving_method.rb', line 42

class ReceivingMethod < Model
  primary_key_attribute :receiving_method_id

  class << self
    def url(*params)
      ["/receivingMethods", *params].join '/'
    end

    def show_url(*params)
      ["/receivingMethod", *params].join '/'
    end
  end
end

Class Method Details

.show_url(*params) ⇒ Object

# File 'lib/conexa/resources/receiving_method.rb', line 50

def show_url(*params)
  ["/receivingMethod", *params].join '/'
end

.url(*params) ⇒ Object

# File 'lib/conexa/resources/receiving_method.rb', line 46

def url(*params)
  ["/receivingMethods", *params].join '/'
end