Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > ContactSnapshot

ContactSnapshot

The ContactSnapshot object preserves a record at a particular point in time of the Bill-To contact or Sold-To contact on a customer account. When invoices are posted, Zuora preserves the Bill To contact and Sold To contact of the invoices in the contact snapshots. If you subsequently update the contact information on a customer account, the original contact information at the time the invoice was posted is saved in ContactSnapshot object instances. 

To preserve contact information when invoices are posted, you must have the following billing rule enabled:

Preserve snapshot of bill-to and sold-to contacts when billing documents are posted

You can retrieve the historical contact information by querying this object.

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

Query
Filter

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: WSDL 85.0+

Values: a valid account ID

Address1

optional

Query
Filter

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 85.0+

Values: a string of 255 characters or fewer

Address2 optional

Query
Filter

The second line of the contact's address.

Type: string

Character limit: 255

Version notes: WSDL 85.0+

Values: a string of 255 characters or fewer

City optional

Query
Filter

The city of the contact's address.

Type: string

Character limit: 40

Version notes: WSDL 85.0+

Values: a string of 40 characters or fewer

ContactId

optional

Query
Filter

The ID of the contact that has the snapshot. 

Type: zns:ID

Character limit: 32

Version notes: WSDL 85.0+

Values: a valid contact ID

Country optional

Query
Filter

The country of the contact's address. If using Zuora 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

: WSDL 85.0+

Values: a valid country name or abbreviation

County optional

Query
Filter

The country. May optionally be used by Z-Tax to calculate county tax.

Type: string

Character limit: 32

Version notes: WSDL 85.0+

Values: a string of 32 characters or fewer

CreatedById optional

Query
Filter

The ID of the Zuora user who created the contact.

Type: zns:ID

Character limit: 32

Version notes: WSDL 85.0+

Values: automatically generated

CreatedDate optional

Query
Filter

The date when the contact was created.

Type: dateTime

Character limit: 29

Version notes: WSDL 85.0+

Values: automatically generated

Description optional

Query
Filter

A description for the contact.

Type: string

Character limit: 100

Version notes: WSDL 85.0+

Values: a string of 100 characters or fewer

Fax optional

Query
Filter

The contact's fax number.

Type: string

Character limit: 40

Version notes: WSDL 85.0+

Values: a string of 40 characters or fewer

FirstName optional

Query
Filter

The contact's first name.

Type: string

Character limit: 100

Version notes: WSDL 85.0+

Values: a string of the contact's first name

HomePhone optional

Query
Filter

The contact's home phone number.

Type: string

Character limit: 40

Version notes: WSDL 85.0+

Values: a string of 40 characters or fewer

LastName optional

Query
Filter

The contact's last name.

Type: string

Character limit: 100

Version notes: WSDL 85.0+

Values: a string of 100 characters or fewer

MobilePhone optional

Query
Filter

The contact's mobile phone number.

Type: string

Character limit: 40

Version notes: WSDL 85.0+

Values: a string of 40 characters or fewer

NickName optional

Query
Filter

A nickname for the contact.

Type: string

Character limit: 100

Version notes: WSDL 85.0+

Values: a string of 100 characters or fewer

OtherPhone optional

Query
Filter

An additional phone number for the contact.

Type: string

Character limit: 40

Version notes: WSDL 85.0+

Values: a string of 40 characters or fewer

OtherPhoneType optional

Query
Filter

The type of the OtherPhone.

Type: string

Character limit: 20

Version notes: WSDL 85.0+

Values: Work, Mobile, Home, Other

PersonalEmail optional

Query
Filter

The contact's personal email address.

Type: string

Character limit: 80

Version notes: WSDL 85.0+

Values: a string of 80 characters or fewer

PostalCode optional

Query
Filter

The zip code for the contact's address.

Type: string

Character limit: 20

Version notes: WSDL 85.0+

Values: a string of 20 characters or fewer

State optional

Query
Filter

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 85.0+

Values: a valid state name or abbreviation

TaxRegion optional

Query
Filter

If using Z-Tax, a region string as optionally defined in your tax rules. Not required.

Type: string

Character limit: 32

Version notes: WSDL 85.0+

Values: a string defined in your Z-Tax tax rules

UpdatedById optional

Query
Filter

The ID of the user who lasted updated the contact.

Type: zns:ID

Character limit: 32

Version notes: WSDL 85.0+

Values: automatically generated

UpdatedDate optional

Query
Filter

The date when the contact was last updated.

Type: dateTime

Character limit: 29

Version notes:WSDL 85.0+

Values: automatically generated

WorkEmail optional

Query
Filter

The contact's business email address.

Type: string

Character limit: 80

Version notes: WSDL 85.0+

Values: a string of 80 characters or fewer

WorkPhone optional

Query
Filter

The contact's business phone number.

Type: string

Character limit: 40

Version notes: WSDL 85.0+

Values: a string of 40 characters or fewer

Example 

Query a Snapshot of Bill To Contact

This example shows how to retrieve a previous Bill To contact information.

  1. Get the ID of the Bill To contact from the Invoice object. The invoice ID is 4028902a5b1d3742015b1d417bc7021f. This call returns the snapshot ID of the Bill To contact.
    select BillToContactSnapshotId from Invoice where Id='4028902a5b1d3742015b1d417bc7021f'
  2. Get certain contact information from the ContactSnapshot object with the snapshot ID.
    select AccountId, Address1, Address2, City, ContactId, Country, County, CreatedById, CreatedDate, Description, Fax, FirstName, HomePhone, LastName, MobilePhone, NickName, OtherPhone, OtherPhoneType, PersonalEmail, PostalCode, State, TaxRegion, UpdatedById, UpdatedDate, WorkEmail, WorkPhone from ContactSnapshot where ContactId = '4028902a5b1d3742015b1d41438e020b'
Last modified
19:34, 16 Apr 2017

Tags

This page has no custom tags.

Classifications

(not set)