Class: XeroRuby::Accounting::Prepayment
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Prepayment
- Defined in:
- lib/xero-ruby/models/accounting/prepayment.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Constant Summary collapse
- RECEIVE_PREPAYMENT =
"RECEIVE-PREPAYMENT".freeze
- SPEND_PREPAYMENT =
"SPEND-PREPAYMENT".freeze
- ARPREPAYMENT =
"ARPREPAYMENT".freeze
- APPREPAYMENT =
"APPREPAYMENT".freeze
- AUTHORISED =
"AUTHORISED".freeze
- PAID =
"PAID".freeze
- VOIDED =
"VOIDED".freeze
Instance Attribute Summary collapse
-
#allocations ⇒ Object
See Allocations.
-
#applied_amount ⇒ Object
The amount of applied to an invoice.
-
#attachments ⇒ Object
See Attachments.
-
#contact ⇒ Object
Returns the value of attribute contact.
-
#currency_code ⇒ Object
Returns the value of attribute currency_code.
-
#currency_rate ⇒ Object
The currency rate for a multicurrency prepayment.
-
#date ⇒ Object
The date the prepayment is created YYYY-MM-DD.
-
#has_attachments ⇒ Object
boolean to indicate if a prepayment has an attachment.
-
#line_amount_types ⇒ Object
Returns the value of attribute line_amount_types.
-
#line_items ⇒ Object
See Prepayment Line Items.
-
#prepayment_id ⇒ Object
Xero generated unique identifier.
-
#reference ⇒ Object
Returns Invoice number field.
-
#remaining_credit ⇒ Object
The remaining credit balance on the prepayment.
-
#status ⇒ Object
See Prepayment Status Codes.
-
#sub_total ⇒ Object
The subtotal of the prepayment excluding taxes.
-
#total ⇒ Object
The total of the prepayment(subtotal + total tax).
-
#total_tax ⇒ Object
The total tax on the prepayment.
-
#type ⇒ Object
See Prepayment Types.
-
#updated_date_utc ⇒ Object
UTC timestamp of last update to the prepayment.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Prepayment
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Prepayment
Initializes the object
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 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 158 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Prepayment` 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::Prepayment`. 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?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'contact') self.contact = attributes[:'contact'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'line_amount_types') self.line_amount_types = attributes[:'line_amount_types'] end if attributes.key?(:'line_items') if (value = attributes[:'line_items']).is_a?(Array) self.line_items = value end 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?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'currency_code') self.currency_code = attributes[:'currency_code'] end if attributes.key?(:'prepayment_id') self.prepayment_id = attributes[:'prepayment_id'] end if attributes.key?(:'currency_rate') self.currency_rate = attributes[:'currency_rate'] end if attributes.key?(:'remaining_credit') self.remaining_credit = attributes[:'remaining_credit'] end if attributes.key?(:'allocations') if (value = attributes[:'allocations']).is_a?(Array) self.allocations = value end end if attributes.key?(:'applied_amount') self.applied_amount = attributes[:'applied_amount'] end if attributes.key?(:'has_attachments') self. = attributes[:'has_attachments'] else self. = false end if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self. = value end end end |
Instance Attribute Details
#allocations ⇒ Object
See Allocations
73 74 75 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 73 def allocations @allocations end |
#applied_amount ⇒ Object
The amount of applied to an invoice
76 77 78 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 76 def applied_amount @applied_amount end |
#attachments ⇒ Object
See Attachments
82 83 84 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 82 def @attachments end |
#contact ⇒ Object
Returns the value of attribute contact.
28 29 30 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 28 def contact @contact end |
#currency_code ⇒ Object
Returns the value of attribute currency_code.
61 62 63 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 61 def currency_code @currency_code end |
#currency_rate ⇒ Object
The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used
67 68 69 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 67 def currency_rate @currency_rate end |
#date ⇒ Object
The date the prepayment is created YYYY-MM-DD
31 32 33 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 31 def date @date end |
#has_attachments ⇒ Object
boolean to indicate if a prepayment has an attachment
79 80 81 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 79 def @has_attachments end |
#line_amount_types ⇒ Object
Returns the value of attribute line_amount_types.
40 41 42 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 40 def line_amount_types @line_amount_types end |
#line_items ⇒ Object
See Prepayment Line Items
43 44 45 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 43 def line_items @line_items end |
#prepayment_id ⇒ Object
Xero generated unique identifier
64 65 66 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 64 def prepayment_id @prepayment_id end |
#reference ⇒ Object
Returns Invoice number field. Reference field isn’t available.
55 56 57 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 55 def reference @reference end |
#remaining_credit ⇒ Object
The remaining credit balance on the prepayment
70 71 72 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 70 def remaining_credit @remaining_credit end |
#status ⇒ Object
See Prepayment Status Codes
34 35 36 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 34 def status @status end |
#sub_total ⇒ Object
The subtotal of the prepayment excluding taxes
46 47 48 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 46 def sub_total @sub_total end |
#total ⇒ Object
The total of the prepayment(subtotal + total tax)
52 53 54 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 52 def total @total end |
#total_tax ⇒ Object
The total tax on the prepayment
49 50 51 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 49 def total_tax @total_tax end |
#type ⇒ Object
See Prepayment Types
21 22 23 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 21 def type @type end |
#updated_date_utc ⇒ Object
UTC timestamp of last update to the prepayment
58 59 60 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 58 def updated_date_utc @updated_date_utc end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 107 def self.attribute_map { :'type' => :'Type', :'contact' => :'Contact', :'date' => :'Date', :'status' => :'Status', :'line_amount_types' => :'LineAmountTypes', :'line_items' => :'LineItems', :'sub_total' => :'SubTotal', :'total_tax' => :'TotalTax', :'total' => :'Total', :'reference' => :'Reference', :'updated_date_utc' => :'UpdatedDateUTC', :'currency_code' => :'CurrencyCode', :'prepayment_id' => :'PrepaymentID', :'currency_rate' => :'CurrencyRate', :'remaining_credit' => :'RemainingCredit', :'allocations' => :'Allocations', :'applied_amount' => :'AppliedAmount', :'has_attachments' => :'HasAttachments', :'attachments' => :'Attachments' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
334 335 336 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 334 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 132 def self.openapi_types { :'type' => :'String', :'contact' => :'Contact', :'date' => :'Date', :'status' => :'String', :'line_amount_types' => :'LineAmountTypes', :'line_items' => :'Array<LineItem>', :'sub_total' => :'BigDecimal', :'total_tax' => :'BigDecimal', :'total' => :'BigDecimal', :'reference' => :'String', :'updated_date_utc' => :'DateTime', :'currency_code' => :'CurrencyCode', :'prepayment_id' => :'String', :'currency_rate' => :'BigDecimal', :'remaining_credit' => :'BigDecimal', :'allocations' => :'Array<Allocation>', :'applied_amount' => :'Float', :'has_attachments' => :'Boolean', :'attachments' => :'Array<Attachment>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 295 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && contact == o.contact && date == o.date && status == o.status && line_amount_types == o.line_amount_types && line_items == o.line_items && sub_total == o.sub_total && total_tax == o.total_tax && total == o.total && reference == o.reference && updated_date_utc == o.updated_date_utc && currency_code == o.currency_code && prepayment_id == o.prepayment_id && currency_rate == o.currency_rate && remaining_credit == o.remaining_credit && allocations == o.allocations && applied_amount == o.applied_amount && == o. && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
362 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 395 396 397 398 399 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 362 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
429 430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 429 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
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 341 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
321 322 323 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 321 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
327 328 329 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 327 def hash [type, contact, date, status, line_amount_types, line_items, sub_total, total_tax, total, reference, updated_date_utc, currency_code, prepayment_id, currency_rate, remaining_credit, allocations, applied_amount, , ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
258 259 260 261 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 258 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
444 445 446 447 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 444 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)
409 410 411 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 409 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
415 416 417 418 419 420 421 422 423 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 415 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
403 404 405 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 403 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
265 266 267 268 269 270 271 |
# File 'lib/xero-ruby/models/accounting/prepayment.rb', line 265 def valid? type_validator = EnumAttributeValidator.new('String', ["RECEIVE-PREPAYMENT", "SPEND-PREPAYMENT", "ARPREPAYMENT", "APPREPAYMENT"]) return false unless type_validator.valid?(@type) status_validator = EnumAttributeValidator.new('String', ["AUTHORISED", "PAID", "VOIDED"]) return false unless status_validator.valid?(@status) true end |