/home/desid573/public_html/angel/payment/xero/lib/Models/Accounting
Edit: /home/desid573/public_html/angel/payment/xero/lib/Models/Accounting/Organisation.php (46336B)
'string',
'api_key' => 'string',
'name' => 'string',
'legal_name' => 'string',
'pays_tax' => 'bool',
'version' => 'string',
'organisation_type' => 'string',
'base_currency' => '\XeroAPI\XeroPHP\Models\Accounting\CurrencyCode',
'country_code' => '\XeroAPI\XeroPHP\Models\Accounting\CountryCode',
'is_demo_company' => 'bool',
'organisation_status' => 'string',
'registration_number' => 'string',
'tax_number' => 'string',
'financial_year_end_day' => 'int',
'financial_year_end_month' => 'int',
'sales_tax_basis' => 'string',
'sales_tax_period' => 'string',
'default_sales_tax' => 'string',
'default_purchases_tax' => 'string',
'period_lock_date' => '\DateTime',
'end_of_year_lock_date' => '\DateTime',
'created_date_utc' => '\DateTime',
'timezone' => '\XeroAPI\XeroPHP\Models\Accounting\TimeZone',
'organisation_entity_type' => 'string',
'short_code' => 'string',
'class' => 'string',
'edition' => 'string',
'line_of_business' => 'string',
'addresses' => '\XeroAPI\XeroPHP\Models\Accounting\Address[]',
'phones' => '\XeroAPI\XeroPHP\Models\Accounting\Phone[]',
'external_links' => '\XeroAPI\XeroPHP\Models\Accounting\ExternalLink[]',
'payment_terms' => '\XeroAPI\XeroPHP\Models\Accounting\PaymentTerm'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPIFormats = [
'organisation_id' => 'uuid',
'api_key' => null,
'name' => null,
'legal_name' => null,
'pays_tax' => null,
'version' => null,
'organisation_type' => null,
'base_currency' => null,
'country_code' => null,
'is_demo_company' => null,
'organisation_status' => null,
'registration_number' => null,
'tax_number' => null,
'financial_year_end_day' => null,
'financial_year_end_month' => null,
'sales_tax_basis' => null,
'sales_tax_period' => null,
'default_sales_tax' => null,
'default_purchases_tax' => null,
'period_lock_date' => 'date',
'end_of_year_lock_date' => 'date',
'created_date_utc' => 'date-time',
'timezone' => null,
'organisation_entity_type' => null,
'short_code' => null,
'class' => null,
'edition' => null,
'line_of_business' => null,
'addresses' => null,
'phones' => null,
'external_links' => null,
'payment_terms' => null
];
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPITypes()
{
return self::$openAPITypes;
}
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPIFormats()
{
return self::$openAPIFormats;
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @var string[]
*/
protected static $attributeMap = [
'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',
'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'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'organisation_id' => 'setOrganisationId',
'api_key' => 'setApiKey',
'name' => 'setName',
'legal_name' => 'setLegalName',
'pays_tax' => 'setPaysTax',
'version' => 'setVersion',
'organisation_type' => 'setOrganisationType',
'base_currency' => 'setBaseCurrency',
'country_code' => 'setCountryCode',
'is_demo_company' => 'setIsDemoCompany',
'organisation_status' => 'setOrganisationStatus',
'registration_number' => 'setRegistrationNumber',
'tax_number' => 'setTaxNumber',
'financial_year_end_day' => 'setFinancialYearEndDay',
'financial_year_end_month' => 'setFinancialYearEndMonth',
'sales_tax_basis' => 'setSalesTaxBasis',
'sales_tax_period' => 'setSalesTaxPeriod',
'default_sales_tax' => 'setDefaultSalesTax',
'default_purchases_tax' => 'setDefaultPurchasesTax',
'period_lock_date' => 'setPeriodLockDate',
'end_of_year_lock_date' => 'setEndOfYearLockDate',
'created_date_utc' => 'setCreatedDateUtc',
'timezone' => 'setTimezone',
'organisation_entity_type' => 'setOrganisationEntityType',
'short_code' => 'setShortCode',
'class' => 'setClass',
'edition' => 'setEdition',
'line_of_business' => 'setLineOfBusiness',
'addresses' => 'setAddresses',
'phones' => 'setPhones',
'external_links' => 'setExternalLinks',
'payment_terms' => 'setPaymentTerms'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'organisation_id' => 'getOrganisationId',
'api_key' => 'getApiKey',
'name' => 'getName',
'legal_name' => 'getLegalName',
'pays_tax' => 'getPaysTax',
'version' => 'getVersion',
'organisation_type' => 'getOrganisationType',
'base_currency' => 'getBaseCurrency',
'country_code' => 'getCountryCode',
'is_demo_company' => 'getIsDemoCompany',
'organisation_status' => 'getOrganisationStatus',
'registration_number' => 'getRegistrationNumber',
'tax_number' => 'getTaxNumber',
'financial_year_end_day' => 'getFinancialYearEndDay',
'financial_year_end_month' => 'getFinancialYearEndMonth',
'sales_tax_basis' => 'getSalesTaxBasis',
'sales_tax_period' => 'getSalesTaxPeriod',
'default_sales_tax' => 'getDefaultSalesTax',
'default_purchases_tax' => 'getDefaultPurchasesTax',
'period_lock_date' => 'getPeriodLockDate',
'end_of_year_lock_date' => 'getEndOfYearLockDate',
'created_date_utc' => 'getCreatedDateUtc',
'timezone' => 'getTimezone',
'organisation_entity_type' => 'getOrganisationEntityType',
'short_code' => 'getShortCode',
'class' => 'getClass',
'edition' => 'getEdition',
'line_of_business' => 'getLineOfBusiness',
'addresses' => 'getAddresses',
'phones' => 'getPhones',
'external_links' => 'getExternalLinks',
'payment_terms' => 'getPaymentTerms'
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @return array
*/
public static function attributeMap()
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @return array
*/
public static function setters()
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @return array
*/
public static function getters()
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName()
{
return self::$openAPIModelName;
}
const VERSION_AU = 'AU';
const VERSION_NZ = 'NZ';
const VERSION__GLOBAL = 'GLOBAL';
const VERSION_UK = 'UK';
const VERSION_US = 'US';
const VERSION_AUONRAMP = 'AUONRAMP';
const VERSION_NZONRAMP = 'NZONRAMP';
const VERSION_GLOBALONRAMP = 'GLOBALONRAMP';
const VERSION_UKONRAMP = 'UKONRAMP';
const VERSION_USONRAMP = 'USONRAMP';
const ORGANISATION_TYPE_ACCOUNTING_PRACTICE = 'ACCOUNTING_PRACTICE';
const ORGANISATION_TYPE_COMPANY = 'COMPANY';
const ORGANISATION_TYPE_CHARITY = 'CHARITY';
const ORGANISATION_TYPE_CLUB_OR_SOCIETY = 'CLUB_OR_SOCIETY';
const ORGANISATION_TYPE_LOOK_THROUGH_COMPANY = 'LOOK_THROUGH_COMPANY';
const ORGANISATION_TYPE_NOT_FOR_PROFIT = 'NOT_FOR_PROFIT';
const ORGANISATION_TYPE_PARTNERSHIP = 'PARTNERSHIP';
const ORGANISATION_TYPE_S_CORPORATION = 'S_CORPORATION';
const ORGANISATION_TYPE_SELF_MANAGED_SUPERANNUATION_FUND = 'SELF_MANAGED_SUPERANNUATION_FUND';
const ORGANISATION_TYPE_SOLE_TRADER = 'SOLE_TRADER';
const ORGANISATION_TYPE_SUPERANNUATION_FUND = 'SUPERANNUATION_FUND';
const ORGANISATION_TYPE_TRUST = 'TRUST';
const SALES_TAX_BASIS_PAYMENTS = 'PAYMENTS';
const SALES_TAX_BASIS_INVOICE = 'INVOICE';
const SALES_TAX_BASIS_NONE = 'NONE';
const SALES_TAX_BASIS_CASH = 'CASH';
const SALES_TAX_BASIS_ACCRUAL = 'ACCRUAL';
const SALES_TAX_BASIS_FLATRATECASH = 'FLATRATECASH';
const SALES_TAX_BASIS_FLATRATEACCRUAL = 'FLATRATEACCRUAL';
const SALES_TAX_BASIS_ACCRUALS = 'ACCRUALS';
const SALES_TAX_PERIOD_MONTHLY = 'MONTHLY';
const SALES_TAX_PERIOD_QUARTERLY1 = 'QUARTERLY1';
const SALES_TAX_PERIOD_QUARTERLY2 = 'QUARTERLY2';
const SALES_TAX_PERIOD_QUARTERLY3 = 'QUARTERLY3';
const SALES_TAX_PERIOD_ANNUALLY = 'ANNUALLY';
const SALES_TAX_PERIOD_ONEMONTHS = 'ONEMONTHS';
const SALES_TAX_PERIOD_TWOMONTHS = 'TWOMONTHS';
const SALES_TAX_PERIOD_SIXMONTHS = 'SIXMONTHS';
const SALES_TAX_PERIOD__1_MONTHLY = '1MONTHLY';
const SALES_TAX_PERIOD__2_MONTHLY = '2MONTHLY';
const SALES_TAX_PERIOD__3_MONTHLY = '3MONTHLY';
const SALES_TAX_PERIOD__6_MONTHLY = '6MONTHLY';
const SALES_TAX_PERIOD_QUARTERLY = 'QUARTERLY';
const SALES_TAX_PERIOD_YEARLY = 'YEARLY';
const ORGANISATION_ENTITY_TYPE_ACCOUNTING_PRACTICE = 'ACCOUNTING_PRACTICE';
const ORGANISATION_ENTITY_TYPE_COMPANY = 'COMPANY';
const ORGANISATION_ENTITY_TYPE_CHARITY = 'CHARITY';
const ORGANISATION_ENTITY_TYPE_CLUB_OR_SOCIETY = 'CLUB_OR_SOCIETY';
const ORGANISATION_ENTITY_TYPE_LOOK_THROUGH_COMPANY = 'LOOK_THROUGH_COMPANY';
const ORGANISATION_ENTITY_TYPE_NOT_FOR_PROFIT = 'NOT_FOR_PROFIT';
const ORGANISATION_ENTITY_TYPE_PARTNERSHIP = 'PARTNERSHIP';
const ORGANISATION_ENTITY_TYPE_S_CORPORATION = 'S_CORPORATION';
const ORGANISATION_ENTITY_TYPE_SELF_MANAGED_SUPERANNUATION_FUND = 'SELF_MANAGED_SUPERANNUATION_FUND';
const ORGANISATION_ENTITY_TYPE_SOLE_TRADER = 'SOLE_TRADER';
const ORGANISATION_ENTITY_TYPE_SUPERANNUATION_FUND = 'SUPERANNUATION_FUND';
const ORGANISATION_ENTITY_TYPE_TRUST = 'TRUST';
const MODEL_CLASS_DEMO = 'DEMO';
const MODEL_CLASS_TRIAL = 'TRIAL';
const MODEL_CLASS_STARTER = 'STARTER';
const MODEL_CLASS_STANDARD = 'STANDARD';
const MODEL_CLASS_PREMIUM = 'PREMIUM';
const MODEL_CLASS_PREMIUM_20 = 'PREMIUM_20';
const MODEL_CLASS_PREMIUM_50 = 'PREMIUM_50';
const MODEL_CLASS_PREMIUM_100 = 'PREMIUM_100';
const MODEL_CLASS_LEDGER = 'LEDGER';
const MODEL_CLASS_GST_CASHBOOK = 'GST_CASHBOOK';
const MODEL_CLASS_NON_GST_CASHBOOK = 'NON_GST_CASHBOOK';
const EDITION_BUSINESS = 'BUSINESS';
const EDITION_PARTNER = 'PARTNER';
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getVersionAllowableValues()
{
return [
self::VERSION_AU,
self::VERSION_NZ,
self::VERSION__GLOBAL,
self::VERSION_UK,
self::VERSION_US,
self::VERSION_AUONRAMP,
self::VERSION_NZONRAMP,
self::VERSION_GLOBALONRAMP,
self::VERSION_UKONRAMP,
self::VERSION_USONRAMP,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getOrganisationTypeAllowableValues()
{
return [
self::ORGANISATION_TYPE_ACCOUNTING_PRACTICE,
self::ORGANISATION_TYPE_COMPANY,
self::ORGANISATION_TYPE_CHARITY,
self::ORGANISATION_TYPE_CLUB_OR_SOCIETY,
self::ORGANISATION_TYPE_LOOK_THROUGH_COMPANY,
self::ORGANISATION_TYPE_NOT_FOR_PROFIT,
self::ORGANISATION_TYPE_PARTNERSHIP,
self::ORGANISATION_TYPE_S_CORPORATION,
self::ORGANISATION_TYPE_SELF_MANAGED_SUPERANNUATION_FUND,
self::ORGANISATION_TYPE_SOLE_TRADER,
self::ORGANISATION_TYPE_SUPERANNUATION_FUND,
self::ORGANISATION_TYPE_TRUST,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getSalesTaxBasisAllowableValues()
{
return [
self::SALES_TAX_BASIS_PAYMENTS,
self::SALES_TAX_BASIS_INVOICE,
self::SALES_TAX_BASIS_NONE,
self::SALES_TAX_BASIS_CASH,
self::SALES_TAX_BASIS_ACCRUAL,
self::SALES_TAX_BASIS_FLATRATECASH,
self::SALES_TAX_BASIS_FLATRATEACCRUAL,
self::SALES_TAX_BASIS_ACCRUALS,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getSalesTaxPeriodAllowableValues()
{
return [
self::SALES_TAX_PERIOD_MONTHLY,
self::SALES_TAX_PERIOD_QUARTERLY1,
self::SALES_TAX_PERIOD_QUARTERLY2,
self::SALES_TAX_PERIOD_QUARTERLY3,
self::SALES_TAX_PERIOD_ANNUALLY,
self::SALES_TAX_PERIOD_ONEMONTHS,
self::SALES_TAX_PERIOD_TWOMONTHS,
self::SALES_TAX_PERIOD_SIXMONTHS,
self::SALES_TAX_PERIOD__1_MONTHLY,
self::SALES_TAX_PERIOD__2_MONTHLY,
self::SALES_TAX_PERIOD__3_MONTHLY,
self::SALES_TAX_PERIOD__6_MONTHLY,
self::SALES_TAX_PERIOD_QUARTERLY,
self::SALES_TAX_PERIOD_YEARLY,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getOrganisationEntityTypeAllowableValues()
{
return [
self::ORGANISATION_ENTITY_TYPE_ACCOUNTING_PRACTICE,
self::ORGANISATION_ENTITY_TYPE_COMPANY,
self::ORGANISATION_ENTITY_TYPE_CHARITY,
self::ORGANISATION_ENTITY_TYPE_CLUB_OR_SOCIETY,
self::ORGANISATION_ENTITY_TYPE_LOOK_THROUGH_COMPANY,
self::ORGANISATION_ENTITY_TYPE_NOT_FOR_PROFIT,
self::ORGANISATION_ENTITY_TYPE_PARTNERSHIP,
self::ORGANISATION_ENTITY_TYPE_S_CORPORATION,
self::ORGANISATION_ENTITY_TYPE_SELF_MANAGED_SUPERANNUATION_FUND,
self::ORGANISATION_ENTITY_TYPE_SOLE_TRADER,
self::ORGANISATION_ENTITY_TYPE_SUPERANNUATION_FUND,
self::ORGANISATION_ENTITY_TYPE_TRUST,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getClassAllowableValues()
{
return [
self::MODEL_CLASS_DEMO,
self::MODEL_CLASS_TRIAL,
self::MODEL_CLASS_STARTER,
self::MODEL_CLASS_STANDARD,
self::MODEL_CLASS_PREMIUM,
self::MODEL_CLASS_PREMIUM_20,
self::MODEL_CLASS_PREMIUM_50,
self::MODEL_CLASS_PREMIUM_100,
self::MODEL_CLASS_LEDGER,
self::MODEL_CLASS_GST_CASHBOOK,
self::MODEL_CLASS_NON_GST_CASHBOOK,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getEditionAllowableValues()
{
return [
self::EDITION_BUSINESS,
self::EDITION_PARTNER,
];
}
/**
* Associative array for storing property values
*
* @var mixed[]
*/
protected $container = [];
/**
* Constructor
*
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
{
$this->container['organisation_id'] = isset($data['organisation_id']) ? $data['organisation_id'] : null;
$this->container['api_key'] = isset($data['api_key']) ? $data['api_key'] : null;
$this->container['name'] = isset($data['name']) ? $data['name'] : null;
$this->container['legal_name'] = isset($data['legal_name']) ? $data['legal_name'] : null;
$this->container['pays_tax'] = isset($data['pays_tax']) ? $data['pays_tax'] : null;
$this->container['version'] = isset($data['version']) ? $data['version'] : null;
$this->container['organisation_type'] = isset($data['organisation_type']) ? $data['organisation_type'] : null;
$this->container['base_currency'] = isset($data['base_currency']) ? $data['base_currency'] : null;
$this->container['country_code'] = isset($data['country_code']) ? $data['country_code'] : null;
$this->container['is_demo_company'] = isset($data['is_demo_company']) ? $data['is_demo_company'] : null;
$this->container['organisation_status'] = isset($data['organisation_status']) ? $data['organisation_status'] : null;
$this->container['registration_number'] = isset($data['registration_number']) ? $data['registration_number'] : null;
$this->container['tax_number'] = isset($data['tax_number']) ? $data['tax_number'] : null;
$this->container['financial_year_end_day'] = isset($data['financial_year_end_day']) ? $data['financial_year_end_day'] : null;
$this->container['financial_year_end_month'] = isset($data['financial_year_end_month']) ? $data['financial_year_end_month'] : null;
$this->container['sales_tax_basis'] = isset($data['sales_tax_basis']) ? $data['sales_tax_basis'] : null;
$this->container['sales_tax_period'] = isset($data['sales_tax_period']) ? $data['sales_tax_period'] : null;
$this->container['default_sales_tax'] = isset($data['default_sales_tax']) ? $data['default_sales_tax'] : null;
$this->container['default_purchases_tax'] = isset($data['default_purchases_tax']) ? $data['default_purchases_tax'] : null;
$this->container['period_lock_date'] = isset($data['period_lock_date']) ? $data['period_lock_date'] : null;
$this->container['end_of_year_lock_date'] = isset($data['end_of_year_lock_date']) ? $data['end_of_year_lock_date'] : null;
$this->container['created_date_utc'] = isset($data['created_date_utc']) ? $data['created_date_utc'] : null;
$this->container['timezone'] = isset($data['timezone']) ? $data['timezone'] : null;
$this->container['organisation_entity_type'] = isset($data['organisation_entity_type']) ? $data['organisation_entity_type'] : null;
$this->container['short_code'] = isset($data['short_code']) ? $data['short_code'] : null;
$this->container['class'] = isset($data['class']) ? $data['class'] : null;
$this->container['edition'] = isset($data['edition']) ? $data['edition'] : null;
$this->container['line_of_business'] = isset($data['line_of_business']) ? $data['line_of_business'] : null;
$this->container['addresses'] = isset($data['addresses']) ? $data['addresses'] : null;
$this->container['phones'] = isset($data['phones']) ? $data['phones'] : null;
$this->container['external_links'] = isset($data['external_links']) ? $data['external_links'] : null;
$this->container['payment_terms'] = isset($data['payment_terms']) ? $data['payment_terms'] : null;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
$allowedValues = $this->getVersionAllowableValues();
if (!is_null($this->container['version']) && !in_array($this->container['version'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'version', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getOrganisationTypeAllowableValues();
if (!is_null($this->container['organisation_type']) && !in_array($this->container['organisation_type'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'organisation_type', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getSalesTaxBasisAllowableValues();
if (!is_null($this->container['sales_tax_basis']) && !in_array($this->container['sales_tax_basis'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'sales_tax_basis', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getSalesTaxPeriodAllowableValues();
if (!is_null($this->container['sales_tax_period']) && !in_array($this->container['sales_tax_period'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'sales_tax_period', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getOrganisationEntityTypeAllowableValues();
if (!is_null($this->container['organisation_entity_type']) && !in_array($this->container['organisation_entity_type'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'organisation_entity_type', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getClassAllowableValues();
if (!is_null($this->container['class']) && !in_array($this->container['class'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'class', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getEditionAllowableValues();
if (!is_null($this->container['edition']) && !in_array($this->container['edition'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'edition', must be one of '%s'",
implode("', '", $allowedValues)
);
}
return $invalidProperties;
}
/**
* Validate all the properties in the model
* return true if all passed
*
* @return bool True if all properties are valid
*/
public function valid()
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets organisation_id
*
* @return string|null
*/
public function getOrganisationId()
{
return $this->container['organisation_id'];
}
/**
* Sets organisation_id
*
* @param string|null $organisation_id Unique Xero identifier
*
* @return $this
*/
public function setOrganisationId($organisation_id)
{
$this->container['organisation_id'] = $organisation_id;
return $this;
}
/**
* Gets api_key
*
* @return string|null
*/
public function getApiKey()
{
return $this->container['api_key'];
}
/**
* Sets api_key
*
* @param string|null $api_key Display a unique key used for Xero-to-Xero transactions
*
* @return $this
*/
public function setApiKey($api_key)
{
$this->container['api_key'] = $api_key;
return $this;
}
/**
* Gets name
*
* @return string|null
*/
public function getName()
{
return $this->container['name'];
}
/**
* Sets name
*
* @param string|null $name Display name of organisation shown in Xero
*
* @return $this
*/
public function setName($name)
{
$this->container['name'] = $name;
return $this;
}
/**
* Gets legal_name
*
* @return string|null
*/
public function getLegalName()
{
return $this->container['legal_name'];
}
/**
* Sets legal_name
*
* @param string|null $legal_name Organisation name shown on Reports
*
* @return $this
*/
public function setLegalName($legal_name)
{
$this->container['legal_name'] = $legal_name;
return $this;
}
/**
* Gets pays_tax
*
* @return bool|null
*/
public function getPaysTax()
{
return $this->container['pays_tax'];
}
/**
* Sets pays_tax
*
* @param bool|null $pays_tax Boolean to describe if organisation is registered with a local tax authority i.e. true, false
*
* @return $this
*/
public function setPaysTax($pays_tax)
{
$this->container['pays_tax'] = $pays_tax;
return $this;
}
/**
* Gets version
*
* @return string|null
*/
public function getVersion()
{
return $this->container['version'];
}
/**
* Sets version
*
* @param string|null $version See Version Types
*
* @return $this
*/
public function setVersion($version)
{
$allowedValues = $this->getVersionAllowableValues();
if (!is_null($version) && !in_array($version, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'version', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['version'] = $version;
return $this;
}
/**
* Gets organisation_type
*
* @return string|null
*/
public function getOrganisationType()
{
return $this->container['organisation_type'];
}
/**
* Sets organisation_type
*
* @param string|null $organisation_type Organisation Type
*
* @return $this
*/
public function setOrganisationType($organisation_type)
{
$allowedValues = $this->getOrganisationTypeAllowableValues();
if (!is_null($organisation_type) && !in_array($organisation_type, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'organisation_type', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['organisation_type'] = $organisation_type;
return $this;
}
/**
* Gets base_currency
*
* @return \XeroAPI\XeroPHP\Models\Accounting\CurrencyCode|null
*/
public function getBaseCurrency()
{
return $this->container['base_currency'];
}
/**
* Sets base_currency
*
* @param \XeroAPI\XeroPHP\Models\Accounting\CurrencyCode|null $base_currency base_currency
*
* @return $this
*/
public function setBaseCurrency($base_currency)
{
$this->container['base_currency'] = $base_currency;
return $this;
}
/**
* Gets country_code
*
* @return \XeroAPI\XeroPHP\Models\Accounting\CountryCode|null
*/
public function getCountryCode()
{
return $this->container['country_code'];
}
/**
* Sets country_code
*
* @param \XeroAPI\XeroPHP\Models\Accounting\CountryCode|null $country_code country_code
*
* @return $this
*/
public function setCountryCode($country_code)
{
$this->container['country_code'] = $country_code;
return $this;
}
/**
* Gets is_demo_company
*
* @return bool|null
*/
public function getIsDemoCompany()
{
return $this->container['is_demo_company'];
}
/**
* Sets is_demo_company
*
* @param bool|null $is_demo_company Boolean to describe if organisation is a demo company.
*
* @return $this
*/
public function setIsDemoCompany($is_demo_company)
{
$this->container['is_demo_company'] = $is_demo_company;
return $this;
}
/**
* Gets organisation_status
*
* @return string|null
*/
public function getOrganisationStatus()
{
return $this->container['organisation_status'];
}
/**
* Sets organisation_status
*
* @param string|null $organisation_status Will be set to ACTIVE if you can connect to organisation via the Xero API
*
* @return $this
*/
public function setOrganisationStatus($organisation_status)
{
$this->container['organisation_status'] = $organisation_status;
return $this;
}
/**
* Gets registration_number
*
* @return string|null
*/
public function getRegistrationNumber()
{
return $this->container['registration_number'];
}
/**
* Sets registration_number
*
* @param string|null $registration_number Shows for New Zealand, Australian and UK organisations
*
* @return $this
*/
public function setRegistrationNumber($registration_number)
{
$this->container['registration_number'] = $registration_number;
return $this;
}
/**
* Gets tax_number
*
* @return string|null
*/
public function getTaxNumber()
{
return $this->container['tax_number'];
}
/**
* Sets tax_number
*
* @param string|null $tax_number 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).
*
* @return $this
*/
public function setTaxNumber($tax_number)
{
$this->container['tax_number'] = $tax_number;
return $this;
}
/**
* Gets financial_year_end_day
*
* @return int|null
*/
public function getFinancialYearEndDay()
{
return $this->container['financial_year_end_day'];
}
/**
* Sets financial_year_end_day
*
* @param int|null $financial_year_end_day Calendar day e.g. 0-31
*
* @return $this
*/
public function setFinancialYearEndDay($financial_year_end_day)
{
$this->container['financial_year_end_day'] = $financial_year_end_day;
return $this;
}
/**
* Gets financial_year_end_month
*
* @return int|null
*/
public function getFinancialYearEndMonth()
{
return $this->container['financial_year_end_month'];
}
/**
* Sets financial_year_end_month
*
* @param int|null $financial_year_end_month Calendar Month e.g. 1-12
*
* @return $this
*/
public function setFinancialYearEndMonth($financial_year_end_month)
{
$this->container['financial_year_end_month'] = $financial_year_end_month;
return $this;
}
/**
* Gets sales_tax_basis
*
* @return string|null
*/
public function getSalesTaxBasis()
{
return $this->container['sales_tax_basis'];
}
/**
* Sets sales_tax_basis
*
* @param string|null $sales_tax_basis The accounting basis used for tax returns. See Sales Tax Basis
*
* @return $this
*/
public function setSalesTaxBasis($sales_tax_basis)
{
$allowedValues = $this->getSalesTaxBasisAllowableValues();
if (!is_null($sales_tax_basis) && !in_array($sales_tax_basis, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'sales_tax_basis', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['sales_tax_basis'] = $sales_tax_basis;
return $this;
}
/**
* Gets sales_tax_period
*
* @return string|null
*/
public function getSalesTaxPeriod()
{
return $this->container['sales_tax_period'];
}
/**
* Sets sales_tax_period
*
* @param string|null $sales_tax_period The frequency with which tax returns are processed. See Sales Tax Period
*
* @return $this
*/
public function setSalesTaxPeriod($sales_tax_period)
{
$allowedValues = $this->getSalesTaxPeriodAllowableValues();
if (!is_null($sales_tax_period) && !in_array($sales_tax_period, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'sales_tax_period', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['sales_tax_period'] = $sales_tax_period;
return $this;
}
/**
* Gets default_sales_tax
*
* @return string|null
*/
public function getDefaultSalesTax()
{
return $this->container['default_sales_tax'];
}
/**
* Sets default_sales_tax
*
* @param string|null $default_sales_tax The default for LineAmountTypes on sales transactions
*
* @return $this
*/
public function setDefaultSalesTax($default_sales_tax)
{
$this->container['default_sales_tax'] = $default_sales_tax;
return $this;
}
/**
* Gets default_purchases_tax
*
* @return string|null
*/
public function getDefaultPurchasesTax()
{
return $this->container['default_purchases_tax'];
}
/**
* Sets default_purchases_tax
*
* @param string|null $default_purchases_tax The default for LineAmountTypes on purchase transactions
*
* @return $this
*/
public function setDefaultPurchasesTax($default_purchases_tax)
{
$this->container['default_purchases_tax'] = $default_purchases_tax;
return $this;
}
/**
* Gets period_lock_date
*
* @return \DateTime|null
*/
public function getPeriodLockDate()
{
return $this->container['period_lock_date'];
}
/**
* Sets period_lock_date
*
* @param \DateTime|null $period_lock_date Shown if set. See lock dates
*
* @return $this
*/
public function setPeriodLockDate($period_lock_date)
{
$this->container['period_lock_date'] = $period_lock_date;
return $this;
}
/**
* Gets end_of_year_lock_date
*
* @return \DateTime|null
*/
public function getEndOfYearLockDate()
{
return $this->container['end_of_year_lock_date'];
}
/**
* Sets end_of_year_lock_date
*
* @param \DateTime|null $end_of_year_lock_date Shown if set. See lock dates
*
* @return $this
*/
public function setEndOfYearLockDate($end_of_year_lock_date)
{
$this->container['end_of_year_lock_date'] = $end_of_year_lock_date;
return $this;
}
/**
* Gets created_date_utc
*
* @return \DateTime|null
*/
public function getCreatedDateUtc()
{
return $this->container['created_date_utc'];
}
/**
* Sets created_date_utc
*
* @param \DateTime|null $created_date_utc Timestamp when the organisation was created in Xero
*
* @return $this
*/
public function setCreatedDateUtc($created_date_utc)
{
$this->container['created_date_utc'] = $created_date_utc;
return $this;
}
/**
* Gets timezone
*
* @return \XeroAPI\XeroPHP\Models\Accounting\TimeZone|null
*/
public function getTimezone()
{
return $this->container['timezone'];
}
/**
* Sets timezone
*
* @param \XeroAPI\XeroPHP\Models\Accounting\TimeZone|null $timezone timezone
*
* @return $this
*/
public function setTimezone($timezone)
{
$this->container['timezone'] = $timezone;
return $this;
}
/**
* Gets organisation_entity_type
*
* @return string|null
*/
public function getOrganisationEntityType()
{
return $this->container['organisation_entity_type'];
}
/**
* Sets organisation_entity_type
*
* @param string|null $organisation_entity_type Organisation Type
*
* @return $this
*/
public function setOrganisationEntityType($organisation_entity_type)
{
$allowedValues = $this->getOrganisationEntityTypeAllowableValues();
if (!is_null($organisation_entity_type) && !in_array($organisation_entity_type, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'organisation_entity_type', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['organisation_entity_type'] = $organisation_entity_type;
return $this;
}
/**
* Gets short_code
*
* @return string|null
*/
public function getShortCode()
{
return $this->container['short_code'];
}
/**
* Sets short_code
*
* @param string|null $short_code A unique identifier for the organisation. Potential uses.
*
* @return $this
*/
public function setShortCode($short_code)
{
$this->container['short_code'] = $short_code;
return $this;
}
/**
* Gets class
*
* @return string|null
*/
public function getClass()
{
return $this->container['class'];
}
/**
* Sets class
*
* @param string|null $class Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
*
* @return $this
*/
public function setClass($class)
{
$allowedValues = $this->getClassAllowableValues();
if (!is_null($class) && !in_array($class, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'class', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['class'] = $class;
return $this;
}
/**
* Gets edition
*
* @return string|null
*/
public function getEdition()
{
return $this->container['edition'];
}
/**
* Sets edition
*
* @param string|null $edition BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
*
* @return $this
*/
public function setEdition($edition)
{
$allowedValues = $this->getEditionAllowableValues();
if (!is_null($edition) && !in_array($edition, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'edition', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['edition'] = $edition;
return $this;
}
/**
* Gets line_of_business
*
* @return string|null
*/
public function getLineOfBusiness()
{
return $this->container['line_of_business'];
}
/**
* Sets line_of_business
*
* @param string|null $line_of_business Description of business type as defined in Organisation settings
*
* @return $this
*/
public function setLineOfBusiness($line_of_business)
{
$this->container['line_of_business'] = $line_of_business;
return $this;
}
/**
* Gets addresses
*
* @return \XeroAPI\XeroPHP\Models\Accounting\Address[]|null
*/
public function getAddresses()
{
return $this->container['addresses'];
}
/**
* Sets addresses
*
* @param \XeroAPI\XeroPHP\Models\Accounting\Address[]|null $addresses Address details for organisation – see Addresses
*
* @return $this
*/
public function setAddresses($addresses)
{
$this->container['addresses'] = $addresses;
return $this;
}
/**
* Gets phones
*
* @return \XeroAPI\XeroPHP\Models\Accounting\Phone[]|null
*/
public function getPhones()
{
return $this->container['phones'];
}
/**
* Sets phones
*
* @param \XeroAPI\XeroPHP\Models\Accounting\Phone[]|null $phones Phones details for organisation – see Phones
*
* @return $this
*/
public function setPhones($phones)
{
$this->container['phones'] = $phones;
return $this;
}
/**
* Gets external_links
*
* @return \XeroAPI\XeroPHP\Models\Accounting\ExternalLink[]|null
*/
public function getExternalLinks()
{
return $this->container['external_links'];
}
/**
* Sets external_links
*
* @param \XeroAPI\XeroPHP\Models\Accounting\ExternalLink[]|null $external_links Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings is updated in Xero. See ExternalLinks below
*
* @return $this
*/
public function setExternalLinks($external_links)
{
$this->container['external_links'] = $external_links;
return $this;
}
/**
* Gets payment_terms
*
* @return \XeroAPI\XeroPHP\Models\Accounting\PaymentTerm|null
*/
public function getPaymentTerms()
{
return $this->container['payment_terms'];
}
/**
* Sets payment_terms
*
* @param \XeroAPI\XeroPHP\Models\Accounting\PaymentTerm|null $payment_terms payment_terms
*
* @return $this
*/
public function setPaymentTerms($payment_terms)
{
$this->container['payment_terms'] = $payment_terms;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param integer $offset Offset
*
* @return boolean
*/
public function offsetExists($offset)
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param integer $offset Offset
*
* @return mixed
*/
public function offsetGet($offset)
{
return isset($this->container[$offset]) ? $this->container[$offset] : null;
}
/**
* Sets value based on offset.
*
* @param integer $offset Offset
* @param mixed $value Value to be set
*
* @return void
*/
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param integer $offset Offset
*
* @return void
*/
public function offsetUnset($offset)
{
unset($this->container[$offset]);
}
/**
* Gets the string presentation of the object
*
* @return string
*/
public function __toString()
{
return json_encode(
AccountingObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
}