-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathorganisation.py
More file actions
1164 lines (912 loc) · 36.3 KB
/
organisation.py
File metadata and controls
1164 lines (912 loc) · 36.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
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
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
619
620
621
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
662
663
664
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
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
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
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
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
995
996
997
998
999
1000
# coding: utf-8
"""
Xero Accounting API
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
Contact: api@xero.com
Generated by: https://openapi-generator.tech
"""
import re # noqa: F401
from xero_python.models import BaseModel
class Organisation(BaseModel):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
"""
Attributes:
openapi_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
openapi_types = {
"organisation_id": "str",
"api_key": "str",
"name": "str",
"legal_name": "str",
"pays_tax": "bool",
"version": "str",
"organisation_type": "str",
"base_currency": "CurrencyCode",
"country_code": "CountryCode",
"is_demo_company": "bool",
"organisation_status": "str",
"registration_number": "str",
"employer_identification_number": "str",
"tax_number": "str",
"financial_year_end_day": "int",
"financial_year_end_month": "int",
"sales_tax_basis": "str",
"sales_tax_period": "str",
"default_sales_tax": "str",
"default_purchases_tax": "str",
"period_lock_date": "date[ms-format]",
"end_of_year_lock_date": "date[ms-format]",
"created_date_utc": "datetime[ms-format]",
"timezone": "TimeZone",
"organisation_entity_type": "str",
"short_code": "str",
"_class": "str",
"edition": "str",
"line_of_business": "str",
"addresses": "list[AddressForOrganisation]",
"phones": "list[Phone]",
"external_links": "list[ExternalLink]",
"payment_terms": "PaymentTerm",
}
attribute_map = {
"organisation_id": "OrganisationID",
"api_key": "APIKey",
"name": "Name",
"legal_name": "LegalName",
"pays_tax": "PaysTax",
"version": "Version",
"organisation_type": "OrganisationType",
"base_currency": "BaseCurrency",
"country_code": "CountryCode",
"is_demo_company": "IsDemoCompany",
"organisation_status": "OrganisationStatus",
"registration_number": "RegistrationNumber",
"employer_identification_number": "EmployerIdentificationNumber",
"tax_number": "TaxNumber",
"financial_year_end_day": "FinancialYearEndDay",
"financial_year_end_month": "FinancialYearEndMonth",
"sales_tax_basis": "SalesTaxBasis",
"sales_tax_period": "SalesTaxPeriod",
"default_sales_tax": "DefaultSalesTax",
"default_purchases_tax": "DefaultPurchasesTax",
"period_lock_date": "PeriodLockDate",
"end_of_year_lock_date": "EndOfYearLockDate",
"created_date_utc": "CreatedDateUTC",
"timezone": "Timezone",
"organisation_entity_type": "OrganisationEntityType",
"short_code": "ShortCode",
"_class": "Class",
"edition": "Edition",
"line_of_business": "LineOfBusiness",
"addresses": "Addresses",
"phones": "Phones",
"external_links": "ExternalLinks",
"payment_terms": "PaymentTerms",
}
def __init__(
self,
organisation_id=None,
api_key=None,
name=None,
legal_name=None,
pays_tax=None,
version=None,
organisation_type=None,
base_currency=None,
country_code=None,
is_demo_company=None,
organisation_status=None,
registration_number=None,
employer_identification_number=None,
tax_number=None,
financial_year_end_day=None,
financial_year_end_month=None,
sales_tax_basis=None,
sales_tax_period=None,
default_sales_tax=None,
default_purchases_tax=None,
period_lock_date=None,
end_of_year_lock_date=None,
created_date_utc=None,
timezone=None,
organisation_entity_type=None,
short_code=None,
_class=None,
edition=None,
line_of_business=None,
addresses=None,
phones=None,
external_links=None,
payment_terms=None,
): # noqa: E501
"""Organisation - a model defined in OpenAPI""" # noqa: E501
self._organisation_id = None
self._api_key = None
self._name = None
self._legal_name = None
self._pays_tax = None
self._version = None
self._organisation_type = None
self._base_currency = None
self._country_code = None
self._is_demo_company = None
self._organisation_status = None
self._registration_number = None
self._employer_identification_number = None
self._tax_number = None
self._financial_year_end_day = None
self._financial_year_end_month = None
self._sales_tax_basis = None
self._sales_tax_period = None
self._default_sales_tax = None
self._default_purchases_tax = None
self._period_lock_date = None
self._end_of_year_lock_date = None
self._created_date_utc = None
self._timezone = None
self._organisation_entity_type = None
self._short_code = None
self.__class = None
self._edition = None
self._line_of_business = None
self._addresses = None
self._phones = None
self._external_links = None
self._payment_terms = None
self.discriminator = None
if organisation_id is not None:
self.organisation_id = organisation_id
if api_key is not None:
self.api_key = api_key
if name is not None:
self.name = name
if legal_name is not None:
self.legal_name = legal_name
if pays_tax is not None:
self.pays_tax = pays_tax
if version is not None:
self.version = version
if organisation_type is not None:
self.organisation_type = organisation_type
if base_currency is not None:
self.base_currency = base_currency
if country_code is not None:
self.country_code = country_code
if is_demo_company is not None:
self.is_demo_company = is_demo_company
if organisation_status is not None:
self.organisation_status = organisation_status
if registration_number is not None:
self.registration_number = registration_number
if employer_identification_number is not None:
self.employer_identification_number = employer_identification_number
if tax_number is not None:
self.tax_number = tax_number
if financial_year_end_day is not None:
self.financial_year_end_day = financial_year_end_day
if financial_year_end_month is not None:
self.financial_year_end_month = financial_year_end_month
if sales_tax_basis is not None:
self.sales_tax_basis = sales_tax_basis
if sales_tax_period is not None:
self.sales_tax_period = sales_tax_period
if default_sales_tax is not None:
self.default_sales_tax = default_sales_tax
if default_purchases_tax is not None:
self.default_purchases_tax = default_purchases_tax
if period_lock_date is not None:
self.period_lock_date = period_lock_date
if end_of_year_lock_date is not None:
self.end_of_year_lock_date = end_of_year_lock_date
if created_date_utc is not None:
self.created_date_utc = created_date_utc
if timezone is not None:
self.timezone = timezone
if organisation_entity_type is not None:
self.organisation_entity_type = organisation_entity_type
if short_code is not None:
self.short_code = short_code
if _class is not None:
self._class = _class
if edition is not None:
self.edition = edition
if line_of_business is not None:
self.line_of_business = line_of_business
if addresses is not None:
self.addresses = addresses
if phones is not None:
self.phones = phones
if external_links is not None:
self.external_links = external_links
if payment_terms is not None:
self.payment_terms = payment_terms
@property
def organisation_id(self):
"""Gets the organisation_id of this Organisation. # noqa: E501
Unique Xero identifier # noqa: E501
:return: The organisation_id of this Organisation. # noqa: E501
:rtype: str
"""
return self._organisation_id
@organisation_id.setter
def organisation_id(self, organisation_id):
"""Sets the organisation_id of this Organisation.
Unique Xero identifier # noqa: E501
:param organisation_id: The organisation_id of this Organisation. # noqa: E501
:type: str
"""
self._organisation_id = organisation_id
@property
def api_key(self):
"""Gets the api_key of this Organisation. # noqa: E501
Display a unique key used for Xero-to-Xero transactions # noqa: E501
:return: The api_key of this Organisation. # noqa: E501
:rtype: str
"""
return self._api_key
@api_key.setter
def api_key(self, api_key):
"""Sets the api_key of this Organisation.
Display a unique key used for Xero-to-Xero transactions # noqa: E501
:param api_key: The api_key of this Organisation. # noqa: E501
:type: str
"""
self._api_key = api_key
@property
def name(self):
"""Gets the name of this Organisation. # noqa: E501
Display name of organisation shown in Xero # noqa: E501
:return: The name of this Organisation. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this Organisation.
Display name of organisation shown in Xero # noqa: E501
:param name: The name of this Organisation. # noqa: E501
:type: str
"""
self._name = name
@property
def legal_name(self):
"""Gets the legal_name of this Organisation. # noqa: E501
Organisation name shown on Reports # noqa: E501
:return: The legal_name of this Organisation. # noqa: E501
:rtype: str
"""
return self._legal_name
@legal_name.setter
def legal_name(self, legal_name):
"""Sets the legal_name of this Organisation.
Organisation name shown on Reports # noqa: E501
:param legal_name: The legal_name of this Organisation. # noqa: E501
:type: str
"""
self._legal_name = legal_name
@property
def pays_tax(self):
"""Gets the pays_tax of this Organisation. # noqa: E501
Boolean to describe if organisation is registered with a local tax authority i.e. true, false # noqa: E501
:return: The pays_tax of this Organisation. # noqa: E501
:rtype: bool
"""
return self._pays_tax
@pays_tax.setter
def pays_tax(self, pays_tax):
"""Sets the pays_tax of this Organisation.
Boolean to describe if organisation is registered with a local tax authority i.e. true, false # noqa: E501
:param pays_tax: The pays_tax of this Organisation. # noqa: E501
:type: bool
"""
self._pays_tax = pays_tax
@property
def version(self):
"""Gets the version of this Organisation. # noqa: E501
See Version Types # noqa: E501
:return: The version of this Organisation. # noqa: E501
:rtype: str
"""
return self._version
@version.setter
def version(self, version):
"""Sets the version of this Organisation.
See Version Types # noqa: E501
:param version: The version of this Organisation. # noqa: E501
:type: str
"""
allowed_values = [
"AU",
"NZ",
"GLOBAL",
"UK",
"US",
"AUONRAMP",
"NZONRAMP",
"GLOBALONRAMP",
"UKONRAMP",
"USONRAMP",
"None",
] # noqa: E501
if version:
if version not in allowed_values:
raise ValueError(
"Invalid value for `version` ({0}), must be one of {1}".format( # noqa: E501
version, allowed_values
)
)
self._version = version
@property
def organisation_type(self):
"""Gets the organisation_type of this Organisation. # noqa: E501
Organisation Type # noqa: E501
:return: The organisation_type of this Organisation. # noqa: E501
:rtype: str
"""
return self._organisation_type
@organisation_type.setter
def organisation_type(self, organisation_type):
"""Sets the organisation_type of this Organisation.
Organisation Type # noqa: E501
:param organisation_type: The organisation_type of this Organisation. # noqa: E501
:type: str
"""
allowed_values = [
"ACCOUNTING_PRACTICE",
"CCORPORATIONLLC",
"COMPANY",
"CHARITY",
"CLUB_OR_SOCIETY",
"INDIVIDUAL",
"LLC",
"LOOK_THROUGH_COMPANY",
"NOT_FOR_PROFIT",
"NOTLLC",
"PARTNERSHIP",
"PARTNERSHIPLLC",
"PERSONAL",
"S_CORPORATION",
"SCORPORATIONLLC",
"SELF_MANAGED_SUPERANNUATION_FUND",
"SINGLEMEMBERLLC",
"SOLE_TRADER",
"SUPERANNUATION_FUND",
"TRUST",
"UNSPECIFIED",
"None",
] # noqa: E501
if organisation_type:
if organisation_type not in allowed_values:
raise ValueError(
"Invalid value for `organisation_type` ({0}), must be one of {1}".format( # noqa: E501
organisation_type, allowed_values
)
)
self._organisation_type = organisation_type
@property
def base_currency(self):
"""Gets the base_currency of this Organisation. # noqa: E501
:return: The base_currency of this Organisation. # noqa: E501
:rtype: CurrencyCode
"""
return self._base_currency
@base_currency.setter
def base_currency(self, base_currency):
"""Sets the base_currency of this Organisation.
:param base_currency: The base_currency of this Organisation. # noqa: E501
:type: CurrencyCode
"""
self._base_currency = base_currency
@property
def country_code(self):
"""Gets the country_code of this Organisation. # noqa: E501
:return: The country_code of this Organisation. # noqa: E501
:rtype: CountryCode
"""
return self._country_code
@country_code.setter
def country_code(self, country_code):
"""Sets the country_code of this Organisation.
:param country_code: The country_code of this Organisation. # noqa: E501
:type: CountryCode
"""
self._country_code = country_code
@property
def is_demo_company(self):
"""Gets the is_demo_company of this Organisation. # noqa: E501
Boolean to describe if organisation is a demo company. # noqa: E501
:return: The is_demo_company of this Organisation. # noqa: E501
:rtype: bool
"""
return self._is_demo_company
@is_demo_company.setter
def is_demo_company(self, is_demo_company):
"""Sets the is_demo_company of this Organisation.
Boolean to describe if organisation is a demo company. # noqa: E501
:param is_demo_company: The is_demo_company of this Organisation. # noqa: E501
:type: bool
"""
self._is_demo_company = is_demo_company
@property
def organisation_status(self):
"""Gets the organisation_status of this Organisation. # noqa: E501
Will be set to ACTIVE if you can connect to organisation via the Xero API # noqa: E501
:return: The organisation_status of this Organisation. # noqa: E501
:rtype: str
"""
return self._organisation_status
@organisation_status.setter
def organisation_status(self, organisation_status):
"""Sets the organisation_status of this Organisation.
Will be set to ACTIVE if you can connect to organisation via the Xero API # noqa: E501
:param organisation_status: The organisation_status of this Organisation. # noqa: E501
:type: str
"""
self._organisation_status = organisation_status
@property
def registration_number(self):
"""Gets the registration_number of this Organisation. # noqa: E501
Shows for New Zealand, Australian and UK organisations # noqa: E501
:return: The registration_number of this Organisation. # noqa: E501
:rtype: str
"""
return self._registration_number
@registration_number.setter
def registration_number(self, registration_number):
"""Sets the registration_number of this Organisation.
Shows for New Zealand, Australian and UK organisations # noqa: E501
:param registration_number: The registration_number of this Organisation. # noqa: E501
:type: str
"""
self._registration_number = registration_number
@property
def employer_identification_number(self):
"""Gets the employer_identification_number of this Organisation. # noqa: E501
Shown if set. US Only. # noqa: E501
:return: The employer_identification_number of this Organisation. # noqa: E501
:rtype: str
"""
return self._employer_identification_number
@employer_identification_number.setter
def employer_identification_number(self, employer_identification_number):
"""Sets the employer_identification_number of this Organisation.
Shown if set. US Only. # noqa: E501
:param employer_identification_number: The employer_identification_number of this Organisation. # noqa: E501
:type: str
"""
self._employer_identification_number = employer_identification_number
@property
def tax_number(self):
"""Gets the tax_number of this Organisation. # noqa: E501
Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global). # noqa: E501
:return: The tax_number of this Organisation. # noqa: E501
:rtype: str
"""
return self._tax_number
@tax_number.setter
def tax_number(self, tax_number):
"""Sets the tax_number of this Organisation.
Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global). # noqa: E501
:param tax_number: The tax_number of this Organisation. # noqa: E501
:type: str
"""
self._tax_number = tax_number
@property
def financial_year_end_day(self):
"""Gets the financial_year_end_day of this Organisation. # noqa: E501
Calendar day e.g. 0-31 # noqa: E501
:return: The financial_year_end_day of this Organisation. # noqa: E501
:rtype: int
"""
return self._financial_year_end_day
@financial_year_end_day.setter
def financial_year_end_day(self, financial_year_end_day):
"""Sets the financial_year_end_day of this Organisation.
Calendar day e.g. 0-31 # noqa: E501
:param financial_year_end_day: The financial_year_end_day of this Organisation. # noqa: E501
:type: int
"""
self._financial_year_end_day = financial_year_end_day
@property
def financial_year_end_month(self):
"""Gets the financial_year_end_month of this Organisation. # noqa: E501
Calendar Month e.g. 1-12 # noqa: E501
:return: The financial_year_end_month of this Organisation. # noqa: E501
:rtype: int
"""
return self._financial_year_end_month
@financial_year_end_month.setter
def financial_year_end_month(self, financial_year_end_month):
"""Sets the financial_year_end_month of this Organisation.
Calendar Month e.g. 1-12 # noqa: E501
:param financial_year_end_month: The financial_year_end_month of this Organisation. # noqa: E501
:type: int
"""
self._financial_year_end_month = financial_year_end_month
@property
def sales_tax_basis(self):
"""Gets the sales_tax_basis of this Organisation. # noqa: E501
The accounting basis used for tax returns. See Sales Tax Basis # noqa: E501
:return: The sales_tax_basis of this Organisation. # noqa: E501
:rtype: str
"""
return self._sales_tax_basis
@sales_tax_basis.setter
def sales_tax_basis(self, sales_tax_basis):
"""Sets the sales_tax_basis of this Organisation.
The accounting basis used for tax returns. See Sales Tax Basis # noqa: E501
:param sales_tax_basis: The sales_tax_basis of this Organisation. # noqa: E501
:type: str
"""
allowed_values = [
"PAYMENTS",
"INVOICE",
"NONE",
"CASH",
"ACCRUAL",
"FLATRATECASH",
"FLATRATEACCRUAL",
"ACCRUALS",
"None",
] # noqa: E501
if sales_tax_basis:
if sales_tax_basis not in allowed_values:
raise ValueError(
"Invalid value for `sales_tax_basis` ({0}), must be one of {1}".format( # noqa: E501
sales_tax_basis, allowed_values
)
)
self._sales_tax_basis = sales_tax_basis
@property
def sales_tax_period(self):
"""Gets the sales_tax_period of this Organisation. # noqa: E501
The frequency with which tax returns are processed. See Sales Tax Period # noqa: E501
:return: The sales_tax_period of this Organisation. # noqa: E501
:rtype: str
"""
return self._sales_tax_period
@sales_tax_period.setter
def sales_tax_period(self, sales_tax_period):
"""Sets the sales_tax_period of this Organisation.
The frequency with which tax returns are processed. See Sales Tax Period # noqa: E501
:param sales_tax_period: The sales_tax_period of this Organisation. # noqa: E501
:type: str
"""
allowed_values = [
"MONTHLY",
"QUARTERLY1",
"QUARTERLY2",
"QUARTERLY3",
"ANNUALLY",
"ONEMONTHS",
"TWOMONTHS",
"SIXMONTHS",
"1MONTHLY",
"2MONTHLY",
"3MONTHLY",
"6MONTHLY",
"QUARTERLY",
"YEARLY",
"NONE",
"None",
] # noqa: E501
if sales_tax_period:
if sales_tax_period not in allowed_values:
raise ValueError(
"Invalid value for `sales_tax_period` ({0}), must be one of {1}".format( # noqa: E501
sales_tax_period, allowed_values
)
)
self._sales_tax_period = sales_tax_period
@property
def default_sales_tax(self):
"""Gets the default_sales_tax of this Organisation. # noqa: E501
The default for LineAmountTypes on sales transactions # noqa: E501
:return: The default_sales_tax of this Organisation. # noqa: E501
:rtype: str
"""
return self._default_sales_tax
@default_sales_tax.setter
def default_sales_tax(self, default_sales_tax):
"""Sets the default_sales_tax of this Organisation.
The default for LineAmountTypes on sales transactions # noqa: E501
:param default_sales_tax: The default_sales_tax of this Organisation. # noqa: E501
:type: str
"""
self._default_sales_tax = default_sales_tax
@property
def default_purchases_tax(self):
"""Gets the default_purchases_tax of this Organisation. # noqa: E501
The default for LineAmountTypes on purchase transactions # noqa: E501
:return: The default_purchases_tax of this Organisation. # noqa: E501
:rtype: str
"""
return self._default_purchases_tax
@default_purchases_tax.setter
def default_purchases_tax(self, default_purchases_tax):
"""Sets the default_purchases_tax of this Organisation.
The default for LineAmountTypes on purchase transactions # noqa: E501
:param default_purchases_tax: The default_purchases_tax of this Organisation. # noqa: E501
:type: str
"""
self._default_purchases_tax = default_purchases_tax
@property
def period_lock_date(self):
"""Gets the period_lock_date of this Organisation. # noqa: E501
Shown if set. See lock dates # noqa: E501
:return: The period_lock_date of this Organisation. # noqa: E501
:rtype: date
"""
return self._period_lock_date
@period_lock_date.setter
def period_lock_date(self, period_lock_date):
"""Sets the period_lock_date of this Organisation.
Shown if set. See lock dates # noqa: E501
:param period_lock_date: The period_lock_date of this Organisation. # noqa: E501
:type: date
"""
self._period_lock_date = period_lock_date
@property
def end_of_year_lock_date(self):
"""Gets the end_of_year_lock_date of this Organisation. # noqa: E501
Shown if set. See lock dates # noqa: E501
:return: The end_of_year_lock_date of this Organisation. # noqa: E501
:rtype: date
"""
return self._end_of_year_lock_date
@end_of_year_lock_date.setter
def end_of_year_lock_date(self, end_of_year_lock_date):
"""Sets the end_of_year_lock_date of this Organisation.
Shown if set. See lock dates # noqa: E501
:param end_of_year_lock_date: The end_of_year_lock_date of this Organisation. # noqa: E501
:type: date
"""
self._end_of_year_lock_date = end_of_year_lock_date
@property
def created_date_utc(self):
"""Gets the created_date_utc of this Organisation. # noqa: E501
Timestamp when the organisation was created in Xero # noqa: E501
:return: The created_date_utc of this Organisation. # noqa: E501
:rtype: datetime
"""
return self._created_date_utc
@created_date_utc.setter
def created_date_utc(self, created_date_utc):
"""Sets the created_date_utc of this Organisation.
Timestamp when the organisation was created in Xero # noqa: E501
:param created_date_utc: The created_date_utc of this Organisation. # noqa: E501
:type: datetime
"""
self._created_date_utc = created_date_utc
@property
def timezone(self):
"""Gets the timezone of this Organisation. # noqa: E501
:return: The timezone of this Organisation. # noqa: E501
:rtype: TimeZone
"""
return self._timezone
@timezone.setter
def timezone(self, timezone):
"""Sets the timezone of this Organisation.
:param timezone: The timezone of this Organisation. # noqa: E501
:type: TimeZone
"""
self._timezone = timezone
@property
def organisation_entity_type(self):
"""Gets the organisation_entity_type of this Organisation. # noqa: E501
Organisation Entity Type # noqa: E501
:return: The organisation_entity_type of this Organisation. # noqa: E501
:rtype: str
"""
return self._organisation_entity_type
@organisation_entity_type.setter
def organisation_entity_type(self, organisation_entity_type):
"""Sets the organisation_entity_type of this Organisation.
Organisation Entity Type # noqa: E501
:param organisation_entity_type: The organisation_entity_type of this Organisation. # noqa: E501
:type: str
"""
allowed_values = [
"ACCOUNTING_PRACTICE",
"CCORPORATIONLLC",
"COMPANY",
"CHARITY",
"CLUB_OR_SOCIETY",
"INDIVIDUAL",
"LLC",
"LOOK_THROUGH_COMPANY",
"NOT_FOR_PROFIT",
"NOTLLC",
"PARTNERSHIP",
"PARTNERSHIPLLC",
"PERSONAL",
"S_CORPORATION",
"SCORPORATIONLLC",
"SELF_MANAGED_SUPERANNUATION_FUND",
"SINGLEMEMBERLLC",
"SOLE_TRADER",
"SUPERANNUATION_FUND",
"TRUST",
"UNSPECIFIED",
"None",
] # noqa: E501
if organisation_entity_type:
if organisation_entity_type not in allowed_values:
raise ValueError(
"Invalid value for `organisation_entity_type` ({0}), must be one of {1}".format( # noqa: E501
organisation_entity_type, allowed_values
)
)
self._organisation_entity_type = organisation_entity_type
@property
def short_code(self):
"""Gets the short_code of this Organisation. # noqa: E501
A unique identifier for the organisation. Potential uses. # noqa: E501
:return: The short_code of this Organisation. # noqa: E501
:rtype: str
"""
return self._short_code
@short_code.setter
def short_code(self, short_code):
"""Sets the short_code of this Organisation.
A unique identifier for the organisation. Potential uses. # noqa: E501
:param short_code: The short_code of this Organisation. # noqa: E501
:type: str
"""
self._short_code = short_code
@property
def _class(self):
"""Gets the _class of this Organisation. # noqa: E501
Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM) # noqa: E501
:return: The _class of this Organisation. # noqa: E501
:rtype: str
"""
return self.__class
@_class.setter
def _class(self, _class):
"""Sets the _class of this Organisation.
Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM) # noqa: E501
:param _class: The _class of this Organisation. # noqa: E501
:type: str
"""
allowed_values = [
"DEMO",
"TRIAL",
"STARTER",
"STANDARD",
"PREMIUM",
"PREMIUM_20",
"PREMIUM_50",
"PREMIUM_100",
"LEDGER",
"GST_CASHBOOK",
"NON_GST_CASHBOOK",
"ULTIMATE",
"LITE",
"ULTIMATE_10",