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 ID 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 nameThe first name of the principal contact.

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

Contact last nameThe last name of the principal contact.

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

EmailThe email of the principal contact.

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

Customer nameThe name or business name of the customer.

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

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

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

Internal notesThe internal notes of the customer.

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

WebsiteThe website address of the customer.

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

PhoneThe telephone number of the customer.

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

MobileThe mobile number of the customer.

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

Toll freeThe toll-free number of the customer.

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

FaxThe fax number of the customer.

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

CurrencyThe default currency used by the customer.

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

Outstanding amountAmount due on customer's invoices.

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

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

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

AddressThe address of the customer.

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

CityThe city of the customer's address.

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

StateThe state or province of the customer's address.

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

CountryThe country of the customer's address.

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

Postal codeThe postal code of the customer's address

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

Shipping nameThe shipping name or business name of the customer.

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

Shipping phoneThe shipping telephone number of the customer.

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

Shipping addressThe shipping address of the customer.

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

Shipping cityThe city of the customer's shipping address.

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

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

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

Shipping countryThe country of the customer's shipping address.

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

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

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

Shipping instructionsDetails for shipping to the customer.

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

Created atDate 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.000+05:00

Modified atWhen the customer was last modified.

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

IDUnique identifier for the customer.

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

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

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

Is archivedWhether or not the customer is archived.

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