Class: Yoomoney::Models::Receipt::Item

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/yoomoney/models/receipt.rb

Defined Under Namespace

Classes: Supplier

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount:, description:, quantity:, vat_code:, agent_type: nil, country_of_origin_code: nil, customs_declaration_number: nil, excise: nil, mark_code_info: nil, mark_mode: nil, mark_quantity: nil, measure: nil, payment_mode: nil, payment_subject: nil, payment_subject_industry_details: nil, planned_status: nil, product_code: nil, supplier: nil) ⇒ Object

Parameters:



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/yoomoney/models/receipt.rb', line 152

class Item < Yoomoney::Internal::Type::BaseModel
  # @!attribute amount
  #
  #   @return [Yoomoney::Models::MonetaryAmount]
  required :amount, -> { Yoomoney::MonetaryAmount }

  # @!attribute description
  #
  #   @return [String]
  required :description, String

  # @!attribute quantity
  #
  #   @return [Float]
  required :quantity, Float

  # @!attribute vat_code
  #
  #   @return [Integer]
  required :vat_code, Integer

  # @!attribute agent_type
  #
  #   @return [Symbol, Yoomoney::Models::ReceiptItemAgentType, nil]
  optional :agent_type, enum: -> { Yoomoney::ReceiptItemAgentType }

  # @!attribute country_of_origin_code
  #
  #   @return [String, nil]
  optional :country_of_origin_code, String

  # @!attribute customs_declaration_number
  #
  #   @return [String, nil]
  optional :customs_declaration_number, String

  # @!attribute excise
  #
  #   @return [String, nil]
  optional :excise, String

  # @!attribute mark_code_info
  #
  #   @return [Yoomoney::Models::MarkCodeInfo, nil]
  optional :mark_code_info, -> { Yoomoney::MarkCodeInfo }

  # @!attribute mark_mode
  #
  #   @return [String, nil]
  optional :mark_mode, String

  # @!attribute mark_quantity
  #
  #   @return [Yoomoney::Models::MarkQuantity, nil]
  optional :mark_quantity, -> { Yoomoney::MarkQuantity }

  # @!attribute measure
  #
  #   @return [Symbol, Yoomoney::Models::ReceiptItemMeasure, nil]
  optional :measure, enum: -> { Yoomoney::ReceiptItemMeasure }

  # @!attribute payment_mode
  #
  #   @return [Symbol, Yoomoney::Models::ReceiptItemPaymentMode, nil]
  optional :payment_mode, enum: -> { Yoomoney::ReceiptItemPaymentMode }

  # @!attribute payment_subject
  #
  #   @return [Symbol, Yoomoney::Models::ReceiptItemPaymentSubject, nil]
  optional :payment_subject, enum: -> { Yoomoney::ReceiptItemPaymentSubject }

  # @!attribute payment_subject_industry_details
  #
  #   @return [Array<Yoomoney::Models::IndustryDetails>, nil]
  optional :payment_subject_industry_details,
           -> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::IndustryDetails] }

  # @!attribute planned_status
  #
  #   @return [Integer, nil]
  optional :planned_status, Integer

  # @!attribute product_code
  #
  #   @return [String, nil]
  optional :product_code, String

  # @!attribute supplier
  #
  #   @return [Yoomoney::Models::Receipt::Item::Supplier, nil]
  optional :supplier, -> { Yoomoney::Receipt::Item::Supplier }

  # @!method initialize(amount:, description:, quantity:, vat_code:, agent_type: nil, country_of_origin_code: nil, customs_declaration_number: nil, excise: nil, mark_code_info: nil, mark_mode: nil, mark_quantity: nil, measure: nil, payment_mode: nil, payment_subject: nil, payment_subject_industry_details: nil, planned_status: nil, product_code: nil, supplier: nil)
  #   @param amount [Yoomoney::Models::MonetaryAmount]
  #   @param description [String]
  #   @param quantity [Float]
  #   @param vat_code [Integer]
  #   @param agent_type [Symbol, Yoomoney::Models::ReceiptItemAgentType]
  #   @param country_of_origin_code [String]
  #   @param customs_declaration_number [String]
  #   @param excise [String]
  #   @param mark_code_info [Yoomoney::Models::MarkCodeInfo]
  #   @param mark_mode [String]
  #   @param mark_quantity [Yoomoney::Models::MarkQuantity]
  #   @param measure [Symbol, Yoomoney::Models::ReceiptItemMeasure]
  #   @param payment_mode [Symbol, Yoomoney::Models::ReceiptItemPaymentMode]
  #   @param payment_subject [Symbol, Yoomoney::Models::ReceiptItemPaymentSubject]
  #   @param payment_subject_industry_details [Array<Yoomoney::Models::IndustryDetails>]
  #   @param planned_status [Integer]
  #   @param product_code [String]
  #   @param supplier [Yoomoney::Models::Receipt::Item::Supplier]

  # @see Yoomoney::Models::Receipt::Item#supplier
  class Supplier < Yoomoney::Models::ReceiptItemSupplier
    # @!attribute inn
    #
    #   @return [String, nil]
    optional :inn, String

    # @!method initialize(inn: nil)
    #   @param inn [String]
  end
end

Instance Attribute Details

#agent_type ⇒ Symbol, ...

Returns:



176
 
# File 'lib/yoomoney/models/receipt.rb', line 176

optional :agent_type, enum: -> { Yoomoney::ReceiptItemAgentType }

#amount ⇒ Yoomoney::Models::MonetaryAmount

Returns:



156
 
# File 'lib/yoomoney/models/receipt.rb', line 156

required :amount, -> { Yoomoney::MonetaryAmount }

#country_of_origin_code ⇒ String?

Returns:

  • (String, nil) 


181
 
# File 'lib/yoomoney/models/receipt.rb', line 181

optional :country_of_origin_code, String

#customs_declaration_number ⇒ String?

Returns:

  • (String, nil) 


186
 
# File 'lib/yoomoney/models/receipt.rb', line 186

optional :customs_declaration_number, String

#description ⇒ String

Returns:

  • (String) 


161
 
# File 'lib/yoomoney/models/receipt.rb', line 161

required :description, String

#excise ⇒ String?

Returns:

  • (String, nil) 


191
 
# File 'lib/yoomoney/models/receipt.rb', line 191

optional :excise, String

#mark_code_info ⇒ Yoomoney::Models::MarkCodeInfo?

Returns:



196
 
# File 'lib/yoomoney/models/receipt.rb', line 196

optional :mark_code_info, -> { Yoomoney::MarkCodeInfo }

#mark_mode ⇒ String?

Returns:

  • (String, nil) 


201
 
# File 'lib/yoomoney/models/receipt.rb', line 201

optional :mark_mode, String

#mark_quantity ⇒ Yoomoney::Models::MarkQuantity?

Returns:



206
 
# File 'lib/yoomoney/models/receipt.rb', line 206

optional :mark_quantity, -> { Yoomoney::MarkQuantity }

#measure ⇒ Symbol, ...

Returns:



211
 
# File 'lib/yoomoney/models/receipt.rb', line 211

optional :measure, enum: -> { Yoomoney::ReceiptItemMeasure }

#payment_mode ⇒ Symbol, ...

Returns:



216
 
# File 'lib/yoomoney/models/receipt.rb', line 216

optional :payment_mode, enum: -> { Yoomoney::ReceiptItemPaymentMode }

#payment_subject ⇒ Symbol, ...

Returns:



221
 
# File 'lib/yoomoney/models/receipt.rb', line 221

optional :payment_subject, enum: -> { Yoomoney::ReceiptItemPaymentSubject }

#payment_subject_industry_details ⇒ Array<Yoomoney::Models::IndustryDetails>?

Returns:



226
227
 
# File 'lib/yoomoney/models/receipt.rb', line 226

optional :payment_subject_industry_details,
-> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::IndustryDetails] }

#planned_status ⇒ Integer?

Returns:

  • (Integer, nil) 


232
 
# File 'lib/yoomoney/models/receipt.rb', line 232

optional :planned_status, Integer

#product_code ⇒ String?

Returns:

  • (String, nil) 


237
 
# File 'lib/yoomoney/models/receipt.rb', line 237

optional :product_code, String

#quantity ⇒ Float

Returns:

  • (Float) 


166
 
# File 'lib/yoomoney/models/receipt.rb', line 166

required :quantity, Float

#supplier ⇒ Yoomoney::Models::Receipt::Item::Supplier?

Returns:



242
 
# File 'lib/yoomoney/models/receipt.rb', line 242

optional :supplier, -> { Yoomoney::Receipt::Item::Supplier }

#vat_code ⇒ Integer

Returns:

  • (Integer) 


171
 
# File 'lib/yoomoney/models/receipt.rb', line 171

required :vat_code, Integer