MYOB Endpoint: CategoryRegister: Difference between revisions
No edit summary |
No edit summary |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The MYOB '''CategoryRegister''' endpoint allows you to access summarised activity totals for your [[MYOB Endpoint: Accounts|chart of accounts]] against each [[MYOB Endpoint: Categories|category]]. | The MYOB '''CategoryRegister''' [[MYOB Endpoints|endpoint]] allows you to access summarised activity totals for your [[MYOB Endpoint: Accounts|chart of accounts]] against each [[MYOB Endpoint: Categories|category]]. | ||
An entry will exist for each account, category, year and month combination. | An entry will exist for each account, category, year and month combination. | ||
== Notes == | |||
# The CategoryRegister endpoint will not contain any values for future financial years. It usually contains values only for the '''current''', '''last''' and '''next''' financial year. To see more recent data, you will need to ensure you rollover your financial year. | |||
| Line 9: | Line 14: | ||
The following fields are available for the CategoryRegister endpoint. | The following fields are available for the CategoryRegister endpoint. | ||
;DataFile | |||
:A [[Field Type: Record|record field]] that provides the [[Field: DataFile|DataFile]] associated with the data. | |||
;UID | ;UID | ||
:A [[Field Type: GUID|GUID field]] representing the internal id of the | :A [[Field Type: GUID|GUID field]] representing the internal id of the CategoryRegister entry. This field cannot be linked to anything else. | ||
; | ;Category | ||
:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Categories|category]] to which this entry applies. | :A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Categories|category]] to which this entry applies. | ||
| Line 20: | Line 28: | ||
;DatesByMonthID | ;DatesByMonthID | ||
:A [[Field Type: Text|text field]] used to link to the [[Endpoint: | :A [[Field Type: Text|text field]] used to link to the [[Endpoint: DatesByMonth|DatesByMonth]] endpoint. | ||
;Year | ;Year | ||
| Line 33: | Line 41: | ||
;YearEndActivity | ;YearEndActivity | ||
:A [[Field Type: Decimal|decimal field]] that represents the total year end activity (e.g. period 13) | :A [[Field Type: Decimal|decimal field]] that represents the total year end activity (e.g. period 13) | ||
;TotalAmount | |||
:A [[Field Type: Decimal|decimal field]] that represents the total amount for the period. | |||
:It is equal Activity + YearEndActivity. | |||
;RowVersion | ;RowVersion | ||
| Line 40: | Line 52: | ||
== MYOB API == | == MYOB API == | ||
For a detailed run through of the | For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/generalledger/categoryregister/ MYOB API]. | ||
== Related Fields == | |||
:[[MYOB Field: Accounts|Accounts]] | |||
:[[MYOB Field: Categories|Categories]] | |||
== Related Endpoints== | |||
:[[MYOB Endpoint: Accounts|Accounts]] | |||
:[[Endpoint: DatesByMonth|DatesByMonth]] | |||
:[[MYOB Endpoint: Categories|Categories]] | |||
== Related Topics == | == Related Topics == | ||
:[[ | :[[MYOB Models]] | ||
:[[MYOB | :[[MYOB Endpoints]] | ||
: | == Changes Log == | ||
;OdataLink v2024.5.31.209 | |||
:Hot fix to the endpoint to resolve performance issue that requested too much data. | |||