MYOB Endpoint: CompanyPreferences
Overview
The MYOB CompanyPreferences endpoint allows you to get access preferences and options setup in MYOB.
Fields
The following fields are available for the CompanyPreferences endpoint.
- System
- A record field that provides the system options and preferences.
- See System Fields for more information.
- ReportsAndForms
- A record field that provides the reports and forms options and preferences.
- See ReportsAndForms Fields for more information.
- Banking
- A record field that provides the banking options and preferences.
- See Banking Fields for more information.
- Sales
- A record field that provides the sales options and preferences.
- See Sales Fields for more information.
- Purchases
- A record field that provides the purchase options and preferences.
- See Purchases Fields for more information.
- Timesheets
- A record field that provides the timesheet options and preferences.
- See Timesheets Fields for more information.
- RowVersion
- A row version field.
System Fields
The System field contains the following sub-fields.
- CategoryTracking
- A text field that provides the status of this transaction.
- Possible values are:
- Off: Indicates that category tracking is not active.
- OnAndNotRequired: Indicates that category tracking is optional.
- OnAndRequired: Indicates that category tracking is mandatory.
- TransactionsCannotBeChangedMustBeReversed
- A true/false field that indicates cannot be deleted.
- LockPeriodPriotTo
- A date field that indicates the cut off date when transations can be entered.
- UseAlphaAccountIdentifier
- A true/false field that indicates that account numbers can contain alpha and numeric characters or only numeric characters.
ReportsAndForms Fields
The ReportsAndForms field contains the following sub-fields.
- ReportTaxablePayments
- A true/false field that indicates if report taxable payments to contractors is active or not.
- EmailDefaults
- A record field that provides the email options and preferences.
- See ReportsAndForms.EmailDefaults Fields for more information.
ReportsAndForms.EmailDefaults Fields
The ReportsAndForms.EmailDefaults field contains the following sub-fields.
- Sales
- A record field that provides the email options and preferences related to sales.
- See ReportsAndForms.EmailDefaults.Sales Fields for more information.
- Purchases
- A record field that provides the email options and preferences related to purchases.
- See ReportsAndForms.EmailDefaults.Purchases Fields for more information.
- PaySlips
- A record field that provides the email details for payslips.
- PaymentSummaries
- A record field that provides the email options and preferences related to payment summaries.
- See ReportsAndForms.EmailDefaults.PaymentSummaries Fields for more information.
- CompanySendEmailProfile
- A record field that provides the email options and preferences related.
- See ReportsAndForms.EmailDefaults.CompanySendEmailProfile Fields for more information.
ReportsAndForms.EmailDefaults.Sales Fields
The ReportsAndForms.EmailDefaults.Sales field contains the following sub-fields.
- Invoice
- A record field that provides the email details for sales invoice.
- Order
- A record field that provides the email details for sales orders.
- Quote
- A record field that provides the email details for sales quote.
ReportsAndForms.EmailDefaults.Purchases Fields
The ReportsAndForms.EmailDefaults.Purchases field contains the following sub-fields.
- Bill
- A record field that provides the email details for purchase invoice.
- Order
- A record field that provides the email details for purchase orders.
- Quote
- A record field that provides the email details for purchase quote.
ReportsAndForms.EmailDefaults.PaymentSummaries Fields
The ReportsAndForms.EmailDefaults.PaymentSummaries field contains the following sub-fields.
- New
- A record field that provides the email details for new payment summaries.
- Amendment
- A record field that provides the email details for amdended payment summaries.
ReportsAndForms.EmailDefaults.CompanySendEmailProfile Fields
The ReportsAndForms.EmailDefaults.CompanySendEmailProfile field contains the following sub-fields.
- OnlineEmailingEnabled
- A true/false field that indicates if emails are sent from the cloud.
- FromName
- A text field that provides the name on the email.
- ReplyToEmail
- A text field that provides the email address to which replies will be sent.
Banking Fields
The Banking field contains the following sub-fields.
- PreferToReceiveMoneyIntoUndepositedFunds
- A true/false field that indicates if receive money will default to undeposited funds or not.
Sales Fields
The Sales field contains the following sub-fields.
- Terms
- A record field that provides the terms for sales.
- See Sales.Terms Fields for more information.
Sales.Terms Fields
The Sales.Terms field contains the following sub-fields.
- PaymentIsDue
- A text field that provides the default the due date algorithm.
- Possible values are:
- CashOnDelivery
- PrePaid
- InAGivenNumberOfDays
- OnADayOfTheMonth
- NumberOfDaysAfterEOM
- DayOfMonthAfterEOM
- DiscountDate
- A integer field that provides the default day or a specific number of days in order to receive a discount.
- BalanceDueDate
- A integer field that provides the default day or a specific number of days in order to pay on time.
- DiscountForEarlyPayment
- A decimal field that provides the default percentage discount for early payment.
- MonthlyChargeForLatePayment
- A decimal field that provides the default charge for late payments.
- Not available for all endpoints.
- PriceLevel
- A text field that indicates the default price level.
- TaxCode
- A record field that provides the default tax code used on sales lines.
- UseCustomerTaxCode
- A true/false field that indicates if the customer tax code will be used as default instead.
- FreightTaxCode
- A record field that provides the default tax code used for freight on sales.
- CreditLimit
- A decimal field that provides default credit limit amount.
Purchases Fields
The Purchases field contains the following sub-fields.
- Terms
- A record field that provides the terms for purchases.
- See Purchases.Terms Fields for more information.
Purchases.Terms Fields
The Purchases.Terms field contains the following sub-fields.
- PaymentIsDue
- A text field that provides the default the due date algorithm.
- Possible values are:
- CashOnDelivery
- PrePaid
- InAGivenNumberOfDays
- OnADayOfTheMonth
- NumberOfDaysAfterEOM
- DayOfMonthAfterEOM
- DiscountDate
- A integer field that provides the default day or a specific number of days in order to receive a discount.
- BalanceDueDate
- A integer field that provides the default day or a specific number of days in order to pay on time.
- DiscountForEarlyPayment
- A decimal field that provides the default percentage discount for early payment.
- TaxCode
- A record field that provides the default tax code used on lines.
- UseSupplierTaxCode
- A true/false field that indicates if the supplier tax code will be used as default instead.
- FreightTaxCode
- A record field that provides the default tax code used for freight.
- CreditLimit
- A decimal field that provides default credit limit amount.
Timesheets Fields
The Timesheets field contains the following sub-fields.
- UseTimesheetsFor
- A text field that indicates what timesheets are used for.
- Possible values are:
- TimeBillingAndPayroll : Indicates the timesheets are used for both time billing and payroll.
- Payroll: Indicates the timesheets are only used for payroll.
- WeekStartsOn
- A text field that indicates the day the week starts.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields
Related Endpoints
- None