Class: LockstepSdk::InvoiceLineModel
- Inherits:
-
Object
- Object
- LockstepSdk::InvoiceLineModel
- Defined in:
- lib/lockstep_sdk/models/invoice_line_model.rb
Overview
Represents a line in an invoice
Instance Attribute Summary collapse
-
#app_enrollment_id ⇒ Uuid
The AppEnrollmentId of the application that imported this record.
-
#attachments ⇒ AttachmentModel
A collection of attachments linked to this record.
-
#created ⇒ Date-time
The date on which this line was created.
-
#created_user_id ⇒ Uuid
The ID number of the user who created this line.
-
#description ⇒ String
Description of this invoice line.
-
#erp_key ⇒ String
The unique ID of this record as it was known in its originating financial system, if it was different from the original ‘LineNumber`.
-
#erp_write_status ⇒ ErpWriteStatuses
Possible statuses for a record that supports ERP write.
-
#erp_write_status_name ⇒ String
The name of the ErpWriteStatus for this Invoice.
-
#exemption_code ⇒ String
If this line is tax exempt, this code indicates the reason for the exemption.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#invoice_id ⇒ Uuid
The ID number of the invoice this line belongs to.
-
#invoice_line_id ⇒ Uuid
The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-
#line_number ⇒ String
The line number of this line, as defined in the originating ERP or accounting system.
-
#modified ⇒ Date-time
The date on which this line was last modified.
-
#modified_user_id ⇒ Uuid
The ID number of the user who most recently modified this line.
-
#notes ⇒ NoteModel
A collection of notes linked to this record.
-
#override_bill_to_address_id ⇒ Uuid
An optional ID number for the line’s bill to address.
-
#override_origin_address_id ⇒ Uuid
An optional ID number for the line’s origin address.
-
#override_ship_to_address_id ⇒ Uuid
An optional ID number for the line’s ship to address.
-
#product_code ⇒ String
A code number identifying the product or service that is specified on this line.
-
#quantity ⇒ Double
The quantity of items for ths line.
-
#quantity_received ⇒ Double
The number of items that has been received.
-
#quantity_shipped ⇒ Double
The number of items that have been shipped.
-
#reporting_date ⇒ Date
If null, the products specified on this line were delivered on the same date as all other lines.
-
#source_modified_date ⇒ Date-time
The date on which this record was last modified in source ERP.
-
#total_amount ⇒ Double
The total amount for this line.
-
#unit_measure_code ⇒ String
For lines measured in a unit other than “quantity”, this code indicates the measurement system for the quantity field.
-
#unit_price ⇒ Double
The price of a single unit for this line.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ InvoiceLineModel
constructor
Initialize the InvoiceLineModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ InvoiceLineModel
Initialize the InvoiceLineModel using the provided prototype
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 25 def initialize(params = {}) @invoice_line_id = params.dig(:invoice_line_id) @group_key = params.dig(:group_key) @invoice_id = params.dig(:invoice_id) @erp_key = params.dig(:erp_key) @line_number = params.dig(:line_number) @product_code = params.dig(:product_code) @description = params.dig(:description) @unit_measure_code = params.dig(:unit_measure_code) @unit_price = params.dig(:unit_price) @quantity = params.dig(:quantity) @quantity_shipped = params.dig(:quantity_shipped) @quantity_received = params.dig(:quantity_received) @total_amount = params.dig(:total_amount) @exemption_code = params.dig(:exemption_code) @reporting_date = params.dig(:reporting_date) @override_origin_address_id = params.dig(:override_origin_address_id) @override_bill_to_address_id = params.dig(:override_bill_to_address_id) @override_ship_to_address_id = params.dig(:override_ship_to_address_id) @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) @erp_write_status = params.dig(:erp_write_status) @erp_write_status_name = params.dig(:erp_write_status_name) @source_modified_date = params.dig(:source_modified_date) @notes = params.dig(:notes) @attachments = params.dig(:attachments) end |
Instance Attribute Details
#app_enrollment_id ⇒ Uuid
146 147 148 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 146 def app_enrollment_id @app_enrollment_id end |
#attachments ⇒ AttachmentModel
166 167 168 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 166 def @attachments end |
#created ⇒ Date-time
130 131 132 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 130 def created @created end |
#created_user_id ⇒ Uuid
134 135 136 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 134 def created_user_id @created_user_id end |
#description ⇒ String
82 83 84 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 82 def description @description end |
#erp_key ⇒ String
70 71 72 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 70 def erp_key @erp_key end |
#erp_write_status ⇒ ErpWriteStatuses
150 151 152 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 150 def erp_write_status @erp_write_status end |
#erp_write_status_name ⇒ String
154 155 156 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 154 def erp_write_status_name @erp_write_status_name end |
#exemption_code ⇒ String
110 111 112 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 110 def exemption_code @exemption_code end |
#group_key ⇒ Uuid
62 63 64 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 62 def group_key @group_key end |
#invoice_id ⇒ Uuid
66 67 68 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 66 def invoice_id @invoice_id end |
#invoice_line_id ⇒ Uuid
58 59 60 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 58 def invoice_line_id @invoice_line_id end |
#line_number ⇒ String
74 75 76 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 74 def line_number @line_number end |
#modified ⇒ Date-time
138 139 140 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 138 def modified @modified end |
#modified_user_id ⇒ Uuid
142 143 144 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 142 def modified_user_id @modified_user_id end |
#notes ⇒ NoteModel
162 163 164 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 162 def notes @notes end |
#override_bill_to_address_id ⇒ Uuid
122 123 124 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 122 def override_bill_to_address_id @override_bill_to_address_id end |
#override_origin_address_id ⇒ Uuid
118 119 120 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 118 def override_origin_address_id @override_origin_address_id end |
#override_ship_to_address_id ⇒ Uuid
126 127 128 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 126 def override_ship_to_address_id @override_ship_to_address_id end |
#product_code ⇒ String
78 79 80 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 78 def product_code @product_code end |
#quantity ⇒ Double
94 95 96 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 94 def quantity @quantity end |
#quantity_received ⇒ Double
102 103 104 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 102 def quantity_received @quantity_received end |
#quantity_shipped ⇒ Double
98 99 100 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 98 def quantity_shipped @quantity_shipped end |
#reporting_date ⇒ Date
114 115 116 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 114 def reporting_date @reporting_date end |
#source_modified_date ⇒ Date-time
158 159 160 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 158 def source_modified_date @source_modified_date end |
#total_amount ⇒ Double
106 107 108 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 106 def total_amount @total_amount end |
#unit_measure_code ⇒ String
86 87 88 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 86 def unit_measure_code @unit_measure_code end |
#unit_price ⇒ Double
90 91 92 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 90 def unit_price @unit_price end |
Instance Method Details
#as_json(options = {}) ⇒ object
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 170 def as_json(={}) { 'invoiceLineId' => @invoice_line_id, 'groupKey' => @group_key, 'invoiceId' => @invoice_id, 'erpKey' => @erp_key, 'lineNumber' => @line_number, 'productCode' => @product_code, 'description' => @description, 'unitMeasureCode' => @unit_measure_code, 'unitPrice' => @unit_price, 'quantity' => @quantity, 'quantityShipped' => @quantity_shipped, 'quantityReceived' => @quantity_received, 'totalAmount' => @total_amount, 'exemptionCode' => @exemption_code, 'reportingDate' => @reporting_date, 'overrideOriginAddressId' => @override_origin_address_id, 'overrideBillToAddressId' => @override_bill_to_address_id, 'overrideShipToAddressId' => @override_ship_to_address_id, 'created' => @created, 'createdUserId' => @created_user_id, 'modified' => @modified, 'modifiedUserId' => @modified_user_id, 'appEnrollmentId' => @app_enrollment_id, 'erpWriteStatus' => @erp_write_status, 'erpWriteStatusName' => @erp_write_status_name, 'sourceModifiedDate' => @source_modified_date, 'notes' => @notes, 'attachments' => @attachments, } end |
#to_json(*options) ⇒ String
205 206 207 |
# File 'lib/lockstep_sdk/models/invoice_line_model.rb', line 205 def to_json(*) "[#{as_json(*).to_json(*)}]" end |