System Fields

Most object types have the following system-generated properties. These properties are always read-only. These fields are automatically updated during API operations and cannot be modified. For example, the internal ID [id] property is automatically generated when you add an object and the last modified date [updated] property is automatically updated when you modify an object.

Property	Database Field Type	Description
`id`	`INTEGER`	With rare exceptions, all object types in the API have an internal ID property. The property value is a unique identifier for each object of that type. It is analogous to a primary key in relational databases. The internal ID value is generated automatically when a new object is added. It is an integer number incremented by `1` for each object of the same type. The value is unique and stays the same for the lifetime of the object. It cannot be modified. You can identify any specific object by its internal ID value in subsequent API calls. All API commands reading, updating, or deleting business data, can or in some cases must include an argument object that includes the `id` property, which references the unique object to retrieve, update, or delete. Many objects have one or more properties referencing a related object by its internal ID value. See Reference Fields.
`created`	`DATETIME`	Eastern Time (UTC – 5) date and time when the object was created.
`updated`	`TIMESTAMP`	Eastern Time (UTC – 5) date and time when the object was last modified.
`deleted`	`CHAR(1)`	A `0` or `1` flag that indicates whether the object has been deleted. The value is `1` if the object was deleted. Objects marked as deleted and last updated 180 or more days ago are removed permanently from the database according to a routine schedule. See Data Deletion. Only a few objects in the API have this property. However, the `Read` (XML API) and `read()` (SOAP API) commands with the `deleted` attribute can be used to read objects that are flagged as deleted. See Read Attributes.
`audit`	`MEDIUMTEXT`	Audit trail information. Object types in the API with the exception of `Reimbursement` do not include this property. Object audit trail information in OpenAir include information about the interface (such as OpenAir UI, XML API, SOAP API, REST API, for example) used to make the changes.

Property

Database Field Type

Description

id

INTEGER

With rare exceptions, all object types in the API have an internal ID property. The property value is a unique identifier for each object of that type. It is analogous to a primary key in relational databases.

The internal ID value is generated automatically when a new object is added. It is an integer number incremented by 1 for each object of the same type. The value is unique and stays the same for the lifetime of the object. It cannot be modified.

You can identify any specific object by its internal ID value in subsequent API calls. All API commands reading, updating, or deleting business data, can or in some cases must include an argument object that includes the id property, which references the unique object to retrieve, update, or delete.

Many objects have one or more properties referencing a related object by its internal ID value. See Reference Fields.

created

DATETIME

Eastern Time (UTC – 5) date and time when the object was created.

updated

TIMESTAMP

Eastern Time (UTC – 5) date and time when the object was last modified.

deleted

CHAR(1)

A 0 or 1 flag that indicates whether the object has been deleted. The value is 1 if the object was deleted.

Objects marked as deleted and last updated 180 or more days ago are removed permanently from the database according to a routine schedule. See Data Deletion.

Only a few objects in the API have this property. However, the Read (XML API) and read() (SOAP API) commands with the deleted attribute can be used to read objects that are flagged as deleted. See Read Attributes.

audit

MEDIUMTEXT

Audit trail information. Object types in the API with the exception of Reimbursement do not include this property. Object audit trail information in OpenAir include information about the interface (such as OpenAir UI, XML API, SOAP API, REST API, for example) used to make the changes.