Contact
From API Documentation
This defines the contact (the end user) for the account. There are two types of contacts that need to be created as part of the customer account creation: the Bill-To and the Sold-To contacts. Contact provides the attributes needed to create these.
Supported Calls
This object is used in the create, query, update, and delete calls.
Fields
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name | Required? | Type | Allowed Operations: ● Yes ○ No | Allowable Values | Description |
|---|---|---|---|---|---|
| AccountId | No for the subscribe call. Yes for all other cases. | zns:ID | ● Create
● Query | A valid account ID (32 characters maximum) | This is the Zuora system account ID that this contact is associated with. |
| Address1 | In version 13+, this is not required. In version 12-, required if a Bill To contact is being specified. | string | ● Create
● Query | 255 characters maximum | The first line of the contact's address. This could be, for example, a street address or a PO box number. |
| Address2 | No | string | ● Create
● Query | 255 characters maximum | The second line of the contact's address. |
| City | In version 13+, this is not required. In version 12 and earlier, required if a Bill To contact is being specified. If you are a customer of Z-Taxation, this may be required. | string | ● Create
● Query | 40 characters maximum | The city portion of the contact's address. |
| Country | In version 13+, this is not required. In version 12-, required if a Bill To contact is being specified. If you are a customer of Z-Taxation, this may be required. | string | ● Create
● Query | 32 characters maximum | The country portion of the contact's address. Country names must be spelled in full; we have provided a list of supported country names. |
| County | In version 13+, this is not required. In version 12 and earlier, this is required if you are specifying a Bill To contact. If you are a customer of Z-Taxation, this may be required. | string | ● Create
● Query | 32 characters maximum | The county of the contact's address. Used by Z-Taxation for county-level tax calculations. See Country and State Codes for more information. |
| CreatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | This field is not editable. 32 characters maximum. | Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who created the object. |
| CreatedDate | Yes | dateTime, system generated | ○ Create
● Query | This field is not editable. | The Zuora system automatically generates this date when the contact is created. |
| Description | No | string | ● Create
● Query | 100 characters maximum | Description field for the contact. |
| Fax | No | string | ● Create
● Query | 40 characters maximum | The contact's fax number. |
| FirstName | Yes | string | ● Create
● Query | 100 characters maximum | The contact's first name, given name, or personal name. |
| HomePhone | No | string | ● Create
● Query | 40 characters maximum | The contact's home phone number. |
| LastName | Yes | string | ● Create
● Query | 100 characters maximum | The contact's last name, surname, or family name. |
| MobilePhone | No | string | ● Create
● Query | 40 characters maximum | The contact's mobile phone number. |
| NickName | No | string | ● Create
● Query | 100 characters maximum | A nickname for the contact. |
| OtherPhone | No | string | ● Create
● Query | 40 characters maximum | Another phone number for the contact. |
| OtherPhoneType | No | string | ● Create
● Query | Work, Mobile, Home, Other. 20 characters maximum. | The type of phone number (home, mobile, office, etc.) for the contact's other phone number. |
| PersonalEmail | No | string | ● Create
● Query | 80 characters maximum | The contact's personal email address. |
| PostalCode | In version 13+, this is not required. In version 12 and earlier, this is required if a Bill To contact is specified. If you are a customer of Z-Taxation, this may be required. | string | ● Create
● Query | 20 characters maximum | The postal code for the contact's address. |
| State | In version 13+, this is not required. In version 12 and earlier, this is required if a Bill To contact is being specified. If you are a customer of Z-Taxation, this may be required. | string | ● Create
● Query | 40 characters maximum | The state or province portion of the contact's address. State names must be spelled in full; we've provided a list of supported state names. |
| TaxRegion | No. Only applicable to users of Z-Taxation. | string | ● Create
● Query | Any string that matches your tax rules. 32 characters maximum. | This is the tax region that belongs to the contact. It will be used to match against the tax rules you've defined in Z-Taxation. |
| UpdatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | This field is not editable. 32 characters maximum. | Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object. |
| UpdatedDate | Yes, system generated | dateTime | ○ Create
● Query | This field is not editable | The Zuora system automatically generates this date when the contact is modified. |
| WorkEmail | In version 13+, this is not required. In version 12-, required if a Bill To contact is being specified. If you are a customer of Z-Taxation, this may be required. | string | ● Create
● Query | 80 characters maximum | The contact's work email address. |
| WorkPhone | No | string | ● Create
● Query | 40 characters maximum | The contact's work telephone number. |
