Contact
The Contact object defines the customer who holds an account or who is otherwise a person to contact about an account. An Account object requires a contact for the BillToId and SoldToId fields before the account can be active. The Contact object provides the attributes that these Account object fields need.
Supported calls
You can use this object with the following calls:
Field Descriptions
All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.
| Name | Require to Create? | Allowed Operations |
Description |
|---|---|---|---|
|
AccountId |
optional |
Create |
The Zuora account ID associated with this contact. This field is not required when you use the subscribe() call. This field is required for all other calls. Type: zns:ID Character limit: 32 Version notes: -- Values: a valid account ID |
| Address1 |
optional |
Create |
The first line of the contact's address, which is often a street address or business name. Type: string Character limit: 255 Version notes: WSDL 12.0 and older require this field for Bill To contacts Values: a string of 255 characters or fewer |
| Address2 | optional |
Create |
The second line of the contact's address. Type: string Character limit: 255 Version notes: -- Values: a string of 255 characters or fewer |
| City | optional |
Create |
The city of the contact's address. Type: string Character limit: 40 Version notes: WSDL 12.0 and older require this field for Bill To contacts Values: a string of 40 characters or fewer |
| Country | conditional |
Create |
The country of the contact's address. If using Z-Tax, be aware that it requires a country in the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. Type: string Character limit: 32 Version notes: WSDL 12.0 and older require this field for bill-to contacts |
| County | optional |
Create |
The country. May optionally be used by Z-Tax to calculate county tax. Type: string Character limit: 32 Version notes: WSDL 12.0 and older require this field for Bill To contacts Values: a string of 32 characters or fewer |
| CreatedById | optional |
Query |
The ID of the Zuora user who created the contact.
Type: zns:ID Character limit: 32 Version notes: WSDL 20.0+ Values: automatically generated |
| CreatedDate | optional |
Query |
The date when the contact was created.
Type: dateTime Character limit: 29 Version notes: WSDL 20.0+ Values: automatically generated |
| Description | optional |
Create |
A description for the contact. Type: string Character limit: 100 Version notes: -- Values: a string of 100 characters or fewer |
| Fax | optional |
Create |
The contact's fax number. Type: string Character limit: 40 Version notes: -- Values: a string of 40 characters or fewer |
| FirstName | required |
Create |
The contact's first name. Type: string Character limit: 100 Version notes: -- Values: a string of the contact's first name |
| HomePhone | optional |
Create |
The contact's home phone number. Type: string Character limit: 40 Version notes: -- Values: a string of 40 characters or fewer |
| Id | required | Query Filter |
The ID of this object. Upon creation of this object, this field becomes Type: zns:ID Character limit: 32 Version notes: -- Values: automatically generated |
| LastName | required |
Create |
The contact's last name. Type: string Character limit: 100 Version notes: -- Values: a string of 100 characters or fewer |
| MobilePhone | optional |
Create |
The contact's mobile phone number. Type: string Character limit: 40 Version notes: -- Values: a string of 40 characters or fewer |
| NickName | optional |
Create |
A nickname for the contact. Type: string Character limit: 100 Version notes: -- Values: a string of 100 characters or fewer |
| OtherPhone | optional |
Create |
An additional phone number for the contact. Type: string Character limit: 40 Version notes: -- Values: a string of 40 characters or fewer |
| OtherPhoneType | optional |
Create |
The type of the OtherPhone.
Type: string Character limit: 20 Version notes: -- Values: |
| PersonalEmail | optional |
Create |
The contact's personal email address. Type: string Character limit: 80 Version notes: -- Values: a string of 80 characters or fewer |
| PostalCode | optional |
Create |
The zip code for the contact's address. Type: string Character limit: 20 Version notes: WSDL 12.0 and older require this field for Bill To contacts Values: a string of 20 characters or fewer |
| State | optional |
Create |
The state or province of the contact's address. If using Z-Tax, be aware that if the country is USA or Canada, Z-Tax requires a state or province in the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. Type: string Character limit: 40 Version notes: WSDL 12.0 and older require this field for Bill To contacts |
| TaxRegion | optional |
Create |
If using Z-Tax, a region string as optionally defined in your tax rules. Not required.
Type: string Character limit: 32 Version notes: Z-Tax Values: a string defined in your Z-Tax tax rules |
| UpdatedById | optional |
Query |
The ID of the user who lasted updated the contact. Type: zns:ID Character limit: 32 Version notes: WSDL 20.0+ Values: automatically generated |
| UpdatedDate | optional |
Query |
The date when the contact was last updated. Type: dateTime Character limit: 29 Version notes: WSDL 20.0+ Values: automatically generated |
| WorkEmail | optional |
Create |
The contact's business email address. Type: string Character limit: 80 Version notes: WSDL 12.0 and older require this field for Bill To contacts Values: a string of 80 characters or fewer |
| WorkPhone | optional |
Create |
The contact's business phone number. Type: string Character limit: 40 Version notes: -- Values: a string of 40 characters or fewer |
Additional Field Detail
Here's more information we think you might like to have about some of these fields. Use the Comments form at the bottom of this page if you have more questions.
Id
The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscription object's ID with the call.
The ID for the Contact object is ContactId.