NetSuite OpenAir SOAP API Reference Guide

223 Pages·2016·1.27 MB·English

SOAP API Reference Guide
October 8, 2022
Copyright © 2013, 2022, Oracle and/or its affiliates.
This software and related documentation are provided under a license agreement containing restrictions
on use and disclosure and are protected by intellectual property laws. Except as expressly permitted
in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast,
modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any
means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-
free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it
on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed or activated on delivered hardware, and modifications of such
programs) and Oracle computer documentation or other Oracle data delivered to or accessed by
U.S. Government end users are "commercial computer software" or "commercial computer software
documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific
supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure,
modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any
operating system, integrated software, any programs embedded, installed or activated on delivered
hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other
Oracle data, is subject to the rights and limitations specified in the license contained in the applicable
contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by the
applicable contract for such services. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications, including
applications that may create a risk of personal injury. If you use this software or hardware in dangerous
applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other
measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages
caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks
of their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks
are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,
Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a
registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content,
products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and
expressly disclaim all warranties of any kind with respect to third-party content, products, and services
unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and
its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use
of third-party content, products, or services, except as set forth in an applicable agreement between you
and Oracle.
If this document is in public or private pre-General Availability status:
This documentation is in pre-General Availability status and is intended for demonstration and preliminary
use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation
and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to
this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of
this documentation.
If this document is in private pre-General Availability status:
The information contained in this document is for informational sharing purposes only and should be
considered in your capacity as a customer advisory board member or pursuant to your pre-General
Availability trial agreement only. It is not a commitment to deliver any material, code, or functionality, and
should not be relied upon in making purchasing decisions. The development, release, timing, and pricing
of any features or functionality described in this document may change and remains at the sole discretion
of Oracle.
This document in any form, software or printed matter, contains proprietary information that is the
exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms
and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle
PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has
been executed by you and Oracle and with which you agree to comply. This document and information
contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle
without prior written consent of Oracle. This document is not part of your license agreement nor can it be
incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website
at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support through My Oracle
Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://
www.oracle.com/pls/topic/lookup?ctx=acc&id=trsif you are hearing impaired.
Sample Code
Oracle may provide sample code in SuiteAnswers, the Help Center, User Guides, or elsewhere through
help links. All such sample code is provided "as is” and “as available”, for use only with an authorized
NetSuite Service account, and is made available as a SuiteCloud Technology subject to the SuiteCloud
Terms of Service at www.netsuite.com/tos, where the term “Service” shall mean the OpenAir Service.
Oracle may modify or remove sample code at any time without notice.
No Excessive Use of the Service
As the Service is a multi-tenant service offering on shared databases, Customer may not use the Service
in excess of limits or thresholds that Oracle considers commercially reasonable for the Service. If Oracle
reasonably concludes that a Customer’s use is excessive and/or will cause immediate or ongoing
performance issues for one or more of Oracle’s other customers, Oracle may slow down or throttle
Customer’s excess use until such time that Customer’s use stays within reasonable limits. If Customer’s
particular usage pattern requires a higher limit or threshold, then the Customer should procure a
subscription to the Service that accommodates a higher limit and/or threshold that more effectively aligns
with the Customer’s actual usage pattern.
Table of Contents
Introduction to OpenAir Web Services ........................................................................................ 1
Technology ......................................................................................................................... 1
Target Audience .................................................................................................................. 1
Overview ............................................................................................................................ 1
Definitions .......................................................................................................................... 2
Error Handling .................................................................................................................... 2
Date Format ....................................................................................................................... 3
Limits ................................................................................................................................ 3
Getting Started ....................................................................................................................... 5
How to Begin ..................................................................................................................... 5
Instructions for Apache Axis Libraries ..................................................................................... 6
Instructions for Microsoft Visual Studio ................................................................................... 8
OAuth 2.0 Authorization ........................................................................................................... 9
Managing API Integration Applications in OpenAir .................................................................... 9
OAuth 2.0 for Integration Applications Developers .................................................................. 17
Authorizing Applications to Access OpenAir on Your Behalf ...................................................... 27
Auditing and Managing OAuth 2.0 Authorizations ................................................................... 29
Methods .............................................................................................................................. 32
login ................................................................................................................................ 32
version ............................................................................................................................. 34
read ................................................................................................................................ 34
add ................................................................................................................................. 42
upsert .............................................................................................................................. 43
createAccount ................................................................................................................... 45
createUser ........................................................................................................................ 46
submit ............................................................................................................................. 47
makeURL .......................................................................................................................... 48
modify ............................................................................................................................. 51
delete .............................................................................................................................. 56
whoami ............................................................................................................................ 57
servertime ........................................................................................................................ 57
logout .............................................................................................................................. 58
approve ........................................................................................................................... 59
reject ............................................................................................................................... 60
unapprove ........................................................................................................................ 61
Web Services Method Complex Types ....................................................................................... 63
Attribute ........................................................................................................................... 63
LoginParams ..................................................................................................................... 63
LoginResult ....................................................................................................................... 63
MakeURLRequest ............................................................................................................... 64
MakeURLResult ................................................................................................................. 64
ReadRequest ..................................................................................................................... 64
ReadResult ....................................................................................................................... 69
SessionHeader .................................................................................................................. 70
SubmitRequest .................................................................................................................. 71
SubmitResult ..................................................................................................................... 71
ApproveRequest ................................................................................................................ 71
ApproveResult ................................................................................................................... 72
RejectRequest ................................................................................................................... 72
RejectResult ...................................................................................................................... 72
UnapproveRequest ............................................................................................................ 73
UnapproveResult ............................................................................................................... 73
UpdateResult .................................................................................................................... 73
VersionResult .................................................................................................................... 74
Custom Fields ....................................................................................................................... 75
Requesting Custom Fields for an Object ................................................................................ 75
Reading Custom Field Values .............................................................................................. 75
Modifying Records to Set Custom Field Values ....................................................................... 76
Adding Records with Inline Custom Field Values ..................................................................... 76
Setting Allocation Grid Custom Field Values ........................................................................... 76
OpenAir Complex Types ......................................................................................................... 77
oaActualcost ..................................................................................................................... 77
oaAccountingPeriod ........................................................................................................... 78
oaAddress ........................................................................................................................ 78
oaAgreement .................................................................................................................... 79
oaAgreement_to_project ..................................................................................................... 80
oaApproval ....................................................................................................................... 80
oaApprovalLine ................................................................................................................. 80
oaApprovalProcess ............................................................................................................ 82
oaAttachment ................................................................................................................... 82
oaAttribute ....................................................................................................................... 83
oaAttributeDescription ........................................................................................................ 83
oaAttributeset ................................................................................................................... 84
oaBase ............................................................................................................................. 84
oaBillingSplit ..................................................................................................................... 85
oaBooking ........................................................................................................................ 86
oaBooking_request ............................................................................................................ 87
oaBookingByDay ............................................................................................................... 88
oaBookingType ................................................................................................................. 89
oaBudget ......................................................................................................................... 90
oaBudgetAllocation ............................................................................................................ 90
oaCategory ....................................................................................................................... 91
oaCategory_1 .................................................................................................................... 92
oaCategory_2 .................................................................................................................... 92
oaCategory_3 .................................................................................................................... 93
oaCategory_4 .................................................................................................................... 93
oaCategory_5 .................................................................................................................... 94
oaCcrate .......................................................................................................................... 94
oaCompany ...................................................................................................................... 95
oaContact ......................................................................................................................... 97
oaCostcategory ................................................................................................................. 99
oaCostcenter .................................................................................................................... 99
oaCosttype ..................................................................................................................... 100
oaCurrency ..................................................................................................................... 100
oaCurrencyrate ................................................................................................................ 100
oaCustField ..................................................................................................................... 101
oaCustomField ................................................................................................................. 103
oaCustomer .................................................................................................................... 103
oaCustomerLocation ........................................................................................................ 108
oaCustomerpo ................................................................................................................ 108
oaCustomerpo_to_project .................................................................................................. 109
oaDate ........................................................................................................................... 110
oaDeal ........................................................................................................................... 110
oaDealcontact ................................................................................................................. 111
oaDealschedule ............................................................................................................... 111
oaDepartment ................................................................................................................. 112
oaEntitytag ..................................................................................................................... 112
oaEnvelope ..................................................................................................................... 113
oaError .......................................................................................................................... 114
oaEstimate ...................................................................................................................... 114
oaEstimateadjustment ...................................................................................................... 115
oaEstimateexpense .......................................................................................................... 115
oaEstimatelabor ............................................................................................................... 116
oaEstimatemarkup ........................................................................................................... 117
oaEstimatephase ............................................................................................................. 117
oaEvent .......................................................................................................................... 118
oaExpensePolicy .............................................................................................................. 118
oaExpensePolicyItem ........................................................................................................ 119
oaFieldAttribute ............................................................................................................... 119
oaFilterset ....................................................................................................................... 120
oaForexInput .................................................................................................................. 120
oaFulfillment ................................................................................................................... 121
oaHierarchy .................................................................................................................... 121
oaHierarchyNode ............................................................................................................. 122
oaHistory ........................................................................................................................ 123
oaImportExport ............................................................................................................... 123
oaInvoice ........................................................................................................................ 124
oaInvoiceLayout ............................................................................................................... 125
oaIssue .......................................................................................................................... 126
oaIssueCategory .............................................................................................................. 127
oaIssueSeverity ................................................................................................................ 127
oaIssueSource ................................................................................................................. 128
oaIssueStage ................................................................................................................... 128
oaIssueStatus .................................................................................................................. 128
oaItem ........................................................................................................................... 129
oaItemToUserLocation ...................................................................................................... 130
oaJobcode ...................................................................................................................... 130
oaJobCodeUsed ............................................................................................................... 131
oaLeave_accrual_rule ........................................................................................................ 131
oaLeave_accrual_rule_to_user ............................................................................................. 132
oaLeave_accrual_transaction .............................................................................................. 133
oaLoadedCost ................................................................................................................. 133
oaModule ....................................................................................................................... 134
oaNewsfeed .................................................................................................................... 134
oaNewsfeedMessage ........................................................................................................ 135
oaPayment ..................................................................................................................... 135
oaPaymentterms .............................................................................................................. 136
oaPaymenttype ................................................................................................................ 136
oaPayrolltype .................................................................................................................. 137
oaPendingBooking ........................................................................................................... 137
oaPreference ................................................................................................................... 138
oaProduct ....................................................................................................................... 139
oaProject ........................................................................................................................ 140
oaProjectAssignmentProfile ............................................................................................... 145
oaProjectassign ............................................................................................................... 146
oaProjectbillingrule .......................................................................................................... 146
oaProjectbillingtransaction ................................................................................................ 151
oaProjectBudgetGroup ..................................................................................................... 152
oaProjectBudgetRule ........................................................................................................ 154
oaProjectBudgetTransaction .............................................................................................. 156
oaProjectgroup ................................................................................................................ 157
oaProjectlocation ............................................................................................................. 158
oaProjectstage ................................................................................................................ 158
oaProjecttask .................................................................................................................. 159
oaProjecttask_type ........................................................................................................... 161
oaProjecttaskassign .......................................................................................................... 162
oaProjecttaskEstimate ....................................................................................................... 162
oaProposal ..................................................................................................................... 163
oaProposalblock .............................................................................................................. 164
oaProxy .......................................................................................................................... 165
oaPurchase_item ............................................................................................................. 166
oaPurchaseorder ............................................................................................................. 168
oaPurchaser .................................................................................................................... 169
oaPurchaserequest .......................................................................................................... 170
oaRatecard ..................................................................................................................... 171
oaRateCardItem ............................................................................................................... 171
oaReimbursement ............................................................................................................ 172
oaRepeat ........................................................................................................................ 172
oaReport ........................................................................................................................ 173
oaRequest_item ............................................................................................................... 173
oaResourceAttachment ..................................................................................................... 175
oaResourceprofile ............................................................................................................ 175
oaResourceprofile_type ..................................................................................................... 176
oaResourceRequest .......................................................................................................... 176
oaResourceRequestQueue ................................................................................................ 177
oaResourcesearch ............................................................................................................ 178
oaRevenue_recognition_rule .............................................................................................. 180
oaRevenue_recognition_rule_amount .................................................................................. 182
oaRevenue_recognition_transaction .................................................................................... 183
oaRevenueContainer ........................................................................................................ 185
oaRevenueProjection ........................................................................................................ 186
oaRevenueStage .............................................................................................................. 189
oaRole ............................................................................................................................ 189
oaSchedulebyday ............................................................................................................. 190
oaScheduleexception ........................................................................................................ 190
oaSchedulerequest .......................................................................................................... 191
oaSchedulerequest_item ................................................................................................... 192
oaSlip ............................................................................................................................. 192
oaSlipProjection ............................................................................................................... 195
oaSlipstage ..................................................................................................................... 197
oaSwitch ......................................................................................................................... 197
oaTagGroup .................................................................................................................... 197
oaTagGroupAttribute ........................................................................................................ 198
oaTargetUtilization ........................................................................................................... 198
oaTask ........................................................................................................................... 199
oaTaskTimecard ............................................................................................................... 202
oaTaxLocation ................................................................................................................. 203
oaTaxRate ....................................................................................................................... 204
oaTerm .......................................................................................................................... 204
oaTicket .......................................................................................................................... 205
oaTimecard ..................................................................................................................... 207
oaTimesheet ................................................................................................................... 208
oaTimetype ..................................................................................................................... 209
oaTodo .......................................................................................................................... 210
oaUprate ........................................................................................................................ 211
oaUser ........................................................................................................................... 211
oaUserLocation ............................................................................................................... 219
oaUserWorkschedule ........................................................................................................ 219
oaVendor ....................................................................................................................... 220
oaViewfilter ..................................................................................................................... 222
oaViewfilterrule ................................................................................................................ 222
oaWorkscheduleWorkhour ................................................................................................ 223
oaWorkspace .................................................................................................................. 223
oaWorkspacelink .............................................................................................................. 224
oaWorkspaceuser ............................................................................................................ 225
Setting Application Switches Via the API .................................................................................. 226
Code Examples .................................................................................................................... 227
Login Functions ............................................................................................................... 227
Read Functions ................................................................................................................ 229
Error Code Listing ................................................................................................................ 232
OpenAir Data Dictionary ....................................................................................................... 245
Best Practices ...................................................................................................................... 246
Build the API Integration .................................................................................................. 246
Optimize the API Integration ............................................................................................. 247
Maintain the API Integration .............................................................................................. 248
Troubleshooting .................................................................................................................. 250
New Features ...................................................................................................................... 251
Interim Features .............................................................................................................. 251
Features for October 8, 2022 ............................................................................................. 251
Features for April 9, 2022 ................................................................................................. 251
Features for October 9, 2021 ............................................................................................. 251
Features for April 10, 2021 ................................................................................................ 252
Features for October 10, 2020 ........................................................................................... 252
Features for April 18, 2020 ................................................................................................ 252
Features for October 12, 2019 ........................................................................................... 253
Features for April 13, 2019 ................................................................................................ 253
Features for October 13, 2018 ........................................................................................... 253
Features for April 14, 2018 ................................................................................................ 254
Features for October 14, 2017 ........................................................................................... 254
Features for April 15, 2017 ................................................................................................ 254
Features for October 15, 2016 ........................................................................................... 255
Features for April 16, 2016 ................................................................................................ 256
Features for October 17, 2015 ........................................................................................... 256
Features for April 18, 2015 ................................................................................................ 256
Features for October 18, 2014 ........................................................................................... 256
Features for May 17, 2014 ................................................................................................ 257
Features for February 15, 2014 .......................................................................................... 257
Features for November 16, 2013 ........................................................................................ 257
Features for August 17, 2013 ............................................................................................ 258
Features for May 18, 2013 ................................................................................................ 258
Features for March 16, 2013 ............................................................................................. 259
Features for January 19, 2013 ............................................................................................ 259
Features for November 17, 2012 ........................................................................................ 259
Features for July 14, 2012 ................................................................................................. 259
Features for May 12, 2012 ................................................................................................ 260
Features for March 17, 2012 ............................................................................................. 260
Features for January 21, 2012 ............................................................................................ 261
Features for November 19, 2011 ........................................................................................ 261
Features for September 17, 2011 ....................................................................................... 261
Features for July 16, 2011 ................................................................................................. 262
Features for May 14, 2011 ................................................................................................ 262
Features for March 19, 2011 ............................................................................................. 263
Features for January 22, 2011 ............................................................................................ 263
Features for November 20, 2010 ........................................................................................ 263
Features for September 18, 2010 ....................................................................................... 264
Features for July 17, 2010 ................................................................................................. 265
Features for May 15, 2010 ................................................................................................ 265
Features for March 20, 2010 ............................................................................................. 266
Features for January 23, 2010 ............................................................................................ 267
Features for November 21, 2009 ........................................................................................ 268
Introduction to OpenAir Web Services 1
Introduction to OpenAir Web Services
OpenAir provides OpenAir Web Services as a layer for the exchange of OpenAir data between the
main site and peripheral programs. These programs include partnered Web sites, OpenAir in-house
applications that don't need direct database access, and third party applications indirectly supported
through OpenAir. Before you begin using this service, we recommend that you review Best Practices.
The application programming interface (API) is data-centric, but it is not a direct line into the OpenAir
database. While it provides access to much of the information on OpenAir, it is a layer of indirection from
the actual database structure. OpenAir's database structure may change, but applications that use the
API will not need to change. OpenAir Web Services exist in addition to the OpenAir XML API and serve as
a wrapper around the XML API, providing the same or very similar functionality. See OpenAir XML API
Reference Guide for detailed documentation.
Technology
OpenAir Web Services are based on Simple Object Access Protocol (SOAP), an XML-based convention. The
following standards are observed.
Standard Name Web Site Reference
Simple Object Access Protocol (SOAP) 1.1 http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
Web Service Description Language (WSDL) 1.1 http://www.w3.org/TR/2001/NOTE-wsdl-20010315
Since OpenAir Web Services are database-driven, it is important that the information you collect from
your users is compatible with the fields in the database. We provide you with the list of commands and
data types that are meaningful to an OpenAir database. Through the use of commands and data types
provided by the API, and by limiting the values that can be stored in each data type, your data will always
be consistent with, and able to be stored within, an OpenAir database.
Target Audience
This document is intended for developers of applications that will connect to the OpenAir Web site.
Overview
The following provides a brief description of what's included in OpenAir SOAP Web Services.
■ Getting Started — includes steps for what you should do to begin using OpenAir Web Services. It
includes general procedures for connecting to the OpenAir API. It also includes specific instructions
for integrations based on Apache Axis libraries or .NET Framework with Microsoft Visual Studio as the
IDE.
■ Methods — lists the supported calls in the API and the syntax, use, arguments, and response of each
call as well as sample C# code and Java code.
■ Web Services Method Complex Types - lists OpenAir-specific datatypes that are required for
executing requests and reading responses with the SOAP API. Provides datatype properties and
methods in which the specific type is used.
SOAP API Reference Guide