MYOB Endpoint: Accounts: Difference between revisions

(21 intermediate revisions by the same user not shown)

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

Line 47:

Line 53:

;Number

:A [[Field Type: ~~Integers~~|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.

: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

Line 53:

Line 59:

;ParentAccount

:A [[Field Type: Record|record field]] that identifies the ~~parent of this~~ [[MYOB ~~Endpoint~~: Accounts|account]].

:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Accounts|parent account]] of this account.

;IsActive

Line 59:

Line 65:

;TaxCode

:A [[Field Type: Record|record field]] that identifies the default [[MYOB ~~Endpoint~~: TaxCodes|tax code]] for this account.

:A [[Field Type: Record|record field]] that identifies the default [[MYOB Field: TaxCodes|tax code]] for this account.

;Level

:A [[Field Type: ~~Integers~~|integer field]] that represents the indentation level of the account within the MYOB chart of accounts. Possible values are between 1 and 4.

: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

Line 71:

Line 77:

;BankingDetails

:A [[Field Type: Record|record field]] 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

:A [[Field Type: Boolean|true/false value]] that indicates if the account is a header or detail account.

;LastReconciledDate

:A [[Field Type: Date|date field]] that stores a date of the last time this account and all transactions attached were reconciled.

;ForeignCurrency

: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

: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.

;~~:BankingDetails.BSBNumber~~

;CompanyTradingName

::A [[Field Type: Text|text field]] used to store the ~~BSB number~~.

:A [[Field Type: Text|text field]] used to store the company trading name used on direct credit ABA files.

;~~:BankingDetails.BankAccountNumber~~

;BankCode

::A [[Field Type: Text|text field]] used to store the bank ~~account number~~.

:A [[Field Type: Text|text field]] used to store the bank code included on direct credit ABA files.

;~~:BankingDetails.BankAccountName~~

;CreateBankFiles

:::A [[Field Type: ~~Text~~|~~text field~~]] used to ~~store the~~ bank account ~~name~~.

:A [[Field Type: Boolean|true/false value]] used to indicate if this bank account is used for direct credit ABA files.

;~~:BankingDetails.CompanyTradingName~~

;DirectEntryUserId

:::A [[Field Type: Text|text field]] used to store the ~~company trading name used~~ on direct credit ABA files.

:A [[Field Type: Text|text field]] used to store the direct entry user id included on direct credit ABA files.

;~~:BankingDetails.BankCode~~

;IncludeSelfBalancingTransaction

::A [[Field Type: ~~Text~~|~~text field~~]] used to ~~store~~ the ~~bank code included on~~ direct credit ABA files.

:A [[Field Type: Boolean|true/false value]] used to indicate if the direct credit ABA files will include a self balancing transaction line.

;~~:BankingDetails.CreateBankFiles~~

;StatementParticulars

::A [[Field Type: ~~Boolean~~|~~true/false value~~]] used to ~~indicate if this bank account is used for~~ direct credit ABA files.

:A [[Field Type: Text|text field]] used to store the statement particulars included on direct credit ABA files.

;~~:BankingDetails.DirectEntryUserId~~

;StatementCode

::A [[Field Type: Text|text field]] used to store the ~~direct entry user id~~ included on direct credit ABA files.

:A [[Field Type: Text|text field]] used to store the statement code included on direct credit ABA files.

;~~:BankingDetails.IncludeSelfBalancingTransaction~~

;StatementReference

::A [[Field Type: ~~Boolean~~|~~true/false value~~]] used to ~~indicate if~~ the direct credit ABA files ~~will include a self balancing transaction line~~.

:A [[Field Type: Text|text field]] used to store the statement reference included on direct credit ABA files.

~~;:BankingDetails.StatementParticulars~~

~~::A [[Field Type: Text|text field]] used to store the statement particulars included on direct credit ABA files.~~

~~;:BankingDetails.StatementCode~~

== MYOB API ==

~~::A [[Field Type: Text|text field]] used to store the statement code included on direct credit ABA files.~~

;:~~BankingDetails~~.~~StatementReference~~

For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/generalledger/account/ MYOB API].

~~::A [[Field Type: Text|text field~~]~~] used to store the statement reference included on direct credit ABA files~~.

~~;IsHeader~~

~~:A [[Field Type: Boolean|true/false value]] that indicates if the account is a header or detail account.~~

~~;LastReconciledDate~~

== Related Fields ==

~~:A [[Field Type: Date|date field]] that stores a date of the last time this account and all transactions attached were reconciled.~~

~~;ForeignCurrency~~

:[[MYOB Field: Accounts|Accounts]]

:A [[Field ~~Type~~: ~~Record~~|~~record field~~]] ~~that identifies the~~ [[MYOB ~~Endpoint~~: ~~Currency~~|~~currency~~]] ~~used when posting transactions to this account.~~

:[[MYOB Field: Currencies|Currencies]]

:[[MYOB Field: TaxCodes|TaxCodes]]

~~;RowVersion~~

~~:A [[Field Type: Row Version|row version field]].~~

== Related Topics ==

~~:[[Endpoints]]~~

:[[MYOB Models]]

:[[MYOB ~~Endpoint: Currency~~]]

:[[MYOB Endpoints]]

:[[MYOB ~~Endpoint: TaxCodes~~]]

@@ 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
@@ Line 47: / Line 53: @@
 ;Number
-:A [[Field Type: Integers|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.
+: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
@@ Line 53: / Line 59: @@
 ;ParentAccount
-:A [[Field Type: Record|record field]] that identifies the parent of this [[MYOB Endpoint: Accounts|account]].
+:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Accounts|parent account]] of this account.
 ;IsActive
@@ Line 59: / Line 65: @@
 ;TaxCode
-:A [[Field Type: Record|record field]] that identifies the default [[MYOB Endpoint: TaxCodes|tax code]] for this account.
+:A [[Field Type: Record|record field]] that identifies the default [[MYOB Field: TaxCodes|tax code]] for this account.
 ;Level
-:A [[Field Type: Integers|integer field]] that represents the indentation level of the account within the MYOB chart of accounts. Possible values are between 1 and 4.
+: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
@@ Line 71: / Line 77: @@
 ;BankingDetails
-:A [[Field Type: Record|record field]] 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
+:A [[Field Type: Boolean|true/false value]] that indicates if the account is a header or detail account.
+;LastReconciledDate
+:A [[Field Type: Date|date field]] that stores a date of the last time this account and all transactions attached were reconciled.
+;ForeignCurrency
+: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
+: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.
-;:BankingDetails.BSBNumber
+;CompanyTradingName
-::A [[Field Type: Text|text field]] used to store the BSB number.
+:A [[Field Type: Text|text field]] used to store the company trading name used on direct credit ABA files.
-;:BankingDetails.BankAccountNumber
+;BankCode
-::A [[Field Type: Text|text field]] used to store the bank account number.
+:A [[Field Type: Text|text field]] used to store the bank code included on direct credit ABA files.
-;:BankingDetails.BankAccountName
+;CreateBankFiles
-:::A [[Field Type: Text|text field]] used to store the bank account name.
+:A [[Field Type: Boolean|true/false value]] used to indicate if this bank account is used for direct credit ABA files.
-;:BankingDetails.CompanyTradingName
+;DirectEntryUserId
-:::A [[Field Type: Text|text field]] used to store the company trading name used on direct credit ABA files.
+:A [[Field Type: Text|text field]] used to store the direct entry user id included on direct credit ABA files.
-;:BankingDetails.BankCode
+;IncludeSelfBalancingTransaction
-::A [[Field Type: Text|text field]] used to store the bank code included on direct credit ABA files.
+:A [[Field Type: Boolean|true/false value]] used to indicate if the direct credit ABA files will include a self balancing transaction line.
-;:BankingDetails.CreateBankFiles
+;StatementParticulars
-::A [[Field Type: Boolean|true/false value]] used to indicate if this bank account is used for direct credit ABA files.
+:A [[Field Type: Text|text field]] used to store the statement particulars included on direct credit ABA files.
-;:BankingDetails.DirectEntryUserId
+;StatementCode
-::A [[Field Type: Text|text field]] used to store the direct entry user id included on direct credit ABA files.
+:A [[Field Type: Text|text field]] used to store the statement code included on direct credit ABA files.
-;:BankingDetails.IncludeSelfBalancingTransaction
+;StatementReference
-::A [[Field Type: Boolean|true/false value]] used to indicate if the direct credit ABA files will include a self balancing transaction line.
+:A [[Field Type: Text|text field]] used to store the statement reference included on direct credit ABA files.
-;:BankingDetails.StatementParticulars
-::A [[Field Type: Text|text field]] used to store the statement particulars included on direct credit ABA files.
-;:BankingDetails.StatementCode
+== MYOB API ==
-::A [[Field Type: Text|text field]] used to store the statement code included on direct credit ABA files.
-;:BankingDetails.StatementReference
+For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/generalledger/account/ MYOB API].
-::A [[Field Type: Text|text field]] used to store the statement reference included on direct credit ABA files.
-;IsHeader
-:A [[Field Type: Boolean|true/false value]] that indicates if the account is a header or detail account.
-;LastReconciledDate
+== Related Fields ==
-:A [[Field Type: Date|date field]] that stores a date of the last time this account and all transactions attached were reconciled.
-;ForeignCurrency
+:[[MYOB Field: Accounts|Accounts]]
-:A [[Field Type: Record|record field]] that identifies the [[MYOB Endpoint: Currency|currency]] used when posting transactions to this account.
+:[[MYOB Field: Currencies|Currencies]]
+:[[MYOB Field: TaxCodes|TaxCodes]]
-;RowVersion
-:A [[Field Type: Row Version|row version field]].
 == Related Topics ==
-:[[Endpoints]]
+:[[MYOB Models]]
-:[[MYOB Endpoint: Currency]]
+:[[MYOB Endpoints]]
-:[[MYOB Endpoint: TaxCodes]]