Skip to content

Mercury: Customers schemas

6 Mercury schemas with complete fields and constraints.

← Customers operations · All schemas

Create a customer — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest data to create a customer using the public api
Additional keys: not allowed
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Create a customer — request body — body address The address for the customer Address input for creating or updating customers
address (anyOf 1) (allOf 2)JSONAll variants applyThe address for the customer.
address (anyOf 2)nullAlternative
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
email (allOf 2)JSONAll variants applyThe email address for the customer.
namestringRequired within parentThe name of the customer.
Maximum length: 5000
Minimum length: 1

Referenced models: Create a customer — request body — body address The address for the customer Address input for creating or updating customers

Create a customer — request body — body address The address for the customer Address input for creating or updating customers

FieldTypePresenceDescription and constraints
$objectRootAddress input for creating or updating customers
Additional keys: not allowed
address1stringRequired within parentPrimary street address line.
Maximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeSecondary street address line (optional).
Maximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
Maximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
country (allOf 2)JSONAll variants applyTwo-letter country code (ISO 3166-1 alpha-2).
namestringRequired within parentThe mailing name of the address.
postalCodestringRequired within parentPostal or ZIP code.
Maximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
region (allOf 2)JSONAll variants applyEither a two-letter US state code i.e. "CA" for California or a free-form identification of a particular region worldwide.

Get a customer — response body

FieldTypePresenceDescription and constraints
$objectRootResponse data for Accounts Receivable customer API endpoints
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
address (anyOf 1) (allOf 2)JSONAll variants applyAddress of customer.
address (anyOf 2)nullAlternative
deletedAtJSONOptional
deletedAt (anyOf 1)JSONAlternative
deletedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
deletedAt (anyOf 1) (allOf 2)JSONAll variants applyThe time the customer was deleted, if it was deleted.
deletedAt (anyOf 2)nullAlternative
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
email (allOf 2)JSONAll variants applyEmail of customer.
idJSONRequired within parent
id (allOf 1)stringAll variants applyThe customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.
Format: uuid
id (allOf 2)JSONAll variants applyArCustomerId
namestringRequired within parentName of customer.
Maximum length: 5000
Minimum length: 1

Referenced models: Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region

Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region

FieldTypePresenceDescription and constraints
$objectRootCustomer address information for Accounts Receivable API
address1stringRequired within parentPrimary street address line.
Maximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeSecondary street address line (optional).
Maximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
Maximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
country (allOf 2)JSONAll variants applyTwo-letter country code (ISO 3166-1 alpha-2).
postalCodestringRequired within parentPostal or ZIP code
Maximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
region (allOf 2)JSONAll variants applyState, province, or region.

List all customers — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response data for Accounts Receivable customers API endpoint
customersarrayRequired within parentThe list of customers for this page
customers[]ModelEach itemExpand Get a customer — response body
pageobjectRequired within parentPagination cursors for navigating to next/previous pages
page.nextPagestringOptionalThe customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.
Format: uuid
page.previousPagestringOptionalThe customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.
Format: uuid

Referenced models: Get a customer — response body

Update a customer — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest data to update a customer using the public api
Additional keys: not allowed
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Create a customer — request body — body address The address for the customer Address input for creating or updating customers
address (anyOf 1) (allOf 2)JSONAll variants applyThe address for the customer.
address (anyOf 2)nullAlternative
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
email (allOf 2)JSONAll variants applyThe email address for the customer.
namestringRequired within parentThe name of the customer.
Maximum length: 5000
Minimum length: 1
resendOpenInvoicesbooleanRequired within parentOpen invoices for the customer will be resent with updated data
when this is true.

Referenced models: Create a customer — request body — body address The address for the customer Address input for creating or updating customers

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.