XML and SOAP API Business Object Reference
This section provides reference information for business objects supported by the XML API and SOAP API.
This section provides reference information for supported business objects only. These are the objects that are used to pass your OpenAir data.
Except where indicated otherwise, all listed business object types are supported in both the XML API and SOAP API. Business object type names in the SOAP API include the prefix oa
.
The SOAP API also uses method objects (complex types) to hold parameters for SOAP requests and return values in SOAP responses. For reference information about the SOAP API commands and method objects, see SOAP API Commands.
The term "object" is equivalent to the term "record" and describes a particular occurrence of an object type. Depending on the object type, an object represents an entity –such as a customer, a project, or a employee, for example–, a transaction –such as a receipt, expense report, or an invoice, for example–, or a relationship between other objects. The term "object property" is equivalent to the term "field". OpenAir object types and object properties are analogous to database tables and the table columns. An object is analogous to a row in a database table.
For a list of supported business object types, see List of Supported Business Object Types.
Reference information for each business object types include:
-
The name of the object types in the XML API and SOAP API, the equivalent REST API object, where supported, and the corresponding table in the OpenAir database as documented in the OpenAir Data Dictionary.
-
A short description of what an object of that type represents.
-
The operations you can perform on objects of that type. Most of the objects accessible through the API are read-write objects. However, there are a few objects that are read-only.
-
A table listing the object properties in the XML API, SOAP API and REST API, and the corresponding column in the OpenAir database table as documented in the OpenAir Data Dictionary.
For information and guidelines about the main types of object properties, including custom fields, see Business Object Properties Overview.
-
Usage guidelines for the business object type, where relevant. These usage guidelines are not exhaustive.
Your applications work with only the objects that you are authorized to access. Programmatic access to objects is determined by your company's OpenAir account configuration, the user role permissions and access settings configured by your account administrator, and other factors related specifically to the object.
List of Supported Business Object Types
The following table lists the business object types available in the XML API and SOAP API with a link to additional information about each object.
For each business object type, the table also shows:
-
The equivalent REST API object, where supported.
-
The corresponding table in the OpenAir database as documented in the OpenAir Data Dictionary.
-
A summary of supported CRUD operations (Create, Read, Update, Delete). For information about each operation type
Note:Review the usage guidelines in the help topic for the business object where provided.
Some operations may be subject to limitations. Asterisks (*) in CRUD operation columns indicate that the operation is supported in special cases only.
For a list of objects supporting approval operations (submit, approve, reject, unapprove), see Object Types Supporting Approval-Related Operations.
XML |
SOAP |
REST |
Database |
C |
Read |
U |
D |
---|---|---|---|---|---|---|---|
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
Must be accessed using endpoints for the parent object — See Attachments |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
|
|
|
— |
— |
|
— |
— |
||
|
— |
— |
|
|
— |
||
|
See Contacts |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
— |
|
— |
— |
|
|
— |
— |
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
See Expense Reports |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
— |
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
|
|
— |
|
|
— |
— |
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
See Job Codes |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
— |
|
— |
— |
|
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
See Projects |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
|
|
|
|
|
|
|
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
— |
|
— |
— |
|
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
—
|
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
— |
|
— |
— |
|
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
||
|
— |
— |
|
— |
— |
||
|
See Receipts |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
|
|
|
|
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
— |
|
— |
— |
||
|
— |
|
|
|
|
||
|
— |
|
|
|
— |
||
|
— |
|
|
|
— |
The following object types are listed in the OpenAir WSDL but are not available for use by client applications: FormPermissionField
, ServerStatus
.
The following object types are described in other sections of this guide: Approval
, CustomField
, Date
, Error
, oaFieldAttribute
, Flag
, oaSwitch
.