Class: LockstepSdk::PaymentAppliedModel

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

Overview

A Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ PaymentAppliedModel

Initialize the PaymentAppliedModel using the provided prototype



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_applied_model.rb', line 28

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @payment_applied_id = params.dig(:payment_applied_id)
    @invoice_id = params.dig(:invoice_id)
    @payment_id = params.dig(:payment_id)
    @erp_key = params.dig(:erp_key)
    @erp_write_status = params.dig(:erp_write_status)
    @erp_write_status_name = params.dig(:erp_write_status_name)
    @entry_number = params.dig(:entry_number)
    @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
    @payment_applied_amount = params.dig(:payment_applied_amount)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
    @app_enrollment_id = params.dig(:app_enrollment_id)
    @source_modified_date = params.dig(:source_modified_date)
    @payment = params.dig(:payment)
    @invoice = params.dig(:invoice)
end

Instance Attribute Details

#app_enrollment_id ⇒ Uuid

Returns The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.

Returns:

  • (Uuid) —

    The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.



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

def app_enrollment_id
  @app_enrollment_id
end

#apply_to_invoice_date ⇒ Date-time

Returns The date this payment was applied to this invoice.

Returns:

  • (Date-time) —

    The date this payment was applied to this invoice.



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

def apply_to_invoice_date
  @apply_to_invoice_date
end

#created ⇒ Date-time

Returns Date payment applied record was created.

Returns:

  • (Date-time) —

    Date payment applied record was created.



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

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The id of the user who created this applied payment.

Returns:

  • (Uuid) —

    The id of the user who created this applied payment.



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

def created_user_id
  @created_user_id
end

#entry_number ⇒ Int32

Returns The entry number of this payment application. This is often a journal entry number, confirmation code, or other identifying field for this payment application.

Returns:

  • (Int32) —

    The entry number of this payment application. This is often a journal entry number, confirmation code, or other identifying field for this payment application.



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

def entry_number
  @entry_number
end

#erp_key ⇒ String

Returns The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value ‘ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](developer.lockstep.io/docs/identity-columns).

Returns:

  • (String) —

    The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value ‘ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](developer.lockstep.io/docs/identity-columns).



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

def erp_key
  @erp_key
end

#erp_write_status ⇒ ErpWriteStatuses

Returns Possible statuses for a record that supports ERP write.

Returns:

  • (ErpWriteStatuses) —

    Possible statuses for a record that supports ERP write.



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

def erp_write_status
  @erp_write_status
end

#erp_write_status_name ⇒ String

Returns The name of the ErpWriteStatus for this payment application.

Returns:

  • (String) —

    The name of the ErpWriteStatus for this payment application



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

def erp_write_status_name
  @erp_write_status_name
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).



51
52
53
 
# File 'lib/lockstep_sdk/models/payment_applied_model.rb', line 51

def group_key
  @group_key
end

#invoice ⇒ InvoiceModel

Returns The invoice associated with this applied payment.

Returns:

  • (InvoiceModel) —

    The invoice associated with this applied payment.



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

def invoice
  @invoice
end

#invoice_id ⇒ Uuid

Returns The Invoice this payment is applied to.

Returns:

  • (Uuid) —

    The Invoice this payment is applied to.



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

def invoice_id
  @invoice_id
end

#modified ⇒ Date-time

Returns Date payment applied record was modified.

Returns:

  • (Date-time) —

    Date payment applied record was modified.



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

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The id of the user who modified this applied payment.

Returns:

  • (Uuid) —

    The id of the user who modified this applied payment.



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

def modified_user_id
  @modified_user_id
end

#payment ⇒ PaymentModel

Returns The payment associated with this applied payment.

Returns:

  • (PaymentModel) —

    The payment associated with this applied payment



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

def payment
  @payment
end

#payment_applied_amount ⇒ Double

Returns The total amount that was applied to this Invoice from the Payment.

Returns:

  • (Double) —

    The total amount that was applied to this Invoice from the Payment.



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

def payment_applied_amount
  @payment_applied_amount
end

#payment_applied_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. For the ID of this record in its originating financial system, see ‘ErpKey`.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. For the ID of this record in its originating financial system, see ‘ErpKey`.



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

def payment_applied_id
  @payment_applied_id
end

#payment_id ⇒ Uuid

Returns The Payment applied to the invoice.

Returns:

  • (Uuid) —

    The Payment applied to the invoice.



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

def payment_id
  @payment_id
end

#source_modified_date ⇒ Date-time

Returns The date on which this record was last modified in source ERP.

Returns:

  • (Date-time) —

    The date on which this record was last modified in source ERP.



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

def source_modified_date
  @source_modified_date
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/lockstep_sdk/models/payment_applied_model.rb', line 123

def as_json(options={})
    {
        'groupKey' => @group_key,
        'paymentAppliedId' => @payment_applied_id,
        'invoiceId' => @invoice_id,
        'paymentId' => @payment_id,
        'erpKey' => @erp_key,
        'erpWriteStatus' => @erp_write_status,
        'erpWriteStatusName' => @erp_write_status_name,
        'entryNumber' => @entry_number,
        'applyToInvoiceDate' => @apply_to_invoice_date,
        'paymentAppliedAmount' => @payment_applied_amount,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'appEnrollmentId' => @app_enrollment_id,
        'sourceModifiedDate' => @source_modified_date,
        'payment' => @payment,
        'invoice' => @invoice,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



148
149
150
 
# File 'lib/lockstep_sdk/models/payment_applied_model.rb', line 148

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