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
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ CreditMemoInvoiceModel
constructor
Initialize the CreditMemoInvoiceModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ CreditMemoInvoiceModel
Initialize the CreditMemoInvoiceModel using the provided prototype
27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 27 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
60 61 62 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 60 def apply_to_invoice_date @apply_to_invoice_date end |
#company_id ⇒ Uuid
72 73 74 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 72 def company_id @company_id end |
#credit_memo_applied_amount ⇒ Double
64 65 66 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 64 def credit_memo_applied_amount @credit_memo_applied_amount end |
#credit_memo_applied_id ⇒ Uuid
48 49 50 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 48 def credit_memo_applied_id @credit_memo_applied_id end |
#credit_memo_invoice_id ⇒ Uuid
56 57 58 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 56 def credit_memo_invoice_id @credit_memo_invoice_id end |
#customer_id ⇒ Uuid
76 77 78 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 76 def customer_id @customer_id end |
#group_key ⇒ Uuid
44 45 46 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 44 def group_key @group_key end |
#invoice_id ⇒ Uuid
52 53 54 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 52 def invoice_id @invoice_id end |
#invoice_status_code ⇒ String
80 81 82 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 80 def invoice_status_code @invoice_status_code end |
#outstanding_balance_amount ⇒ Double
88 89 90 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 88 def outstanding_balance_amount @outstanding_balance_amount end |
#reference_code ⇒ String
68 69 70 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 68 def reference_code @reference_code end |
#total_amount ⇒ Double
84 85 86 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 84 def total_amount @total_amount end |
Instance Method Details
#as_json(options = {}) ⇒ object
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 92 def as_json(={}) { 'groupKey' => @group_key, 'creditMemoAppliedId' => @credit_memo_applied_id, 'invoiceId' => @invoice_id, 'creditMemoInvoiceId' => @credit_memo_invoice_id, 'applyToInvoiceDate' => @apply_to_invoice_date, 'creditMemoAppliedAmount' => @credit_memo_applied_amount, 'referenceCode' => @reference_code, 'companyId' => @company_id, 'customerId' => @customer_id, 'invoiceStatusCode' => @invoice_status_code, 'totalAmount' => @total_amount, 'outstandingBalanceAmount' => @outstanding_balance_amount, } end |
#to_json(*options) ⇒ String
111 112 113 |
# File 'lib/lockstep_sdk/models/credit_memo_invoice_model.rb', line 111 def to_json(*) "[#{as_json(*).to_json(*)}]" end |