Xero Accounting Endpoint: Organisation - Revision history

Nic at 05:20, 22 September 2021

2021-09-22T05:20:31Z

← Older revision		Revision as of 00:20, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''Organisation''' [[Endpoints\|endpoint]] allows you to access various information about your Xero organisation / data file.		The Xero '''Organisation''' [[Xero Accounting Endpoints\|endpoint]] allows you to access various information about your Xero organisation / data file.


Line 251:		Line 251:
	:[[Xero Accounting Endpoint: Currencies\|Currencies]]		:[[Xero Accounting Endpoint: Currencies\|Currencies]]
	:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]		:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]


			== Related Topics ==

			:[[Xero Accounting Models]]
			:[[Xero Accounting Endpoints]]

Nic at 01:45, 22 September 2021

2021-09-22T01:45:05Z

← Older revision		Revision as of 20:45, 21 September 2021
Line 147:		Line 147:

	;DefaultSalesTax		;DefaultSalesTax
	:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting ~~Endpoint~~: TaxTypes\|default tax type]] for sales.		:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Field: TaxTypes\|default tax type]] for sales.

	;DefaultPurchasesTax		;DefaultPurchasesTax
	:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting ~~Endpoint~~: TaxTypes\|default tax type]] for purchases.		:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Field: TaxTypes\|default tax type]] for purchases.

	;PeriodLockDate		;PeriodLockDate

Nic at 06:15, 17 September 2021

2021-09-17T06:15:41Z

← Older revision		Revision as of 01:15, 17 September 2021
Line 242:		Line 242:
	== Related Fields ==		== Related Fields ==

			:[[Xero Accounting Field: Addresses\|Addresses]]
			:[[Xero Accounting Field: PhoneNumbers\|PhoneNumbers]]
	:[[Xero Accounting Field: TaxTypes\|TaxTypes]]		:[[Xero Accounting Field: TaxTypes\|TaxTypes]]

Line 247:		Line 249:
	== Related Endpoints ==		== Related Endpoints ==

			:[[Xero Accounting Endpoint: Currencies\|Currencies]]
	:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]		:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]

Nic at 06:02, 17 September 2021

2021-09-17T06:02:23Z

← Older revision		Revision as of 01:02, 17 September 2021
Line 109:		Line 109:
	:A [[Field Type: Text\|text field]] that provides the default sales tax basis.		:A [[Field Type: Text\|text field]] that provides the default sales tax basis.
	:Possible values for '''Australia, US and Global''' are:		:Possible values for '''Australia, US and Global''' are:
	:* '''CASH'''~~: Cash Basis~~		:* '''CASH'''
	:* '''ACCRUALS'''~~: Accruals Basis~~		:* '''ACCRUALS'''
	:* '''NONE'''~~: None~~		:* '''NONE'''
	:Possible values for '''New Zealand''' are:		:Possible values for '''New Zealand''' are:
	:* '''PAYMENTS'''~~: Payments Basis~~		:* '''PAYMENTS'''
	:* '''INVOICE'''~~: Invoice Basis~~		:* '''INVOICE'''
	:* '''NONE~~: None~~		:* '''NONE
	:Possible values for the '''United Kingdom''' are:		:Possible values for the '''United Kingdom''' are:
	:* '''CASH'''~~: Cash Scheme~~		:* '''CASH'''
	:* '''ACCRUAL'''~~: Accrual Scheme~~		:* '''ACCRUAL'''
	:* '''FLATRATECASH'''~~: Flat Rate Cash Scheme~~		:* '''FLATRATECASH'''
	:* '''FLATRATEACCRUAL'''~~: Flat Rate Accrual Scheme~~		:* '''FLATRATEACCRUAL'''
	:* '''NONE'''~~: None~~		:* '''NONE'''

	;SalesTaxPeriod		;SalesTaxPeriod
	:A [[Field Type: Text\|text field]] that provides the frequency with which sales tax returns are processed.		:A [[Field Type: Text\|text field]] that provides the frequency with which sales tax returns are processed.
	:Possible values for '''Australia''' are:		:Possible values for '''Australia''' are:
	:* '''MONTHLY'''~~: Monthly~~		:* '''MONTHLY'''
	:* '''QUARTERLY1'''~~: Quarterly (Option1)~~		:* '''QUARTERLY1'''
	:* '''QUARTERLY2'''~~: Quarterly (Option2)~~		:* '''QUARTERLY2'''
	:* '''QUARTERLY3'''~~: Quarterly (Option3)~~		:* '''QUARTERLY3'''
	:* '''ANNUALLY'''~~: Annually~~		:* '''ANNUALLY'''
	:Possible values for '''New Zealand''' are:		:Possible values for '''New Zealand''' are:
	:* '''ONEMONTHS'''~~: Every month.~~		:* '''ONEMONTHS'''
	:* '''TWOMONTHS'''~~: Every two months.~~		:* '''TWOMONTHS'''
	:* '''SIXMONTHS'''~~: Every six months.~~		:* '''SIXMONTHS'''
	:Possible values for the '''United Kingdom''' are:		:Possible values for the '''United Kingdom''' are:
	:* '''MONTHLY'''~~: Monthly~~		:* '''MONTHLY'''
	:* '''QUARTERLY'''~~: Quarterly~~		:* '''QUARTERLY'''
	:* '''YEARLY'''~~: Yearly~~		:* '''YEARLY'''
	:Possible values for the '''US and Global''' are:		:Possible values for the '''US and Global''' are:
	:* '''1MONTHLY'''~~: Monthly~~		:* '''1MONTHLY'''
	:* '''2MONTHLY'''~~: 2 Monthly~~		:* '''2MONTHLY'''
	:* '''3MONTHLY'''~~: 3 Monthly~~		:* '''3MONTHLY'''
	:* '''6MONTHLY'''~~: 6 Monthly~~		:* '''6MONTHLY'''
	:* '''ANNUALLY'''~~: Annually~~		:* '''ANNUALLY'''

	;DefaultSalesTax		;DefaultSalesTax

Nic: Created page with "== Overview == The Xero '''Organisation''' endpoint allows you to access various information about your Xero organisation / data file. == Fields == The follo..."

2021-09-17T06:01:13Z

Created page with "== Overview == The Xero '''Organisation''' endpoint allows you to access various information about your Xero organisation / data file. == Fields == The follo..."

New page

== Overview ==

The Xero '''Organisation''' [[Endpoints|endpoint]] allows you to access various information about your Xero organisation / data file.

== Fields ==

The following fields are available for the Organisation endpoint.

;OrganisationID
:A [[Field Type: GUID|GUID field]] representing the internal id of the organisation.
:This field does not link to other endpoints.

;Name
:A [[Field Type: Text|text field]] that provides the name of the xero organisation.

;LegalName
:A [[Field Type: Text|text field]] that provides the legal name of the xero organisation.

;OrganisationType
:A [[Field Type: Text|text field]] that indicates the type of organisation.
:Possible values are:
:* '''ACCOUNTING_PRACTICE'''
:* '''CHARITY'''
:* '''CLUB_OR_SOCIETY'''
:* '''COMPANY'''
:* '''LOOK_THROUGH_COMPANY'''
:* '''NOT_FOR_PROFIT'''
:* '''PARTNERSHIP'''
:* '''S_CORPORATION'''
:* '''SELF_MANAGED_SUPERANNUATION_FUND'''
:* '''SOLE_TRADER'''
:* '''SUPERANNUATION_FUND'''
:* '''TRUST'''

;OrganisationEntityType
:A [[Field Type: Text|text field]] that indicates the type of organisation. Similar to '''OrganisationType'''.

;OrganisationStatus
:A [[Field Type: Text|text field]] that indicates the status of organisation.
:This should always be set to '''ACTIVE'''.

;LineOfBusiness
:A [[Field Type: Text|text field]] that indicates the type of business as chosen within the organisation settings screen.

;CountryCode
:A [[Field Type: Text|text field]] that provides the country code of the organisation.

;BaseCurrency
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Currencies|native currency code]] of the organisation.

;Timezone
:A [[Field Type: Text|text field]] that provides the timezone for the organisation.

;ShortCode
:A [[Field Type: Text|text field]] that provides a unique identifier for the organisation.
:This would commonly be used for deep-linking to other systems.

;TaxNumber
:A [[Field Type: Text|text field]] that provides the tax number of the organisation (ABN, TFN, etc.)

;PaysTax
:A [[Field Type: Boolean|true/false value]] that indicates if the organisation pays tax or not.

;Addresses
:A [[Field Type: Table|table field]] that provides one or more [[Xero Accounting Field: Addresses|address]] for the organisation.

;Phones
:A [[Field Type: Table|table field]] that provides one or more [[Xero Accounting Field: PhoneNumbers|phone number]] for the organisation.

;Version
:A [[Field Type: Text|text field]] that provides the version of Xero running for this organisation.
:Possible values are:
:* '''AU'''
:* '''NZ'''
:* '''GLOBAL'''
:* '''UK'''
:* '''US'''

;Edition
:A [[Field Type: Text|text field]] that provides the edition of Xero running for this organisation.
:Possible values are:
:* '''BUSINESS'''
:* '''PARTNER'''

;Class
:A [[Field Type: Text|text field]] that provides the class of Xero running for this organisation.
:Possible values are:
:* '''DEMO'''
:* '''TRIAL'''
:* '''PREMIUM'''

;RegistrationNumber
:A [[Field Type: Text|text field]] that provides the registration number of Xero running for this organisation (Australia, New Zealand and UK only).

;EmployerIdentificationNumber
:A [[Field Type: Text|text field]] that provides the employer identifier number (US only).

;IsDemoCompany
:A [[Field Type: Boolean|true/false value]] that indicates if the data file is a demo organisation.

;FinancialYearEndDay
:A [[Field Type: Integer|whole number field]] that provides the end day of the financial year.

;FinancialYearEndMonth
:A [[Field Type: Integer|whole number field]] that provides the end month of the financial year.

;SalesTaxBasis
:A [[Field Type: Text|text field]] that provides the default sales tax basis.
:Possible values for '''Australia, US and Global''' are:
:* '''CASH''': Cash Basis
:* '''ACCRUALS''': Accruals Basis
:* '''NONE''': None
:Possible values for '''New Zealand''' are:
:* '''PAYMENTS''': Payments Basis
:* '''INVOICE''': Invoice Basis
:* '''NONE: None
:Possible values for the '''United Kingdom''' are:
:* '''CASH''': Cash Scheme
:* '''ACCRUAL''': Accrual Scheme
:* '''FLATRATECASH''': Flat Rate Cash Scheme
:* '''FLATRATEACCRUAL''': Flat Rate Accrual Scheme
:* '''NONE''': None

;SalesTaxPeriod
:A [[Field Type: Text|text field]] that provides the frequency with which sales tax returns are processed.
:Possible values for '''Australia''' are:
:* '''MONTHLY''': Monthly
:* '''QUARTERLY1''': Quarterly (Option1)
:* '''QUARTERLY2''': Quarterly (Option2)
:* '''QUARTERLY3''': Quarterly (Option3)
:* '''ANNUALLY''': Annually
:Possible values for '''New Zealand''' are:
:* '''ONEMONTHS''': Every month.
:* '''TWOMONTHS''': Every two months.
:* '''SIXMONTHS''': Every six months.
:Possible values for the '''United Kingdom''' are:
:* '''MONTHLY''': Monthly
:* '''QUARTERLY''': Quarterly
:* '''YEARLY''': Yearly
:Possible values for the '''US and Global''' are:
:* '''1MONTHLY''': Monthly
:* '''2MONTHLY''': 2 Monthly
:* '''3MONTHLY''': 3 Monthly
:* '''6MONTHLY''': 6 Monthly
:* '''ANNUALLY''': Annually

;DefaultSalesTax
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: TaxTypes|default tax type]] for sales.

;DefaultPurchasesTax
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: TaxTypes|default tax type]] for purchases.

;PeriodLockDate
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date from which transaction can be entered.

;EndOfYearLockDate
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date from which transaction can be entered.

;PaymentTerms
:A [[Field Type: Record|record field]] provides further information for payment terms for sales and purchases.
:See [[#PaymentTerms Fields|PaymentTerms Fields]] for more information.

;ExternalLinks
:A [[Field Type: Table|table field]] provides further information for populate external links such as facebook, twitter, etc.
:See [[#ExternalLinks Fields|ExternalLinks Fields]] for more information.

;APIKey
:A [[Field Type: Text|text field]] that provides the unique API key used for xero-to-xero transactions.

;CreatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this record was created.

== PaymentTerms Fields ==

The [[#Fields|PaymentTerms Fields]] include the following sub fields.

;Bills
:A [[Field Type: Record|record field]] provides further information for payment terms for purchases.
:See [[#PaymentTerms.Bills Fields|PaymentTerms.Bills Fields]] for more information.

;Sales
:A [[Field Type: Record|record field]] provides further information for payment terms for sales.
:See [[#PaymentTerms.Sales Fields|PaymentTerms.Sales Fields]] for more information.

== PaymentTerms.Bills Fields ==

The [[#PaymentTerms Fields|PaymentTerms.Bills Fields]] include the following sub fields.

;Day
:A [[Field Type: Integer|whole number field]] that indicates the day of the month.

;Type
:A [[Field Type: Text|text field]] that indicates how the day field is applied.
:Possible values are:
:* '''DAYSAFTERBILLDATE''': x days after bill date
:* '''DAYSAFTERBILLMONTH''': x days after bill month
:* '''OFCURRENTMONTH''': on a specific day of the current month
:* '''OFFOLLOWINGMONTH''': on a specific day of the following month

== PaymentTerms.Sales Fields ==

The [[#PaymentTerms Fields|PaymentTerms.Sales Fields]] include the following sub fields.

;Day
:A [[Field Type: Integer|whole number field]] that indicates the day of the month.

;Type
:A [[Field Type: Text|text field]] that indicates how the day field is applied.
:Possible values are:
:* '''DAYSAFTERBILLDATE''': x days after bill date
:* '''DAYSAFTERBILLMONTH''': x days after bill month
:* '''OFCURRENTMONTH''': on a specific day of the current month
:* '''OFFOLLOWINGMONTH''': on a specific day of the following month

== ExternalLinks Fields ==

The [[#Fields|ExternalLinks Fields]] include the following sub fields.

;LinkType
:A [[Field Type: Text|text field]] that indicates the type of link it is.
:Possible values are:
:* '''Facebook'''
:* '''GooglePlus'''
:* '''LinkedIn'''
:* '''Twitter'''
:* '''Website'''

;Url
:A [[Field Type: Text|text field]] that provides the URL for the link.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/organisation Xero API].

== Related Fields ==

:[[Xero Accounting Field: TaxTypes|TaxTypes]]

== Related Endpoints ==

:[[Xero Accounting Endpoint: TaxRates|TaxRates]]