Class: ConnectWise::Agreement

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/agreement.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Agreement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 328

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'company')
    self.company = attributes[:'company']
  end

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

  if attributes.has_key?(:'subContractCompany')
    self.sub_contract_company = attributes[:'subContractCompany']
  end

  if attributes.has_key?(:'subContractContact')
    self.sub_contract_contact = attributes[:'subContractContact']
  end

  if attributes.has_key?(:'parentAgreementId')
    self.parent_agreement_id = attributes[:'parentAgreementId']
  end

  if attributes.has_key?(:'customerPO')
    self.customer_po = attributes[:'customerPO']
  end

  if attributes.has_key?(:'locationId')
    self.location_id = attributes[:'locationId']
  end

  if attributes.has_key?(:'businessUnitId')
    self.business_unit_id = attributes[:'businessUnitId']
  end

  if attributes.has_key?(:'restrictLocationFlag')
    self.restrict_location_flag = attributes[:'restrictLocationFlag']
  end

  if attributes.has_key?(:'restrictDepartmentFlag')
    self.restrict_department_flag = attributes[:'restrictDepartmentFlag']
  end

  if attributes.has_key?(:'startDate')
    self.start_date = attributes[:'startDate']
  end

  if attributes.has_key?(:'endDate')
    self.end_date = attributes[:'endDate']
  end

  if attributes.has_key?(:'noEndingDateFlag')
    self.no_ending_date_flag = attributes[:'noEndingDateFlag']
  end

  if attributes.has_key?(:'opportunity')
    self.opportunity = attributes[:'opportunity']
  end

  if attributes.has_key?(:'cancelledFlag')
    self.cancelled_flag = attributes[:'cancelledFlag']
  end

  if attributes.has_key?(:'dateCancelled')
    self.date_cancelled = attributes[:'dateCancelled']
  end

  if attributes.has_key?(:'reasonCancelled')
    self.reason_cancelled = attributes[:'reasonCancelled']
  end

  if attributes.has_key?(:'slaId')
    self.sla_id = attributes[:'slaId']
  end

  if attributes.has_key?(:'workOrder')
    self.work_order = attributes[:'workOrder']
  end

  if attributes.has_key?(:'internalNotes')
    self.internal_notes = attributes[:'internalNotes']
  end

  if attributes.has_key?(:'applicationUnits')
    self.application_units = attributes[:'applicationUnits']
  end

  if attributes.has_key?(:'applicationLimit')
    self.application_limit = attributes[:'applicationLimit']
  end

  if attributes.has_key?(:'applicationCycle')
    self.application_cycle = attributes[:'applicationCycle']
  end

  if attributes.has_key?(:'applicationUnlimitedFlag')
    self.application_unlimited_flag = attributes[:'applicationUnlimitedFlag']
  end

  if attributes.has_key?(:'oneTimeFlag')
    self.one_time_flag = attributes[:'oneTimeFlag']
  end

  if attributes.has_key?(:'coverAgreementTime')
    self.cover_agreement_time = attributes[:'coverAgreementTime']
  end

  if attributes.has_key?(:'coverAgreementProduct')
    self.cover_agreement_product = attributes[:'coverAgreementProduct']
  end

  if attributes.has_key?(:'coverAgreementExpense')
    self.cover_agreement_expense = attributes[:'coverAgreementExpense']
  end

  if attributes.has_key?(:'coverSalesTax')
    self.cover_sales_tax = attributes[:'coverSalesTax']
  end

  if attributes.has_key?(:'carryOverUnused')
    self.carry_over_unused = attributes[:'carryOverUnused']
  end

  if attributes.has_key?(:'allowOverruns')
    self.allow_overruns = attributes[:'allowOverruns']
  end

  if attributes.has_key?(:'expiredDays')
    self.expired_days = attributes[:'expiredDays']
  end

  if attributes.has_key?(:'limit')
    self.limit = attributes[:'limit']
  end

  if attributes.has_key?(:'expireWhenZero')
    self.expire_when_zero = attributes[:'expireWhenZero']
  end

  if attributes.has_key?(:'chargeToFirm')
    self.charge_to_firm = attributes[:'chargeToFirm']
  end

  if attributes.has_key?(:'employeeCompRate')
    self.employee_comp_rate = attributes[:'employeeCompRate']
  end

  if attributes.has_key?(:'employeeCompNotExceed')
    self.employee_comp_not_exceed = attributes[:'employeeCompNotExceed']
  end

  if attributes.has_key?(:'compHourlyRate')
    self.comp_hourly_rate = attributes[:'compHourlyRate']
  end

  if attributes.has_key?(:'compLimitAmount')
    self.comp_limit_amount = attributes[:'compLimitAmount']
  end

  if attributes.has_key?(:'billCycleId')
    self.bill_cycle_id = attributes[:'billCycleId']
  end

  if attributes.has_key?(:'billOneTimeFlag')
    self.bill_one_time_flag = attributes[:'billOneTimeFlag']
  end

  if attributes.has_key?(:'billTermsId')
    self.bill_terms_id = attributes[:'billTermsId']
  end

  if attributes.has_key?(:'invoicingCycle')
    self.invoicing_cycle = attributes[:'invoicingCycle']
  end

  if attributes.has_key?(:'billToCompany')
    self.bill_to_company = attributes[:'billToCompany']
  end

  if attributes.has_key?(:'billToSite')
    self.bill_to_site = attributes[:'billToSite']
  end

  if attributes.has_key?(:'billAmount')
    self.bill_amount = attributes[:'billAmount']
  end

  if attributes.has_key?(:'taxable')
    self.taxable = attributes[:'taxable']
  end

  if attributes.has_key?(:'prorateFirstBill')
    self.prorate_first_bill = attributes[:'prorateFirstBill']
  end

  if attributes.has_key?(:'billStartDate')
    self.bill_start_date = attributes[:'billStartDate']
  end

  if attributes.has_key?(:'taxCodeId')
    self.tax_code_id = attributes[:'taxCodeId']
  end

  if attributes.has_key?(:'restrictDownPayment')
    self.restrict_down_payment = attributes[:'restrictDownPayment']
  end

  if attributes.has_key?(:'prorateFlag')
    self.prorate_flag = attributes[:'prorateFlag']
  end

  if attributes.has_key?(:'invoiceDescription')
    self.invoice_description = attributes[:'invoiceDescription']
  end

  if attributes.has_key?(:'topComment')
    self.top_comment = attributes[:'topComment']
  end

  if attributes.has_key?(:'bottomComment')
    self.bottom_comment = attributes[:'bottomComment']
  end

  if attributes.has_key?(:'workRole')
    self.work_role = attributes[:'workRole']
  end

  if attributes.has_key?(:'workType')
    self.work_type = attributes[:'workType']
  end

  if attributes.has_key?(:'projectTypeId')
    self.project_type_id = attributes[:'projectTypeId']
  end

  if attributes.has_key?(:'invoiceTemplateSetupId')
    self.invoice_template_setup_id = attributes[:'invoiceTemplateSetupId']
  end

  if attributes.has_key?(:'billTime')
    self.bill_time = attributes[:'billTime']
  end

  if attributes.has_key?(:'billExpenses')
    self.bill_expenses = attributes[:'billExpenses']
  end

  if attributes.has_key?(:'billProducts')
    self.bill_products = attributes[:'billProducts']
  end

  if attributes.has_key?(:'billableTimeInvoice')
    self.billable_time_invoice = attributes[:'billableTimeInvoice']
  end

  if attributes.has_key?(:'billableExpenseInvoice')
    self.billable_expense_invoice = attributes[:'billableExpenseInvoice']
  end

  if attributes.has_key?(:'billableProductInvoice')
    self.billable_product_invoice = attributes[:'billableProductInvoice']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'periodType')
    self.period_type = attributes[:'periodType']
  end

  if attributes.has_key?(:'_info')
    self._info = attributes[:'_info']
  end

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



148
149
150
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 148

def _info
  @_info
end

#allow_overruns ⇒ Object

Returns the value of attribute allow_overruns.



73
74
75
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 73

def allow_overruns
  @allow_overruns
end

#application_cycle ⇒ Object

Returns the value of attribute application_cycle.



57
58
59
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 57

def application_cycle
  @application_cycle
end

#application_limit ⇒ Object

Returns the value of attribute application_limit.



55
56
57
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 55

def application_limit
  @application_limit
end

#application_units ⇒ Object

Returns the value of attribute application_units.



53
54
55
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 53

def application_units
  @application_units
end

#application_unlimited_flag ⇒ Object

Returns the value of attribute application_unlimited_flag.



59
60
61
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 59

def application_unlimited_flag
  @application_unlimited_flag
end

#bill_amount ⇒ Object

Returns the value of attribute bill_amount.



103
104
105
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 103

def bill_amount
  @bill_amount
end

#bill_cycle_id ⇒ Object

Returns the value of attribute bill_cycle_id.



91
92
93
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 91

def bill_cycle_id
  @bill_cycle_id
end

#bill_expenses ⇒ Object

Returns the value of attribute bill_expenses.



133
134
135
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 133

def bill_expenses
  @bill_expenses
end

#bill_one_time_flag ⇒ Object

Returns the value of attribute bill_one_time_flag.



93
94
95
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 93

def bill_one_time_flag
  @bill_one_time_flag
end

#bill_products ⇒ Object

Returns the value of attribute bill_products.



135
136
137
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 135

def bill_products
  @bill_products
end

#bill_start_date ⇒ Object

Returns the value of attribute bill_start_date.



109
110
111
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 109

def bill_start_date
  @bill_start_date
end

#bill_terms_id ⇒ Object

Returns the value of attribute bill_terms_id.



95
96
97
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 95

def bill_terms_id
  @bill_terms_id
end

#bill_time ⇒ Object

Returns the value of attribute bill_time.



131
132
133
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 131

def bill_time
  @bill_time
end

#bill_to_company ⇒ Object

Returns the value of attribute bill_to_company.



99
100
101
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 99

def bill_to_company
  @bill_to_company
end

#bill_to_site ⇒ Object

Returns the value of attribute bill_to_site.



101
102
103
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 101

def bill_to_site
  @bill_to_site
end

#billable_expense_invoice ⇒ Object

Returns the value of attribute billable_expense_invoice.



139
140
141
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 139

def billable_expense_invoice
  @billable_expense_invoice
end

#billable_product_invoice ⇒ Object

Returns the value of attribute billable_product_invoice.



141
142
143
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 141

def billable_product_invoice
  @billable_product_invoice
end

#billable_time_invoice ⇒ Object

Returns the value of attribute billable_time_invoice.



137
138
139
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 137

def billable_time_invoice
  @billable_time_invoice
end

#bottom_comment ⇒ Object

Returns the value of attribute bottom_comment.



121
122
123
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 121

def bottom_comment
  @bottom_comment
end

#business_unit_id ⇒ Object

Returns the value of attribute business_unit_id.



27
28
29
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 27

def business_unit_id
  @business_unit_id
end

#cancelled_flag ⇒ Object

Returns the value of attribute cancelled_flag.



41
42
43
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 41

def cancelled_flag
  @cancelled_flag
end

#carry_over_unused ⇒ Object

Returns the value of attribute carry_over_unused.



71
72
73
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 71

def carry_over_unused
  @carry_over_unused
end

#charge_to_firm ⇒ Object

Returns the value of attribute charge_to_firm.



81
82
83
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 81

def charge_to_firm
  @charge_to_firm
end

#comp_hourly_rate ⇒ Object

Returns the value of attribute comp_hourly_rate.



87
88
89
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 87

def comp_hourly_rate
  @comp_hourly_rate
end

#comp_limit_amount ⇒ Object

Returns the value of attribute comp_limit_amount.



89
90
91
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 89

def comp_limit_amount
  @comp_limit_amount
end

#company ⇒ Object

Returns the value of attribute company.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 13

def company
  @company
end

#contact ⇒ Object

Returns the value of attribute contact.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 15

def contact
  @contact
end

#cover_agreement_expense ⇒ Object

Returns the value of attribute cover_agreement_expense.



67
68
69
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 67

def cover_agreement_expense
  @cover_agreement_expense
end

#cover_agreement_product ⇒ Object

Returns the value of attribute cover_agreement_product.



65
66
67
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 65

def cover_agreement_product
  @cover_agreement_product
end

#cover_agreement_time ⇒ Object

Returns the value of attribute cover_agreement_time.



63
64
65
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 63

def cover_agreement_time
  @cover_agreement_time
end

#cover_sales_tax ⇒ Object

Returns the value of attribute cover_sales_tax.



69
70
71
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 69

def cover_sales_tax
  @cover_sales_tax
end

#currency ⇒ Object

Returns the value of attribute currency.



143
144
145
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 143

def currency
  @currency
end

#customer_po ⇒ Object

Returns the value of attribute customer_po.



23
24
25
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 23

def customer_po
  @customer_po
end

#date_cancelled ⇒ Object

Returns the value of attribute date_cancelled.



43
44
45
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 43

def date_cancelled
  @date_cancelled
end

#employee_comp_not_exceed ⇒ Object

Returns the value of attribute employee_comp_not_exceed.



85
86
87
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 85

def employee_comp_not_exceed
  @employee_comp_not_exceed
end

#employee_comp_rate ⇒ Object

Returns the value of attribute employee_comp_rate.



83
84
85
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 83

def employee_comp_rate
  @employee_comp_rate
end

#end_date ⇒ Object

Returns the value of attribute end_date.



35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 35

def end_date
  @end_date
end

#expire_when_zero ⇒ Object

Returns the value of attribute expire_when_zero.



79
80
81
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 79

def expire_when_zero
  @expire_when_zero
end

#expired_days ⇒ Object

Returns the value of attribute expired_days.



75
76
77
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 75

def expired_days
  @expired_days
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 7

def id
  @id
end

#internal_notes ⇒ Object

Returns the value of attribute internal_notes.



51
52
53
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 51

def internal_notes
  @internal_notes
end

#invoice_description ⇒ Object

Returns the value of attribute invoice_description.



117
118
119
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 117

def invoice_description
  @invoice_description
end

#invoice_template_setup_id ⇒ Object

Returns the value of attribute invoice_template_setup_id.



129
130
131
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 129

def invoice_template_setup_id
  @invoice_template_setup_id
end

#invoicing_cycle ⇒ Object

Returns the value of attribute invoicing_cycle.



97
98
99
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 97

def invoicing_cycle
  @invoicing_cycle
end

#limit ⇒ Object

Returns the value of attribute limit.



77
78
79
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 77

def limit
  @limit
end

#location_id ⇒ Object

Returns the value of attribute location_id.



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 25

def location_id
  @location_id
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 9

def name
  @name
end

#no_ending_date_flag ⇒ Object

Returns the value of attribute no_ending_date_flag.



37
38
39
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 37

def no_ending_date_flag
  @no_ending_date_flag
end

#one_time_flag ⇒ Object

Returns the value of attribute one_time_flag.



61
62
63
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 61

def one_time_flag
  @one_time_flag
end

#opportunity ⇒ Object

Returns the value of attribute opportunity.



39
40
41
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 39

def opportunity
  @opportunity
end

#parent_agreement_id ⇒ Object

Returns the value of attribute parent_agreement_id.



21
22
23
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 21

def parent_agreement_id
  @parent_agreement_id
end

#period_type ⇒ Object

Returns the value of attribute period_type.



145
146
147
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 145

def period_type
  @period_type
end

#project_type_id ⇒ Object

Returns the value of attribute project_type_id.



127
128
129
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 127

def project_type_id
  @project_type_id
end

#prorate_first_bill ⇒ Object

Returns the value of attribute prorate_first_bill.



107
108
109
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 107

def prorate_first_bill
  @prorate_first_bill
end

#prorate_flag ⇒ Object

Returns the value of attribute prorate_flag.



115
116
117
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 115

def prorate_flag
  @prorate_flag
end

#reason_cancelled ⇒ Object

Returns the value of attribute reason_cancelled.



45
46
47
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 45

def reason_cancelled
  @reason_cancelled
end

#restrict_department_flag ⇒ Object

Returns the value of attribute restrict_department_flag.



31
32
33
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 31

def restrict_department_flag
  @restrict_department_flag
end

#restrict_down_payment ⇒ Object

Returns the value of attribute restrict_down_payment.



113
114
115
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 113

def restrict_down_payment
  @restrict_down_payment
end

#restrict_location_flag ⇒ Object

Returns the value of attribute restrict_location_flag.



29
30
31
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 29

def restrict_location_flag
  @restrict_location_flag
end

#sla_id ⇒ Object

Returns the value of attribute sla_id.



47
48
49
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 47

def sla_id
  @sla_id
end

#start_date ⇒ Object

Returns the value of attribute start_date.



33
34
35
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 33

def start_date
  @start_date
end

#sub_contract_company ⇒ Object

Returns the value of attribute sub_contract_company.



17
18
19
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 17

def sub_contract_company
  @sub_contract_company
end

#sub_contract_contact ⇒ Object

Returns the value of attribute sub_contract_contact.



19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 19

def sub_contract_contact
  @sub_contract_contact
end

#tax_code_id ⇒ Object

Returns the value of attribute tax_code_id.



111
112
113
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 111

def tax_code_id
  @tax_code_id
end

#taxable ⇒ Object

Returns the value of attribute taxable.



105
106
107
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 105

def taxable
  @taxable
end

#top_comment ⇒ Object

Returns the value of attribute top_comment.



119
120
121
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 119

def top_comment
  @top_comment
end

#type ⇒ Object

Returns the value of attribute type.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 11

def type
  @type
end

#work_order ⇒ Object

Returns the value of attribute work_order.



49
50
51
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 49

def work_order
  @work_order
end

#work_role ⇒ Object

Returns the value of attribute work_role.



123
124
125
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 123

def work_role
  @work_role
end

#work_type ⇒ Object

Returns the value of attribute work_type.



125
126
127
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 125

def work_type
  @work_type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 173

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type',
    :'company' => :'company',
    :'contact' => :'contact',
    :'sub_contract_company' => :'subContractCompany',
    :'sub_contract_contact' => :'subContractContact',
    :'parent_agreement_id' => :'parentAgreementId',
    :'customer_po' => :'customerPO',
    :'location_id' => :'locationId',
    :'business_unit_id' => :'businessUnitId',
    :'restrict_location_flag' => :'restrictLocationFlag',
    :'restrict_department_flag' => :'restrictDepartmentFlag',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'no_ending_date_flag' => :'noEndingDateFlag',
    :'opportunity' => :'opportunity',
    :'cancelled_flag' => :'cancelledFlag',
    :'date_cancelled' => :'dateCancelled',
    :'reason_cancelled' => :'reasonCancelled',
    :'sla_id' => :'slaId',
    :'work_order' => :'workOrder',
    :'internal_notes' => :'internalNotes',
    :'application_units' => :'applicationUnits',
    :'application_limit' => :'applicationLimit',
    :'application_cycle' => :'applicationCycle',
    :'application_unlimited_flag' => :'applicationUnlimitedFlag',
    :'one_time_flag' => :'oneTimeFlag',
    :'cover_agreement_time' => :'coverAgreementTime',
    :'cover_agreement_product' => :'coverAgreementProduct',
    :'cover_agreement_expense' => :'coverAgreementExpense',
    :'cover_sales_tax' => :'coverSalesTax',
    :'carry_over_unused' => :'carryOverUnused',
    :'allow_overruns' => :'allowOverruns',
    :'expired_days' => :'expiredDays',
    :'limit' => :'limit',
    :'expire_when_zero' => :'expireWhenZero',
    :'charge_to_firm' => :'chargeToFirm',
    :'employee_comp_rate' => :'employeeCompRate',
    :'employee_comp_not_exceed' => :'employeeCompNotExceed',
    :'comp_hourly_rate' => :'compHourlyRate',
    :'comp_limit_amount' => :'compLimitAmount',
    :'bill_cycle_id' => :'billCycleId',
    :'bill_one_time_flag' => :'billOneTimeFlag',
    :'bill_terms_id' => :'billTermsId',
    :'invoicing_cycle' => :'invoicingCycle',
    :'bill_to_company' => :'billToCompany',
    :'bill_to_site' => :'billToSite',
    :'bill_amount' => :'billAmount',
    :'taxable' => :'taxable',
    :'prorate_first_bill' => :'prorateFirstBill',
    :'bill_start_date' => :'billStartDate',
    :'tax_code_id' => :'taxCodeId',
    :'restrict_down_payment' => :'restrictDownPayment',
    :'prorate_flag' => :'prorateFlag',
    :'invoice_description' => :'invoiceDescription',
    :'top_comment' => :'topComment',
    :'bottom_comment' => :'bottomComment',
    :'work_role' => :'workRole',
    :'work_type' => :'workType',
    :'project_type_id' => :'projectTypeId',
    :'invoice_template_setup_id' => :'invoiceTemplateSetupId',
    :'bill_time' => :'billTime',
    :'bill_expenses' => :'billExpenses',
    :'bill_products' => :'billProducts',
    :'billable_time_invoice' => :'billableTimeInvoice',
    :'billable_expense_invoice' => :'billableExpenseInvoice',
    :'billable_product_invoice' => :'billableProductInvoice',
    :'currency' => :'currency',
    :'period_type' => :'periodType',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 250

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'type' => :'AgreementTypeReference',
    :'company' => :'CompanyReference',
    :'contact' => :'ContactReference',
    :'sub_contract_company' => :'CompanyReference',
    :'sub_contract_contact' => :'ContactReference',
    :'parent_agreement_id' => :'Integer',
    :'customer_po' => :'String',
    :'location_id' => :'Integer',
    :'business_unit_id' => :'Integer',
    :'restrict_location_flag' => :'BOOLEAN',
    :'restrict_department_flag' => :'BOOLEAN',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'no_ending_date_flag' => :'BOOLEAN',
    :'opportunity' => :'OpportunityReference',
    :'cancelled_flag' => :'BOOLEAN',
    :'date_cancelled' => :'DateTime',
    :'reason_cancelled' => :'String',
    :'sla_id' => :'Integer',
    :'work_order' => :'String',
    :'internal_notes' => :'String',
    :'application_units' => :'String',
    :'application_limit' => :'Float',
    :'application_cycle' => :'String',
    :'application_unlimited_flag' => :'BOOLEAN',
    :'one_time_flag' => :'BOOLEAN',
    :'cover_agreement_time' => :'BOOLEAN',
    :'cover_agreement_product' => :'BOOLEAN',
    :'cover_agreement_expense' => :'BOOLEAN',
    :'cover_sales_tax' => :'BOOLEAN',
    :'carry_over_unused' => :'BOOLEAN',
    :'allow_overruns' => :'BOOLEAN',
    :'expired_days' => :'Integer',
    :'limit' => :'Integer',
    :'expire_when_zero' => :'BOOLEAN',
    :'charge_to_firm' => :'BOOLEAN',
    :'employee_comp_rate' => :'String',
    :'employee_comp_not_exceed' => :'String',
    :'comp_hourly_rate' => :'Float',
    :'comp_limit_amount' => :'Float',
    :'bill_cycle_id' => :'Integer',
    :'bill_one_time_flag' => :'BOOLEAN',
    :'bill_terms_id' => :'Integer',
    :'invoicing_cycle' => :'String',
    :'bill_to_company' => :'CompanyReference',
    :'bill_to_site' => :'SiteReference',
    :'bill_amount' => :'Float',
    :'taxable' => :'BOOLEAN',
    :'prorate_first_bill' => :'Float',
    :'bill_start_date' => :'DateTime',
    :'tax_code_id' => :'Integer',
    :'restrict_down_payment' => :'BOOLEAN',
    :'prorate_flag' => :'BOOLEAN',
    :'invoice_description' => :'String',
    :'top_comment' => :'BOOLEAN',
    :'bottom_comment' => :'BOOLEAN',
    :'work_role' => :'WorkRoleReference',
    :'work_type' => :'WorkTypeReference',
    :'project_type_id' => :'Integer',
    :'invoice_template_setup_id' => :'Integer',
    :'bill_time' => :'String',
    :'bill_expenses' => :'String',
    :'bill_products' => :'String',
    :'billable_time_invoice' => :'BOOLEAN',
    :'billable_expense_invoice' => :'BOOLEAN',
    :'billable_product_invoice' => :'BOOLEAN',
    :'currency' => :'CurrencyReference',
    :'period_type' => :'String',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 846

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      company == o.company &&
      contact == o.contact &&
      sub_contract_company == o.sub_contract_company &&
      sub_contract_contact == o.sub_contract_contact &&
      parent_agreement_id == o.parent_agreement_id &&
      customer_po == o.customer_po &&
      location_id == o.location_id &&
      business_unit_id == o.business_unit_id &&
      restrict_location_flag == o.restrict_location_flag &&
      restrict_department_flag == o.restrict_department_flag &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      no_ending_date_flag == o.no_ending_date_flag &&
      opportunity == o.opportunity &&
      cancelled_flag == o.cancelled_flag &&
      date_cancelled == o.date_cancelled &&
      reason_cancelled == o.reason_cancelled &&
      sla_id == o.sla_id &&
      work_order == o.work_order &&
      internal_notes == o.internal_notes &&
      application_units == o.application_units &&
      application_limit == o.application_limit &&
      application_cycle == o.application_cycle &&
      application_unlimited_flag == o.application_unlimited_flag &&
      one_time_flag == o.one_time_flag &&
      cover_agreement_time == o.cover_agreement_time &&
      cover_agreement_product == o.cover_agreement_product &&
      cover_agreement_expense == o.cover_agreement_expense &&
      cover_sales_tax == o.cover_sales_tax &&
      carry_over_unused == o.carry_over_unused &&
      allow_overruns == o.allow_overruns &&
      expired_days == o.expired_days &&
      limit == o.limit &&
      expire_when_zero == o.expire_when_zero &&
      charge_to_firm == o.charge_to_firm &&
      employee_comp_rate == o.employee_comp_rate &&
      employee_comp_not_exceed == o.employee_comp_not_exceed &&
      comp_hourly_rate == o.comp_hourly_rate &&
      comp_limit_amount == o.comp_limit_amount &&
      bill_cycle_id == o.bill_cycle_id &&
      bill_one_time_flag == o.bill_one_time_flag &&
      bill_terms_id == o.bill_terms_id &&
      invoicing_cycle == o.invoicing_cycle &&
      bill_to_company == o.bill_to_company &&
      bill_to_site == o.bill_to_site &&
      bill_amount == o.bill_amount &&
      taxable == o.taxable &&
      prorate_first_bill == o.prorate_first_bill &&
      bill_start_date == o.bill_start_date &&
      tax_code_id == o.tax_code_id &&
      restrict_down_payment == o.restrict_down_payment &&
      prorate_flag == o.prorate_flag &&
      invoice_description == o.invoice_description &&
      top_comment == o.top_comment &&
      bottom_comment == o.bottom_comment &&
      work_role == o.work_role &&
      work_type == o.work_type &&
      project_type_id == o.project_type_id &&
      invoice_template_setup_id == o.invoice_template_setup_id &&
      bill_time == o.bill_time &&
      bill_expenses == o.bill_expenses &&
      bill_products == o.bill_products &&
      billable_time_invoice == o.billable_time_invoice &&
      billable_expense_invoice == o.billable_expense_invoice &&
      billable_product_invoice == o.billable_product_invoice &&
      currency == o.currency &&
      period_type == o.period_type &&
      _info == o._info
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



958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 958

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(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
    temp_model = ConnectWise.const_get(type).new
    temp_model.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



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 1024

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



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 937

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


924
925
926
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 924

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



930
931
932
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 930

def hash
  [id, name, type, company, contact, sub_contract_company, sub_contract_contact, parent_agreement_id, customer_po, location_id, business_unit_id, restrict_location_flag, restrict_department_flag, start_date, end_date, no_ending_date_flag, opportunity, cancelled_flag, date_cancelled, reason_cancelled, sla_id, work_order, internal_notes, application_units, application_limit, application_cycle, application_unlimited_flag, one_time_flag, cover_agreement_time, cover_agreement_product, cover_agreement_expense, cover_sales_tax, carry_over_unused, allow_overruns, expired_days, limit, expire_when_zero, charge_to_firm, employee_comp_rate, employee_comp_not_exceed, comp_hourly_rate, comp_limit_amount, bill_cycle_id, bill_one_time_flag, bill_terms_id, invoicing_cycle, bill_to_company, bill_to_site, bill_amount, taxable, prorate_first_bill, bill_start_date, tax_code_id, restrict_down_payment, prorate_flag, invoice_description, top_comment, bottom_comment, work_role, work_type, project_type_id, invoice_template_setup_id, bill_time, bill_expenses, bill_products, billable_time_invoice, billable_expense_invoice, billable_product_invoice, currency, period_type, _info].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 622

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end

  if @name.to_s.length > 100
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 100.")
  end

  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

  if @company.nil?
    invalid_properties.push("invalid value for 'company', company cannot be nil.")
  end

  if @contact.nil?
    invalid_properties.push("invalid value for 'contact', contact cannot be nil.")
  end

  if !@customer_po.nil? && @customer_po.to_s.length > 50
    invalid_properties.push("invalid value for 'customer_po', the character length must be smaller than or equal to 50.")
  end

  if !@reason_cancelled.nil? && @reason_cancelled.to_s.length > 50
    invalid_properties.push("invalid value for 'reason_cancelled', the character length must be smaller than or equal to 50.")
  end

  if !@work_order.nil? && @work_order.to_s.length > 20
    invalid_properties.push("invalid value for 'work_order', the character length must be smaller than or equal to 20.")
  end

  if !@internal_notes.nil? && @internal_notes.to_s.length > 5000
    invalid_properties.push("invalid value for 'internal_notes', the character length must be smaller than or equal to 5000.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



1004
1005
1006
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 1004

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



1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 1010

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



998
999
1000
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 998

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



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/connectwise-ruby-sdk/models/agreement.rb', line 665

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @type.nil?
  return false if @company.nil?
  return false if @contact.nil?
  return false if !@customer_po.nil? && @customer_po.to_s.length > 50
  return false if !@reason_cancelled.nil? && @reason_cancelled.to_s.length > 50
  return false if !@work_order.nil? && @work_order.to_s.length > 20
  return false if !@internal_notes.nil? && @internal_notes.to_s.length > 5000
  application_units_validator = EnumAttributeValidator.new('String', ["Amount", "Hours", "Incidents"])
  return false unless application_units_validator.valid?(@application_units)
  application_cycle_validator = EnumAttributeValidator.new('String', ["Contract2Weeks", "Contract4Weeks", "ContractYear", "CalendarMonth", "CalendarQuarter", "CalendarWeek", "ContractQuarter", "CalendarYear", "OneTimeOnly"])
  return false unless application_cycle_validator.valid?(@application_cycle)
  employee_comp_rate_validator = EnumAttributeValidator.new('String', ["Actual", "Hourly"])
  return false unless employee_comp_rate_validator.valid?(@employee_comp_rate)
  employee_comp_not_exceed_validator = EnumAttributeValidator.new('String', ["Billing", "Percent", "Amount"])
  return false unless employee_comp_not_exceed_validator.valid?(@employee_comp_not_exceed)
  invoicing_cycle_validator = EnumAttributeValidator.new('String', ["CalendarYear", "ContractYear"])
  return false unless invoicing_cycle_validator.valid?(@invoicing_cycle)
  bill_time_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_time_validator.valid?(@bill_time)
  bill_expenses_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_expenses_validator.valid?(@bill_expenses)
  bill_products_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_products_validator.valid?(@bill_products)
  period_type_validator = EnumAttributeValidator.new('String', ["Current", "Future", "Both", "Undefined"])
  return false unless period_type_validator.valid?(@period_type)
  return true
end