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



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

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

#address1 ⇒ String

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.



115
116
117
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 115

def address1
  @address1
end

#address2 ⇒ String

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.



119
120
121
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 119

def address2
  @address2
end

#address3 ⇒ String

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.



123
124
125
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 123

def address3
  @address3
end

#city ⇒ String

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.



127
128
129
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 127

def city
  @city
end

#country_code ⇒ String

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.



139
140
141
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 139

def country_code
  @country_code
end

#customer_id ⇒ Uuid

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

Returns:

  • (Uuid) —

    The ID of the customer to which this Payment belongs.



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

def customer_id
  @customer_id
end

#customer_name ⇒ String

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

Returns:

  • (String) —

    The name of the customer to which this Payment belongs.



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

def customer_name
  @customer_name
end

#email ⇒ String

Returns The Email address of the Customer.

Returns:

  • (String) —

    The Email address of the Customer.



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

def email
  @email
end

#fax ⇒ String

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

Returns:

  • (String) —

    The fax number of the Customer's Primary Contact.



111
112
113
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 111

def fax
  @fax
end

#group_key ⇒ Uuid

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



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

def group_key
  @group_key
end

#memo_text ⇒ String

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

Returns:

  • (String) —

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



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

def memo_text
  @memo_text
end

#payment_amount ⇒ Double

Returns Total amount of this Payment.

Returns:

  • (Double) —

    Total amount of this Payment.



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

def payment_amount
  @payment_amount
end

#payment_date ⇒ Date

Returns The date of this Payment.

Returns:

  • (Date) —

    The date of this Payment.



99
100
101
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 99

def payment_date
  @payment_date
end

#payment_id ⇒ Uuid

Returns The unique ID of this Payment.

Returns:

  • (Uuid) —

    The unique ID of this Payment.



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

def payment_id
  @payment_id
end

#payment_type ⇒ String

Returns The type of payment, Payment or AP Payment.

Returns:

  • (String) —

    The type of payment, Payment or AP Payment.



95
96
97
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 95

def payment_type
  @payment_type
end

#phone ⇒ String

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

Returns:

  • (String) —

    The phone number of the Customer's Primary Contact.



107
108
109
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 107

def phone
  @phone
end

#post_date ⇒ Date

Returns Payment post date.

Returns:

  • (Date) —

    Payment post date.



103
104
105
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 103

def post_date
  @post_date
end

#postal_code ⇒ String

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.



135
136
137
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 135

def postal_code
  @postal_code
end

#primary_contact ⇒ String

Returns The name of the Primary Contact for the Customer.

Returns:

  • (String) —

    The name of the Primary Contact for the Customer.



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

def primary_contact
  @primary_contact
end

#reference_code ⇒ String

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

Returns:

  • (String) —

    Reference code for the payment for the given Erp system.



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

def reference_code
  @reference_code
end

#state_region ⇒ String

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.



131
132
133
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 131

def state_region
  @state_region
end

#unapplied_amount ⇒ Double

Returns Unapplied balance of this Payment.

Returns:

  • (Double) —

    Unapplied balance of this Payment.



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

def unapplied_amount
  @unapplied_amount
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 143

def as_json(options={})
    {
        'groupKey' => @group_key,
        'paymentId' => @payment_id,
        'customerId' => @customer_id,
        'customerName' => @customer_name,
        'memoText' => @memo_text,
        'referenceCode' => @reference_code,
        'primaryContact' => @primary_contact,
        'email' => @email,
        'paymentAmount' => @payment_amount,
        'unappliedAmount' => @unapplied_amount,
        'paymentType' => @payment_type,
        'paymentDate' => @payment_date,
        'postDate' => @post_date,
        'phone' => @phone,
        'fax' => @fax,
        'address1' => @address1,
        'address2' => @address2,
        'address3' => @address3,
        'city' => @city,
        'stateRegion' => @state_region,
        'postalCode' => @postal_code,
        'countryCode' => @country_code,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



172
173
174
 
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 172

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end