Base Type

Entity

Base class for all API entities

Entity

The Entity class is the base class that all API entities inherit from. It provides common functionality for interacting with the Acumatica REST API.

Overview

Every entity in the API (such as SalesOrder, Customer, BusinessAccount, etc.) extends this base class. The Entity class provides:

  • Standard CRUD operations (Create, Read, Update, Delete)
  • Linking and navigation between related entities
  • Common metadata fields

Common Properties

All entities inherit these base properties:

PropertyTypeDescription
idGuidUnique identifier for the entity record
rowNumberintRow number when returned in a list
noteStringValueFree-form notes attached to the record
customCustomFieldsCustom fields defined for the entity
filesList<FileLink>Attached files
DeletebooleanFlag to mark record for deletion

JSON Structure

{
  "id": "e47a0b2c-1234-5678-abcd-ef1234567890",
  "rowNumber": 1,
  "note": {
    "value": "Sample note text"
  },
  "custom": {},
  "files": []
}

Usage Notes

  • When creating new records, the id field is typically omitted and auto-generated
  • The Delete property is used in PUT requests to mark related records for deletion
  • The rowNumber property is read-only and set by the API when returning lists