describe_entity
Retrieve full metadata for any Acumatica entity, including valid fields, key format, actions, and sub-collections, to correctly construct API calls.
Instructions
Return the full metadata for an entity: fields, key format, actions, and sub-collections.
Always call this before list_records or get_record when you are unsure of:
which field names are valid (use these in select= and filter= expressions)
how to format the id= argument for get_record / delete_record
which sub-collections can be passed to expand=
Args: entity: Entity name, e.g. "SalesOrder", "Bill", "Customer".
Returns one of two shapes:
Normal entity (has a key): { "entity": "SalesOrder", "fields": ["OrderType", "OrderNbr", "CustomerID", ...], # valid $select / $filter names "key_fields": ["OrderType", "OrderNbr"], # fields that make up the URL key "key_format": "Slash-separated: /", # how to build the id= string "actions": ["CancelSalesOrder", ...], "expand": ["Details", "Shipments", ...] }
Query-only entity (inquiry/summary view - no addressable key): { "entity": "AccountSummaryInquiry", "query_only": true, "note": "This entity has no addressable key - use list_records with filter= only. ...", "fields": [...], "actions": [], "expand": [] } For query-only entities: do NOT call get_record - pass at least one filter= to list_records. Calling list_records with no filter on these entities returns HTTP 500 on this tenant.
Returns {error: "Unknown entity"} if the entity is not in the catalog.
Examples: describe_entity("SalesOrder") # -> key_format: "Slash-separated: /" # -> use get_record("SalesOrder", "QT/I004264")
describe_entity("Bill")
# -> key_format: "Slash-separated: <Type>/<ReferenceNbr>"
# -> use get_record("Bill", "Bill/012979")
describe_entity("AccountSummaryInquiry")
# -> query_only: true
# -> use list_records("AccountSummaryInquiry", filter="Period eq '202506'")
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||