1. API
  2. XML API and SOAP API
  3. Getting Started with the XML API and SOAP API
  4. XML Schema and WSDL Definition Documents

XML Schema and WSDL Definition Documents

This topic provides steps to generate and download the following reference documents:

Note:

The SuiteProjects Pro WSDL definition is available with the following binding styles:

  • rpc-encoded – Remote procedure call (rpc) style, encoded use.

  • wrapped document-literal – Document style, literal use, wrapped. One advantage of the wrapped document-literal binding style is that everything in the SOAP body is described by the XML schema and can therefore be validated against XML schema definitions.

The wrapped document-literal WSDL supports the login(), read(), add(), createUser(), modify(), and delete() methods only.

XML Schema Definitions

SuiteProjects Pro provides an XML schema for each business object type supported by the XML API.

Account administrators and users with the Export data role permission can use the following steps to download the account-specific SuiteProjects Pro WSDL.

To download the XML schema definitions:

  1. Go to Administration > Global Settings > Account > Integration: Import/Export.

    You must be an account administrator or have the Export data role permission to access this page.

  2. Click XSD schema files.

    SuiteProjects Pro generates a ZIP archive containing XML schema definitions for each business object type supported by the XML API. A confirmation page appears on completion.

  3. Click the Click here link to download the ZIP archive to your computer

SuiteProjects Pro WSDL Definition

To view the SuiteProjects Pro WSDL definition in your browser, enter one of the following URLs in the address bar, replacing <company-id> with the unique identifier for your account domain. The URL you use depends on the type of SuiteProjects Pro account and the required WSDL binding style. You can then save the page to your computer to retain a local copy of the WSDL definition.

Account type

WSDL – rpc-encoded binding

WSDL – wrapped document-literal binding

Production

https://<company-id>.app.netsuitesuiteprojectspro.com/wsdl.pl

https://<company-id>.app.netsuitesuiteprojectspro.com/wsdl.pl?style=document

Sandbox

https://<company-id>.app.sandbox.netsuitesuiteprojectspro.com/wsdl.pl

https://<company-id>.app.sandbox.netsuitesuiteprojectspro.com/wsdl.pl?style=document

Note:

OpenAir is now SuiteProjects Pro. As of 5 a.m. Eastern Time (UTC–5) on January 25, 2025, for your sandbox account, and on February 15, 2025, for your production account, service URLs with the netsuitesuiteprojectspro.com domain name replace URLs with the openair.com domain name.

For your production account, the WSDL URL now is https://<company-id>.app.netsuitesuiteprojectspro.com/wsdl.pl.

For backward compatibility, WSDL URLs with the openair.com domain name continue to be supported until further notice.

For more information about the change, see Introducing SuiteProjects Pro.

Account-Specific SuiteProjects Pro WSDL Definition

The account-specific SuiteProjects Pro WSDL definition includes custom fields defined for your account

Account administrators and users with the Export data role permission can use the following steps to generate the account-specific SuiteProjects Pro WSDL.

To generate and save the account-specific SuiteProjects Pro WSDL definition:

  1. Go to Administration > Global Settings > Account > Integration: Import/Export.

  2. Click Account specific WSDL.

    The rpc-encoded account-specific WSDL appears in a new browser tab.

  3. (Optional) To generate the wrapped document-literal account-specific WSDL, append a semi-colon (;) and style=document to the URL in the address bar of your browser and press Enter.

  4. Save the page to your computer to retain a local copy of the WSDL definition.