Class: LockstepSdk::InvoiceModel

Inherits:

Object

Object
LockstepSdk::InvoiceModel

show all

Defined in:: lib/lockstep_sdk/models/invoice_model.rb

Overview

An Invoice represents a bill sent from one company to another. The creator of the invoice is identified by the CompanyId field, and the recipient of the invoice is identified by the CustomerId field. Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP “key” that was generated by the system that originated the invoice. Invoices have a total amount and a due date, and when some payments have been made on the Invoice the TotalAmount and the OutstandingBalanceAmount may be different.

Instance Attribute Summary collapse

#addresses ⇒ InvoiceAddressModel

All addresses connected to this invoice.
#app_enrollment_id ⇒ Uuid

The AppEnrollmentId of the application that imported this record.
#attachments ⇒ AttachmentModel

A collection of attachments linked to this record.
#base_currency_discount_amount ⇒ Double

The total discounts given by the seller to the buyer on this invoice in the group’s base currency.
#base_currency_outstanding_balance_amount ⇒ Double

The remaining balance value of this invoice in the group’s base currency.
#base_currency_sales_tax_amount ⇒ Double

The total sales (or transactional) tax calculated for this invoice in the group’s base currency.
#base_currency_total_amount ⇒ Double

The total value of this invoice, inclusive of all taxes and line items in the group’s base currency.
#company ⇒ CompanyModel

The Company associated to this invoice.
#company_id ⇒ Uuid

The ID number of the company that created this invoice.
#created ⇒ Date-time

The date on which this invoice record was created.
#created_user_id ⇒ Uuid

The ID number of the user who created this invoice.
#credit_memos ⇒ CreditMemoInvoiceModel

The credit memos associated to this invoice.
#currency_code ⇒ String

The three-character ISO 4217 currency code used for this invoice.
#currency_rate ⇒ Double

The Currency Rate used to get from the account’s base currency to the invoice amount.
#custom_field_definitions ⇒ CustomFieldDefinitionModel

A collection of custom fields linked to this record.
#custom_field_values ⇒ CustomFieldValueModel

A collection of custom fields linked to this record.
#customer ⇒ CompanyModel

The Customer associated to the invoice customer To retrieve this item, specify Customer in the “Include” parameter for your query.
#customer_id ⇒ Uuid

The ID number of the counterparty for the invoice, for example, a customer or vendor.
#customer_primary_contact ⇒ ContactModel

The Contact associated to the invoice customer To retrieve this item, specify Customer in the “Include” parameter for your query.
#discount_amount ⇒ Double

The total discounts given by the seller to the buyer on this invoice in it’s tendered currency.
#discount_date ⇒ Date

The date when discounts were adjusted for this invoice.
#erp_key ⇒ String

The unique ID of this record as it was known in its originating financial system.
#exclude_from_aging ⇒ Boolean

Should the invoice be excluded from aging calculations?.
#group_key ⇒ Uuid

The GroupKey uniquely identifies a single Lockstep Platform account.
#imported_date ⇒ Date-time

The date and time when this record was imported from the user’s ERP or accounting system.
#in_dispute ⇒ Boolean

Is the invoice in dispute?.
#invoice_closed_date ⇒ Date

The date when the invoice was closed and finalized after completion of all payments and delivery of all products and services.
#invoice_date ⇒ Date

The reporting date for this invoice.
#invoice_id ⇒ Uuid

The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
#invoice_status_code ⇒ String

A code identifying the status of this invoice.
#invoice_type_code ⇒ String

A code identifying the type of this invoice.
#is_voided ⇒ Boolean

Is the invoice voided?.
#lines ⇒ InvoiceLineModel

All lines attached to this invoice.
#modified ⇒ Date-time

The date on which this invoice record was last modified.
#modified_user_id ⇒ Uuid

The ID number of the user who most recently modified this invoice.
#notes ⇒ NoteModel

A collection of notes linked to this record.
#outstanding_balance_amount ⇒ Double

The remaining balance value of this invoice in it’s tendered currency.
#payment_due_date ⇒ Date

The date when the remaining outstanding balance is due.
#payments ⇒ InvoicePaymentDetailModel

All payments attached to this invoice, the amount of the payment applied to this Invoice, and the date the Payment was applied.
#posted_date ⇒ Date

The date when this invoice posted to the company’s general ledger.
#preferred_delivery_method ⇒ String

Indicates the preferred delivery method for this invoice.
#primary_bill_to_address_id ⇒ Uuid

The ID number of the invoice’s bill-to address.
#primary_origin_address_id ⇒ Uuid

The ID number of the invoice’s origination address.
#primary_ship_to_address_id ⇒ Uuid

The ID number of the invoice’s ship-to address.
#purchase_order_code ⇒ String

The “Purchase Order Code” is a code that is sometimes used by companies to refer to the original PO that was sent that caused this invoice to be written.
#reference_code ⇒ String

An additional reference code that is sometimes used to identify this invoice.
#sales_tax_amount ⇒ Double

The total sales (or transactional) tax calculated for this invoice in it’s tendered currency.
#salesperson_code ⇒ String

A code identifying the salesperson responsible for writing this quote, invoice, or order.
#salesperson_name ⇒ String

A name identifying the salesperson responsible for writing this quote, invoice, or order.
#special_terms ⇒ String

If the customer negotiated any special terms different from the standard terms above, describe them here.
#terms_code ⇒ String

A code identifying the terms given to the purchaser.
#total_amount ⇒ Double

The total value of this invoice, inclusive of all taxes and line items in it’s tendered currency.

Instance Method Summary collapse

#as_json(options = {}) ⇒ object

This object as a JSON key-value structure.
#initialize(params = {}) ⇒ InvoiceModel constructor

Initialize the InvoiceModel using the provided prototype.
#to_json(*options) ⇒ String

This object converted to a JSON string.

Constructor Details

#initialize(params = {}) ⇒ `InvoiceModel`

Initialize the InvoiceModel using the provided prototype

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 30

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @invoice_id = params.dig(:invoice_id)
    @company_id = params.dig(:company_id)
    @customer_id = params.dig(:customer_id)
    @erp_key = params.dig(:erp_key)
    @purchase_order_code = params.dig(:purchase_order_code)
    @reference_code = params.dig(:reference_code)
    @salesperson_code = params.dig(:salesperson_code)
    @salesperson_name = params.dig(:salesperson_name)
    @invoice_type_code = params.dig(:invoice_type_code)
    @invoice_status_code = params.dig(:invoice_status_code)
    @terms_code = params.dig(:terms_code)
    @special_terms = params.dig(:special_terms)
    @currency_code = params.dig(:currency_code)
    @total_amount = params.dig(:total_amount)
    @sales_tax_amount = params.dig(:sales_tax_amount)
    @discount_amount = params.dig(:discount_amount)
    @outstanding_balance_amount = params.dig(:outstanding_balance_amount)
    @invoice_date = params.dig(:invoice_date)
    @discount_date = params.dig(:discount_date)
    @posted_date = params.dig(:posted_date)
    @invoice_closed_date = params.dig(:invoice_closed_date)
    @payment_due_date = params.dig(:payment_due_date)
    @imported_date = params.dig(:imported_date)
    @primary_origin_address_id = params.dig(:primary_origin_address_id)
    @primary_bill_to_address_id = params.dig(:primary_bill_to_address_id)
    @primary_ship_to_address_id = params.dig(:primary_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)
    @is_voided = params.dig(:is_voided)
    @in_dispute = params.dig(:in_dispute)
    @exclude_from_aging = params.dig(:exclude_from_aging)
    @preferred_delivery_method = params.dig(:preferred_delivery_method)
    @currency_rate = params.dig(:currency_rate)
    @base_currency_total_amount = params.dig(:base_currency_total_amount)
    @base_currency_sales_tax_amount = params.dig(:base_currency_sales_tax_amount)
    @base_currency_discount_amount = params.dig(:base_currency_discount_amount)
    @base_currency_outstanding_balance_amount = params.dig(:base_currency_outstanding_balance_amount)
    @addresses = params.dig(:addresses)
    @lines = params.dig(:lines)
    @payments = params.dig(:payments)
    @notes = params.dig(:notes)
    @attachments = params.dig(:attachments)
    @company = params.dig(:company)
    @customer = params.dig(:customer)
    @customer_primary_contact = params.dig(:customer_primary_contact)
    @credit_memos = params.dig(:credit_memos)
    @custom_field_values = params.dig(:custom_field_values)
    @custom_field_definitions = params.dig(:custom_field_definitions)
end

Instance Attribute Details

#addresses ⇒ `InvoiceAddressModel`



251
252
253

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 251

def addresses
  @addresses
end

#app_enrollment_id ⇒ `Uuid`



211
212
213

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 211

def app_enrollment_id
  @app_enrollment_id
end

#attachments ⇒ `AttachmentModel`



267
268
269

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 267

def attachments
  @attachments
end

#base_currency_discount_amount ⇒ `Double`



243
244
245

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 243

def base_currency_discount_amount
  @base_currency_discount_amount
end

#base_currency_outstanding_balance_amount ⇒ `Double`



247
248
249

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 247

def base_currency_outstanding_balance_amount
  @base_currency_outstanding_balance_amount
end

#base_currency_sales_tax_amount ⇒ `Double`



239
240
241

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 239

def base_currency_sales_tax_amount
  @base_currency_sales_tax_amount
end

#base_currency_total_amount ⇒ `Double`



235
236
237

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 235

def base_currency_total_amount
  @base_currency_total_amount
end

#company ⇒ `CompanyModel`



271
272
273

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 271

def company
  @company
end

#company_id ⇒ `Uuid`



95
96
97

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 95

def company_id
  @company_id
end

#created ⇒ `Date-time`



195
196
197

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 195

def created
  @created
end

#created_user_id ⇒ `Uuid`



199
200
201

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 199

def created_user_id
  @created_user_id
end

#credit_memos ⇒ `CreditMemoInvoiceModel`



283
284
285

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 283

def credit_memos
  @credit_memos
end

#currency_code ⇒ `String`



139
140
141

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 139

def currency_code
  @currency_code
end

#currency_rate ⇒ `Double`



231
232
233

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 231

def currency_rate
  @currency_rate
end

#custom_field_definitions ⇒ `CustomFieldDefinitionModel`



291
292
293

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 291

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_values ⇒ `CustomFieldValueModel`



287
288
289

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 287

def custom_field_values
  @custom_field_values
end

#customer ⇒ `CompanyModel`



275
276
277

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 275

def customer
  @customer
end

#customer_id ⇒ `Uuid`



99
100
101

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 99

def customer_id
  @customer_id
end

#customer_primary_contact ⇒ `ContactModel`



279
280
281

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 279

def customer_primary_contact
  @customer_primary_contact
end

#discount_amount ⇒ `Double`



151
152
153

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 151

def discount_amount
  @discount_amount
end

#discount_date ⇒ `Date`



163
164
165

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 163

def discount_date
  @discount_date
end

#erp_key ⇒ `String`



103
104
105

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 103

def erp_key
  @erp_key
end

#exclude_from_aging ⇒ `Boolean`



223
224
225

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 223

def exclude_from_aging
  @exclude_from_aging
end

#group_key ⇒ `Uuid`



87
88
89

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 87

def group_key
  @group_key
end

#imported_date ⇒ `Date-time`



179
180
181

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 179

def imported_date
  @imported_date
end

#in_dispute ⇒ `Boolean`



219
220
221

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 219

def in_dispute
  @in_dispute
end

#invoice_closed_date ⇒ `Date`



171
172
173

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 171

def invoice_closed_date
  @invoice_closed_date
end

#invoice_date ⇒ `Date`



159
160
161

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 159

def invoice_date
  @invoice_date
end

#invoice_id ⇒ `Uuid`



91
92
93

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 91

def invoice_id
  @invoice_id
end

#invoice_status_code ⇒ `String`



127
128
129

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 127

def invoice_status_code
  @invoice_status_code
end

#invoice_type_code ⇒ `String`



123
124
125

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 123

def invoice_type_code
  @invoice_type_code
end

#is_voided ⇒ `Boolean`



215
216
217

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 215

def is_voided
  @is_voided
end

#lines ⇒ `InvoiceLineModel`



255
256
257

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 255

def lines
  @lines
end

#modified ⇒ `Date-time`



203
204
205

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 203

def modified
  @modified
end

#modified_user_id ⇒ `Uuid`



207
208
209

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 207

def modified_user_id
  @modified_user_id
end

#notes ⇒ `NoteModel`



263
264
265

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 263

def notes
  @notes
end

#outstanding_balance_amount ⇒ `Double`



155
156
157

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 155

def outstanding_balance_amount
  @outstanding_balance_amount
end

#payment_due_date ⇒ `Date`



175
176
177

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 175

def payment_due_date
  @payment_due_date
end

#payments ⇒ `InvoicePaymentDetailModel`



259
260
261

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 259

def payments
  @payments
end

#posted_date ⇒ `Date`



167
168
169

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 167

def posted_date
  @posted_date
end

#preferred_delivery_method ⇒ `String`



227
228
229

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 227

def preferred_delivery_method
  @preferred_delivery_method
end

#primary_bill_to_address_id ⇒ `Uuid`



187
188
189

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 187

def primary_bill_to_address_id
  @primary_bill_to_address_id
end

#primary_origin_address_id ⇒ `Uuid`



183
184
185

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 183

def primary_origin_address_id
  @primary_origin_address_id
end

#primary_ship_to_address_id ⇒ `Uuid`



191
192
193

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 191

def primary_ship_to_address_id
  @primary_ship_to_address_id
end

#purchase_order_code ⇒ `String`



107
108
109

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 107

def purchase_order_code
  @purchase_order_code
end

#reference_code ⇒ `String`



111
112
113

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 111

def reference_code
  @reference_code
end

#sales_tax_amount ⇒ `Double`



147
148
149

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 147

def sales_tax_amount
  @sales_tax_amount
end

#salesperson_code ⇒ `String`



115
116
117

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 115

def salesperson_code
  @salesperson_code
end

#salesperson_name ⇒ `String`



119
120
121

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 119

def salesperson_name
  @salesperson_name
end

#special_terms ⇒ `String`



135
136
137

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 135

def special_terms
  @special_terms
end

#terms_code ⇒ `String`



131
132
133

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 131

def terms_code
  @terms_code
end

#total_amount ⇒ `Double`



143
144
145

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 143

def total_amount
  @total_amount
end

Instance Method Details

#as_json(options = {}) ⇒ `object`

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 295

def as_json(options={})
    {
        'groupKey' => @group_key,
        'invoiceId' => @invoice_id,
        'companyId' => @company_id,
        'customerId' => @customer_id,
        'erpKey' => @erp_key,
        'purchaseOrderCode' => @purchase_order_code,
        'referenceCode' => @reference_code,
        'salespersonCode' => @salesperson_code,
        'salespersonName' => @salesperson_name,
        'invoiceTypeCode' => @invoice_type_code,
        'invoiceStatusCode' => @invoice_status_code,
        'termsCode' => @terms_code,
        'specialTerms' => @special_terms,
        'currencyCode' => @currency_code,
        'totalAmount' => @total_amount,
        'salesTaxAmount' => @sales_tax_amount,
        'discountAmount' => @discount_amount,
        'outstandingBalanceAmount' => @outstanding_balance_amount,
        'invoiceDate' => @invoice_date,
        'discountDate' => @discount_date,
        'postedDate' => @posted_date,
        'invoiceClosedDate' => @invoice_closed_date,
        'paymentDueDate' => @payment_due_date,
        'importedDate' => @imported_date,
        'primaryOriginAddressId' => @primary_origin_address_id,
        'primaryBillToAddressId' => @primary_bill_to_address_id,
        'primaryShipToAddressId' => @primary_ship_to_address_id,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'appEnrollmentId' => @app_enrollment_id,
        'isVoided' => @is_voided,
        'inDispute' => @in_dispute,
        'excludeFromAging' => @exclude_from_aging,
        'preferredDeliveryMethod' => @preferred_delivery_method,
        'currencyRate' => @currency_rate,
        'baseCurrencyTotalAmount' => @base_currency_total_amount,
        'baseCurrencySalesTaxAmount' => @base_currency_sales_tax_amount,
        'baseCurrencyDiscountAmount' => @base_currency_discount_amount,
        'baseCurrencyOutstandingBalanceAmount' => @base_currency_outstanding_balance_amount,
        'addresses' => @addresses,
        'lines' => @lines,
        'payments' => @payments,
        'notes' => @notes,
        'attachments' => @attachments,
        'company' => @company,
        'customer' => @customer,
        'customerPrimaryContact' => @customer_primary_contact,
        'creditMemos' => @credit_memos,
        'customFieldValues' => @custom_field_values,
        'customFieldDefinitions' => @custom_field_definitions,
    }
end

#to_json(*options) ⇒ `String`



354
355
356

# File 'lib/lockstep_sdk/models/invoice_model.rb', line 354

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

Class: LockstepSdk::InvoiceModel

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ InvoiceModel

Instance Attribute Details

#addresses ⇒ InvoiceAddressModel

#app_enrollment_id ⇒ Uuid

#attachments ⇒ AttachmentModel

#base_currency_discount_amount ⇒ Double

#base_currency_outstanding_balance_amount ⇒ Double

#base_currency_sales_tax_amount ⇒ Double

#base_currency_total_amount ⇒ Double

#company ⇒ CompanyModel

#company_id ⇒ Uuid

#created ⇒ Date-time

#created_user_id ⇒ Uuid

#credit_memos ⇒ CreditMemoInvoiceModel

#currency_code ⇒ String

#currency_rate ⇒ Double

#custom_field_definitions ⇒ CustomFieldDefinitionModel

#custom_field_values ⇒ CustomFieldValueModel

#customer ⇒ CompanyModel

#customer_id ⇒ Uuid

#customer_primary_contact ⇒ ContactModel

#discount_amount ⇒ Double

#discount_date ⇒ Date

#erp_key ⇒ String

#exclude_from_aging ⇒ Boolean

#group_key ⇒ Uuid

#imported_date ⇒ Date-time

#in_dispute ⇒ Boolean

#invoice_closed_date ⇒ Date

#invoice_date ⇒ Date

#invoice_id ⇒ Uuid

#invoice_status_code ⇒ String

#invoice_type_code ⇒ String

#is_voided ⇒ Boolean

#lines ⇒ InvoiceLineModel

#modified ⇒ Date-time

#modified_user_id ⇒ Uuid

#notes ⇒ NoteModel

#outstanding_balance_amount ⇒ Double

#payment_due_date ⇒ Date

#payments ⇒ InvoicePaymentDetailModel

#posted_date ⇒ Date

#preferred_delivery_method ⇒ String

#primary_bill_to_address_id ⇒ Uuid

#primary_origin_address_id ⇒ Uuid

#primary_ship_to_address_id ⇒ Uuid

#purchase_order_code ⇒ String

#reference_code ⇒ String

#sales_tax_amount ⇒ Double

#salesperson_code ⇒ String

#salesperson_name ⇒ String

#special_terms ⇒ String

#terms_code ⇒ String

#total_amount ⇒ Double