To help us identify and track API endpoints, all ISVs must use a consistent naming convention for entity endpoints.
The endpoint name should clearly identify the ISV responsible for it.
If you have one app
Use your company name as the endpoint name.
Example: /entity/CompanyName/18.200.001/Invoice
If you have multiple apps
Use your company name + product name.
Example: /entity/CompanyNameProductName/18.200.001/Invoice
This allows each endpoint to be easily identified and attributed to the relevant ISV and product.
Register your naming convention with MYOB
Please email acumatica.isv@myob.com with your ISV naming convention so it can be registered with MYOB.
Please include:
-
Your company name.
-
Your product name(s), if applicable.
-
The naming convention you will use for your custom endpoints.
Why this is required
Consistent naming helps MYOB:
-
Identify the ISV responsible for an endpoint at a glance.
-
Track API usage and activity by ISV and product.
-
Investigate performance or other API-related issues more efficiently.
-
Ensure custom endpoints are clearly attributable when reviewing API activity.
Existing endpoints
If you have existing custom endpoints using Default or another non-standard naming convention, please update them to follow the convention above and email acumatica.isv@myob.com with your updated naming setup.