Class: LockstepSdk::PaymentDetailModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/payment_detail_model.rb

Overview

Contains detailed information about a Payment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ PaymentDetailModel

Initialize the PaymentDetailModel using the provided prototype



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 24

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @payment_id = params.dig(:payment_id)
    @customer_id = params.dig(:customer_id)
    @customer_name = params.dig(:customer_name)
    @memo_text = params.dig(:memo_text)
    @reference_code = params.dig(:reference_code)
    @primary_contact = params.dig(:primary_contact)
    @email = params.dig(:email)
    @payment_amount = params.dig(:payment_amount)
    @unapplied_amount = params.dig(:unapplied_amount)
    @payment_type = params.dig(:payment_type)
    @payment_date = params.dig(:payment_date)
    @post_date = params.dig(:post_date)
    @phone = params.dig(:phone)
    @fax = params.dig(:fax)
    @address1 = params.dig(:address1)
    @address2 = params.dig(:address2)
    @address3 = params.dig(:address3)
    @city = params.dig(:city)
    @state_region = params.dig(:state_region)
    @postal_code = params.dig(:postal_code)
    @country_code = params.dig(:country_code)
end

Instance Attribute Details

#address1String

Returns The first line of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The first line of the address for the Customer's Primary Contact.



80
81
82
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 80

def address1
  @address1
end

#address2String

Returns The second line of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The second line of the address for the Customer's Primary Contact.



82
83
84
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 82

def address2
  @address2
end

#address3String

Returns The third line of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The third line of the address for the Customer's Primary Contact.



84
85
86
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 84

def address3
  @address3
end

#cityString

Returns The city of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The city of the address for the Customer's Primary Contact.



86
87
88
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 86

def city
  @city
end

#country_codeString

Returns The 2 character country code of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The 2 character country code of the address for the Customer's Primary Contact.



92
93
94
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 92

def country_code
  @country_code
end

#customer_idUuid

Returns The ID of the customer to which this Payment belongs.

Returns:

  • (Uuid)

    The ID of the customer to which this Payment belongs.



54
55
56
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 54

def customer_id
  @customer_id
end

#customer_nameString

Returns The name of the customer to which this Payment belongs.

Returns:

  • (String)

    The name of the customer to which this Payment belongs.



56
57
58
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 56

def customer_name
  @customer_name
end

#emailString

Returns The Email address of the Customer.

Returns:

  • (String)

    The Email address of the Customer.



64
65
66
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 64

def email
  @email
end

#faxString

Returns The fax number of the Customer's Primary Contact.

Returns:

  • (String)

    The fax number of the Customer's Primary Contact.



78
79
80
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 78

def fax
  @fax
end

#group_keyUuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid)

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



50
51
52
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 50

def group_key
  @group_key
end

#memo_textString

Returns Memo or reference text (ex. memo field on a check).

Returns:

  • (String)

    Memo or reference text (ex. memo field on a check).



58
59
60
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 58

def memo_text
  @memo_text
end

#payment_amountDouble

Returns Total amount of this Payment.

Returns:

  • (Double)

    Total amount of this Payment.



66
67
68
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 66

def payment_amount
  @payment_amount
end

#payment_dateDate

Returns The date of this Payment.

Returns:

  • (Date)

    The date of this Payment.



72
73
74
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 72

def payment_date
  @payment_date
end

#payment_idUuid

Returns The unique ID of this Payment.

Returns:

  • (Uuid)

    The unique ID of this Payment.



52
53
54
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 52

def payment_id
  @payment_id
end

#payment_typeString

Returns The type of payment, Payment or AP Payment.

Returns:

  • (String)

    The type of payment, Payment or AP Payment.



70
71
72
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 70

def payment_type
  @payment_type
end

#phoneString

Returns The phone number of the Customer's Primary Contact.

Returns:

  • (String)

    The phone number of the Customer's Primary Contact.



76
77
78
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 76

def phone
  @phone
end

#post_dateDate

Returns Payment post date.

Returns:

  • (Date)

    Payment post date.



74
75
76
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 74

def 
  @post_date
end

#postal_codeString

Returns The postal/zip code of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The postal/zip code of the address for the Customer's Primary Contact.



90
91
92
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 90

def postal_code
  @postal_code
end

#primary_contactString

Returns The name of the Primary Contact for the Customer.

Returns:

  • (String)

    The name of the Primary Contact for the Customer.



62
63
64
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 62

def primary_contact
  @primary_contact
end

#reference_codeString

Returns Reference code for the payment for the given Erp system.

Returns:

  • (String)

    Reference code for the payment for the given Erp system.



60
61
62
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 60

def reference_code
  @reference_code
end

#state_regionString

Returns The state/region of the address for the Customer's Primary Contact.

Returns:

  • (String)

    The state/region of the address for the Customer's Primary Contact.



88
89
90
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 88

def state_region
  @state_region
end

#unapplied_amountDouble

Returns Unapplied balance of this Payment.

Returns:

  • (Double)

    Unapplied balance of this Payment.



68
69
70
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 68

def unapplied_amount
  @unapplied_amount
end