Editing a model's details - Revision history

Nic at 23:10, 2 August 2026

2026-08-02T23:10:05Z

← Older revision		Revision as of 18:10, 2 August 2026
Line 60:		Line 60:
	=== Notes ===		=== Notes ===

	: ^In Xero, ~~Paginanation~~ is supported by some, but not all, endpoints. [https://developer.xero.com/documentation/best-practices/integration-health/paging/ Xero Reference].		: ^In Xero, Pagination is supported by some, but not all, endpoints. [https://developer.xero.com/documentation/best-practices/integration-health/paging/ Xero Reference].
	: For a comprehensive list of Xero and MYOB endpoints that support pagination, please refer to [[Default Page Size]].		: For a comprehensive list of Xero and MYOB endpoints that support pagination, please refer to [[Default Page Size]].

Nic at 00:20, 1 May 2026

2026-05-01T00:20:04Z

← Older revision		Revision as of 19:20, 30 April 2026
Line 40:		Line 40:
	#: Set the '''Sensitivity''' in months to control the date range used when polling.		#: Set the '''Sensitivity''' in months to control the date range used when polling.
	#: You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.		#: You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.
	#: For more on polling, see [[~~HelpID:Polling~~]]		#: For more on information on polling, see [[Configure OdataLink to poll for changes]].
	# If using the '''Live (with archive)''' [[Archive Types\|'''archive types''']], you can also turn on the '''Developer''' option.		# If using the '''Live (with archive)''' [[Archive Types\|'''archive types''']], you can also turn on the '''Developer''' option.
	#: When the '''Developer''' option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.		#: When the '''Developer''' option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.

Nic at 00:15, 1 May 2026

2026-05-01T00:15:44Z

← Older revision		Revision as of 19:15, 30 April 2026
Line 28:		Line 28:
	#;<br \>{{large\|Performance Options}}		#;<br \>{{large\|Performance Options}}
	# Choose the [[Archive Types\|'''Archive Type''']].		# Choose the [[Archive Types\|'''Archive Type''']].
	#: '''Live''' optimises the model for live use.		#: '''Live (with Archive)''' optimises the model for live use.
	#: '''Live (no archive)''' provides access to data without caching any information (worse performance).		#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
	~~#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours~~
	#: '''Static''' optimises the model for historical data that never changes.		#: '''Static''' optimises the model for historical data that never changes.
	# If using the '''Live''' [[Archive Types\|'''archive types''']], you can also configure whether to archive old historical data. You can do so by choosing how the '''Cut Off Date''' is calculated.		# If using the '''Live (with archive)''' [[Archive Types\|'''archive types''']], you can also configure whether to archive old historical data. You can do so by choosing how the '''Cut Off Date''' is calculated.
	#: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.		#: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.
	#: '''Archive data prior to cut off date''' archives any data created prior to the cut off date entered.		#: '''Archive data prior to cut off date''' archives any data created prior to the cut off date entered.
	#: '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.		#: '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.
	#: '''Archive data prior X days''' archives any data created prior to the cut off date calculated from the number of days entered.		#: '''Archive data prior X days''' archives any data created prior to the cut off date calculated from the number of days entered.
	# ~~Choose~~ the [[Archive ~~Paging~~\|'''Archive ~~Paging~~''']].		# If using the '''Live (with archive)''' [[Archive Types\|'''archive types''']], you can also configure whether OdataLink polls for changes.
	#: '''~~Default~~''': OdataLink will ~~page~~ the ~~date as requested~~.		#: '''Turning Polling On''' will allow OdataLink to poll of changes to provide live data in the most optimal manner.
	#: '''By Month''': OdataLink will page the data one ~~calendar~~ month at a time. This may increase the performance for VERY LARGE data files.		#: Set the '''Sensitivity''' in months to control the date range used when polling.
	#: '''~~By Year~~''': OdataLink will page the data one ~~calendar year~~ at a time. This may increase the performance for LARGE data files.		#: You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.
			#: For more on polling, see [[HelpID:Polling]]
			# If using the '''Live (with archive)''' [[Archive Types\|'''archive types''']], you can also turn on the '''Developer''' option.
			#: When the '''Developer''' option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.
			# Choose the [[Archive Paging\|'''Page By''']] option.
			#: '''Month''': OdataLink will page the data one month at a time. This may increase the performance for VERY LARGE data files.
			#: '''Quarter''': OdataLink will page the data one quarter at a time. This may increase the performance for LARGE data files.
			#: '''Year''': OdataLink will page the data one calendar year at a time. This option is provided for SMALLER data files.
			#: '''Default''': OdataLink will page the date as requested. This is provided for those that build more complex queries where you do not want OdataLink to page the data by date.
	# Enter a '''[[Default Date Range]]''' to control how much data is retrieved.		# Enter a '''[[Default Date Range]]''' to control how much data is retrieved.
	#: These dates will apply when no date filters are applied via the [[OData client]].		#: These dates will apply when no date filters are applied via the [[OData client]].

Nic at 22:53, 9 April 2026

2026-04-09T22:53:43Z

← Older revision		Revision as of 17:53, 9 April 2026
Line 15:		Line 15:
	#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.		#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.
	#;<br \>{{large\|Data File Options}}		#;<br \>{{large\|Data File Options}}
	:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''		#:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''
	#Tick/untick the '''Consolidation Allowed''' checkbox;		#Tick/untick the '''Consolidation Allowed''' checkbox;
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.

Ash at 02:10, 8 April 2026

2026-04-08T02:10:28Z

Nic at 04:33, 19 June 2025

2025-06-19T04:33:22Z

Nic at 04:22, 19 June 2025

2025-06-19T04:22:20Z

← Older revision		Revision as of 23:22, 18 June 2025
Line 16:		Line 16:
	#;<br \>Data File Options		#;<br \>Data File Options
	:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''		:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''
	#~~<li value="7">~~Tick/untick the '''Consolidation Allowed''' checkbox;~~</li>~~		#Tick/untick the '''Consolidation Allowed''' checkbox;
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.
	#;<br \>Security Options		#;<br \>Security Options

Nic at 04:19, 19 June 2025

2025-06-19T04:19:48Z

Nic at 04:19, 19 June 2025

2025-06-19T04:19:13Z

← Older revision		Revision as of 23:19, 18 June 2025
Line 15:		Line 15:
	#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.		#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.
	#;<br \>Data File Options		#;<br \>Data File Options
	: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''		:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''
	#<li value="7">Tick/untick the '''Consolidation Allowed''' checkbox;</li>		#<li value="7">Tick/untick the '''Consolidation Allowed''' checkbox;</li>
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.

Nic at 04:19, 19 June 2025

2025-06-19T04:19:06Z

← Older revision		Revision as of 23:19, 18 June 2025
Line 14:		Line 14:
	# Enter the '''Model Code''';		# Enter the '''Model Code''';
	#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.		#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.
	~~:'''~~Data File Options~~'''~~		#;<br \>Data File Options
	: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''		: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''
	#<li value="7">Tick/untick the '''Consolidation Allowed''' checkbox;</li>		#<li value="7">Tick/untick the '''Consolidation Allowed''' checkbox;</li>

← Older revision		Revision as of 17:53, 9 April 2026
Line 15:		Line 15:
	#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.		#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.
	#;<br \>{{large\|Data File Options}}		#;<br \>{{large\|Data File Options}}
	:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''		#:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''
	#Tick/untick the '''Consolidation Allowed''' checkbox;		#Tick/untick the '''Consolidation Allowed''' checkbox;
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.

← Older revision		Revision as of 21:10, 7 April 2026
Line 19:		Line 19:
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.
	#;<br \>{{large\|Security Options}}		#;<br \>{{large\|Security Options}}
	# Choose the [[Login Types\|Login Type]] required to access the data.		# Choose the [[Login Types\|'''Login Type''']] required to access the data.
	#: '''Basic''' login will require the username and password of a [[Users\|user]] when accessing data.		#: '''Basic''' login will require the username and password of a [[Users\|user]] when accessing data.
	#: '''Anonymous''' will not require any credentials when accessing data.		#: '''Anonymous''' will not require any credentials when accessing data.
Line 27:		Line 27:
	#: Controls whether all [[OData Feed URLs\|OData feed urls]] for this [[Models\|model]] are usable.		#: Controls whether all [[OData Feed URLs\|OData feed urls]] for this [[Models\|model]] are usable.
	#;<br \>{{large\|Performance Options}}		#;<br \>{{large\|Performance Options}}
	# Choose the [[Archive Types\|Archive Type]].		# Choose the [[Archive Types\|'''Archive Type''']].
	#: '''Live''' optimises the model for live use.		#: '''Live''' optimises the model for live use.
	#: '''Live (no archive)''' provides access to data without caching any information (worse performance).		#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
	#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours		#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours
	#: '''Static''' optimises the model for ~~historica~~ data that never changes.		#: '''Static''' optimises the model for historical data that never changes.
	# If using the '''Live''' [[Archive Types\|archive types]], you can also configure whether to archive old historical data. You can do so by choosing how the '''Cut Off Date''' is calculated.		# If using the '''Live''' [[Archive Types\|'''archive types''']], you can also configure whether to archive old historical data. You can do so by choosing how the '''Cut Off Date''' is calculated.
	#: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.		#: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.
	#: '''Archive data prior to cut off date''' archives any data created prior to the cut off date entered.		#: '''Archive data prior to cut off date''' archives any data created prior to the cut off date entered.
	#: '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.		#: '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.
	#: '''Archive data prior X days''' archives any data created prior to the cut off date calculated from the number of days entered.		#: '''Archive data prior X days''' archives any data created prior to the cut off date calculated from the number of days entered.
	# Choose the [[Archive Paging\|Archive Paging]].		# Choose the [[Archive Paging\|'''Archive Paging''']].
	#: '''Default''': OdataLink will page the date as requested.		#: '''Default''': OdataLink will page the date as requested.
	#: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.		#: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.
	#: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.		#: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.
	# Enter a [[Default Date Range]] to control how much data is retrieved.		# Enter a '''[[Default Date Range]]''' to control how much data is retrieved.
	#: These dates will apply when no date filters are applied via the [[OData client]].		#: These dates will apply when no date filters are applied via the [[OData client]].
	# If applicable, enter the [[Default Page Size]].		# If applicable, enter the '''[[Default Page Size]]'''.
	#: This controls the number of records that will be returned on a single call for most endpoints^.		#: This controls the number of records that will be returned on a single call for most endpoints^.
	#;<br \>{{large\|Miscellaneous Options}}		#;<br \>{{large\|Miscellaneous Options}}
	# Choose the [[OData Client Compatibility\|OData Client Compatibility]] option required.		# Choose the [[OData Client Compatibility\|'''OData Client Compatibility''']] option required.
	#: We recommend leaving this setting as ''(Auto Detect)''.		#: We recommend leaving this setting as ''(Auto Detect)''.
	# Click '''Save'''.		# Click '''Save'''.

← Older revision		Revision as of 23:33, 18 June 2025
Line 14:		Line 14:
	# Enter the '''Model Code''';		# Enter the '''Model Code''';
	#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.		#: The ''secret'' code which will form part of the [[OData Feed URLs\|OData feed url]]. It must be unique for your [[Account\|account]]. Changing it will ''break'' any [[OData Feed URLs\|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs\|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed.
	#;<br \>Data File Options		#;<br \>{{large\|Data File Options}}
	:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''		:: ''Note: The [[Model Type\|Data File Type]] cannot be changed once a model has been created.''
	#Tick/untick the '''Consolidation Allowed''' checkbox;		#Tick/untick the '''Consolidation Allowed''' checkbox;
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.
	#;<br \>Security Options		#;<br \>{{large\|Security Options}}
	# Choose the [[Login Types\|Login Type]] required to access the data.		# Choose the [[Login Types\|Login Type]] required to access the data.
	#: '''Basic''' login will require the username and password of a [[Users\|user]] when accessing data.		#: '''Basic''' login will require the username and password of a [[Users\|user]] when accessing data.
Line 26:		Line 26:
	# Tick/untick the '''Enabled''' checkbox;		# Tick/untick the '''Enabled''' checkbox;
	#: Controls whether all [[OData Feed URLs\|OData feed urls]] for this [[Models\|model]] are usable.		#: Controls whether all [[OData Feed URLs\|OData feed urls]] for this [[Models\|model]] are usable.
	#;<br \>Performance Options		#;<br \>{{large\|Performance Options}}
	# Choose the [[Archive Types\|Archive Type]].		# Choose the [[Archive Types\|Archive Type]].
	#: '''Live''' optimises the model for live use.		#: '''Live''' optimises the model for live use.
Line 45:		Line 45:
	# If applicable, enter the [[Default Page Size]].		# If applicable, enter the [[Default Page Size]].
	#: This controls the number of records that will be returned on a single call for most endpoints^.		#: This controls the number of records that will be returned on a single call for most endpoints^.
	#;<br \>Miscellaneous Options		#;<br \>{{large\|Miscellaneous Options}}
	# Choose the [[OData Client Compatibility\|OData Client Compatibility]] option required.		# Choose the [[OData Client Compatibility\|OData Client Compatibility]] option required.
	#: We recommend leaving this setting as ''(Auto Detect)''.		#: We recommend leaving this setting as ''(Auto Detect)''.

← Older revision		Revision as of 23:19, 18 June 2025
Line 18:		Line 18:
	#<li value="7">Tick/untick the '''Consolidation Allowed''' checkbox;</li>		#<li value="7">Tick/untick the '''Consolidation Allowed''' checkbox;</li>
	#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.		#: This option controls whether the [[Consolidation OData Feed\|Consolidation OData feed]] is available or not.
	# ~~Next, Configure the '''~~Security Options~~'''.~~		#;<br \>Security Options
	# Choose the [[Login Types\|Login Type]] required to access the data.		# Choose the [[Login Types\|Login Type]] required to access the data.
	#: '''Basic''' login will require the username and password of a [[Users\|user]] when accessing data.		#: '''Basic''' login will require the username and password of a [[Users\|user]] when accessing data.
Line 26:		Line 26:
	# Tick/untick the '''Enabled''' checkbox;		# Tick/untick the '''Enabled''' checkbox;
	#: Controls whether all [[OData Feed URLs\|OData feed urls]] for this [[Models\|model]] are usable.		#: Controls whether all [[OData Feed URLs\|OData feed urls]] for this [[Models\|model]] are usable.
	# ~~Next, configure the '''~~Performance Options~~'''~~		#;<br \>Performance Options
	# Choose the [[Archive Types\|Archive Type]].		# Choose the [[Archive Types\|Archive Type]].
	#: '''Live''' optimises the model for live use.		#: '''Live''' optimises the model for live use.
Line 45:		Line 45:
	# If applicable, enter the [[Default Page Size]].		# If applicable, enter the [[Default Page Size]].
	#: This controls the number of records that will be returned on a single call for most endpoints^.		#: This controls the number of records that will be returned on a single call for most endpoints^.
	# ~~Next, configure the '''~~Miscellaneous Options~~'''.~~		#;<br \>Miscellaneous Options
	# Choose the [[OData Client Compatibility\|OData Client Compatibility]] option required.		# Choose the [[OData Client Compatibility\|OData Client Compatibility]] option required.
	#: We recommend leaving this setting as ''(Auto Detect)''.		#: We recommend leaving this setting as ''(Auto Detect)''.