Release History

The following summarizes the main changes to XML API and SOAP API for each OpenAir release.

April 13, 2023

Extended coverage to include the following object types and properties.

Object type	Properties
Customer	credit_invoice_layout_id
Project	credit_invoice_layout_id
User	mfa_status

October 7, 2023

Added the following Error Codes:

• 965 — File could not be saved.

• 1422 — Missing Address object.

April 15, 2023

• Added the following error codes Error Codes:

  • 426 — You must use an account-specific domain.

  • 1418 — Invalid preference settings format.

  • 1419 — No full user licenses available.

  • 1420 — No T&E or full user licenses available

  • 1421 — No guest or full user licenses available

  See also object type User, and commands CreateUser and Modify (XML API) or createUser() and modify() (SOAP API).

• Added support for commands Unapprove (XML API) and unapprove() (SOAP API) to the Schedulerequest object type.

• Added support for the Attachment Thumbnail feature. See object type Attachment.

October 8, 2022

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Customer	customer_location_id
  CustomerLocation	active, created, deleted, ID, name, notes, updated

• Fixed a previous limitation that prevented specifying the address information properties to be returned when reading Company, Contact, Customer, CustomerProspect, User or Vendor records. The XML API returned values for all address fields. The SOAP API either returned values for all address fields if the XML property names were used, or did not return any address field values if the SOAP property names were used (property names beginning with addr_, billing_addr_, or contact_addr_).

April 9, 2022

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Projectbillingtransaction	fulfillmentid
  Projectbillingtransaction	limit_values

• Added Error code 206 — Role error. See Error Codes.

October 9, 2021

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Projectbillingrule	cap_by_customerpo, project_task_id

• Added the following error codes Error Codes:

  • 1416 — Invalid cap by customer PO.

  • 1417 — Invalid project task ID.

• Changes to OAuth 2.0 Authorization:

  • OAuth 2.0 access token validity period cannot be greater than session timeout — see Application Configuration.

  • OAuth 2.0 refresh token validity period can be between 1 and 31 days in one–day increments — see Application Configuration.

April 10, 2021

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Resourcesearch	location, skill, industry, jobrole, education, customprofile_1 — customprofile_35

• Added audit and management capabilities for user authorizations. Account administrators can use web services reports to audit and revoke authorizations granted by OpenAir users to integration applications. See Auditing and Managing OAuth 2.0 Authorizations under OAuth 2.0 Authorization.

• Added the following Error Codes:

  • 1414 — Invalid approval status.

  • 1415 — Phase cannot be assigned.

  • 1500 — Access to the Expenses module denied.

October 10, 2020

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Invoice	payment_termsid

• Added an option to disallow adding or modifying a Ticket object with the property quantity set to zero. Added corresponding error code (1412 — Invalid quantity). See Error Codes.

April 18, 2020

• Extended coverage to include the following object types and properties.

  Object type	Properties
  JobCodeUsed	id, table_name, used_by, position, created, updated
  ResourceRequestQueue	booking_type_id

• Added support for OAuth 2.0 token based authentication. See OAuth 2.0 Authorization and Authentication.

October 12, 2019

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Projectbillingrule	extra_data
  Projecttaskassign	rule_rate_override, rule_rate_override_currency
  Timesheet	min_hours, max_hours
  WorkscheduleWorkhour	id, attributes, workscheduleid, workday, workhours, created, updated

• Added support for returning the minimum number of hours required on the timesheet and maximum number of hours allowed in a Timesheet object type as determined by Timesheet rules. This includes:

  • Added calculated Fields min_hours and max_hours to Timesheet object type.

  • Added read attribute calculate_hours. See Read Attributes.

• Added support for commands Delete (XML API) and delete() (SOAP API) to the Uprate object type.

April 13, 2019

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Newsfeed	id, created, updated, attributes
  NewsfeedMessage	id, newsfeedid, title, content, tagid, created, authorid, updated, editorid, attributes
  Project	newsfeedid
  Projectbillingtransaction	currency

• Added Administration > Global Settings > Account > API Limits page in the OpenAir UI. See API Limits.

October 13, 2018

• Extended coverage to include the following object types and properties.

  Object type	Properties
  ProjectBudgetGroup	etc, etc_labor, etc_expense, etc_purchase, eac, eac_labor, eac_expense, eac_purchase, itd, itd_labor, itd_expense, itd_purchase
  Task	start_time, end_time

• Added support for approval operation Approval-Related Operations to the Booking object type.

• Added the following Error Codes:

  • 1404 — Invalid time.

  • 1405 — Illegal time range.

  • 1406 — No permission to edit time data.

  • 1407 — Invalid hours.

April 14, 2018

• Extended coverage to include the following object types and properties.

  Object type	Properties
  ProjecttaskEstimate	id, project_task_id, user_id, timesheet_id, hours, date_changed, changed_by, created, updated

• Added the ability to generate the OpenAir WSDL with wrapped document-literal binding. See XML Schema and WSDL Definition Documents.

October 14, 2017

• Extended coverage to include the following object types and properties.

  Object type	Properties
  AccountingPeriod	id, name, start_date, end_date, period_date_how, period_date, current_period, default_period, notes, active, created, updated
  Proxy	id, user_id, proxy_id, own, role_id, expiration, deleted, created, updated, audit
  ResourceAttachment	id, userid, attachment_id, type, latest_attachment_id, created, updated
  Resourceprofile_type	id, name, description, type, related_table, related_id, active, external_id, deleted, created, updated, audit
  Revenue_recognition_rule	project_billing_ruleid
  User	cv_attachment_id

• Added XML API command ModifyOnCondition.

• Added read attribute order. See Read Attributes.

• Added the following Error Codes: 960, 961, 962, 963, and 964.

April 15, 2017

• Extended coverage to include the following object types and properties.

  Object type	Properties
  Attachment	size
  AttributeDescription	id, resourceprofile_typeid, attributeid, description, deleted, created, updated, audit
  ExpensePolicy	id, customerid, projectid, description, deleted, created, updated, audit, all_items_allowed
  ExpensePolicyItem	id, expense_policyid, itemid, price_max, price_fixed, currency, deleted, created, updated, audit
  Project	main_contactid
  Purchase_item	project_taskid

• Added support for commands Delete (XML API) and delete() (SOAP API) to the Category_<N>, Costcenter and Request_item object types.

• Added the following Error Codes: 899, 900, 947, 948, 949, 950, and 951.

October 15, 2016

• Extended coverage to include the following object types and properties.

  Object type	Properties
  ApprovalLine	id, approvalid, status, timesheetid, envelopeid, proposalid, purchaserequestid, purchaseorderid, authorizationid, schedule_requestid, booking_requestid, deal_booking_requestid, invoiceid, revenue_containerid, bookingid, customerid, project_budget_groupid, projectid, userid, submitter, approvalprocessid, approvalprocess_ruleid, seq_number, action, date, pending_done, project_total, notes, created, updated, audit, delay_to, delay_action
  ProjectBudgetGroup	approval_status, budget_by, calculated_total, cf_opt, cf_pes, created, currency, customerid, date, date_approved, date_archived, date_submitted, funding_total, ID, internal_total, labor_subcategory, name, notes, parentid, profitability, projectid, setting, total, total_calculated_billing, total_calculated_cost, total_expected_billing, total_expected_cost, total_from_funding, unassigned_task, updated, userid, version
  ProjectBudgetRule	category, categoryid, created, currency, customerid, date, end_date, ID, imported, itemid, job_codeid, notes, period, productid, profitability, project_budget_groupid, project_taskid, projectid, quantity, quantity_best, quantity_most_likely, quantity_worst, rate, start_date, total, total_best, total_most_likely, total_worst, updated
  ProjectBudgetTransaction	category, categoryid, created, currency, customerid, date, ID, itemid, job_codeid, productid, project_budget_groupid, project_budget_ruleid, project_taskid, projectid, quantity, quantity_best, quantity_most_likely, quantity_worst, total, total_best, total_most_likely, total_worst, updated
  Projecttask	classification

• Added SOAP API commands approve(), reject() and unapprove().

• Added support for commands Unapprove (XM API) and unapprove() (SOAP API) to the Envelope, Invoice and Timesheet object types.

• Added the following Error Codes: 945 and 946.

April 16, 2016

• Extended coverage to include the Role object type.

• Added controls to prevent renaming, modifying, or deleting a custom field if it is used by an active script.

October 17, 2015

• Extended coverage to include the following object types and properties.

  Object	Properties
  Paymenttype	default_status, default_payment_type
  Slip	skip_recognition
  TaskAdjustment	created, id, new_taskid, new_timesheetid, old_taskid, old_timesheetid, updated

• Added error code 943 — Project names must be unique by customer. See Error Codes.

April 18, 2015

Extended coverage to include the following object types and properties.

Object	Properties
Booking_request	—
Project	rate_cardid
Agreement, BookingType, Category, Category_<N>, Contact, Costcenter, Customer, Customerpo, Department, Item, Payrolltype, Project, ProjectStage, Projecttask_type, Timetype, User, Vendor	picklist_label

October 18, 2014

Extended coverage to include the following object types and properties.

Object	Properties
Booking	source_booking_id
ItemToUserLocation	—
Projectbillingrule	assigned_user
Ticket	user_locationid
UserLocation	—

May 17, 2014

Extended coverage to include the following object types and properties.

Object	Properties
Attachment	ownerid, is_a_folder, owner_type, name
ResourceRequest	—
ResourceRequestQueue	—
Resourcesearch	—
Workspace	—

February 15, 2014

Extended coverage to include the following object types and properties.

Object	Properties
Address	contact_id

November 16, 2013

Extended coverage to include the following object types and properties.

Object	Properties
Address	id
ApprovalProcess	externalid
BillingSplit	—
BookingByDay	userid
Company	addr_id
Contact	exported, addr_id
Customer	billing_addr_id, contact_addr_id, addr_id
Invoice	submitted, approved
LoadedCost	externalid
Projectbillingtransaction	customerpoid, cost_centerid, timetypeid, customerid, agreementid, payroll_typeid
Reimbursement	userid, audit
SlipProjection	projecttask_typeid, cost_centerid, acct_date, job_codeid
User	addr_id
Vendor	addr_id

August 17, 2013

• Extended coverage to include the following object types and properties.

  Object	Properties
  Booking	project_assignment_profile_id
  PendingBooking	—
  Project	rm_approver, rm_approvalprocess
  ProjectAssignmentProfile	—
  Projecttaskassign	project_assignment_profile_id, pending_booking_id, booking_id
  User	rm_approver, rm_approvalprocess

• Added restriction on reading RevenueProjection objects if projections are running.

• Added error code 606. See Error Codes.

May 18, 2013

• Extended coverage to include the following object types and properties.

  Object	Properties
  BookingByDay	—
  Projectbillingtransaction	slip_stage_id
  RevenueProjection	—
  Slip	originating_id

• Extended the page coverage for command MakeURL (XML API) or makeURL() (SOAP API) with the following new page attribute value: calendar-user.

• Added support for using the XML API to read the number of requests remaining within the current 24-hour window. To do so, use the Read XML API command and the RateLimit object. See Tracking API Usage Against Frequency Limits.

March 16, 2013

Extended coverage to include the following object types and properties.

Object	Properties
Booking	date_approved, date_submitted, approval_status

January 19, 2013

Added support for reading custom fields for Custom fields associated with Budget objects.

November 17, 2012

Extended coverage to include the following object types and properties.

Object	Properties
Item	cost_is_fixed

July 14, 2012

• Extended coverage to include the following object types and properties.

  Object	Properties
  Booking	notify_owner
  Projectbillingrule	exclude_non_billable_task
  Revenue_recognition_transaction	portfolio_projectid
  Slip	portfolio_projectid

• Added error code 885. See Error Codes.

May 12, 2012

Extended coverage to include the following object types and properties.

Object	Properties
Project	portfolio_projectid, is_portfolio_project

March 17, 2012

• Extended coverage to include the following object types and properties.

  Object	Properties
  Customer	created, updated, billing_code

• Added the read attribute generic. Set the generic attribute to 1 to return generic resources (users) only. By default the API returns named resources (users) only. See Read Attributes.

• Added the following Error Codes: 941, 1106.

January 21, 2012

• Extended coverage to include the following object types and properties.

  Object	Properties
  Schedulebyday	id, date, user_id, hours, base_hours, target_hours, target_base_hours, created, updated

• Added custom field support for Purchaseorder, Request_item, and Schedulebyday objects.

November 19, 2011

Extended coverage to include the following object types and properties.

Object	Properties
Customer	locationid
RevenueStage	id, name, revenue_stage_type, created, updated
Revenue_recognition_transaction	is_from_open_stage

September 17, 2011

• Extended coverage to include the following object types and properties.

  Object	Properties
  Invoice	credit_rebill_status, original_invoiceid
  Project	rv_approver, rv_approvalprocess
  Projectbillingrule	category_1id, category_2id, category_3id, category_4id, category_5id
  RevenueContainer	project_billing_rule_filter, category_1id, category_2id, category_3id, category_4id, category_5id
  Revenue_recognition_transaction	category_1id, category_2id, category_3id, category_4id, category_5id
  Slip	ref_slipid
  TaskTimecard	category_1id, category_2id, category_3id, category_4id, category_5id
  UserWorkschedule	id, name, userid, use_this_schedule, account_workscheduleid, workdays, workhours, created, updated

• Added API support for all existing time entry [Task] rounding rules.

• Added error code 882. See Error Codes.

July 16, 2011

• Extended the page coverage for command MakeURL (XML API) or makeURL() (SOAP API) with the following new page attribute values: view-invoice, dashboard-project, grid-timesheet, report-timesheet.

• Added custom field support for Payment, User.

• Extended User object type usage to support generic users.

• Added error code 556. See Error Codes.

May 14, 2011

• Extended coverage to include the following object types and properties.

  Object	Properties
  Attachment	parentid
  Projecttask	default_category_1, default_category_2, default_category_3, default_category_4, default_category_5
  RevenueContainer	id, number, date, balancing_type, total_recognized, currency, date_approved, updated, date_submitted, approval_status, total_deferred, name, acct_date, total_accrued, projectid, externalid, total_posted, created, notes, total_invoiced, customerid, exported, prefix

• Added controls to prevent negative values for quantity on non-PO purchase items.

• Fixed an issue with updating Contact objects where email value was cleared if not explicitly set.

• Added the following Error Codes: 880, 881.

March 19, 2011

• Extended coverage to include the following object types and properties.

  Object	Properties
  CustField	never_copy
  Task	category_1id, category_2id, category_3id, category_4id, category_5id

• Extended TargetUtilization object type usage to support target utilization for inactive users.

• Changes to Customer: terms defaults to the default payment terms if not set when adding a new object.

• Changes to Projectassign and Projecttaskassign: job_codeid can be set to 0 when modifying an object.

• Changes to Purchase_item: date of associated Fulfillment object is set to date_fulfilled, if specified, or to the current date otherwise.

• Added the following Error Codes: 555, 914, 915

January 22, 2011

• Extended coverage to include the following object types and properties.

  Object	Properties
  Revenue_recognition_rule_amount	cost_center_id
  Task	acct_date
  Ticket	externalid
  Timesheet	acct_date

• Added custom field support for Paymentterms.

• Added support for commands Modify (XML API) and modify() (SOAP API) to the Attachment object type.

• Added support for commands Delete (XML API) and delete() (SOAP API) to the Attachment and Booking object types.

• Added the following Error Codes: 878, 879, 1105.

November 20, 2010

• Extended coverage to include the following object types and properties.

  Object	Properties
  Attribute	id, name, attribute_setid, updated, created, notes.
  Projectassign	job_codeid
  Projectbillingrule	daily_rate_multiplier, job_code_filter
  Projectbillingrule	job_codeid
  Projectgroup	id, attributes, assigned_users, created, updated, name, notes, active
  Projecttaskassign	job_codeid
  RevenueContainer	asb_which_slips
  Uprate	job_codeid

• Related object lookup when adding or modifying objects using the SOAP API now uses oaFieldAttribute instead of oaAttribute to specify the reference fields and the lookup properties. The oaAttribute object is now used to represent a measurement level for a skill or competency (see Attribute). See also Related Object Lookup Using the SOAP API.

  Important:

  If you update the OpenAir WSDL in your development environment, replace all references to the oaAttribute object with oaFieldAttribute in your code. Related object look ups will stop working otherwise.

• Added support for add and modify operations to the Agreement_to_project object type.

• Added support for delete operations to the Agreement_to_project and Entitytag object types.

• Added the following Error Codes: 876, 877, 936, 937, 938, 1104.

September 18, 2010

• Extended coverage to include the following object types and properties.

  Object	Properties
  Agreement_to_project	agreementid, attribute, customerid, projectid, active, created, updated
  Attributeset	id, name, attribute, notes, created, updated
  Booking	job_code_id
  Customer	sold_to_contact_id
  IssueStatus	id, name, attribute, active, created, and updated
  Revenue_recognition_transaction	project_billing_rule_id, job_code_id, rate, decimal_hours, hour, minute, revenue_containerid, revenue_stageid, originatingid, offsetsid
  Slip	projecttask_type_id, job_code_id, payroll_type_id

• Added the following filter: approved-revenue-recognition-transactions. See Filtering.

July 17, 2010

• Extended coverage to include the following object types and properties.

  Object	Properties
  Booking	starttime and endtime
  Category_<N>	id, name, code, externalid, active, created, updated, and notes
  Revenue_recognition_transaction	category_1id, category_2id, category_3id, category_4id, and category_5id

• Added custom field support for Revenue_recognition_transaction.

May 15, 2010

• Extended coverage to include the following object types and properties.

  Object	Properties
  Agreement	acct_date
  Customerpo	acct_date
  Project	attachmentid

• Added the following Error Codes: 871, 872, 873, 874.

March 20, 2010

• Extended coverage to include the following object types and properties.

  Object	Properties
  all except Address, Date, oaFieldAttribute and Module	attributes
  Address, Date, oaFieldAttribute and Module	id, name, userid, date, period, currency, cost, cost_typeid, is_accrual, externalid, notes, created, updated
  Attachment	attachmentid
  Costcategory	id, name, active, notes, created, updated, externalid
  Costtype	id, name, active, notes, created, updated, externalid
  Envelope	currency_exchange_intolerance
  Repeat	id, frequency, every, end, occur_number, how_end, exclude_dow, created, updated
  RevenueContainer	cost_centerid
  Ticket	attachmentid, currency_exchange_intolerance

• Added SOAP API support for reading and setting custom field values. See Reading or Setting Custom Field Values Inline. Custom fields are returned by default when reading objects using SOAP API.

• Added SOAP API support for looking up objects matching a custom field value. See Look Up and Update Objects Matching a Custom Field Value.

• Added SOAP API support for multiple argument objects and combined relational read methods using logical operators. See Combining Relational Methods Using Logical Operators (SOAP API).

• Added SOAP API support for looking up related object by extrenalid or name when adding or modifying objects. See Related Object Lookup Using the SOAP API.

• Added custom field support for the Fulfillment.

• Added support for add and update operations for the Schedulerequest object type.

  Changes to ImportExport: either one of the imported and exported properties is required.

• Changes to User: project_access_node allows more than one node per hierarchy.

• Changes to Projectbillingrule: cost_centerid is not required when updating objects.

• When adding Attachment objects, the response includes Attachment object properties.

January 23, 2010

• Extended coverage to include the following object types and properties.

  Object	Properties
  Booking	owner_id
  Company	workscheduleid
  Hierarchy	externalid
  HierarchyNode	available_as_column, externalid, primary_dropdown_filter, primary_user_filterset
  Report	id, userid, name, type, thin_client_context, date_created, email_report, relatedid, created, updated

• Added XML API command Report.

  Added support for add and update operations to the Hierarchy and HierarchyNode object types.

  Added support for the delete operation to the HierarchyNode object type.

• Fixed an issue when creating User objects where UserWorkschedule was not set.

• Fixed an issue with reading ImportExport with deleted attribute set to 1 and filter attribute set to not-exported.

• Changed invalid UTF-8 character handling: invalid UTF-8 characters are stripped out instead of converted to decimal numbers. Removed more UTF-8 encoding errors in the server log for accounts not configured for UTF-8.

• Changes to commands CreateUser (XML API) and createUser() (SOAP API) to follow the behavior of the OpenAir UI more closely when setting a name for the new User.

November 21, 2009

• Extended coverage to include the following object types and properties.

  Object	Properties
  Envelope	attachmentid
  Project	pm_approver_1, pm_approver_2, pm_approver_3, payroll_type_filter
  Resourceprofile	externalid
  Resourceprofile_type	externalid
  User	update_workschedule, is_user_schedule, workschedule_workdays, workschedule_workhours

• Changes to User:

  • Added support for adding or updating a UserWorkschedule when adding or updating a User.

  • Fixed issue with invalid start_date value for added or updated Entitytag when adding or updating a User.

  • Added support for updating Entitytag for inactive User.

• Changes to Slip: projectid and customerid validation when adding objects

• Changes to Projecttask: Ability to use default filtering mechanism when reading objects.

• Changes to ImportExport: Added controls to prevent duplicate objects when adding objects.

• Changes to commands CreateUser (XML API) and createUser() (SOAP API): Added support for returning error codes.

• Added support for 0 offset in limit read attribute.