Class: LockstepSdk::PaymentDetailModel
- Inherits:
-
Object
- Object
- LockstepSdk::PaymentDetailModel
- Defined in:
- lib/lockstep_sdk/models/payment_detail_model.rb
Overview
Contains detailed information about a Payment.
Instance Attribute Summary collapse
-
#address1 ⇒ String
The first line of the address for the Customer's Primary Contact.
-
#address2 ⇒ String
The second line of the address for the Customer's Primary Contact.
-
#address3 ⇒ String
The third line of the address for the Customer's Primary Contact.
-
#city ⇒ String
The city of the address for the Customer's Primary Contact.
-
#country_code ⇒ String
The 2 character country code of the address for the Customer's Primary Contact.
-
#customer_id ⇒ Uuid
The ID of the customer to which this Payment belongs.
-
#customer_name ⇒ String
The name of the customer to which this Payment belongs.
-
#email ⇒ String
The Email address of the Customer.
-
#fax ⇒ String
The fax number of the Customer's Primary Contact.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#memo_text ⇒ String
Memo or reference text (ex. memo field on a check).
-
#payment_amount ⇒ Double
Total amount of this Payment.
-
#payment_date ⇒ Date
The date of this Payment.
-
#payment_id ⇒ Uuid
The unique ID of this Payment.
-
#payment_type ⇒ String
The type of payment, Payment or AP Payment.
-
#phone ⇒ String
The phone number of the Customer's Primary Contact.
-
#post_date ⇒ Date
Payment post date.
-
#postal_code ⇒ String
The postal/zip code of the address for the Customer's Primary Contact.
-
#primary_contact ⇒ String
The name of the Primary Contact for the Customer.
-
#reference_code ⇒ String
Reference code for the payment for the given Erp system.
-
#state_region ⇒ String
The state/region of the address for the Customer's Primary Contact.
-
#unapplied_amount ⇒ Double
Unapplied balance of this Payment.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ PaymentDetailModel
constructor
Initialize the PaymentDetailModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ PaymentDetailModel
Initialize the PaymentDetailModel using the provided prototype
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 26 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.
82 83 84 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 82 def address1 @address1 end |
#address2 ⇒ String
Returns The second 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 address2 @address2 end |
#address3 ⇒ String
Returns The third line of the address for the Customer's Primary Contact.
86 87 88 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 86 def address3 @address3 end |
#city ⇒ String
Returns The city of the address for the Customer's Primary Contact.
88 89 90 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 88 def city @city end |
#country_code ⇒ String
Returns The 2 character country code of the address for the Customer's Primary Contact.
94 95 96 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 94 def country_code @country_code end |
#customer_id ⇒ Uuid
Returns The ID of the customer to which this Payment belongs.
56 57 58 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 56 def customer_id @customer_id end |
#customer_name ⇒ String
Returns The name of the customer to which this Payment belongs.
58 59 60 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 58 def customer_name @customer_name end |
#email ⇒ String
Returns The Email address of the Customer.
66 67 68 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 66 def email @email end |
#fax ⇒ String
Returns The fax number of the Customer's Primary Contact.
80 81 82 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 80 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).
52 53 54 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 52 def group_key @group_key end |
#memo_text ⇒ String
Returns Memo or reference text (ex. memo field on a check).
60 61 62 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 60 def memo_text @memo_text end |
#payment_amount ⇒ Double
Returns Total amount of this Payment.
68 69 70 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 68 def payment_amount @payment_amount end |
#payment_date ⇒ Date
Returns The date of this Payment.
74 75 76 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 74 def payment_date @payment_date end |
#payment_id ⇒ Uuid
Returns The unique ID of this Payment.
54 55 56 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 54 def payment_id @payment_id end |
#payment_type ⇒ String
Returns The type of payment, Payment or AP Payment.
72 73 74 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 72 def payment_type @payment_type end |
#phone ⇒ String
Returns The phone number of the Customer's Primary Contact.
78 79 80 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 78 def phone @phone end |
#post_date ⇒ Date
Returns Payment post date.
76 77 78 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 76 def post_date @post_date end |
#postal_code ⇒ String
Returns The postal/zip 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 postal_code @postal_code end |
#primary_contact ⇒ String
Returns The name of the Primary Contact for the Customer.
64 65 66 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 64 def primary_contact @primary_contact end |
#reference_code ⇒ String
Returns Reference code for the payment for the given Erp system.
62 63 64 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 62 def reference_code @reference_code end |
#state_region ⇒ String
Returns The state/region of the address for the Customer's Primary Contact.
90 91 92 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 90 def state_region @state_region end |
#unapplied_amount ⇒ Double
Returns Unapplied balance of this Payment.
70 71 72 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 70 def unapplied_amount @unapplied_amount end |
Instance Method Details
#as_json(options = {}) ⇒ object
Returns This object as a JSON key-value structure.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 97 def as_json(={}) { '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.
125 126 127 |
# File 'lib/lockstep_sdk/models/payment_detail_model.rb', line 125 def to_json(*) "[#{as_json(*).to_json(*)}]" end |