MYOB Advanced API Custom Endpoints: Companies & Financial Period Guide

Introduction to MYOB Advanced API Custom Endpoints

MYOB Acumatica does not expose Companies and Financial Period data by default.

You must extend Web Service Endpoints to access this data via API.

In this guide, we show how to create custom endpoints and expose Financial Period data step by step.

In MYOB Acumatica API (formerly MYOB Advanced Business), certain data structures are not available through the standard REST API.

When the platform does not expose specific screens or objects as REST entities, you must extend the Web Service Endpoint manually to make them accessible.

What Are Web Service Endpoints in MYOB Advanced?

Web Service Endpoints in MYOB Advanced define which screens, entities, fields, and actions are available through the REST API.

Each endpoint works as a contract between MYOB Advanced and the external application that needs to read, create, or update data.

The default endpoint covers many common business objects, but it may not include every screen or field required for a custom integration.

For example, Companies and Financial Period data may not be available in the standard endpoint, which is why developers often need to extend the endpoint and manually expose the required entities.

A custom endpoint is useful when your integration needs access to specific screens, custom fields, or company-specific financial data that is not included in the default API structure.

Default Endpoint vs Custom Endpoint in MYOB Advanced

The default MYOB Advanced endpoint is suitable for standard API operations such as accessing common entities, customers, vendors, items, sales orders, and other frequently used business data.

However, it may not expose every screen or field available inside MYOB Advanced.

A custom endpoint gives developers more control over what data is available through the API.

You can extend an existing endpoint, add new entities, map fields from a specific screen, and expose custom business data required by external systems.

Default endpoints are available out of the box and are useful for standard integrations.

Custom endpoints are created or extended manually and are better suited for complex integrations where additional screens, fields, or entities are required.

If your integration only needs standard data, the default endpoint may be enough.

But if your application needs Financial Period, Company-specific calendar data, or custom screen fields, extending the endpoint is usually the better approach.

How to Expose Companies Through MYOB Advanced API

To expose Company data through the API, follow these steps on the Web Service Endpoints screen:

1. Navigate to the Web Service Endpoints (SM207060) screen in MYOB Acumatica.
2. Click the EXTEND ENDPOINT button and provide an Endpoint name and version.
3. On the tree view on the left side, select the topmost ENDPOINT node.
4. Click the INSERT button to add a new entity.
5. Fill in the Object Name and set the Screen Name to CS101500.
6. Select the new Companies entity, go to the FIELDS tab, and click POPULATE to auto-fill the available fields.
7. Save the endpoint configuration.

When Do You Need Custom Endpoints in MYOB Acumatica?

Custom endpoints in MYOB Acumatica become essential when the default API structure doesn’t fully support your business workflows or integration requirements.

While standard endpoints work well for common use cases, there are specific scenarios where custom endpoints offer much better control and flexibility.

When Required Data Is Missing from the Default MYOB Advanced API

The default API endpoints may not expose all fields, relationships, or business logic required for your operations.

This is especially common when:

• You need access to custom fields or DAC extensions.
• Data is spread across multiple entities and requires consolidation.
• Certain computed or conditional data is not directly accessible.

Custom endpoints allow you to extend and expose exactly the data you need, without relying on workarounds or multiple API calls.

When Building MYOB Advanced Integrations with External Systems

If you’re integrating MYOB Acumatica with external systems such as CRMs, SaaS platforms, or internal tools, default endpoints may not correspond with your data structure or workflow.

In such cases, custom endpoints help you:

• Create customized data models for better integration.
• Reduce API complexity by combining multiple operations into a single endpoint.
• Preserve consistency between systems without heavy transformation logic.

When Managing Financial Period Workflows Through API

Financial processes often involve strict rules around periods, validations, and approvals.

Default APIs may not fully support these workflows, particularly when dealing with:

• Period-specific transactions
• Closing and reopening financial periods
• Validation rules tied to accounting logic

How to Expose Financial Period Data Through MYOB Acumatica API

The Financial Period data is not included in the standard REST API.

This means the out-of-the-box endpoint does not expose Financial Period details, and you cannot retrieve or update periods via the default entity endpoints.

To make Financial Period information accessible, you must extend a Web Service Endpoint and add Financial Period as a custom entity using the same process described above for the Companies endpoint.

Why Financial Period Is Not Available in the Default MYOB Acumatica API

Financial Period screens are not exposed in the default REST endpoint (Default Endpoint, 2026). Because of this:

• Financial Periods cannot be retrieved or filtered through the standard API
• The entity does not exist under any default endpoint.
• Integration tools cannot access period configurations unless you extend the endpoint manually.

This is why adding a Financial Period through a custom endpoint is required for any integration that needs period data.

Financial Period API Behavior: Centralised Period Management On vs Off

The Financial Period API behavior depends on whether Centralized Period Management is enabled or disabled in your MYOB Acumatica instance.

When Centralized Period Management Is Enabled

Since Centralized Period Management is enabled, all companies share the same Financial Period configuration. Because the periods are global:

• Financial Periods cannot be filtered by Company ID.
• Period setup is done on the Master Financial Calendar (GL201000) screen.
• Company-specific changes are not allowed.

When Centralized Period Management Is Disabled

When this setting is disabled:

• Each company maintains its own Financial Periods.
• Configuration is done on the Company Financial Calendar (GL201100) screen.
• API updates can include the Company ID

Example: Updating Company-Specific Financial Period

(Only when Centralized Period Management = OFF)

Method: PUT
{{baseURL}}/{{endpoint}}/CompanyFinancialPeriod?$expand=Details

Final Thoughts on MYOB Advanced API Custom Endpoints

By adding Financial Period and Company Financial Period as custom endpoints, you can access data that is not available in MYOB Acumatica’s standard API.

Depending on whether Centralized Period Management is enabled, your integration can retrieve global periods or manage company-specific calendars.

With these custom entities in place, your application can now work seamlessly with all financial period data.

Common Issues When Creating MYOB Advanced Custom Endpoints

While creating custom endpoints in MYOB Advanced, developers may run into a few common issues. Most of these issues happen because the entity, screen, or fields are not mapped correctly in the Web Service Endpoints screen.

Entity Is Not Visible in the API Response

If the custom entity is not visible in the API response, check whether the endpoint was saved after adding the entity. Also confirm that the correct screen ID has been mapped and the endpoint name and version in the API URL are correct.

Fields Are Missing After Adding the Entity

If fields are missing, open the custom entity in the Web Service Endpoints screen and use the Populate option under the Fields tab. After that, review the field list and remove anything that is not required for the integration.

Financial Period Data Is Not Filtering by Company

Company-level filtering depends on the Centralised Period Management setting. If Centralised Period Management is enabled, all companies share the same financial period setup, so filtering Financial Periods by Company ID may not work as expected.

API URL Returns an Error

If the API request fails, verify the endpoint name, endpoint version, entity name, authentication details, and request method. Even a small mismatch in the endpoint URL or entity name can cause the API call to fail.

Custom Fields Are Not Returning Data

For custom fields, confirm that the field is available on the mapped screen and has been added to the endpoint field list. If the field belongs to a customization package, make sure the package is published and active in the MYOB Advanced instance.

FAQs About MYOB Advanced API Custom Endpoints

What is a custom endpoint in MYOB Acumatica?

A custom endpoint allows you to expose data that is not available in the default API by extending Web Service Endpoints.

How do I expose custom entities in MYOB Acumatica?

You can extend Web Service Endpoints and add new entities using screen mapping and field population.

Why are Financial Periods not available in the default MYOB Acumatica API?

MYOB Acumatica’s standard REST API does not expose all screens as entities. Financial Period screens are among those excluded, so you must manually extend the Web Service Endpoint to add them as custom entities.

What screen ID do I use when adding the Companies entity?

Use screen ID CS101500 when adding the Companies entity to your custom Web Service Endpoint.

Can I filter Financial Periods by Company ID?

Only if Centralised Period Management is disabled. When it is enabled, all companies share the same periods and company-level filtering is not supported.

What is the difference between GL201000 and GL201100 screens?

GL201000 is the Master Financial Calendar used when Centralised Period Management is enabled. GL201100 is the Company Financial Calendar used when each company manages its own periods independently.