### Example GET Response for Purchase Order Source: https://developer.myob.com/api/myob-business-api/v2/purchase/order/order_item An example JSON response for a GET request to retrieve a purchase order, illustrating the structure and data. ```APIDOC ## GET Purchase Order Example Response ### Response Example (200 OK) ```json { "UID": "0c55818c-855a-452e-be92-d8a1595fc5e9", "Number": "00000919", "Date": "2014-08-21T00:00:00", "SupplierInvoiceNumber": "AAA000099899819", "Supplier": { "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29", "Name": "Huston & Huston Packaging", "DisplayID": "SUPP000004", "URI": "{cf_uri}/Contact/Supplier/63b984e5-241e-4c1a-bfe1-7868a69f5e29" }, "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130", "Terms": { "PaymentIsDue": "DayOfMonthAfterEOM", "DiscountDate": 1, "BalanceDueDate": 30, "DiscountForEarlyPayment": 2, "DiscountExpiryDate": "2014-09-01T00:00:00", "Discount": 2, "DiscountForeign": null, "DueDate": "2014-09-30T00:00:00" }, "IsTaxInclusive": true, "Lines": [ { "RowID": 533, "Type": "Transaction", "Description": "Cooler Filter Large", "BillQuantity": 5, "ReceivedQuantity": 5, "UnitPrice": 50.22, "UnitPriceForeign": null, "DiscountPercent": 0, "Total": 251.10, "TotalForeign": null, "Item": { "UID": "ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb", "Number": 120, "Name": "Cooler Filter Large", "URI": "{cf_uri}/Inventory/Item/ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb" }, "Job": null, "TaxCode": { "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8", "Code": "GST", "URI": "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8" }, "Location": { "UID": "04ad68a3-91f5-4739-8b83-13f86ecd2e33", "Identifier": "Location1", "Name": "Primary Location", "URI": "{cf_uri}" }, "RowVersion": "8653760884428439681" } ], "IsReportable": false, "Subtotal": 251.10, "SubtotalForeign": null, "Freight": 0, "FreightForeign": null, "FreightTaxCode": { "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8", "Code": "GST", "URI": "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8" }, "TotalTax": 22.83, "TotalTaxForeign": null, "TotalAmount": 251.10, "TotalAmountForeign": null, "Category": null, "Comment": "Thank you!", "ShippingMethod": "Federal Express", "JournalMemo": "Purchase; Huston & Huston Packaging", "PromisedDate": null, "AppliedToDate": 0, "AppliedToDateForeign": null, "OrderDeliveryStatus": "Print", "BalanceDueAmount": 251.10, "BalanceDueAmountForeign": null, "Status": "ConvertedToBill", "LastPaymentDate": null, "ForeignCurrency": null, "CurrencyExchangeRate": null, "URI": "{cf_uri}/Purchase/Bill/Order/0c55818c-855a-452e-be92-d8a1595fc5e9", "RowVersion": "8330251935751864320" } ``` **Note:** The `{cf_uri}` is provided by the `businessId` parameter. ``` -------------------------------- ### Example JSON GET Response for Job Projects Source: https://developer.myob.com/api/exo/endpoints/jobproject This is an example of the JSON response structure when retrieving job projects via a GET request. It shows the attributes and their corresponding values for a single job project. ```json { "0": [ { "projectcode": "PR01", "projecttitle": "READY VEHICLES FOR SALE", "active": true, "description": "Fit out of the new workshop in Kent Street ready for opening", "id": 1, "href": "{URI}https://exo-stage.api.myob.com/jobproject/1" } ] } ``` -------------------------------- ### Profit and Loss Summary GET Request Example Source: https://developer.myob.com/api/myob-business-api/v2/report/profitandlosssummary Example of a GET request to retrieve the Profit and Loss Summary with specified parameters. The {cf_uri} is derived from the businessId. ```http GET /{cf_uri}/Report/ProfitAndLossSummary?StartDate=2017-07-01&EndDate=2017-09-30&ReportingBasis=Cash&YearEndAdjust=true ``` -------------------------------- ### Sale Order Service - Example GET Response Source: https://developer.myob.com/api/myob-business-api/v2/sale/order/order_service An example JSON response for retrieving a service sale order. ```APIDOC ## GET /Sale/Order/Service/{businessId} ### Response Example (Success - 200 OK) ```json { "UID" : "ce2379d6-ab03-4b57-aac4-a393bafa5e47", "Number" : "00000014", "Date" : "2014-05-29T00:00:00", "ShipToAddress" : "The Motor Company 63 Driveaway Road Edwardstown NSW 2112 Australia", "CustomerPurchaseOrderNumber" : null, "Customer" : { "UID" : "f005d6df-eada-4a40-9908-1d982f047d05", "Name" : "The Motor Company", "DisplayID" : "CUS000010", "URI" : "{cf_uri}/Contact/Customer/f005d6df-eada-4a40-9908-1d982f047d05" }, "Terms" : { "PaymentIsDue" : "DayOfMonthAfterEOM", "DiscountDate" : 1, "BalanceDueDate" : 30, "DiscountForEarlyPayment" : 5, "MonthlyChargeForLatePayment" : 7, "DiscountExpiryDate" : "2014-06-01T00:00:00", "Discount" : 5, "DiscountForeign" : null, "DueDate" : "2014-06-30T00:00:00", "FinanceCharge" : 6.08, "FinanceChargeForeign" : null }, "IsTaxInclusive" : true, "Lines" : [ { "RowID" : 1, "Type" : "Header", "Description" : "General Services", "RowVersion" : "-4657084081930764299" }, { "RowID" : 2, "Type" : "Transaction", "Description" : "Planned service per due date", "Total" : 100, "TotalForeign" : null, "Account" : { "UID" : "89f2b352-c147-4e35-b4b5-7a4e21989e5e", "Name" : "Sales - Water Cooler", "DisplayID" : "4-1300", "URI" : "{cf_uri}/GeneralLedger/Account/89f2b352-c147-4e35-b4b5-7a4e21989e5e" }, "Job" : null, "TaxCode" : { "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8", "Code" : "GST", "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8" }, "RowVersion" : "-6148539391267569664" } ], "Subtotal" : 100, "SubtotalForeign" : null, "Freight" : 0, "FreightForeign" : null, "FreightTaxCode" : { "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8", "Code" : "GST", "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8" }, "TotalTax" : 9.09, "TotalTaxForeign" : null, "TotalAmount" : 100, "TotalAmountForeign" : null, "Category" : { "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1", "Name" : "Melbourne", "DisplayID" : "CAT101", "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1" }, "Salesperson" : { "UID" : "5383ff72-4bb6-4d8b-bcf0-8b10857455d8", "Name" : "Mary Jones", "DisplayID" : "EMP00001", "URI" : "{cf_uri}/Contact/Employee/5383ff72-4bb6-4d8b-bcf0-8b10857455d8" }, "Comment" : "Thank you!", "ShippingMethod" : "Australia Post", "JournalMemo" : "Sale; The Motor Company", "PromisedDate" : "2014-06-06T00:00:00", "DeliveryStatus" : "Print", "ReferralSource" : "Yellow Pages", "AppliedToDate" : 0, "AppliedToDateForeign" : null, "BalanceDueAmount" : 100, "BalanceDueAmountForeign" : null, "Status" : "Open", "LastPaymentDate" : null, "ForeignCurrency" : null, "CurrencyExchangeRate" : null, "LastModified" : "2019-05-01T00:47:43.757", "URI" : "{cf_uri}/Sale/Order/Service/ce2379d6-ab03-4b57-aac4-a393bafa5e47", "RowVersion" : "-6292654579343425536" } ``` **Note:** The `{cf_uri}` in the example response is a placeholder for the `businessId` provided in the API request. ``` -------------------------------- ### Profit and Loss Summary GET Response Example Source: https://developer.myob.com/api/myob-business-api/v2/report/profitandlosssummary Example JSON response structure for the ProfitAndLossSummary endpoint, detailing account breakdowns and totals. ```json { "StartDate" : "2018-07-01T00:00:00", "EndDate" : "2018-09-30T23:59:59", "ReportingBasis" : "Cash", "YearEndAdjust" : true, "TaxCodeBreakdown" : [ { "AccountTotal" : 762.72, "Account" : { "UID" : "59fc77d9-fadc-47c3-a4bf-be9d1ff491bc", "Name" : "Sales - Spring Water", "DisplayID" : "4-1100", "URI" : "{cf_uri}/GeneralLedger/Account/59fc77d9-fadc-47c3-a4bf-be9d1ff491bc" } }, { "AccountTotal" : 505.31, "Account" : { "UID" : "730d3678-7ecf-4d5b-b28d-3677b780b2be", "Name" : "Sales - Carbonated Water", "DisplayID" : "4-1200", "URI" : "{cf_uri}/GeneralLedger/Account/730d3678-7ecf-4d5b-b28d-3677b780b2be" } } ], "URI" : "{cf_uri}/Report/ProfitAndLossSummary?StartDate=2017-07-01&EndDate=2017-09-30&ReportingBasis=Cash&YearEndAdjust=true" } ``` -------------------------------- ### Example GET Response for Spend Money Attachments Source: https://developer.myob.com/api/myob-business-api/v2/banking/spend_money/spend-money-attachments Illustrates the structure of a successful GET request response for spend money attachments, including attachment details and URIs. ```json { "UID" : "4e03c825-d2cc-4318-97f2-9aea19766ab2", "Attachments" : [ { "UID" : "ac7f6c6e-500a-4828-8602-56b04304364a", "OriginalFileName" : "94bcf0bb-913e-4da9-8e8f-764cff49908c-item.pdf", "ThumbnailUri" : "https://production-alex....ca401631b7a122c706b22b505c19f080e", "FileUri" : "https://production-alex....ac6c9a969318ac759498aa7fc07b"", "FileBase64Content" : null, "URI" : "{cf_uri}/Banking/SpendMoneyTxn/4e03c825-d2cc-4318-97f2-9aea19766ab2/Attachment/ac7f6c6e-500a-4828-8602-56b04304364a", "RowVersion" : "0" } ], "URI" : "{cf_uri}/Banking/SpendMoneyTxn/4e03c825-d2cc-4318-97f2-9aea19766ab2/Attachment", "RowVersion" : "0" } ``` -------------------------------- ### Advert Type GET Response Example Source: https://developer.myob.com/api/exo/endpoints/list-endpoints/adverttype This is an example of a JSON response when retrieving advert types. It includes details like description, process ID, and href. ```json { "description" : "APRIL ADVERTISEMENT", "processid" : 2, "id" : 2, "href" : "{URI}adverttype/2" } ``` -------------------------------- ### GET /feeds/{externalId} Response Example Source: https://developer.myob.com/api/myob-transactions-api/feeds Example response body for the GET /feeds/{externalId} endpoint, showing details for a specific feed. ```json { "feeds": [ { "feedId":"B000000427", "externalId":"tyf6q4-d6bnd8-7op81z-JI4gHm", "status": "Cancelled" } ] } ``` -------------------------------- ### Example EXO API Request Headers Source: https://developer.myob.com/api/exo/exo-api-overview/authentication These are example headers required for authenticating requests to the EXO API. Replace placeholder values with your actual credentials. ```text Authorization: Basic RXhvQWRtaW46RXhvQW!288H1 x-myobapi-key: ABCta353c5R6YXRvcjo= x-myobapi-exotoken: 123AA353c5R6YXRsTAQ18*% ``` -------------------------------- ### Example JSON GET Response for Company Files Source: https://developer.myob.com/api/myob-business-api/v2/company-files This is an example of the JSON structure returned when requesting company file information. It includes details like file ID, name, product version, and subscription information. ```json { "Id": "770ed441-0abb-4832-bd2b-2032d035656e", "Name": "API Team Sandbox", "LibraryPath": "API Team Sandbox", "ProductVersion": "2021.4", "ProductLevel" : { "Code" : 50, "Name" : "Premier" }, "Subscription": { "IsTrial": False, "Product": { "ProductLine": "MYOB Essentials (New)", "Name": "Accounting + Payroll", "DisplayName": "Accounting + Payroll", "Id": "52" } }, "CheckedOutDate" : null, "CheckedOutBy" : null, "Uri": "{cf_uri}", "Country": "AU," "SerialNumber": "xxxxxxxxxxxx", "UIAccessFlags": 2, } ``` -------------------------------- ### GET /feeds Response Example Source: https://developer.myob.com/api/myob-transactions-api/feeds Example response body for the GET /feeds endpoint, showing a list of feeds with their IDs, external IDs, and statuses. ```json { "feeds": [ { "feedId":"B000000426, "externalId":"ty79v3-452iU-7op81z-AwMDIxMj", "status": "BankFeedReady" }, { "feedId":"B000000427, "externalId":"tyf6q4-d6bnd8-7op81z-JI4gHm", "status": "Cancelled" } ] } ``` -------------------------------- ### Get Search Results with Parameters Source: https://developer.myob.com/api/exo/endpoints/searchtemplate This example shows how to use a search template (ID 1) to find debtors, filtering by account number and a search string. ```http GET http://exo.api.myob.com/searchtemplate/1?accno=21&q=airfil ``` -------------------------------- ### Online API Example Headers Source: https://developer.myob.com/api/myob-business-api/api-overview/headers An example of the headers used for the MYOB Online API, demonstrating the format for authentication and versioning. ```http Authorization: Bearer [OAUTH_ACCESS_TOKEN] x-myobapi-cftoken: ABCta353c5R6YXRvcjo= x-myobapi-key: [API_KEY_HERE] x-myobapi-version: v2 ``` -------------------------------- ### NZGSTReport API GET Response Example Source: https://developer.myob.com/api/myob-business-api/v2/report/nzgstreport This is an example JSON response for the NZGSTReport API when making a GET request. It includes details about the company, reporting period, and financial figures. ```json { "CompanyName" : "API Sandbox Demo NZ 1", "IrdNumber" : "12-345-678", "Address" : "25 Spring Street\r\nWellington\r\n\r\n\r\nA/C XX-YYYY-MMMMMMM-123", "PhoneNumber" : "04-123-4567", "ReportingBasis" : "Cash", "StartDate" : "2018-06-01T00:00:00", "EndDate" : "2018-11-30T00:00:00", "ReportingPeriod" : "6m", "TotalSales" : 119.98, "ZeroRatedSupplies" : 0, "NetGSTSales" : 119.98, "TotalGSTCollectedOnSales" : 15.65, "DebitAdjustments" : 0, "TotalGSTCollected" : 15.65, "TotalPurchases" : 1799.98, "TotalGSTCollectedOnPurchases" : 234.78, "CreditAdjustments" : 0, "TotalGSTCredit" : 234.78, "PaymentAmount" : 219.13, "URI" : "{cf_uri}/Report/GST/NZGSTReport?ReportingPeriod=6m&EndDate=2018-11-30&ReportingBasis=Cash&YearEndAdjust=true" } ``` -------------------------------- ### POST /transactions Request Example Source: https://developer.myob.com/api/myob-transactions-api/transactions This example demonstrates the structure of a POST request to the /transactions endpoint, including account details and a list of transactions. ```json { "account":{ "externalId":"ty79v3-452iU-7op81z-AwMDIxMj", "balance":"1089.00", "balanceUpdated":"2023-04-23T11:59:15.000922+13:00" }, "transactions":[ { "transactionId":"eyJN49EZuOCJ9", "amount":"5.95", "currency":"AUD", "narration":"Corner Store Cafe Pty", "transactionTypeCode":"WITHDRAWAL", "transactionTypeDescription":"Withdrawal", "reference":"Cafe", "originalDate":"2023-04-22T13:06:00.000000+13:00", "postedDate":"2023-04-22T23:59:59.000000+13:00" }, { "transactionId":"eytZ298Ot84tx", "amount":"79.11", "currency":"AUD", "narration":"TRF Payee 48629", "transactionTypeCode":"WITHDRAWAL", "transactionTypeDescription":"Withdrawal", "reference":"PayID 67", "originalDate":"2023-04-22T17:21:11.000000+13:00", "postedDate":"2023-04-22T23:59:59.000000+13:00" } ] } ``` -------------------------------- ### Example JSON GET Response for PayrollCategory Source: https://developer.myob.com/api/myob-business-api/v2/payroll/payroll-category This is an example of the JSON response you can expect when making a GET request to the PayrollCategory API. It shows the structure and typical values for a payroll category. ```json { "UID" : "b8cfe4cf-bb11-4013-a13d-0e4e1f3b3b41", "Name" : "Advance", "Type" : "Wage", "URI" : "{cf_uri}/PayrollCategory/Wage/b8cfe4cf-bb11-4013-a13d-0e4e1f3b3b41", "RowVersion" : "3694640544304070656" } ``` -------------------------------- ### Example JSON GET Response for Base Price Source: https://developer.myob.com/api/exo/endpoints/list-endpoints/baseprice This is an example of the JSON response structure when retrieving base price information using a GET request. It shows the 'name', 'id', and 'href' attributes. ```json { "name" : "Internet", "id" : 1, "href" : "http://exo.api.myob.com/baseprice/1" } ``` -------------------------------- ### Calculate Discounts and Fees Request Example Source: https://developer.myob.com/api/myob-business-api/v2/sale/customerpayment/calculate_discounts_fees This JSON object demonstrates the structure for a request to calculate discounts and fees. It includes an array of items, each specifying a RequestID, Sale details (UID and Type), and the PaymentDate. ```json { "Items" : [ { "RequestID" : 1, "Sale" : { "UID" : "19bc3c39-a0c1-41c8-b406-fc433f1431c0", "Type" : "Invoice" }, "PaymentDate" : "2013-11-04T00:00:00" } ] } ``` -------------------------------- ### Example Purchase Order GET Response Source: https://developer.myob.com/api/myob-business-api/v2/purchase/order This JSON object represents a typical response when retrieving a purchase order. It includes details about the order, supplier, tax, and financial information. The {cf_uri} placeholder should be replaced with the actual base URI provided by the business ID. ```json { "UID" : "c4h9e7cf-c1d9-46fa-8ca1-1613c8f4acb8", "Number" : "00000579", "Date" : "2014-08-21T00:00:00.000", "SupplierInvoiceNumber" : "AAA000005899766", "Supplier" : { "UID" : "a1ea92fd-8f22-4be6-992c-4e078871091e", "Name" : "Clear & Bright Filters", "DisplayID" : "SUPP000002", "URI" : "{cf_uri}/Contact/Supplier/a1ea92fd-8f22-4be6-992c-4e078871091e" }, "ShipToAddress" : "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130", "Terms" : { "PaymentIsDue" : "DayOfMonthAfterEOM", "DiscountDate" : 1, "BalanceDueDate" : 30, "DiscountForEarlyPayment" : 2, "DiscountExpiryDate" : "2014-09-01T00:00:00", "Discount" : 2, "DueDate" : "2014-09-30T00:00:00" }, "IsTaxInclusive" : true, "IsReportable" : false, "Subtotal" : 270.00, "Freight" : 10, "FreightTaxCode" : { "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8", "Code" : "GST", "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8" }, "TotalTax" : 28.53, "TotalAmount" : 308.53, "Category" : { "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1", "Name" : "Victoria", "DisplayID" : "API101", "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1" }, "JournalMemo" : "Purchase; Clear & Bright Filters", "AppliedToDate" : 0, "BalanceDueAmount" : 308.53, "Status" : "Open", "LastPaymentDate" : null, "OrderType" : "Item", "ForeignCurrency" : null, "URI" : "{cf_uri}/Purchase/Order/Item/c4h9e7cf-c1d9-46fa-8ca1-1613c8f4acb8", "RowVersion" : "8330251935751864320" } ``` -------------------------------- ### POST /feeds Response Example Source: https://developer.myob.com/api/myob-transactions-api/feeds Example response body for the POST /feeds endpoint after successfully creating a feed, showing the new feed details. ```json { "feeds": [ { "feedId":"B000000428, "externalId":"27fh5r-htnf5i-jsuhe4-37Ku4", "status": "BankFeedReady" }, { "feedId":"B000000429, "externalId":"36fc5a-htqm7i-Q1Ce4-34Lm7", "status": "BankFeedReady" } ] } ``` -------------------------------- ### Example GET Response for Miscellaneous Purchase Bill Source: https://developer.myob.com/api/myob-business-api/v2/purchase/bill/bill_miscellaneous An example JSON response illustrating the structure of a miscellaneous purchase bill object. ```APIDOC ## GET /Purchase/Bill/Miscellaneous/{uid} ### Description Retrieves details of a specific miscellaneous purchase bill. ### Method GET ### Endpoint `/Purchase/Bill/Miscellaneous/{uid}` ### Response #### Success Response (200) ```json { "UID" : "a96e2635-0931-4781-8756-011c2c3c9290", "Number" : "PJ000012", "Date" : "2014-08-11T00:00:00", "SupplierInvoiceNumber" : "AAA000005899869", "Supplier" : { "UID" : "9884b884-e08e-4d17-99c6-1b3c4a5b312d", "Name" : "Curbys Super Stands", "DisplayID" : "SUPP000003", "URI" : "{cf_uri}/Contact/Supplier/9884b884-e08e-4d17-99c6-1b3c4a5b312d" }, "Terms" : { "PaymentIsDue" : "DayOfMonthAfterEOM", "DiscountDate" : 1, "BalanceDueDate" : 30, "DiscountForEarlyPayment" : 0, "MonthlyChargeForLatePayment" : 0, "DiscountExpiryDate" : "2014-09-01T00:00:00", "Discount" : 0, "DueDate" : "2014-09-30T00:00:00" }, "IsTaxInclusive" : true, "IsReportable" : false, "Lines" : [ { "RowID" : 67, "Type" : "Transaction", "Description" : "Purchase of new Sofa", "Account" : { "UID" : "3f3bfe41-1a1d-4eae-9f1e-eb99566e9687", "Name" : "F & F - At Cost", "DisplayID" : "1-2110", "URI" : "{cf_uri}/GeneralLedger/Account/3f3bfe41-1a1d-4eae-9f1e-eb99566e9687" }, "Total" : 1250, "Job" : { "UID" : "b3af77fa-93d5-4c0f-8346-d81be0804f4c", "Number" : "117", "Name" : "Maintenance GM", "URI" : "{cf_uri}/GeneralLedger/Job/b3af77fa-93d5-4c0f-8346-d81be0804f4c" }, "TaxCode" : { "UID" : "38a37ae8-565c-46f8-ad4a-2a87069607f8", "Code" : "GST", "URI" : "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8" }, "RowVersion" : "8172062998840475648" } ], "Subtotal" : 1250, "TotalTax" : 113.64, "TotalAmount" : 1250, "Category" : null, "JournalMemo" : "Purchase; Curbys Super Stands", "AppliedToDate" : 1000, "BalanceDueAmount" : 250, "Status" : "Open", "LastPaymentDate" : null, "Order" : null, "URI" : "{cf_uri}/Purchase/Bill/Miscellaneous/a96e2635-0931-4781-8756-011c2c3c9290", "RowVersion" : "8466204349503111168" } ``` **Note:** The `{cf_uri}` is provided by the `businessId` parameter. ``` -------------------------------- ### Example GET Response for Current User Permissions Source: https://developer.myob.com/api/myob-business-api/v2/current-user This JSON structure illustrates the expected response when querying the CurrentUser endpoint. It shows the user's access rights for different resources, including the resource path and the specific HTTP methods they are permitted to use. ```json { "UserAccess" : [ { "ResourcePath" : "{cf_uri}/Contact/Customer/", "Access" : [ "GET", "POST", "PUT", "DELETE" ] }, { "ResourcePath" : "{cf_uri}/GeneralLedger/Account/", "Access" : [ "GET" ] } ] } ``` -------------------------------- ### Tax Code Summary Report GET Example Response Source: https://developer.myob.com/api/myob-business-api/v2/report/taxcodesummary Example JSON response for a Tax Code Summary Report GET request. This structure includes the reporting period, basis, year-end adjustment status, and a detailed breakdown of sales, purchases, and tax collected/paid for each tax code. ```json { "StartDate" : "2018-07-01T00:00:00", "EndDate" : "2018-09-30T23:59:59", "ReportingBasis" : "Cash", "YearEndAdjust" : true, "TaxCodeBreakdown" : [ { "SalesTotal" : 12516.64, "PurchasesTotal" : 28599.4, "TaxCollected" : 1137.88, "TaxPaid" : 2599.95, "TaxRate" : 10, "TaxCode" : { "UID" : "2ab1cf79-bce8-4da0-986c-a3bbdd1d02bc", "Code" : "GST", "URI" : "{cf_uri}/GeneralLedger/TaxCode/2ab1cf79-bce8-4da0-986c-a3bbdd1d02bc" } } ], "URI" : "{cf_uri}/Report/TaxCodeSummary?StartDate=2018-07-01&EndDate=2018-09-30&ReportingBasis=Cash&YearEndAdjust=true" } ``` -------------------------------- ### Example Prospect Activity GET Response Source: https://developer.myob.com/api/exo/endpoints/prospect/prospectactivity This JSON structure represents a typical response when querying for prospect activities. It includes detailed information about the activity, associated company, contact, and custom fields. ```json { "0": { "parentid": 7, "recurrenceindex": -1, "type": 0, "subject": "Call with D&C", "details": null, "startdatetime": "2014-11-07T09:00:00+11:00", "enddatetime": "2014-11-07T12:29:00+11:00", "companyid": { "companytype": 3, "accno": 2 }, "companyname": "D & C Panelbeaters", "companyphone": "02 9832 2822", "companyemail": "connor@hotmail.example.com", "companylattitude": -33.891457, "companylongitude": 151.208095, "contactid": 7, "contactname": "Connor Hill", "contactdirectphone": "02-9832 2822", "contactmobile": "0405 7935437", "contactemail": "connor@hotmail.example.com", "contactlatitude": -33.881856, "contactlongitude": 151.227394, "opportunityid": 0, "assignedtoid": 0, "assignedbyid": 8, "reminderdate": "2014-11-07T08:45:00+11:00", "reminderminutes": 15, "completed": false, "completeddatetime": null, "showtimeas": 2, "activitytypeid": 2, "activitytypetext": "New Business", "activitystatusid": 100, "activitystatustext": "Not Started", "priority": "Normal", "actualstart": "2014-11-07T00:00:00+11:00", "actualfinish": "2014-11-07T00:00:00+11:00", "createdbyid": 8, "createdate": "2014-11-06T17:31:27+11:00", "completedpercent": 0, "syncactivity": false, "campaignid": 0, "campaignwaveid": -1, "jobid": -1, "serviceableunitid": -1, "salesorderid": -1, "subscriptionid": -1, "purchaseorderid": -1, "alldayevent": false, "reminder": false, "eventtype": 0, "label": "Business", "recurrencecount": -1, "extrafields": { "0": { "key": "X_DECIMAL_EXTRA", "value": null }, "1": { "key": "X_INTEGER_EXTRA", "value": null }, "2": { "key": "X_CHECKBOX_TEST", "value": "N" }, "3": { "key": "X_DATE_TEST", "value": "2014-10-20" }, "4": { "key": "X_TEST_DROPDOWN", "value": "5. MALCOLM BREEN" }, "5": { "key": "X_TEST_DROPDOWNEDIT", "value": "3. TIM MCINTOSH" }, "6": { "key": "X_TEST_READONLY", "value": "Readonly extra field" }, "7": { "key": "X_TEST_TEXT", "value": "Extra field text" }, "8": { "key": "X_TEST_URL", "value": "www.myob.co.nz" }, "9": { "key": "X_TEST_URLLABEL", "value": "www.myob.co.nz" } }, "id": 7, "href": "{URI}https://exo-stage.api.myob.com/activity/7" } } ```