Class: Merge::Accounting::Invoice

Inherits:

Object

Object
Merge::Accounting::Invoice

show all

Defined in:: lib/merge_ruby_client/accounting/types/invoice.rb

Overview

The Invoice Object

Description

The Invoice object represents an itemized record of goods and/or services sold to a customer or bought from a vendor. Represents a Bill when the Invoice type is ACCOUNTS_PAYABLE. References an Invoice when the Invoice type is ACCOUNTS_RECEIVABLE.

Usage Example

Fetch from the LIST Invoices endpoint and view a company's invoices.

Constant Summary collapse

OMIT =

Object.new

Instance Attribute Summary collapse

#accounting_period ⇒ Merge::Accounting::InvoiceAccountingPeriod readonly
The accounting period that the Invoice was generated in.
#additional_properties ⇒ OpenStruct readonly
Additional properties unmapped to the current class definition.
#applied_credit_notes ⇒ Array<Merge::Accounting::InvoiceAppliedCreditNotesItem> readonly
CreditNoteApplyLines applied to the Invoice.
#applied_payments ⇒ Array<Merge::Accounting::InvoiceAppliedPaymentsItem> readonly
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
#applied_vendor_credits ⇒ Array<Merge::Accounting::InvoiceAppliedVendorCreditsItem> readonly
VendorCreditApplyLines applied to the Invoice.
#balance ⇒ Float readonly
The invoice's remaining balance.
#company ⇒ Merge::Accounting::InvoiceCompany readonly
The company the invoice belongs to.
#contact ⇒ Merge::Accounting::InvoiceContact readonly
The invoice's contact.
#created_at ⇒ DateTime readonly
The datetime that this object was created by Merge.
#currency ⇒ Merge::Accounting::TransactionCurrencyEnum readonly
The invoice's currency.
#due_date ⇒ DateTime readonly
The invoice's due date.
#employee ⇒ Merge::Accounting::InvoiceEmployee readonly
The employee this overall transaction relates to.
#exchange_rate ⇒ String readonly
The invoice's exchange rate.
#field_mappings ⇒ Hash{String => Object} readonly
#id ⇒ String readonly
#inclusive_of_tax ⇒ Boolean readonly
If the transaction is inclusive or exclusive of tax.
#issue_date ⇒ DateTime readonly
The invoice's issue date.
#line_items ⇒ Array<Merge::Accounting::InvoiceLineItem> readonly
#memo ⇒ String readonly
The invoice's private note.
#modified_at ⇒ DateTime readonly
The datetime that this object was modified by Merge.
#number ⇒ String readonly
The invoice's number.
#paid_on_date ⇒ DateTime readonly
The invoice's paid date.
#payment_term ⇒ Merge::Accounting::InvoicePaymentTerm readonly
The payment term that applies to this transaction.
#payments ⇒ Array<Merge::Accounting::InvoicePaymentsItem> readonly
Array of Payment object IDs.
#purchase_orders ⇒ Array<Merge::Accounting::InvoicePurchaseOrdersItem> readonly
#remote_data ⇒ Array<Merge::Accounting::RemoteData> readonly
#remote_fields ⇒ Array<Merge::Accounting::RemoteField> readonly
#remote_id ⇒ String readonly
The third-party API ID of the matching object.
#remote_updated_at ⇒ DateTime readonly
When the third party's invoice entry was updated.
#remote_was_deleted ⇒ Boolean readonly
Indicates whether or not this object has been deleted in the third party platform.
#status ⇒ Merge::Accounting::InvoiceStatusEnum readonly
The status of the invoice.
#sub_total ⇒ Float readonly
The total amount being paid before taxes.
#total_amount ⇒ Float readonly
The invoice's total amount.
#total_discount ⇒ Float readonly
The total discounts applied to the total cost.
#total_tax_amount ⇒ Float readonly
The total amount being paid in taxes.
#tracking_categories ⇒ Array<Merge::Accounting::InvoiceTrackingCategoriesItem> readonly
#type ⇒ Merge::Accounting::InvoiceTypeEnum readonly
Whether the invoice is an accounts receivable or accounts payable.

Class Method Summary collapse

.from_json(json_object:) ⇒ Merge::Accounting::Invoice
Deserialize a JSON object to an instance of Invoice.
.validate_raw(obj:) ⇒ Void
Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, type: OMIT, contact: OMIT, number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT, memo: OMIT, company: OMIT, employee: OMIT, currency: OMIT, exchange_rate: OMIT, payment_term: OMIT, total_discount: OMIT, sub_total: OMIT, status: OMIT, total_tax_amount: OMIT, total_amount: OMIT, balance: OMIT, remote_updated_at: OMIT, tracking_categories: OMIT, accounting_period: OMIT, purchase_orders: OMIT, payments: OMIT, applied_payments: OMIT, line_items: OMIT, applied_credit_notes: OMIT, applied_vendor_credits: OMIT, inclusive_of_tax: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ `Merge::Accounting::Invoice`

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 795

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, type: OMIT, contact: OMIT,
               number: OMIT, issue_date: OMIT, due_date: OMIT, paid_on_date: OMIT, memo: OMIT, company: OMIT, employee: OMIT, currency: OMIT, exchange_rate: OMIT, payment_term: OMIT, total_discount: OMIT, sub_total: OMIT, status: OMIT, total_tax_amount: OMIT, total_amount: OMIT, balance: OMIT, remote_updated_at: OMIT, tracking_categories: OMIT, accounting_period: OMIT, purchase_orders: OMIT, payments: OMIT, applied_payments: OMIT, line_items: OMIT, applied_credit_notes: OMIT, applied_vendor_credits: OMIT, inclusive_of_tax: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @type = type if type != OMIT
  @contact = contact if contact != OMIT
  @number = number if number != OMIT
  @issue_date = issue_date if issue_date != OMIT
  @due_date = due_date if due_date != OMIT
  @paid_on_date = paid_on_date if paid_on_date != OMIT
  @memo = memo if memo != OMIT
  @company = company if company != OMIT
  @employee = employee if employee != OMIT
  @currency = currency if currency != OMIT
  @exchange_rate = exchange_rate if exchange_rate != OMIT
  @payment_term = payment_term if payment_term != OMIT
  @total_discount = total_discount if total_discount != OMIT
  @sub_total = sub_total if sub_total != OMIT
  @status = status if status != OMIT
  @total_tax_amount = total_tax_amount if total_tax_amount != OMIT
  @total_amount = total_amount if total_amount != OMIT
  @balance = balance if balance != OMIT
  @remote_updated_at = remote_updated_at if remote_updated_at != OMIT
  @tracking_categories = tracking_categories if tracking_categories != OMIT
  @accounting_period = accounting_period if accounting_period != OMIT
  @purchase_orders = purchase_orders if purchase_orders != OMIT
  @payments = payments if payments != OMIT
  @applied_payments = applied_payments if applied_payments != OMIT
  @line_items = line_items if line_items != OMIT
  @applied_credit_notes = applied_credit_notes if applied_credit_notes != OMIT
  @applied_vendor_credits = applied_vendor_credits if applied_vendor_credits != OMIT
  @inclusive_of_tax = inclusive_of_tax if inclusive_of_tax != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "type": type,
    "contact": contact,
    "number": number,
    "issue_date": issue_date,
    "due_date": due_date,
    "paid_on_date": paid_on_date,
    "memo": memo,
    "company": company,
    "employee": employee,
    "currency": currency,
    "exchange_rate": exchange_rate,
    "payment_term": payment_term,
    "total_discount": total_discount,
    "sub_total": sub_total,
    "status": status,
    "total_tax_amount": total_tax_amount,
    "total_amount": total_amount,
    "balance": balance,
    "remote_updated_at": remote_updated_at,
    "tracking_categories": tracking_categories,
    "accounting_period": accounting_period,
    "purchase_orders": purchase_orders,
    "payments": payments,
    "applied_payments": applied_payments,
    "line_items": line_items,
    "applied_credit_notes": applied_credit_notes,
    "applied_vendor_credits": applied_vendor_credits,
    "inclusive_of_tax": inclusive_of_tax,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#accounting_period ⇒ `Merge::Accounting::InvoiceAccountingPeriod` (readonly)



400
401
402

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 400

def accounting_period
  @accounting_period
end

#additional_properties ⇒ `OpenStruct` (readonly)



429
430
431

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 429

def additional_properties
  @additional_properties
end

#applied_credit_notes ⇒ `Array<Merge::Accounting::InvoiceAppliedCreditNotesItem>` (readonly)



411
412
413

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 411

def applied_credit_notes
  @applied_credit_notes
end

#applied_payments ⇒ `Array<Merge::Accounting::InvoiceAppliedPaymentsItem>` (readonly)



407
408
409

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 407

def applied_payments
  @applied_payments
end

#applied_vendor_credits ⇒ `Array<Merge::Accounting::InvoiceAppliedVendorCreditsItem>` (readonly)



413
414
415

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 413

def applied_vendor_credits
  @applied_vendor_credits
end

#balance ⇒ `Float` (readonly)



394
395
396

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 394

def balance
  @balance
end

#company ⇒ `Merge::Accounting::InvoiceCompany` (readonly)



62
63
64

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 62

def company
  @company
end

#contact ⇒ `Merge::Accounting::InvoiceContact` (readonly)



50
51
52

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 50

def contact
  @contact
end

#created_at ⇒ `DateTime` (readonly)



40
41
42

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 40

def created_at
  @created_at
end

#currency ⇒ `Merge::Accounting::TransactionCurrencyEnum` (readonly)



372
373
374

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 372

def currency
  @currency
end

#due_date ⇒ `DateTime` (readonly)



56
57
58

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 56

def due_date
  @due_date
end

#employee ⇒ `Merge::Accounting::InvoiceEmployee` (readonly)



64
65
66

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 64

def employee
  @employee
end

#exchange_rate ⇒ `String` (readonly)



374
375
376

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 374

def exchange_rate
  @exchange_rate
end

#field_mappings ⇒ `Hash{String => Object}` (readonly)



423
424
425

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 423

def field_mappings
  @field_mappings
end

#id ⇒ `String` (readonly)



36
37
38

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 36

def id
  @id
end

#inclusive_of_tax ⇒ `Boolean` (readonly)



416
417
418

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 416

def inclusive_of_tax
  @inclusive_of_tax
end

#issue_date ⇒ `DateTime` (readonly)



54
55
56

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 54

def issue_date
  @issue_date
end

#line_items ⇒ `Array<Merge::Accounting::InvoiceLineItem>` (readonly)



409
410
411

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 409

def line_items
  @line_items
end

#memo ⇒ `String` (readonly)



60
61
62

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 60

def memo
  @memo
end

#modified_at ⇒ `DateTime` (readonly)



42
43
44

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 42

def modified_at
  @modified_at
end

#number ⇒ `String` (readonly)



52
53
54

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 52

def number
  @number
end

#paid_on_date ⇒ `DateTime` (readonly)



58
59
60

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 58

def paid_on_date
  @paid_on_date
end

#payment_term ⇒ `Merge::Accounting::InvoicePaymentTerm` (readonly)



376
377
378

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 376

def payment_term
  @payment_term
end

#payments ⇒ `Array<Merge::Accounting::InvoicePaymentsItem>` (readonly)



404
405
406

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 404

def payments
  @payments
end

#purchase_orders ⇒ `Array<Merge::Accounting::InvoicePurchaseOrdersItem>` (readonly)



402
403
404

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 402

def purchase_orders
  @purchase_orders
end

#remote_data ⇒ `Array<Merge::Accounting::RemoteData>` (readonly)



425
426
427

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 425

def remote_data
  @remote_data
end

#remote_fields ⇒ `Array<Merge::Accounting::RemoteField>` (readonly)



427
428
429

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 427

def remote_fields
  @remote_fields
end

#remote_id ⇒ `String` (readonly)



38
39
40

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 38

def remote_id
  @remote_id
end

#remote_updated_at ⇒ `DateTime` (readonly)



396
397
398

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 396

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ `Boolean` (readonly)



421
422
423

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 421

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ `Merge::Accounting::InvoiceStatusEnum` (readonly)



388
389
390

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 388

def status
  @status
end

#sub_total ⇒ `Float` (readonly)



380
381
382

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 380

def sub_total
  @sub_total
end

#total_amount ⇒ `Float` (readonly)



392
393
394

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 392

def total_amount
  @total_amount
end

#total_discount ⇒ `Float` (readonly)



378
379
380

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 378

def total_discount
  @total_discount
end

#total_tax_amount ⇒ `Float` (readonly)



390
391
392

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 390

def total_tax_amount
  @total_tax_amount
end

#tracking_categories ⇒ `Array<Merge::Accounting::InvoiceTrackingCategoriesItem>` (readonly)



398
399
400

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 398

def tracking_categories
  @tracking_categories
end

#type ⇒ `Merge::Accounting::InvoiceTypeEnum` (readonly)



48
49
50

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 48

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ `Merge::Accounting::Invoice`

Deserialize a JSON object to an instance of Invoice

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 880

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  type = parsed_json["type"]
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Accounting::InvoiceContact.from_json(json_object: contact)
  end
  number = parsed_json["number"]
  issue_date = (DateTime.parse(parsed_json["issue_date"]) unless parsed_json["issue_date"].nil?)
  due_date = (DateTime.parse(parsed_json["due_date"]) unless parsed_json["due_date"].nil?)
  paid_on_date = (DateTime.parse(parsed_json["paid_on_date"]) unless parsed_json["paid_on_date"].nil?)
  memo = parsed_json["memo"]
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::InvoiceCompany.from_json(json_object: company)
  end
  if parsed_json["employee"].nil?
    employee = nil
  else
    employee = parsed_json["employee"].to_json
    employee = Merge::Accounting::InvoiceEmployee.from_json(json_object: employee)
  end
  currency = parsed_json["currency"]
  exchange_rate = parsed_json["exchange_rate"]
  if parsed_json["payment_term"].nil?
    payment_term = nil
  else
    payment_term = parsed_json["payment_term"].to_json
    payment_term = Merge::Accounting::InvoicePaymentTerm.from_json(json_object: payment_term)
  end
  total_discount = parsed_json["total_discount"]
  sub_total = parsed_json["sub_total"]
  status = parsed_json["status"]
  total_tax_amount = parsed_json["total_tax_amount"]
  total_amount = parsed_json["total_amount"]
  balance = parsed_json["balance"]
  remote_updated_at = unless parsed_json["remote_updated_at"].nil?
                        DateTime.parse(parsed_json["remote_updated_at"])
                      end
  tracking_categories = parsed_json["tracking_categories"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoiceTrackingCategoriesItem.from_json(json_object: item)
  end
  if parsed_json["accounting_period"].nil?
    accounting_period = nil
  else
    accounting_period = parsed_json["accounting_period"].to_json
    accounting_period = Merge::Accounting::InvoiceAccountingPeriod.from_json(json_object: accounting_period)
  end
  purchase_orders = parsed_json["purchase_orders"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoicePurchaseOrdersItem.from_json(json_object: item)
  end
  payments = parsed_json["payments"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoicePaymentsItem.from_json(json_object: item)
  end
  applied_payments = parsed_json["applied_payments"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoiceAppliedPaymentsItem.from_json(json_object: item)
  end
  line_items = parsed_json["line_items"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoiceLineItem.from_json(json_object: item)
  end
  applied_credit_notes = parsed_json["applied_credit_notes"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoiceAppliedCreditNotesItem.from_json(json_object: item)
  end
  applied_vendor_credits = parsed_json["applied_vendor_credits"]&.map do |item|
    item = item.to_json
    Merge::Accounting::InvoiceAppliedVendorCreditsItem.from_json(json_object: item)
  end
  inclusive_of_tax = parsed_json["inclusive_of_tax"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteData.from_json(json_object: item)
  end
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteField.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    type: type,
    contact: contact,
    number: number,
    issue_date: issue_date,
    due_date: due_date,
    paid_on_date: paid_on_date,
    memo: memo,
    company: company,
    employee: employee,
    currency: currency,
    exchange_rate: exchange_rate,
    payment_term: payment_term,
    total_discount: total_discount,
    sub_total: sub_total,
    status: status,
    total_tax_amount: total_tax_amount,
    total_amount: total_amount,
    balance: balance,
    remote_updated_at: remote_updated_at,
    tracking_categories: tracking_categories,
    accounting_period: accounting_period,
    purchase_orders: purchase_orders,
    payments: payments,
    applied_payments: applied_payments,
    line_items: line_items,
    applied_credit_notes: applied_credit_notes,
    applied_vendor_credits: applied_vendor_credits,
    inclusive_of_tax: inclusive_of_tax,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    remote_fields: remote_fields,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ `Void`

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 1027

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.type&.is_a?(Merge::Accounting::InvoiceTypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.contact.nil? || Merge::Accounting::InvoiceContact.validate_raw(obj: obj.contact)
  obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
  obj.issue_date&.is_a?(DateTime) != false || raise("Passed value for field obj.issue_date is not the expected type, validation failed.")
  obj.due_date&.is_a?(DateTime) != false || raise("Passed value for field obj.due_date is not the expected type, validation failed.")
  obj.paid_on_date&.is_a?(DateTime) != false || raise("Passed value for field obj.paid_on_date is not the expected type, validation failed.")
  obj.memo&.is_a?(String) != false || raise("Passed value for field obj.memo is not the expected type, validation failed.")
  obj.company.nil? || Merge::Accounting::InvoiceCompany.validate_raw(obj: obj.company)
  obj.employee.nil? || Merge::Accounting::InvoiceEmployee.validate_raw(obj: obj.employee)
  obj.currency&.is_a?(Merge::Accounting::TransactionCurrencyEnum) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.")
  obj.exchange_rate&.is_a?(String) != false || raise("Passed value for field obj.exchange_rate is not the expected type, validation failed.")
  obj.payment_term.nil? || Merge::Accounting::InvoicePaymentTerm.validate_raw(obj: obj.payment_term)
  obj.total_discount&.is_a?(Float) != false || raise("Passed value for field obj.total_discount is not the expected type, validation failed.")
  obj.sub_total&.is_a?(Float) != false || raise("Passed value for field obj.sub_total is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Accounting::InvoiceStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.total_tax_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_tax_amount is not the expected type, validation failed.")
  obj.total_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_amount is not the expected type, validation failed.")
  obj.balance&.is_a?(Float) != false || raise("Passed value for field obj.balance is not the expected type, validation failed.")
  obj.remote_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_at is not the expected type, validation failed.")
  obj.tracking_categories&.is_a?(Array) != false || raise("Passed value for field obj.tracking_categories is not the expected type, validation failed.")
  obj.accounting_period.nil? || Merge::Accounting::InvoiceAccountingPeriod.validate_raw(obj: obj.accounting_period)
  obj.purchase_orders&.is_a?(Array) != false || raise("Passed value for field obj.purchase_orders is not the expected type, validation failed.")
  obj.payments&.is_a?(Array) != false || raise("Passed value for field obj.payments is not the expected type, validation failed.")
  obj.applied_payments&.is_a?(Array) != false || raise("Passed value for field obj.applied_payments is not the expected type, validation failed.")
  obj.line_items&.is_a?(Array) != false || raise("Passed value for field obj.line_items is not the expected type, validation failed.")
  obj.applied_credit_notes&.is_a?(Array) != false || raise("Passed value for field obj.applied_credit_notes is not the expected type, validation failed.")
  obj.applied_vendor_credits&.is_a?(Array) != false || raise("Passed value for field obj.applied_vendor_credits is not the expected type, validation failed.")
  obj.inclusive_of_tax&.is_a?(Boolean) != false || raise("Passed value for field obj.inclusive_of_tax is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
  obj.remote_fields&.is_a?(Array) != false || raise("Passed value for field obj.remote_fields is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ `String`

Serialize an instance of Invoice to a JSON object



1017
1018
1019

# File 'lib/merge_ruby_client/accounting/types/invoice.rb', line 1017

def to_json(*_args)
  @_field_set&.to_json
end

Class: Merge::Accounting::Invoice

Overview

The Invoice Object

Description

Usage Example

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#accounting_period ⇒ Merge::Accounting::InvoiceAccountingPeriod (readonly)

#additional_properties ⇒ OpenStruct (readonly)

#applied_credit_notes ⇒ Array<Merge::Accounting::InvoiceAppliedCreditNotesItem> (readonly)

#applied_payments ⇒ Array<Merge::Accounting::InvoiceAppliedPaymentsItem> (readonly)

#applied_vendor_credits ⇒ Array<Merge::Accounting::InvoiceAppliedVendorCreditsItem> (readonly)

#balance ⇒ Float (readonly)

#company ⇒ Merge::Accounting::InvoiceCompany (readonly)

#contact ⇒ Merge::Accounting::InvoiceContact (readonly)

#created_at ⇒ DateTime (readonly)

#currency ⇒ Merge::Accounting::TransactionCurrencyEnum (readonly)

#due_date ⇒ DateTime (readonly)

#employee ⇒ Merge::Accounting::InvoiceEmployee (readonly)

#exchange_rate ⇒ String (readonly)

#field_mappings ⇒ Hash{String => Object} (readonly)

#id ⇒ String (readonly)

#inclusive_of_tax ⇒ Boolean (readonly)

#issue_date ⇒ DateTime (readonly)

#line_items ⇒ Array<Merge::Accounting::InvoiceLineItem> (readonly)

#memo ⇒ String (readonly)

#modified_at ⇒ DateTime (readonly)

#number ⇒ String (readonly)

#paid_on_date ⇒ DateTime (readonly)

#payment_term ⇒ Merge::Accounting::InvoicePaymentTerm (readonly)

#payments ⇒ Array<Merge::Accounting::InvoicePaymentsItem> (readonly)

#purchase_orders ⇒ Array<Merge::Accounting::InvoicePurchaseOrdersItem> (readonly)

#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)

#remote_fields ⇒ Array<Merge::Accounting::RemoteField> (readonly)

#remote_id ⇒ String (readonly)

#remote_updated_at ⇒ DateTime (readonly)

#remote_was_deleted ⇒ Boolean (readonly)

#status ⇒ Merge::Accounting::InvoiceStatusEnum (readonly)

#sub_total ⇒ Float (readonly)

#total_amount ⇒ Float (readonly)

#total_discount ⇒ Float (readonly)

#total_tax_amount ⇒ Float (readonly)

#tracking_categories ⇒ Array<Merge::Accounting::InvoiceTrackingCategoriesItem> (readonly)

#type ⇒ Merge::Accounting::InvoiceTypeEnum (readonly)