Class: XeroRuby::Accounting::PurchaseOrder

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/purchase_order.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurchaseOrder

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 191

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::PurchaseOrder` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::PurchaseOrder`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'contact')
    self.contact = attributes[:'contact']
  end

  if attributes.key?(:'line_items')
    if (value = attributes[:'line_items']).is_a?(Array)
      self.line_items = value
    end
  end

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.key?(:'delivery_date')
    self.delivery_date = attributes[:'delivery_date']
  end

  if attributes.key?(:'line_amount_types')
    self.line_amount_types = attributes[:'line_amount_types']
  end

  if attributes.key?(:'purchase_order_number')
    self.purchase_order_number = attributes[:'purchase_order_number']
  end

  if attributes.key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.key?(:'branding_theme_id')
    self.branding_theme_id = attributes[:'branding_theme_id']
  end

  if attributes.key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'sent_to_contact')
    self.sent_to_contact = attributes[:'sent_to_contact']
  end

  if attributes.key?(:'delivery_address')
    self.delivery_address = attributes[:'delivery_address']
  end

  if attributes.key?(:'attention_to')
    self.attention_to = attributes[:'attention_to']
  end

  if attributes.key?(:'telephone')
    self.telephone = attributes[:'telephone']
  end

  if attributes.key?(:'delivery_instructions')
    self.delivery_instructions = attributes[:'delivery_instructions']
  end

  if attributes.key?(:'expected_arrival_date')
    self.expected_arrival_date = attributes[:'expected_arrival_date']
  end

  if attributes.key?(:'purchase_order_id')
    self.purchase_order_id = attributes[:'purchase_order_id']
  end

  if attributes.key?(:'currency_rate')
    self.currency_rate = attributes[:'currency_rate']
  end

  if attributes.key?(:'sub_total')
    self.sub_total = attributes[:'sub_total']
  end

  if attributes.key?(:'total_tax')
    self.total_tax = attributes[:'total_tax']
  end

  if attributes.key?(:'total')
    self.total = attributes[:'total']
  end

  if attributes.key?(:'total_discount')
    self.total_discount = attributes[:'total_discount']
  end

  if attributes.key?(:'has_attachments')
    self.has_attachments = attributes[:'has_attachments']
  else
    self.has_attachments = false
  end

  if attributes.key?(:'updated_date_utc')
    self.updated_date_utc = attributes[:'updated_date_utc']
  end

  if attributes.key?(:'status_attribute_string')
    self.status_attribute_string = attributes[:'status_attribute_string']
  end

  if attributes.key?(:'validation_errors')
    if (value = attributes[:'validation_errors']).is_a?(Array)
      self.validation_errors = value
    end
  end

  if attributes.key?(:'warnings')
    if (value = attributes[:'warnings']).is_a?(Array)
      self.warnings = value
    end
  end

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end
end

Instance Attribute Details

#attachments ⇒ Object

Displays array of attachments from the API



97
98
99
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 97

def attachments
  @attachments
end

#attention_to ⇒ Object

The person that the delivery is going to



52
53
54
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 52

def attention_to
  @attention_to
end

#branding_theme_id ⇒ Object

See BrandingThemes



38
39
40
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 38

def branding_theme_id
  @branding_theme_id
end

#contact ⇒ Object

Returns the value of attribute contact.



18
19
20
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 18

def contact
  @contact
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



40
41
42
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 40

def currency_code
  @currency_code
end

#currency_rate ⇒ Object

The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.



67
68
69
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 67

def currency_rate
  @currency_rate
end

#date ⇒ Object

Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation



24
25
26
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 24

def date
  @date
end

#delivery_address ⇒ Object

The address the goods are to be delivered to



49
50
51
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 49

def delivery_address
  @delivery_address
end

#delivery_date ⇒ Object

Date the goods are to be delivered – YYYY-MM-DD



27
28
29
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 27

def delivery_date
  @delivery_date
end

#delivery_instructions ⇒ Object

A free text feild for instructions (500 characters max)



58
59
60
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 58

def delivery_instructions
  @delivery_instructions
end

#expected_arrival_date ⇒ Object

The date the goods are expected to arrive.



61
62
63
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 61

def expected_arrival_date
  @expected_arrival_date
end

#has_attachments ⇒ Object

boolean to indicate if a purchase order has an attachment



82
83
84
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 82

def has_attachments
  @has_attachments
end

#line_amount_types ⇒ Object

Returns the value of attribute line_amount_types.



29
30
31
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 29

def line_amount_types
  @line_amount_types
end

#line_items ⇒ Object

See LineItems



21
22
23
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 21

def line_items
  @line_items
end

#purchase_order_id ⇒ Object

Xero generated unique identifier for purchase order



64
65
66
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 64

def purchase_order_id
  @purchase_order_id
end

#purchase_order_number ⇒ Object

Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)



32
33
34
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 32

def purchase_order_number
  @purchase_order_number
end

#reference ⇒ Object

Additional reference number



35
36
37
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 35

def reference
  @reference
end

#sent_to_contact ⇒ Object

Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed



46
47
48
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 46

def sent_to_contact
  @sent_to_contact
end

#status ⇒ Object

See Purchase Order Status Codes



43
44
45
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 43

def status
  @status
end

#status_attribute_string ⇒ Object

A string to indicate if a invoice status



88
89
90
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 88

def status_attribute_string
  @status_attribute_string
end

#sub_total ⇒ Object

Total of purchase order excluding taxes



70
71
72
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 70

def sub_total
  @sub_total
end

#telephone ⇒ Object

The phone number for the person accepting the delivery



55
56
57
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 55

def telephone
  @telephone
end

#total ⇒ Object

Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)



76
77
78
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 76

def total
  @total
end

#total_discount ⇒ Object

Total of discounts applied on the purchase order line items



79
80
81
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 79

def total_discount
  @total_discount
end

#total_tax ⇒ Object

Total tax on purchase order



73
74
75
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 73

def total_tax
  @total_tax
end

#updated_date_utc ⇒ Object

Last modified date UTC format



85
86
87
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 85

def updated_date_utc
  @updated_date_utc
end

#validation_errors ⇒ Object

Displays array of validation error messages from the API



91
92
93
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 91

def validation_errors
  @validation_errors
end

#warnings ⇒ Object

Displays array of warning messages from the API



94
95
96
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 94

def warnings
  @warnings
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 122

def self.attribute_map
  {
    :'contact' => :'Contact',
    :'line_items' => :'LineItems',
    :'date' => :'Date',
    :'delivery_date' => :'DeliveryDate',
    :'line_amount_types' => :'LineAmountTypes',
    :'purchase_order_number' => :'PurchaseOrderNumber',
    :'reference' => :'Reference',
    :'branding_theme_id' => :'BrandingThemeID',
    :'currency_code' => :'CurrencyCode',
    :'status' => :'Status',
    :'sent_to_contact' => :'SentToContact',
    :'delivery_address' => :'DeliveryAddress',
    :'attention_to' => :'AttentionTo',
    :'telephone' => :'Telephone',
    :'delivery_instructions' => :'DeliveryInstructions',
    :'expected_arrival_date' => :'ExpectedArrivalDate',
    :'purchase_order_id' => :'PurchaseOrderID',
    :'currency_rate' => :'CurrencyRate',
    :'sub_total' => :'SubTotal',
    :'total_tax' => :'TotalTax',
    :'total' => :'Total',
    :'total_discount' => :'TotalDiscount',
    :'has_attachments' => :'HasAttachments',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'status_attribute_string' => :'StatusAttributeString',
    :'validation_errors' => :'ValidationErrors',
    :'warnings' => :'Warnings',
    :'attachments' => :'Attachments'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



402
403
404
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 402

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 156

def self.openapi_types
  {
    :'contact' => :'Contact',
    :'line_items' => :'Array<LineItem>',
    :'date' => :'Date',
    :'delivery_date' => :'Date',
    :'line_amount_types' => :'LineAmountTypes',
    :'purchase_order_number' => :'String',
    :'reference' => :'String',
    :'branding_theme_id' => :'String',
    :'currency_code' => :'CurrencyCode',
    :'status' => :'String',
    :'sent_to_contact' => :'Boolean',
    :'delivery_address' => :'String',
    :'attention_to' => :'String',
    :'telephone' => :'String',
    :'delivery_instructions' => :'String',
    :'expected_arrival_date' => :'Date',
    :'purchase_order_id' => :'String',
    :'currency_rate' => :'Float',
    :'sub_total' => :'Float',
    :'total_tax' => :'Float',
    :'total' => :'Float',
    :'total_discount' => :'Float',
    :'has_attachments' => :'Boolean',
    :'updated_date_utc' => :'DateTime',
    :'status_attribute_string' => :'String',
    :'validation_errors' => :'Array<ValidationError>',
    :'warnings' => :'Array<ValidationError>',
    :'attachments' => :'Array<Attachment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 354

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact == o.contact &&
      line_items == o.line_items &&
      date == o.date &&
      delivery_date == o.delivery_date &&
      line_amount_types == o.line_amount_types &&
      purchase_order_number == o.purchase_order_number &&
      reference == o.reference &&
      branding_theme_id == o.branding_theme_id &&
      currency_code == o.currency_code &&
      status == o.status &&
      sent_to_contact == o.sent_to_contact &&
      delivery_address == o.delivery_address &&
      attention_to == o.attention_to &&
      telephone == o.telephone &&
      delivery_instructions == o.delivery_instructions &&
      expected_arrival_date == o.expected_arrival_date &&
      purchase_order_id == o.purchase_order_id &&
      currency_rate == o.currency_rate &&
      sub_total == o.sub_total &&
      total_tax == o.total_tax &&
      total == o.total &&
      total_discount == o.total_discount &&
      has_attachments == o.has_attachments &&
      updated_date_utc == o.updated_date_utc &&
      status_attribute_string == o.status_attribute_string &&
      validation_errors == o.validation_errors &&
      warnings == o.warnings &&
      attachments == o.attachments
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 430

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 495

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 409

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


389
390
391
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 389

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



395
396
397
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 395

def hash
  [contact, line_items, date, delivery_date, line_amount_types, purchase_order_number, reference, branding_theme_id, currency_code, status, sent_to_contact, delivery_address, attention_to, telephone, delivery_instructions, expected_arrival_date, purchase_order_id, currency_rate, sub_total, total_tax, total, total_discount, has_attachments, updated_date_utc, status_attribute_string, validation_errors, warnings, attachments].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



329
330
331
332
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 329

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



510
511
512
513
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 510

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



475
476
477
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 475

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



481
482
483
484
485
486
487
488
489
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 481

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



469
470
471
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 469

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



336
337
338
339
340
 
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 336

def valid?
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "SUBMITTED", "AUTHORISED", "BILLED", "DELETED"])
  return false unless status_validator.valid?(@status)
  true
end