Find a customer

This query returns an existing customer.

Developer info

API endpoint slug: wave.find_customer
Runtime method: performQuery("wave.find_customer"}

Query fields

Business Dropdown list

Label: Which business?
Helper text: Required: Select your account to use.
Slug: business_id
Required: true
Can have default value: false

Email Text input > Other

Label: What email?
Helper text: Required: Enter the email of the customer.
Slug: email
Required: true
Can have default value: true

Ingredients

Contact first name The first name of the principal contact.

Slug: first_name
Filter code: Wave.findCustomer.ContactFirstName
Type: String
Example: John

Contact last name The last name of the principal contact.

Slug: last_name
Filter code: Wave.findCustomer.ContactLastName
Type: String
Example: Doe

Email The email of the principal contact.

Slug: email
Filter code: Wave.findCustomer.Email
Type: String
Example: example@example.com

Customer name The name or business name of the customer.

Slug: name
Filter code: Wave.findCustomer.CustomerName
Type: String
Example: John Doe

Account number The custom account number or ID you assigned to the customer.

Slug: display_id
Filter code: Wave.findCustomer.AccountNumber
Type: String
Example: 123

Internal notes The internal notes of the customer.

Slug: internal_notes
Filter code: Wave.findCustomer.InternalNotes
Type: String
Example: This is a note

Website The website address of the customer.

Slug: website
Filter code: Wave.findCustomer.Website
Type: String
Example: https://example.com

Phone The telephone number of the customer.

Slug: phone
Filter code: Wave.findCustomer.Phone
Type: String
Example: 123-456-7890

Mobile The mobile number of the customer.

Slug: mobile
Filter code: Wave.findCustomer.Mobile
Type: String
Example: 123-456-7890

Toll free The toll-free number of the customer.

Slug: toll_free
Filter code: Wave.findCustomer.TollFree
Type: String
Example: 123-456-7890

Fax The fax number of the customer.

Slug: fax
Filter code: Wave.findCustomer.Fax
Type: String
Example: 123-456-7890

Currency The default currency used by the customer.

Slug: currency
Filter code: Wave.findCustomer.Currency
Type: String
Example: USD

Outstanding amount Amount due on customer's invoices.

Slug: outstanding_amount
Filter code: Wave.findCustomer.OutstandingAmount
Type: String
Example: 100

Overdue amount Amount due on customer's invoices with due date that have passed.

Slug: overdue_amount
Filter code: Wave.findCustomer.OverdueAmount
Type: String
Example: 100

Address The address of the customer.

Slug: address
Filter code: Wave.findCustomer.Address
Type: String
Example: 123 Main St

City The city of the customer's address.

Slug: city
Filter code: Wave.findCustomer.City
Type: String
Example: San Francisco

State The state or province of the customer's address.

Slug: state
Filter code: Wave.findCustomer.State
Type: String
Example: CA

Country The country of the customer's address.

Slug: country
Filter code: Wave.findCustomer.Country
Type: String
Example: US

Postal code The postal code of the customer's address

Slug: postal_code
Filter code: Wave.findCustomer.PostalCode
Type: String
Example: 94114

Shipping name The shipping name or business name of the customer.

Slug: shipping_name
Filter code: Wave.findCustomer.ShippingName
Type: String
Example: John Doe

Shipping phone The shipping telephone number of the customer.

Slug: shipping_phone
Filter code: Wave.findCustomer.ShippingPhone
Type: String
Example: 123-456-7890

Shipping address The shipping address of the customer.

Slug: shipping_address
Filter code: Wave.findCustomer.ShippingAddress
Type: String
Example: 123 Main St

Shipping city The city of the customer's shipping address.

Slug: shipping_city
Filter code: Wave.findCustomer.ShippingCity
Type: String
Example: San Francisco

Shipping state The state or province of the customer's shipping address.

Slug: shipping_state
Filter code: Wave.findCustomer.ShippingState
Type: String
Example: CA

Shipping country The country of the customer's shipping address.

Slug: shipping_country
Filter code: Wave.findCustomer.ShippingCountry
Type: String
Example: US

Shipping postal code The postal code of the customer's shipping address.

Slug: shipping_postal_code
Filter code: Wave.findCustomer.ShippingPostalCode
Type: String
Example: 94114

Shipping instructions Details for shipping to the customer.

Slug: shipping_instructions
Filter code: Wave.findCustomer.ShippingInstructions
Type: String
Example: This is a note

Created at Date and time the customer was created.

Slug: created_at
Filter code: Wave.findCustomer.CreatedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06+05:00

Modified at When the customer was last modified.

Slug: modified_at
Filter code: Wave.findCustomer.ModifiedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06+05:00

Id Unique identifier for the customer.

Slug: id
Filter code: Wave.findCustomer.Id
Type: String
Example: 123

Business The unique identifier for your business that the customer belongs to.

Slug: business_id
Filter code: Wave.findCustomer.BusinessId
Type: String
Example: 123

Is archived Whether or not the customer is archived.

Slug: is_archived
Filter code: Wave.findCustomer.IsArchived
Type: String
Example: true