Class: LockstepSdk::CreditMemoInvoiceModel
- Inherits:
-
Object
- Object
- LockstepSdk::CreditMemoInvoiceModel
- Defined in:
- lib/lockstep_sdk/models/credit_memo_invoice_model.rb
Overview
Contains information about a credit memo invoice
Instance Attribute Summary collapse
-
#apply_to_invoice_date ⇒ Date
Date invoice applied to credit memo.
-
#company_id ⇒ Uuid
The ID number of the company that created this invoice.
-
#credit_memo_applied_amount ⇒ Double
Amount applied to credit memo.
-
#credit_memo_applied_id ⇒ Uuid
The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-
#credit_memo_invoice_id ⇒ Uuid
The id of the credit memo invoice.
-
#customer_id ⇒ Uuid
The ID number of the counterparty for the invoice, for example, a customer or vendor.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#invoice_id ⇒ Uuid
The id of the invoice.
-
#invoice_status_code ⇒ String
A code identifying the status of this invoice.
-
#outstanding_balance_amount ⇒ Double
The remaining balance value of this invoice.
-
#reference_code ⇒ String
An additional reference code that is sometimes used to identify this invoice.
-
#total_amount ⇒ Double
The total value of this invoice, inclusive of all taxes and line items.
Instance Method Summary collapse
-
#initialize(params = {}) ⇒ CreditMemoInvoiceModel
constructor
Initialize the CreditMemoInvoiceModel using the provided prototype.
Constructor Details
#initialize(params = {}) ⇒ CreditMemoInvoiceModel
Initialize the CreditMemoInvoiceModel using the provided prototype
24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 24 def initialize(params = {}) @group_key = params.dig(:group_key) @credit_memo_applied_id = params.dig(:credit_memo_applied_id) @invoice_id = params.dig(:invoice_id) @credit_memo_invoice_id = params.dig(:credit_memo_invoice_id) @apply_to_invoice_date = params.dig(:apply_to_invoice_date) @credit_memo_applied_amount = params.dig(:credit_memo_applied_amount) @reference_code = params.dig(:reference_code) @company_id = params.dig(:company_id) @customer_id = params.dig(:customer_id) @invoice_status_code = params.dig(:invoice_status_code) @total_amount = params.dig(:total_amount) @outstanding_balance_amount = params.dig(:outstanding_balance_amount) end |
Instance Attribute Details
#apply_to_invoice_date ⇒ Date
Returns Date invoice applied to credit memo.
48 49 50 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 48 def apply_to_invoice_date @apply_to_invoice_date end |
#company_id ⇒ Uuid
Returns The ID number of the company that created this invoice.
54 55 56 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 54 def company_id @company_id end |
#credit_memo_applied_amount ⇒ Double
Returns Amount applied to credit memo.
50 51 52 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 50 def credit_memo_applied_amount @credit_memo_applied_amount end |
#credit_memo_applied_id ⇒ Uuid
Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
42 43 44 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 42 def credit_memo_applied_id @credit_memo_applied_id end |
#credit_memo_invoice_id ⇒ Uuid
Returns The id of the credit memo invoice.
46 47 48 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 46 def credit_memo_invoice_id @credit_memo_invoice_id end |
#customer_id ⇒ Uuid
Returns The ID number of the counterparty for the invoice, for example, a customer or vendor.
56 57 58 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 56 def customer_id @customer_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).
40 41 42 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 40 def group_key @group_key end |
#invoice_id ⇒ Uuid
Returns The id of the invoice.
44 45 46 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 44 def invoice_id @invoice_id end |
#invoice_status_code ⇒ String
Returns A code identifying the status of this invoice.
58 59 60 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 58 def invoice_status_code @invoice_status_code end |
#outstanding_balance_amount ⇒ Double
Returns The remaining balance value of this invoice.
62 63 64 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 62 def outstanding_balance_amount @outstanding_balance_amount end |
#reference_code ⇒ String
Returns An additional reference code that is sometimes used to identify this invoice. 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/credit_memo_invoice_model.rb', line 52 def reference_code @reference_code end |
#total_amount ⇒ Double
Returns The total value of this invoice, inclusive of all taxes and line items.
60 61 62 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 60 def total_amount @total_amount end |