Mercury: Customers schemas
6 Mercury schemas with complete fields and constraints.
← Customers operations · All schemas
Create a customer — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request data to create a customer using the public api Additional keys: not allowed |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create a customer — request body — body address The address for the customer Address input for creating or updating customers |
address (anyOf 1) (allOf 2) | JSON | All variants apply | The address for the customer. |
address (anyOf 2) | null | Alternative | |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
email (allOf 2) | JSON | All variants apply | The email address for the customer. |
name | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address input for creating or updating customers Additional keys: not allowed |
address1 | string | Required within parent | Primary street address line. Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Secondary street address line (optional). Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
country (allOf 2) | JSON | All variants apply | Two-letter country code (ISO 3166-1 alpha-2). |
name | string | Required within parent | The mailing name of the address. |
postalCode | string | Required within parent | Postal or ZIP code. Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply | |
region (allOf 2) | JSON | All variants apply | Either 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response data for Accounts Receivable customer API endpoints |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region |
address (anyOf 1) (allOf 2) | JSON | All variants apply | Address of customer. |
address (anyOf 2) | null | Alternative | |
deletedAt | JSON | Optional | |
deletedAt (anyOf 1) | JSON | Alternative | |
deletedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
deletedAt (anyOf 1) (allOf 2) | JSON | All variants apply | The time the customer was deleted, if it was deleted. |
deletedAt (anyOf 2) | null | Alternative | |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
email (allOf 2) | JSON | All variants apply | Email of customer. |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | The 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) | JSON | All variants apply | ArCustomerId |
name | string | Required within parent | Name 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customer address information for Accounts Receivable API |
address1 | string | Required within parent | Primary street address line. Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Secondary street address line (optional). Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
country (allOf 2) | JSON | All variants apply | Two-letter country code (ISO 3166-1 alpha-2). |
postalCode | string | Required within parent | Postal or ZIP code Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply | |
region (allOf 2) | JSON | All variants apply | State, province, or region. |
List all customers — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response data for Accounts Receivable customers API endpoint |
customers | array | Required within parent | The list of customers for this page |
customers[] | Model | Each item | Expand Get a customer — response body |
page | object | Required within parent | Pagination cursors for navigating to next/previous pages |
page.nextPage | string | Optional | The 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.previousPage | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request data to update a customer using the public api Additional keys: not allowed |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create a customer — request body — body address The address for the customer Address input for creating or updating customers |
address (anyOf 1) (allOf 2) | JSON | All variants apply | The address for the customer. |
address (anyOf 2) | null | Alternative | |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
email (allOf 2) | JSON | All variants apply | The email address for the customer. |
name | string | Required within parent | The name of the customer. Maximum length: 5000 Minimum length: 1 |
resendOpenInvoices | boolean | Required within parent | Open 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