$expand Parameter

When you retrieve records from MYOB Acumatica by using the contract-based REST API, you use the $expand parameter to specify the linked and detail entities that should be expanded. By default, no linked or detail entities are expanded; that is, only fields of the top-level entity are returned. You explicitly specify each linked or detail entity to be expanded.

You use OData URI conventions to specify the value of the $expand parameter.

Tip:

If you use the $expand parameter in a request, its use will not cause the concurrent request limit or rate limit imposed by the license to be exhausted sooner.

Example: Expanding Detail Lines

To obtain the values of the warehouse detail lines of stock item records, you use the following parameter string: $expand=WarehouseDetails.

Example: Nested Expanding

If you specify $expand=MainContact for the Customer entity, only the Contact linked entity of the Customer entity is expanded, but the Address linked entity within MainContact is not. To expand the Address entity, you should explicitly specify the Address entity to be expanded as follows: $expand=MainContact,MainContact/Address.

Example: Expanding File Data for a Top-Level Entity

You use the $expand=files parameter for a top-level entity to retrieve the data of the files attached to the entity.

Example: Expanding File Data for a Detail Entity

You use the $expand=WarehouseDetails/files parameter to retrieve the data of the files attached to the warehouse detail lines of stock item records.