We have just introduced a new endpoint that will allow us to have better visibility over the API and audit the transactions where needed. The new endpoint JournalTransactionHistory will allow us to see what transactions have been Added, Edited, Deleted, Reversed and System Edited within the program.
Please note: In order to view this endpoint you will need to have the user access Administrator or Accountant/Bookkeeper. This is because this report will access a wide range of endpoints to access this data.
Example request:
URL https://api.myob.com/accountright/ | Supports |
/{cf_uri}/Report/JournalTransactionHistory | GET |
Example Response:
{
"UID": "07c780ed-3765-49da-96f5-827fedXXXXXX",
"DisplayID": "APICR3",
"JournalType": "Sale",
"SourceTransaction": {
"UID": "09efe41f-adbf-4b45-b562-8881e5XXXXX",
"TransactionType": "Invoice",
"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e7XXXXXX/Sale/Invoice/09efe41f-adbf-4b45-b562-8881e519129e"
},
"DateOccurred": "2022-12-08T00:00:00",
"DatePosted": "2022-12-07T22:56:21.057",
"Description": "Sale; Hannah Test (do not use)",
"OperationType": "Edited",
"GroupUID": "adb1206d-1eeb-4990-b3dc-d1a75314c813",
"Lines": [
{
"Account": {
"UID": "d873c7ac-438c-4466-aae5-9c8d45ce0a52",
"Name": "Trade Debtors",
"DisplayID": "1-1700",
"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e7XXXXXX/GeneralLedger/Account/d873c7ac-438c-4466-aae5-9c8d45ce0a52"
},
"Amount": 71.500000,
"IsCredit": true,
"Job": null,
"LineDescription": "",
"ReconciledDate": null,
"UnitCount": null
},
{
"Account": {
"UID": "ba60da97-26df-4700-9435-3752f65c2826",
"Name": "GST Collected",
"DisplayID": "2-3010",
"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470eXXXXX/GeneralLedger/Account/ba60da97-26df-4700-9435-3752f65c2826"
},
"Amount": 6.500000,
"IsCredit": false,
"Job": null,
"LineDescription": "",
"ReconciledDate": null,
"UnitCount": null
},
{
"Account": {
"UID": "8d0e7f6d-da41-4c8c-8fbb-cc77f1e986d7",
"Name": "Sales - Spring Water",
"DisplayID": "4-1100",
"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e70XXXXXX/GeneralLedger/Account/8d0e7f6d-da41-4c8c-8fbb-cc77f1e986d7"
},
"Amount": 65.000000,
"IsCredit": false,
"Job": null,
"LineDescription": "credit ",
"ReconciledDate": null,
"UnitCount": null
}
],
"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e70XXXXXX/Report/JournalTransactionHistory/07c780ed-3765-49da-96f5-827fedcde602",
"RowVersion": "3161051949390888960"
}
Key fields to take note of:
"OperationType": "XXXXX",
OperationType: | Example: |
Added | New entry e.g New invoice |
System | System edited |
Edited | Existing entry edited |
Deleted | Entry Deleted |
Reversed | an entry has been reversed not deleted |
Filtering
You can only $filter on these properties:
- UID
- JournalType
- DateOccurred
- DatePosted
- SourceTransaction/UID
- OperationType
- GroupUID
You can only $orderby for one of the below properties:
- DateOccurred
- DatePosted
If you have any questions, feel to log a ticket with the Customisation & Integration Team
Comments
0 comments
Article is closed for comments.