MYOB Endpoint: Accounts: Difference between revisions

← Older edit

@@ Line 1: / Line 1: @@
 == Overview ==
-The MYOB '''Accounts''' endpoint allows you to access the chart of accounts located within MYOB.
+The MYOB '''Accounts''' [[MYOB Endpoints|endpoint]] allows you to access the chart of accounts located within MYOB.
+Note an alternate endpoint named [[MYOB Endpoint: AccountsTable|AccountsTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
 == Fields ==
 The following fields are available for the Accounts endpoint.
+;DataFile
+:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record.
 ;UID
-:Provides the internal id of an account in the form of a GUID. This field can be used to link to other data.
+:A [[Field Type: GUID|GUID field]] representing the internal id of an account. This field can be used to link to other endpoints.
 ;Name
-:Represents the account name of an account.
+:A [[Field Type: Text|text field]] used as the account name.
 ;DisplayID
-:Represents the account number of an account.
+:A [[Field Type: Text|text field]] used as the account number.
 ;Classification
-:Identifies the high-level type of account. Possible values are: Asset, Liability, Equity, Income, CostOfSales, Expense, OtherIncome, OtherExpense.
+:A [[Field Type: Text|text field]] that identifies the high-level type of account. Possible values are:
+::Asset
+::Liability
+::Equity
+::Income
+::CostOfSales
+::Expense
+::OtherIncome
+::OtherExpense
 ;Type
-:Identifies the more detailed type of an account. Possible values are:
+:A [[Field Type: Text|text field]] that identifies the more detailed type of an account. Possible values are:
+::AccountReceivable
+::AccountsPayable
+::Bank
+::CostOfSales
+::CreditCard
+::Equity
+::Expense
+::FixedAsset
+::Income
+::LongTermLiability
+::OtherAsset
+::OtherCurrentAsset
+::OtherCurrentLiability
+::OtherExpense
+::OtherIncome
+::OtherLiability
 ;Number
-:Represents the last digits of an account number that follows the dash.  For example, 4-1234 will have a number of 1234.
+:A [[Field Type: Integer|integer field]] that represents the last digits of an account number that follows the dash.  For example, 4-1234 will have a number of 1234.
 ;Description
-:Represents the more detailed description of an account.
+:A [[Field Type: Text|text field]] used as the account description.
 ;ParentAccount
-:Returns an object that identifies the parent of this account.
+:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Accounts|parent account]] of this account.
 ;IsActive
-:Is a true/false value indicating if the account is active and useable within MYOB.
+:A [[Field Type: Boolean|true/false value]] that indicates if the account is active and useable within MYOB.
 ;TaxCode
-:Returns an object that identifies the default tax code for this account.
+:A [[Field Type: Record|record field]] that identifies the default [[MYOB Field: TaxCodes|tax code]] for this account.
 ;Level
-:Is a value between 1 to 4 that represents the indentation level of the account within the MYOB chart of accounts.
+:A [[Field Type: Integer|integer field]] that represents the indentation level of the account within the MYOB chart of accounts. Possible values are between 1 and 4.
 ;OpeningBalance
-:Represents the original opening balance value for this account when first created.
+:A [[Field Type: Decimal|decimal field]] that represents the original opening balance value for this account when first created.
 ;CurrentBalance
-:Represents the closing balance value for this account as at the end-of-time.
+:A [[Field Type: Decimal|decimal field]] that represents the closing balance value for this account as at the end-of-time.
 ;BankingDetails
-:Returns an object containing banking details of the account (for Bank Accounts only).
+:A [[Field Type: Record|record field]] containing [[#BankingDetails Fields|banking details]] of the account (for Bank Accounts only). It provides access to banking information used when creating ABA files or processing bank feeds.
 ;IsHeader
-:Is a true/false value indicating if the account is a header or detail account.
+:A [[Field Type: Boolean|true/false value]] that indicates if the account is a header or detail account.
 ;LastReconciledDate
-:Stores a date of the last time this account and all transactions attached were reconciled.
+:A [[Field Type: Date|date field]] that stores a date of the last time this account and all transactions attached were reconciled.
 ;ForeignCurrency
-:Returns an object identying the foreign currency account used when posting transactions to this account.
+:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Currencies|currency]] used when posting transactions to this account.
+;LastModified
+:A [[Field Type: DateTimeOffset|date time field]] that stores the date/time this activity was last modified.
 ;RowVersion
-:Returns the [[MYOB Field: RowVersion|row version]].
+:A [[Field Type: Row Version|row version field]].
+== BankingDetails Fields ==
+The [[#Fields|BankingDetails]] field includes the following fields. It provides access to banking information used when creating ABA files or processing bank feeds.
+;BSBNumber
+:A [[Field Type: Text|text field]] used to store the BSB number.
+;BankAccountNumber
+:A [[Field Type: Text|text field]] used to store the bank account number.
+;BankAccountName
+:A [[Field Type: Text|text field]] used to store the bank account name.
+;CompanyTradingName
+:A [[Field Type: Text|text field]] used to store the company trading name used on direct credit ABA files.
+;BankCode
+:A [[Field Type: Text|text field]] used to store the bank code included on direct credit ABA files.
+;CreateBankFiles
+:A [[Field Type: Boolean|true/false value]] used to indicate if this bank account is used for direct credit ABA files.
+;DirectEntryUserId
+:A [[Field Type: Text|text field]] used to store the direct entry user id included on direct credit ABA files.
+;IncludeSelfBalancingTransaction
+:A [[Field Type: Boolean|true/false value]] used to indicate if the direct credit ABA files will include a self balancing transaction line.
+;StatementParticulars
+:A [[Field Type: Text|text field]] used to store the statement particulars included on direct credit ABA files.
+;StatementCode
+:A [[Field Type: Text|text field]] used to store the statement code included on direct credit ABA files.
+;StatementReference
+:A [[Field Type: Text|text field]] used to store the statement reference included on direct credit ABA files.
+== MYOB API ==
+For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/generalledger/account/ MYOB API].
+== Related Fields ==
+:[[MYOB Field: Accounts|Accounts]]
+:[[MYOB Field: Currencies|Currencies]]
+:[[MYOB Field: TaxCodes|TaxCodes]]
+== Related Topics ==
+:[[MYOB Models]]
+:[[MYOB Endpoints]]