XML and SOAP API Business Object Reference

This section provides reference information for business objects supported by the XML API and SOAP API.

Note:

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.

Important:

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	Create	Read	Update	Delete
AccountingPeriod	oaAccountingPeriod	—	accounting_period
Actualcost	oaActualcost	—	actual_cost				—
Address	oaAddress	—	address
Agreement	oaAgreement	—	agreement
Agreement_to_project	oaAgreement_to_project	—	agreement_to_project
ApprovalLine	oaApprovalLine	—	approval	—		—	—
ApprovalProcess	oaApprovalProcess	—	approvalprocess
Attachment	oaAttachment	Attachment Must be accessed using endpoints for the parent object — See Attachments	attachment			*
Attribute	oaAttribute	—	attribute	—		—	—
AttributeDescription	oaAttributeDescription	—	attribute_description
Attributeset	oaAttributeset	—	attribute_set	—		—	—
BillingSplit	oaBillingSplit	—	billing_split	—		—	—
Booking	oaBooking	—	booking
BookingByDay	oaBookingByDay	—	booking_by_day	—		—	—
BookingType	oaBookingType	—	booking_type				—
Booking_request	oaBooking_request	—	booking_request	—		—	—
Budget	oaBudget	—	budget				—
BudgetAllocation	oaBudgetAllocation	—	budget_allocation				—
Category	oaCategory	—	category
Category_<N>	oaCategory_<N>	—	category_<N> (category_1)
Ccrate	oaCcrate	—	cc_rate	—		—	—
Company	oaCompany	—	account	—			—
Contact	oaContact	Contact See Contacts	contact
Costcategory	oaCostcategory	—	cost_category				—
Costcenter	oaCostcenter	—	cost_center
Costtype	oaCosttype	—	cost_type				—
Currency	oaCurrency	—	currency				—
Currencyrate	oaCurrencyrate	—	—	—		—	—
CustField	oaCustField	—	cust_field	—			—
Customer	oaCustomer	—	customer
CustomerLocation	oaCustomerLocation	—	customer_location
Customerpo	oaCustomerpo	—	customerpo
Customerpo_to_project	oaCustomerpo_to_project	—	customerpo_to_project				—
CustomerProspect	oaCustomer	—	customer
Deal	oaDeal	—	deal	—		—	—
Dealcontact	oaDealcontact	—	deal_contact	—		—	—
Dealschedule	oaDealschedule	—	deal_schedule	—		—	—
Department	oaDepartment	—	department
Entitytag	oaEntitytag	—	entity_tag
Envelope	oaEnvelope	ExpenseReport See Expense Reports	envelope
Estimate	oaEstimate	—	estimate	—		—	—
Estimateadjustment	oaEstimateadjustment	—	estimate_adjustment	—		—	—
Estimateexpense	oaEstimateexpense	—	estimate_expense	—		—	—
Estimatelabor	oaEstimatelabor	—	estimate_labor	—		—	—
Estimatemarkup	oaEstimatemarkup	—	estimate_markup	—		—	—
Estimatephase	oaEstimatephase	—	estimate_phase	—		—	—
Event	oaEvent	—	event				—
ExpensePolicy	oaExpensePolicy	—	expense_policy
ExpensePolicyItem	oaExpensePolicyItem	—	expense_policy_item
Filter	—	—	filter	—		—	—
Filterset	oaFilterset	—	filter_set	—		—	—
ForexInput	oaForexInput	—	—				—
Fulfillment	oaFulfillment	—	fulfillment	—			—
Hierarchy	oaHierarchy	—	hierarchy				—
HierarchyNode	oaHierarchyNode	—	hierarchy_node
History	oaHistory	—	approval	—		—	—
HistoryNotes	oaHistoryNotes	—	approval	—		—	—
ImportExport	oaImportExport	—	import_export
Invoice	oaInvoice	—	invoice
InvoiceLayout	oaInvoiceLayout	—	invoice_layout	—		—	—
Issue	oaIssue	—	issue
IssueCategory	oaIssueCategory	—	issue_category				—
IssueSeverity	oaIssueSeverity	—	issue_severity				—
IssueSource	oaIssueSource	—	issue_source				—
IssueStage	oaIssueStage	—	issue_stage				—
IssueStatus	oaIssueStatus	—	issue_status	—		—	—
Item	oaItem	—	item
ItemToUserLocation	oaItemToUserLocation	—	item_to_user_location
Jobcode	oaJobcode	JobCode See Job Codes	job_code				—
JobCodeUsed	oaJobCodeUsed	—	job_code_used	—		—	—
Leave_accrual_rule	oaLeave_accrual_rule	—	leave_accrual_rule				—
Leave_accrual_rule_to_user	oaLeave_accrual_rule_to_user	—	leave_accrual_rule_to_user				—
Leave_accrual_transaction	oaLeave_accrual_transaction	—	leave_accrual_transaction				—
LoadedCost	oaLoadedCost	—	loaded_cost				—
Module	oaModule	—	—	—		—	—
Newsfeed	oaNewsfeed	—	newsfeed
NewsfeedMessage	oaNewsfeedMessage	—	newsfeed_message
Payment	oaPayment	—	payment
Paymentterms	oaPaymenttems	—	payment_tems				—
Paymenttype	oaPaymenttype	—	payment_type
Payrolltype	oaPayrolltype	—	payroll_type
PendingBooking	oaPendingBooking	—	pending_booking	—		—	—
Preference	oaPreference	—	preference				—
Product	oaProduct	—	product				—
Project	oaProject	Project See Projects	project
Projectassign	oaProjectassign	—	project_assign
ProjectAssignmentProfile	oaProjectAssignmentProfile	—	project_assignment_profile
Projectbillingrule	oaProjectbillingrule	—	project_billing_rule				—
Projectbillingtransaction	oaProjectbillingtransaction	—	project_billing_transaction	*		*	*
ProjectBudgetGroup	oaProjectBudgetGroup	—	project_budget_group
ProjectBudgetRule	oaProjectBudgetRule	—	project_budget_rule
ProjectBudgetTransaction	oaProjectBudgetTransaction	—	project_budget_transaction
Projectgroup	oaProjectgroup	—	project_group				—
Projectlocation	oaProjectlocation	—	project_location	—		—	—
ProjectPricing	oaProjectPricing	—	project_pricing
ProjectStage	oaProjectstage	—	project_stage
Projecttask	oaProjecttask	ProjectMilestone – See Project Milestones ProjectPhase – See Project Phases ProjectTask – See Project Tasks	project_task classification set to M for milestones, P for phases, or T for tasks
Projecttaskassign	oaProjecttaskassign	—	project_task_assign
ProjecttaskEstimate	oaProjecttaskEstimate	—	project_task_estimate
Projecttask_type	oaProjecttask_type	—	project_task_type				—
Proposal	oaProposal	—	proposal	—		—	—
Proposalblock	oaProposalblock	—	proposal_block	—		—	—
Proxy	oaProxy	—	proxy
Purchase_item	oaPurchase_item	—	purchase_item	*		*
Purchaseorder	oaPurchaseorder	—	purchaseorder
Purchaser	oaPurchaser	—	purchaser	—		—	—
Purchaserequest	oaPurchaserequest	—	purchase_request	—		—	—
Ratecard	oaRatecard	—	rate_card				—
RateCardItem	oaRateCardItem	—	rate_card_item				—
Reimbursement	oaReimbursement	—	reimbursement
Repeat	oaRepeat	—	repeat				—
Report	oaReport	—	report	—		—	—
Request_item	oaRequest_item	—	request_item	—		—
ResourceAttachment	oaResourceAttachment	—	resource_attachment
Resourceprofile	oaResourceprofile	—	resourceprofile
Resourceprofile_type	oaResourceprofile_type	—	resourceprofile_type
ResourceRequest	oaResourceRequest	—	resource_request
ResourceRequestQueue	oaResourceRequestQueue	—	resource_request_queue
Resourcesearch	oaResourcesearch	—	resourcesearch
RevenueContainer	oaRevenueContainer	—	revenue_container	—		*	—
RevenueProjection	oaRevenueProjection	—	revenue_projection	—		—	—
Revenue_recognition_rule	oaRevenue_recognition_rule	—	revenue_recognition_rule				—
Revenue_recognition_rule_amount	oaRevenue_recognition_rule_amount	—	revenue_recognition_rule_amount				—
Revenue_recognition_transaction	oaRevenue_recognition_transaction	—	revenue_recognition_transaction				—
RevenueStage	oaRevenueStage	—	revenue_stage	—		—	—
Role	oaRole	—	role	—		—	—
Schedulebyday	oaSchedulebyday	—	schedule_by_day	—		—	—
Scheduleexception	oaScheduleexception	—	scheduleexception
Schedulerequest	oaSchedulerequest	—	schedule_request
Schedulerequest_item	oaSchedulerequest_item	—	schedule_request_item	—
Slip	oaSlip	—	slip
SlipProjection	oaSlipProjection	—	slip_projection, slip	—		—	—
Slipstage	oaSlipstage	—	slip_stage				—
SummaryView	oaSummaryView	—	—	—		—	—
TagGroup	oaTagGroup	—	tag_group
TagGroupAttribute	oaTagGroupAttribute	—	tag_group_attribute
TargetUtilization	oaTargetUtilization	—	target_utilization
Task	oaTask	— TimeEntry – See Time Entries	task
TaskAdjustment	oaTaskAdjustment	—	task_adjustment	—		—	—
TaskTimecard	oaTaskTimecard	—	—	—		—	—
TaxLocation	oaTaxLocation	—	tax_location				—
TaxRate	oaTaxRate	—	tax_rate				—
Term	oaTerm	—	term	—		—	—
Ticket	oaTicket	Receipt See Receipts	ticket
Timecard	oaTimecard	—	time_card	—		—	—
Timesheet	oaTimesheet	—	timesheet
Timetype	oaTimetype	—	time_type
Todo	oaTodo	—	todo	—		—	—
Uprate	oaUprate	—	up_rate
User	oaUser	—	user
UserLocation	oaUserLocation	—	user_location
UserWorkschedule	oaUserWorkschedule	—	workschedule
Vendor	oaVendor	—	vendor
Viewfilter	oaViewfilter	—	viewfilter	—		—	—
Viewfilterrule	oaViewfilterrule	—	viewfilter_rule	—		—	—
WorkscheduleWorkhour	oaWorkscheduleWorkhour	—	workschedule_workhour	—		—	—
Workspace	oaWorkspace	—	workspace
Workspacelink	oaWorkspacelink	—	workspace_link				—
Workspaceuser	oaWorkspaceuser	—	workspace_user				—

Note:

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.