Class: LockstepSdk::InvoicePaymentDetailModel

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

Overview

View to return Payment Detail information for a given Invoice record.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ InvoicePaymentDetailModel

Initialize the InvoicePaymentDetailModel using the provided prototype



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 26

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)
    @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
    @payment_applied_amount = params.dig(:payment_applied_amount)
    @reference_code = params.dig(:reference_code)
    @company_id = params.dig(:company_id)
    @payment_amount = params.dig(:payment_amount)
    @unapplied_amount = params.dig(:unapplied_amount)
end

Instance Attribute Details

#apply_to_invoice_date ⇒ Date

Returns Date Payment applied to Invoice.

Returns:

  • (Date) —

    Date Payment applied to Invoice.



48
49
50
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 48

def apply_to_invoice_date
  @apply_to_invoice_date
end

#company_id ⇒ Uuid

Returns The ID number of the Company (CompanyType = “Customer”) that created this Payment.

Returns:

  • (Uuid) —

    The ID number of the Company (CompanyType = “Customer”) that created this Payment.



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

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



40
41
42
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 40

def group_key
  @group_key
end

#invoice_id ⇒ Uuid

Returns The database id of the invoice.

Returns:

  • (Uuid) —

    The database id of the invoice



44
45
46
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 44

def invoice_id
  @invoice_id
end

#payment_amount ⇒ Double

Returns The total value of this Payment.

Returns:

  • (Double) —

    The total value of this Payment.



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

def payment_amount
  @payment_amount
end

#payment_applied_amount ⇒ Double

Returns Amount applied to Invoice.

Returns:

  • (Double) —

    Amount applied to Invoice.



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

def payment_applied_amount
  @payment_applied_amount
end

#payment_applied_id ⇒ Uuid

Returns The unique identifier of this PaymentApplied record.

Returns:

  • (Uuid) —

    The unique identifier of this PaymentApplied record.



42
43
44
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 42

def payment_applied_id
  @payment_applied_id
end

#payment_id ⇒ Uuid

Returns The database id of the Payment.

Returns:

  • (Uuid) —

    The database id of the Payment.



46
47
48
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 46

def payment_id
  @payment_id
end

#reference_code ⇒ String

Returns An additional reference code that is sometimes used to identify this Payment. The meaning of this field is specific to the ERP or accounting system used by the user.

Returns:

  • (String) —

    An additional reference code that is sometimes used to identify this Payment. The meaning of this field is specific to the ERP or accounting system used by the user.



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

def reference_code
  @reference_code
end

#unapplied_amount ⇒ Double

Returns The remaining balance value of this Payment.

Returns:

  • (Double) —

    The remaining balance value of this Payment.



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

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 61

def as_json(options={})
    {
        'groupKey' => @group_key,
        'paymentAppliedId' => @payment_applied_id,
        'invoiceId' => @invoice_id,
        'paymentId' => @payment_id,
        'applyToInvoiceDate' => @apply_to_invoice_date,
        'paymentAppliedAmount' => @payment_applied_amount,
        'referenceCode' => @reference_code,
        'companyId' => @company_id,
        'paymentAmount' => @payment_amount,
        'unappliedAmount' => @unapplied_amount,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



77
78
79
 
# File 'lib/lockstep_sdk/models/invoice_payment_detail_model.rb', line 77

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