Explore Plans
Mobile menu Close menu
WaveWave

Find or create a customer

This query returns a customer matching the given email.

Developer info

API endpoint slug
wave.find_or_create_customer
Runtime method
performQuery("wave.find_or_create_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
The email of the customer.
Slug
email
Required
true
Can have default value
true

Name Text input > Other

Label
Customer or Company Name
Helper text
Optional: This name will only be used to create a new customer if none exists for the email entered above.
Slug
name
Required
false
Can have default value
true

Ingredients

Contact first nameThe first name of the principal contact.

Slug
first_name
Filter code
Wave.findOrCreateCustomer.ContactFirstName
Type
String
Example
John

Contact last nameThe last name of the principal contact.

Slug
last_name
Filter code
Wave.findOrCreateCustomer.ContactLastName
Type
String
Example
Doe

EmailThe email of the principal contact.

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

Customer nameThe name or business name of the customer.

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

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

Slug
display_id
Filter code
Wave.findOrCreateCustomer.AccountNumber
Type
String
Example
123

Internal notesThe internal notes of the customer.

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

WebsiteThe website address of the customer.

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

PhoneThe telephone number of the customer.

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

MobileThe mobile number of the customer.

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

Toll freeThe toll-free number of the customer.

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

FaxThe fax number of the customer.

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

CurrencyThe default currency used by the customer.

Slug
currency
Filter code
Wave.findOrCreateCustomer.Currency
Type
String
Example
USD

Outstanding amountAmount due on customer's invoices.

Slug
outstanding_amount
Filter code
Wave.findOrCreateCustomer.OutstandingAmount
Type
String
Example
100

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

Slug
overdue_amount
Filter code
Wave.findOrCreateCustomer.OverdueAmount
Type
String
Example
100

AddressThe address of the customer.

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

CityThe city of the customer's address.

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

StateThe state or province of the customer's address.

Slug
state
Filter code
Wave.findOrCreateCustomer.State
Type
String
Example
CA

CountryThe country of the customer's address.

Slug
country
Filter code
Wave.findOrCreateCustomer.Country
Type
String
Example
US

Postal codeThe postal code of the customer's address

Slug
postal_code
Filter code
Wave.findOrCreateCustomer.PostalCode
Type
String
Example
94114

Shipping nameThe shipping name or business name of the customer.

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

Shipping phoneThe shipping telephone number of the customer.

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

Shipping addressThe shipping address of the customer.

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

Shipping cityThe city of the customer's shipping address.

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

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

Slug
shipping_state
Filter code
Wave.findOrCreateCustomer.ShippingState
Type
String
Example
CA

Shipping countryThe country of the customer's shipping address.

Slug
shipping_country
Filter code
Wave.findOrCreateCustomer.ShippingCountry
Type
String
Example
US

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

Slug
shipping_postal_code
Filter code
Wave.findOrCreateCustomer.ShippingPostalCode
Type
String
Example
94114

Shipping instructionsDetails for shipping to the customer.

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

Created atDate and time the customer was created.

Slug
created_at
Filter code
Wave.findOrCreateCustomer.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.findOrCreateCustomer.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.findOrCreateCustomer.Id
Type
String
Example
123

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

Slug
business_id
Filter code
Wave.findOrCreateCustomer.BusinessId
Type
String
Example
123

Is archivedWhether or not the customer is archived.

Slug
is_archived
Filter code
Wave.findOrCreateCustomer.IsArchived
Type
String
Example
true