Settings Endpoint: Model
Overview
The Model settings endpoint allows you to retrieve the configuration information of a model.
Fields
The following fields are available for the Model endpoint.
- ModelID
- A GUID field representing the internal id of a model.
- This field can be used to link to other endpoints.
- ModelName
- A text field that provides the name of the model.
- ModelCode
- A text field that provides the code of the model used to construct the OData Feed URL.
- ModelType
- A text field that indicates type of Model.
- Possible values are:
- MYOB: Indicates the model provides access to MYOB data.
- Xero Accounting: Indicates the model provides access to the Xero Accounting data.
- Xero Payroll (AU): Indicates the model provides access to the Xero Payroll data for Australian organisation.
- Xero Payroll (NZ): Indicates the model provides access to the Xero Payroll data for New Zealand organisation.
- Xero Projects: Indicates the model provides access to the Xero Projects data.
- DataFileType
- A text field that indicates type of data file..
- Possible values are:
- MYOB: Indicates the model provides access to MYOB data.
- Xero: Indicates the model provides access to the Xero data.
- LoginType
- A text field that indicates the type of login in use.
- Possible values are:
- Anonymous: Indicates no user name or password are required.
- Basic: Indicates a user name and password must be provided to access the data.
- ArchiveType
- A text field that indicates the type of archiving mechanism in use.
- Possible values are:
- IsEnabled
- A true/false value that indicates if this model is enabled or not.
- Ironically, this will only be set to true as pulling Settings Endpoints will not be possible if set to false.
- IsFirewallEnabled
- A true/false value that indicates if this firewall is enabled for the model or not.
- DefaultStartDate
- A date field that provides the default start date in use when not filtering data by date.
- DefaultEndDate
- A date field that provides the default end date in use when not filtering data by date.