Understanding the Zuora WSDL
From API Documentation
If you think of calls as verbs and objects as the things that those calls act upon, then the WSDL shows the verbs and objects the Zuora API understands. It defines the interface to the Zuora API and describes its data types so that your application can know how to send messages to Zuora.
Contents |
Accessing the Production WSDL
To access the production WSDL:
- Log in from the Zuora.com home page
- Select Z-Billing > Settings > Download the Zuora WSDL.
- Select Download the Zuora WSDL.
Order of Object Fields
When sending Zuora an XML SOAP message with values for an object's fields, you must pass in the fields in the order in which they are defined on the objects.
WSDL Data Types
The WSDL has certain data types that the Zuora API uses. The following table describes these WSDL data types for your convenience. information on allowable lengths and values is provided with the specific calls.
| Data Type | Description |
| boolean | A boolean data type can only have one of two values: true or false. These values can also be represented as true, yes, or 1 (one), or false, no, or 0 (zero). |
| date | A date data type represents a specific moment in time as a date only. The discussion of date for dateTime applies; see that entry, below, for more information. |
| dateTime | A dateTime data type represents a specific moment in time as both a date and a time. It contains a year, a month, and a date, and also hours, minutes, seconds, and milliseconds. The date range is 10,000 years, from January 1 of the year 1 to December 31, 9999.
The value is in Coordinated Universal Time (UTC). Unlike local time, any given date and time in UTC is the same everywhere on earth simultaneously. Therefore, you may wish or need to convert this value from UTC to local time. Also, refer to the documentation for your development tool to see how it handles dateTime data types. And be aware of the differences in how dates are specified in different languages. For example, the month and day portion of a date can be interpreted as either dd/mm or as mm/dd. This data type can be very handy to specify in queries, as you can filter on the dateTime fields only. Some of the date fields in the API are automatically generated by the system, such as CreatedDate and UpdatedDate. |
| double | A double data type is a double-precision 64-bit IEEE 754 floating point value. It is used for data that might contain decimal values. double values might be limited as follows:
precision: The sum of the number digits on both sides of the decimal point. scale: The maximum allowed number of digits to the right of the decimal point. The maximum number of digits to the left of the decimal place is calculated by subtracting scale from precision. With double values, if the number is large enough (for positive values) or small enough (for negative values), the values can be stored in scientific notation. For more information, see the W3C XML Schema Part 2: Datatypes Second Edition specification. |
| int | An int (integer) data type is a whole number without a decimal point or any value that would follow a decimal point. For example, 1 is an integer. However, 1.0 and 1. are not. An integer can be a negative number. |
| long | The long data type is a 64-bit signed two's complement integer. It has a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807. This data type is generally used when the int data type is not large enough. |
| string | The string data type can contain characters, line feeds, carriage returns, and tab characters. |
See Also
- You can obtain the WSDL at the following URL: https://www.zuora.com/apps/Api.do. You will need to have login credentials to access the WSDL. Contact your Zuora representative for those credentials if you do not already have them.
- For information on importing the WSDL into your development environment, see Preparatory Tasks.
- For information on how the data types are interpreted, see Field Types.
- See WSDL and API Versions for more information about WSDL and API versions.
