Class: XeroRuby::Accounting::PurchaseOrder

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

DRAFT =
"DRAFT".freeze
SUBMITTED =
"SUBMITTED".freeze
AUTHORISED =
"AUTHORISED".freeze
BILLED =
"BILLED".freeze
DELETED =
"DELETED".freeze

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


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
326
327
328
329
330
331
332
333
334
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 200

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

#attachmentsObject

Displays array of attachments from the API


106
107
108
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 106

def attachments
  @attachments
end

#attention_toObject

The person that the delivery is going to


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

def attention_to
  @attention_to
end

#branding_theme_idObject

See BrandingThemes


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

def branding_theme_id
  @branding_theme_id
end

#contactObject

Returns the value of attribute contact


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

def contact
  @contact
end

#currency_codeObject

Returns the value of attribute currency_code


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

def currency_code
  @currency_code
end

#currency_rateObject

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


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

def currency_rate
  @currency_rate
end

#dateObject

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


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

def date
  @date
end

#delivery_addressObject

The address the goods are to be delivered to


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

def delivery_address
  @delivery_address
end

#delivery_dateObject

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


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

def delivery_date
  @delivery_date
end

#delivery_instructionsObject

A free text feild for instructions (500 characters max)


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

def delivery_instructions
  @delivery_instructions
end

#expected_arrival_dateObject

The date the goods are expected to arrive.


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

def expected_arrival_date
  @expected_arrival_date
end

#has_attachmentsObject

boolean to indicate if a purchase order has an attachment


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

def has_attachments
  @has_attachments
end

#line_amount_typesObject

Returns the value of attribute line_amount_types


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

def line_amount_types
  @line_amount_types
end

#line_itemsObject

See LineItems


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

def line_items
  @line_items
end

#purchase_order_idObject

Xero generated unique identifier for purchase order


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

def purchase_order_id
  @purchase_order_id
end

#purchase_order_numberObject

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


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

def purchase_order_number
  @purchase_order_number
end

#referenceObject

Additional reference number


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

def reference
  @reference
end

#sent_to_contactObject

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


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

def sent_to_contact
  @sent_to_contact
end

#statusObject

See Purchase Order Status Codes


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

def status
  @status
end

#status_attribute_stringObject

A string to indicate if a invoice status


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

def status_attribute_string
  @status_attribute_string
end

#sub_totalObject

Total of purchase order excluding taxes


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

def sub_total
  @sub_total
end

#telephoneObject

The phone number for the person accepting the delivery


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

def telephone
  @telephone
end

#totalObject

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


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

def total
  @total
end

#total_discountObject

Total of discounts applied on the purchase order line items


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

def total_discount
  @total_discount
end

#total_taxObject

Total tax on purchase order


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

def total_tax
  @total_tax
end

#updated_date_utcObject

Last modified date UTC format


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

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


100
101
102
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 100

def validation_errors
  @validation_errors
end

#warningsObject

Displays array of warning messages from the API


103
104
105
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 103

def warnings
  @warnings
end

Class Method Details

.attribute_mapObject

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


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 131

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


411
412
413
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 411

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

.openapi_typesObject

Attribute type mapping.


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

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' => :'BigDecimal',
    :'sub_total' => :'BigDecimal',
    :'total_tax' => :'BigDecimal',
    :'total' => :'BigDecimal',
    :'total_discount' => :'BigDecimal',
    :'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


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 363

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


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
466
467
468
469
470
471
472
473
474
475
476
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 439

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 :BigDecimal
    BigDecimal(value.to_s)
  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, downcase: false) ⇒ 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


512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 512

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 418

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

398
399
400
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 398

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


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

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_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


528
529
530
531
532
533
534
535
536
537
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 528

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


504
505
506
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 504

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


486
487
488
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 486

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


492
493
494
495
496
497
498
499
500
501
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 492

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


480
481
482
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 480

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


345
346
347
348
349
# File 'lib/xero-ruby/models/accounting/purchase_order.rb', line 345

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