Class: Merge::Accounting::PaymentLineItemRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/payment_line_item_request.rb

Overview

# The PaymentLineItem Object

### Description
The `PaymentLineItem` object is an applied-to-line on a `Payment` that can
either be a `Invoice`, `CreditNote`, or `JournalEntry`.
### Usage Example
`Payment` will have a field called `applied-to-lines` which will be an array of
`PaymentLineItemInternalMappingSerializer` objects that can either be a
`Invoice`, `CreditNote`, or `JournalEntry`.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote_id: OMIT, applied_amount: OMIT, applied_date: OMIT, related_object_id: OMIT, related_object_type: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Accounting::PaymentLineItemRequest

Parameters:

  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • applied_amount (String) (defaults to: OMIT) —

    The amount being applied to the transaction.

  • applied_date (DateTime) (defaults to: OMIT) —

    The date the payment portion is applied.

  • related_object_id (String) (defaults to: OMIT) —

    The Merge ID of the transaction the payment portion is being applied to.

  • related_object_type (String) (defaults to: OMIT) —

    The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 51

def initialize(remote_id: OMIT, applied_amount: OMIT, applied_date: OMIT, related_object_id: OMIT,
               related_object_type: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil)
  @remote_id = remote_id if remote_id != OMIT
  @applied_amount = applied_amount if applied_amount != OMIT
  @applied_date = applied_date if applied_date != OMIT
  @related_object_id = related_object_id if related_object_id != OMIT
  @related_object_type = related_object_type if related_object_type != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "remote_id": remote_id,
    "applied_amount": applied_amount,
    "applied_date": applied_date,
    "related_object_id": related_object_id,
    "related_object_type": related_object_type,
    "integration_params": integration_params,
    "linked_account_params": 
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



34
35
36
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 34

def additional_properties
  @additional_properties
end

#applied_amount ⇒ String (readonly)

Returns The amount being applied to the transaction.

Returns:

  • (String) —

    The amount being applied to the transaction.



21
22
23
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 21

def applied_amount
  @applied_amount
end

#applied_date ⇒ DateTime (readonly)

Returns The date the payment portion is applied.

Returns:

  • (DateTime) —

    The date the payment portion is applied.



23
24
25
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 23

def applied_date
  @applied_date
end

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

Returns:

  • (Hash{String => Object}) 


30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 30

def integration_params
  @integration_params
end

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

Returns:

  • (Hash{String => Object}) 


32
33
34
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 32

def 
  @linked_account_params
end

#related_object_id ⇒ String (readonly)

Returns The Merge ID of the transaction the payment portion is being applied to.

Returns:

  • (String) —

    The Merge ID of the transaction the payment portion is being applied to.



25
26
27
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 25

def related_object_id
  @related_object_id
end

#related_object_type ⇒ String (readonly)

Returns The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.

Returns:

  • (String) —

    The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.



28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 28

def related_object_type
  @related_object_type
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



19
20
21
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 19

def remote_id
  @remote_id
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::PaymentLineItemRequest

Deserialize a JSON object to an instance of PaymentLineItemRequest

Parameters:

  • json_object (String)

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 78

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  remote_id = parsed_json["remote_id"]
  applied_amount = parsed_json["applied_amount"]
  applied_date = (DateTime.parse(parsed_json["applied_date"]) unless parsed_json["applied_date"].nil?)
  related_object_id = parsed_json["related_object_id"]
  related_object_type = parsed_json["related_object_type"]
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  new(
    remote_id: remote_id,
    applied_amount: applied_amount,
    applied_date: applied_date,
    related_object_id: related_object_id,
    related_object_type: related_object_type,
    integration_params: integration_params,
    linked_account_params: ,
    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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


113
114
115
116
117
118
119
120
121
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 113

def self.validate_raw(obj:)
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.applied_amount&.is_a?(String) != false || raise("Passed value for field obj.applied_amount is not the expected type, validation failed.")
  obj.applied_date&.is_a?(DateTime) != false || raise("Passed value for field obj.applied_date is not the expected type, validation failed.")
  obj.related_object_id&.is_a?(String) != false || raise("Passed value for field obj.related_object_id is not the expected type, validation failed.")
  obj.related_object_type&.is_a?(String) != false || raise("Passed value for field obj.related_object_type is not the expected type, validation failed.")
  obj.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of PaymentLineItemRequest to a JSON object

Returns:

  • (String) 


103
104
105
 
# File 'lib/merge_ruby_client/accounting/types/payment_line_item_request.rb', line 103

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