Update customer

patch

https://api.epicorretailcloud.com/api/sales/v1/customer/{customer_id}/

Updates a customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

integer

required

The unique system assigned value that identifies this record.

Body Params

Customer information

name

string

length between 1 and 128

[^\s]+

The name of this customer.

customer_number

string | null

The customer number. If not specified, the next available sequential number will be automatically assigned.

customer_type

integer

enum

-2147483648 to 2147483647

The customer type.

0 - Personal
1 - Business

Allowed:

store_account_opened_id

integer | null

The unique identifier of the store where the customer account was opened.

customer_price_group_id

integer | null

The unique identifier for this customer's price group.

default_price_type_id

integer | null

The unique identifier for this customer's default price type.

is_active

boolean

Set to False if this customer is no longer considered active

pricing_sequence

integer

enum

-2147483648 to 2147483647

The pricing sequence.

0 - Best Pricing
1 - No Promotions
2 - No Price Books
3 - Average Cost
4 - Replacement Cost

Allowed:

salesperson_id

integer | null

The unique identifier for this customer's salesperson.

is_po_required

boolean

customer_privacy

integer

enum

-2147483648 to 2147483647

Enter customer privacy.

0 - NA-Blank
1 - Agree
2 - Disagree

Allowed:

tax_code_id

integer | null

The unique identifier representing the customer's tax code.

tax_exemption_number

string

length ≤ 30

The customer's tax exemption number

tax_exempt_reason_id

integer | null

The unique identifier representing the customer's tax exemption reason

is_tax_exempt

boolean

Is this customer tax exempt?

tax_exemption_expiration_date

date | null

The date the customer's tax exemption code expires

charge_allowed

boolean

Can this customer charge in POS?

balance_method

integer

enum

-2147483648 to 2147483647

Balance Forward = Payments apply to oldest first; Open Item = Pick and choose what gets paid

1 - Balance Forward
2 - Open Item

Allowed:

finance_charge_applied

integer

enum

-2147483648 to 2147483647

Indicates how far past due a balance must be for a finance charge to be applied

0 - Never add finance charges
1 - When past due
31 - When more than 30 days past due
61 - When more than 60 days past due
91 - When more than 90 days past due

Allowed:

credit_ar_only

integer

enum

-2147483648 to 2147483647

Enter Credit A/R Only.

10 - Cash or Credit for Returns
20 - Credit A/R for Returns
30 - A/R Only for Sales & Credits

Allowed:

credit_hold

boolean

Is this customer on credit hold?

credit_limit

string

^-?\d{0,9}(?:\.\d{0,4})?$

What is the customer credit limit.

credit_message

string | null

The credit message

credit_terms_id

integer | null

The unique identifier representing the customer's credit terms.

statement_delivery_method

integer

enum

-2147483648 to 2147483647

Control how statements are delivered

0 - Do not send statements
1 - Print Statements
2 - Print Statements with Invoice Link
3 - Email Statements
4 - Email Statements with Invoice Link

Allowed:

statement_format

integer

enum

-2147483648 to 2147483647

Balance Forward = Payments apply to oldest first; Open Item = Pick and choose what gets paid

1 - Balance Forward
2 - Open Item

Allowed:

check_allowed

boolean

If True, A/R payments may be made by check

print_invoice

boolean

Set to True if this customer will print an invoice

title

string

length ≤ 40

The customer's title.

first_name

string

length between 1 and 128

The customer's first name.

last_name

string

length ≤ 40

The customer's last name.

string

length ≤ 128

The customer's e-mail address.

line_1

string | null

The customer's address line 1.

line_2

string | null

The customer's address line 2.

line_3

string | null

The customer's address line 3.

city

string | null

The customer's city.

postal_code_location

string | null

The customer's postal code location.

postal_code

string | null

The customer's postal code.

country

string | null

The customer's country.

phone_number

string

length ≤ 32

The phone number of the primary contact for this customer. Valid phone number format with country code : +1 2144141441 or without country code: 2144141441.

phone_country

string

length ≤ 2

Primary Phone number’s country. If Blank, system will default country to “US”.

phone_type

string

enum

Primary Phone number’s type. If Blank, system will default Phone Type to “M”.

`` -
O - Office
M - Mobile
F - Fax
H - Home
C - Business Main
P - Pager
T - Toll-Free
X - Other

Headers

X-Active-Store

integer

required

The id of the active store to be used for this API invocation

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200