Preferences

Returns company data file preferences

Date Released: Nov 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Company/Preferences GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials

The elements list below details information for Preferences. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • System
  • The following set of information pulls through system preferences for an AccountRight company file.
    • CategoryTrackingString
    • Can consist of the following values:
      Off
      OnAndNotRequired
      OnAndRequired
    • TransactionsCannotBeChangedMustBeReversedBoolean
    • True indicates that transctions cannot be changed or deleted, they must be reversed.
      False indicates transctions can be either changed or deleted.
    • LockPeriodPriorToDateTime
    • Lock period disabling entries prior to a given date, date format YYYY-MM-DD HH:MM:SS { 'Date': '2013-08-11 13:33:02' }
    • UseAlphaAccountIdentifierBoolean
    • True indicates that alpha-numeric Account number values are allowed.
      False indicates that alpha-numeric Account number values are not allowed.
  • ReportsAndForms
  • The following set of information pulls through system preferences for reports and forms.
    • ReportTaxablePaymentsBoolean
    • True indicates that report taxable payments made to contractors is turned on.
      False indicates that report taxable payments made to contractors is turned off.
    • EmailDefaults
    • The following set pulls through the default subject and message for emails.
      • Sales
      • The following sets pull through the subject and messages for Sales emails.
        • Invoice
        • The following set contains the subject and message for Invoice's that are emailed.
          • SubjectString
          • The Subject line for the email.
          • MessageString
          • The message body of the email.
          • IncludeNumberInSubjectBoolean
          • True indicates the Invoice number being included in the subject.
            False indicates the Invoice number not being included in the subject.
        • Order
        • The following set contains the subject and message for Order's that are emailed.
          • SubjectString
          • The Subject line for the email.
          • MessageString
          • The message body of the email.
          • IncludeNumberInSubjectBoolean
          • True indicates the Order number being included in the subject.
            False indicates the Order number not being included in the subject.
        • Quote
        • The following set contains the subject and message for Quote's that are emailed.
          • SubjectString
          • The Subject line for the email.
          • MessageString
          • The message body of the email.
          • IncludeNumberInSubjectBoolean
          • True indicates the Quote number being included in the subject.
            False indicates the Quote number not being included in the subject.
      • Purchases
      • The following sets pull through the subject and messages for Purchases emails.
        • Invoice
        • The following set contains the subject and message for Invoice's that are emailed.
          • SubjectString
          • The Subject line for the email.
          • MessageString
          • The message body of the email.
          • IncludeNumberInSubjectBoolean
          • True indicates the Invoice number being included in the subject.
            False indicates the Invoice number not being included in the subject.
        • Order
        • The following set contains the subject and message for Order's that are emailed.
          • SubjectString
          • The Subject line for the email.
          • MessageString
          • The message body of the email.
          • IncludeNumberInSubjectBoolean
          • True indicates the Order number being included in the subject.
            False indicates the Order number not being included in the subject.
        • Quote
        • The following set contains the subject and message for Quote's that are emailed.
          • SubjectString
          • The Subject line for the email.
          • MessageString
          • The message body of the email.
          • IncludeNumberInSubjectBoolean
          • True indicates the Quote number being included in the subject.
            False indicates the Quote number not being included in the subject.
      • Payslips
      • The following sets pull through the subject and messages for Payslips emails.
        • SubjectString
        • The Subject line for the email.
        • MessageString
        • The message body of the email.
    • CompanySendEmailProfile
    • The object that contains the email profile
      • OnlineEmailingEnabledBoolean
      • Whether online emailing is turned on for this company
      • FromNameString
      • From Name to use for online emailing
      • ReplyToEmailString
      • Reply To email address to use for online emailing
    • Banking
    • The following set of information pulls through system preferences for banking.
      • PreferToReceiveMoneyIntoUndepositedFundsBoolean
      • True indicates the preference When I receive money, I prefer to Group with Other Undeposited funds is turned on.
        False indicates the preference When I receive money, I prefer to Group with Other Undeposited funds is turned off.
    • Sales
    • The following set of information pulls through system preferences for sales.
      • Terms
      • The following set of information pulls through default customer payment terms.
        • PaymentIsDueString
        • Default Terms of Payment definitions:
          CashOnDelivery
          PrePaid
          InAGivenNumberOfDays
          OnADayOfTheMonth
          NumberOfDaysAfterEOM
          DayOfMonthAfterEOM
        • DiscountDate Integer
        • The discount date which includes EOM (End of Month).
        • BalanceDueDate Integer
        • The balance due date which includes EOM (End of Month).
        • DiscountForEarlyPayment Double (99.99%)
        • % discount for early payment.
        • MonthlyChargeForLatePayment Double (99.99%)
        • % monthly charge for late payment.
        • PriceLevelString (3)
        • Default price level.
        • TaxCode
        • The following set of information pulls through details for the default TaxCodes
          • UID GUID (36)
          • Foreign Key: Unique tax code identifier in the form of a guid
          • Code String (3)
          • 3 digit code assigned to the tax code.
          • URI String
          • Uniform resource identifier associated with the Tax code object
        • UseCustomerTaxCodeBoolean
        • True indicates to use the customer tax code.
          False indicates do not use the customer tax code.
        • FreightTaxCode
        • The following set of information pulls through the details for freight Tax Codes
          • UID GUID (36)
          • Foreign Key: Unique freight tax code identifier in the form of a guid
          • Code String (3)
          • 3 digit code assigned to the freight tax code.
          • URI String
          • Uniform resource identifier associated with the freight tax code object.
        • CreditLimit Decimal (13.6)
        • Default customer contact credit limit.
    • Purchases
    • The following set of information pulls through system preferences for purchases.
      • Terms
      • The following set of information pulls through default supplier terms.
        • PaymentIsDueString
        • Default Terms of Payment definitions:
          CashOnDelivery
          PrePaid
          InAGivenNumberOfDays
          OnADayOfTheMonth
          NumberOfDaysAfterEOM
          DayOfMonthAfterEOM
        • DiscountDate Integer
        • Number of early payment discount days.
        • BalanceDueDate Integer
        • Number of days until due.
        • DiscountForEarlyPayment Double (99.99%)
        • % discount for early payment.
        • TaxCode
        • The following set of information pulls through details for the default TaxCode
          • UID GUID (36)
          • Foreign Key: Unique tax code identifier in the form of a guid
          • Code String (3)
          • 3 digit code assigned to the tax code.
          • URI String
          • Uniform resource identifier associated with the Tax code object
        • UseSupplierTaxCodeBoolean
        • True indicates to use the supplier tax code.
          False indicates not to use the supplier tax code.
        • FreightTaxCode
        • The following set of information pulls through the details for default freight Tax Codes
          • UID GUID (36)
          • Foreign Key: Unique freight tax code identifier in the form of a guid
          • Code String (3)
          • 3 digit code assigned to the freight tax code.
          • URI String
          • Uniform resource identifier associated with the freight tax code object.
        • CreditLimit Decimal (13.6)
        • Default customer contact credit limit.
    • Timesheets
    • The following set of information pulls through details for Timesheets
      ONLY AVAILABLE FOR ACCOUNTRIGHT PLUS, PREMIER
      Null if preference is not turned on
      • UseTimesheetsFor String
      • Can consist of either TimeBillingAndPayroll or Payroll.
      • WeekStartsOn String
      • Day the week starts on ie: Monday, Tuesday, Wednesday.
    • RowVersionString
    • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.

Example json GET response

  • {
  • "System" : {
    • "CategoryTracking" : "Off",
    • "TransactionsCannotBeChangedMustBeReversed" : false,
    • "LockPeriodPriorTo" : "2013-07-01T00:00:00",
    • "UseAlphaAccountIdentifier" : false
    • },
  • "ReportsAndForms" : {
    • "ReportTaxablePayments" : false,
    • "EmailDefaults" : {
    • "Sales" : {
      • "Invoice" : {
        • "Subject" : "From Clearwater Pty Ltd",
        • "Message" : "Please contact us immediately if you are unable to detach or download your Invoice. Thank you.",
        • "IncludeNumberInSubject": true },
      • "Order": {
        • "Subject" : "From Clearwater Pty Ltd",
        • "Message" : "Please contact us immediately if you are unable to detach or download your Order. Thank you.",
        • "IncludeNumberInSubject": true },
      • "Quote": {
        • "Subject" : "From Clearwater Pty Ltd",
        • "Message" : "Please contact us immediately if you are unable to detach or download your Quote. Thank you.",
        • "IncludeNumberInSubject": true },
      • },
    • "Purchases": {
      • "Bill": {
        • "Subject" : "From Clearwater Pty Ltd",
        • "Message" : "Please contact us immediately if you are unable to detach or download your Bill. Thank you.",
        • "IncludeNumberInSubject": true },
      • "Order": {
        • "Subject" : "From Clearwater Pty Ltd",
        • "Message" : "Please contact us immediately if you are unable to detach or download your Order. Thank you.",
        • "IncludeNumberInSubject": true },
      • "Quote": {
        • "Subject" : "From Clearwater Pty Ltd",
        • "Message" : "Please contact us immediately if you are unable to detach or download your Quote. Thank you.",
        • "IncludeNumberInSubject": true },
      • }
    • }
    • "PaySlips": {
      • "Subject" : "From Clearwater Pty Ltd",
      • "Message" : "Please contact us immediately if you are unable to detach or download your Payslip. Thank you.",
      • },
    • "CompanySendEmailProfile": {
    • "OnlineEmailingEnabled": true,
    • "FromName": "John Clearwater",
    • "ReplyToEmail": "john@clearwater.com"
    • }
    • },
  • "Banking" : {
    • "PreferToReceiveMoneyIntoUndepositedFunds" : false
    • },
  • "Sales" : {
    • "Terms" : {
      • "PaymentIsDue" : "DayOfMonthAfterEOM",
      • "DiscountDate" : 1,
      • "BalanceDueDate" : 30,
      • "DiscountForEarlyPayment" : 0,
      • "MonthlyChargeForLatePayment" : 0,
      • "PriceLevel" : "LevelA",
      • "TaxCode" : {
        • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
        • },
      • "UseCustomerTaxCode" : false,
      • "FreightTaxCode" : {
        • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
        • },
      • "CreditLimit" : 0
      • }
    • },
  • "Purchases" : {
    • "Terms" : {
      • "PaymentIsDue" : "DayOfMonthAfterEOM",
      • "DiscountDate" : 1,
      • "BalanceDueDate" : 30,
      • "DiscountForEarlyPayment" : 0,
      • "TaxCode" : {
        • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
        • },
      • "UseSupplierTaxCode" : false,
      • "FreightTaxCode" : {
        • "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
        • },
      • "CreditLimit" : 0
      • }
    • },
  • "Timesheets" : {
    • "UseTimesheetsFor" : "Payroll",
    • "WeekStartsOn" : "Monday"
    • },
  • "RowVersion" : "-3991596644733812736"
  • }
Hypermedia in the MYOB Business API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the MYOB Business API in our best practice guide.