REresolvepay
Customers

Update a customer

Update a customer, including the default financing type for new invoices.

put/customers/{customer_id}

Request

Path parameters

customer_idstring required

ID of the customer to update

Request body

business_addressstring

Street address of the business' primary location.

business_citystring

City of the business' primary location.

business_statestring

State or province of the business' primary location.

business_zipstring

US zip code of the business' primary location.

business_countrystring

Country of the business' primary location.

business_ap_emailstring

Email address of the business' accounts payable person or department.

business_ap_phonestring

Phone number of the business' accounts payable person or department.

business_ap_phone_extensionstring

Phone number extension of the business' accounts payable person or department.

business_namestring

Full legal name of the business being applied for.

emailstring email

Email of the customer applying for terms.

default_terms'net7' | 'net10' | 'net10th' | 'net15' | 'net20' | 'net30' | 'net45' | 'net60' | 'net75' | 'net90' | 'net120' | 'net180' | 'null' nullable

Set default terms that will apply to this customer's invoices. Can be overridden when requesting an advance.

finance_type'advanced' | 'non_advanced'

Set the default financing type for this customer's new invoices.

external_idstring nullable

Optional customer identifier from your system. Send null or an empty string to clear it.

Example request

{
  "business_address": "111 Main Street",
  "business_city": "San Francisco",
  "business_state": "CA",
  "business_zip": "94104",
  "business_country": "US",
  "business_ap_email": "ap@example.com",
  "business_ap_phone": "(202) 456-1414",
  "business_ap_phone_extension": "123",
  "business_name": "Example, Inc.",
  "email": "user@example.com",
  "finance_type": "advanced",
  "external_id": "CUS-123456"
}

Response

An object representing the customer.

idstring
external_idstring nullable

Optional customer identifier from your system. This value is not required to be unique and can be used with the external_id list filter.

created_atstring date-time

Date the customer was created.

updated_atstring date-time

Date the customer was last updated.

source'QUICKBOOKS' | 'MERCHANT_USER' | 'ADMIN_USER' | 'APPLICATION' | 'CUSTOMER_USER' | 'API'
business_addressstring

Street address of the business' primary location.

business_citystring

City of the business' primary location.

business_statestring

State or province of the business' primary location.

business_zipstring

US zip code of the business' primary location.

business_countrystring

Country of the business' primary location according to the ISO 3166-1 alpha 2 standard.

business_age_range'0-2' | '2-5' | '5-10' | '10+'

String indicating age of the business in years.

business_ap_emailstring

Email address of the business' accounts payable person or department.

business_ap_phonestring

Phone number of the business' accounts payable person or department.

business_ap_phone_extensionstring

Phone number extension of the business' accounts payable person or department.

business_namestring

Full legal name of the business being applied for.

business_trade_namestring

Trade name of the business, if different than business_name.

business_phonestring

Phone number of the business' primary location.

business_type'sole_prop_or_partnership' | 'llc' | 'corporation' | 'nonprofit' | 'government'

String indicating the business' type of legal entity.

emailstring email

Email of the customer applying for terms.

personal_name_firststring

First name of the person applying on behalf of the business.

personal_name_laststring

Last name of the person applying on behalf of the business.

personal_phonestring

Personal phone number of the customer representative applying for terms.

amount_approvedinteger

Total amount of the credit approved.

amount_authorizedinteger

Amount of the credit line reserved for authorized charges.

amount_availableinteger

Current amount of the credit line available for purchases.

amount_balanceinteger

Current balance on the customer's credit line.

amount_unapplied_paymentsinteger

Current amount of a customer's unapplied payments.

default_terms'net7' | 'net10' | 'net10th' | 'net15' | 'net20' | 'net30' | 'net45' | 'net60' | 'net75' | 'net90' | 'net120' | 'net180' | 'null' nullable

Set default terms that will apply to this customer's invoices. Can be overridden when requesting an advance.

finance_type'advanced' | 'non_advanced'

Default financing type for this customer's new invoices.

advance_ratenumber double nullable

The advance rate that will be used to determine the amount advanced for this customer's invoices.

credit_status'approved' | 'hold' | 'declined' | 'pending' | 'deactivated' | 'null' nullable

Current credit status of this customer. See <a href="#operation/requestCustomerCreditCheck">#request-a-credit-check</a> for more details.

net_terms_status'enrolled' | 'pending_enrollment' | 'enrollment_expired' | 'null' nullable

Current net terms enrollment status of this customer. See <a href="#operation/fetchCustomer">#fetchCustomer</a> for more details.

net_terms_enrollment_urlstring nullable

The URL for a customer to complete enrollment requirements when net_terms_status is pending_enrollment. See <a href="#operation/fetchCustomer">#fetchCustomer</a> for more details.

net_terms_enrollment_expires_atstring date-time nullable

The date by which the customer must be enrolled in this net terms offer, not null when net_terms_status is pending_enrollment.

credit_check_requested_atstring date-time nullable

The date a credit check was requested.

archivedboolean

Boolean indicating if customer is archived.

duns_numberstring nullable

Dun & Bradstreet unique nine-digit identifier for businesses that is associated with a business's Live Business Identity

Example response

{
  "id": "PMMlaE5wbg0",
  "external_id": "CUS-123456",
  "created_at": "2020-01-01T00:00:00.750Z",
  "updated_at": "2020-01-01T00:00:00.750Z",
  "source": "MERCHANT_USER",
  "business_address": "111 Main Street",
  "business_city": "San Francisco",
  "business_state": "CA",
  "business_zip": "94104",
  "business_country": "US",
  "business_age_range": "5-10",
  "business_ap_email": "ap@example.com",
  "business_ap_phone": "(202) 456-1414",
  "business_ap_phone_extension": "123",
  "business_name": "Example, Inc.",
  "business_trade_name": "Example Trading Company",
  "business_phone": "(202) 456-1414",
  "business_type": "corporation",
  "email": "user@example.com",
  "personal_name_first": "James",
  "personal_name_last": "Bond",
  "personal_phone": "(202) 456-1414",
  "amount_approved": 10000,
  "amount_authorized": 10000,
  "amount_available": 10000,
  "amount_balance": 2000,
  "amount_unapplied_payments": 1000,
  "finance_type": "advanced",
  "advance_rate": 0.75,
  "net_terms_enrollment_url": "www.app.resolvepay.com/merchant-id/activate/123456",
  "net_terms_enrollment_expires_at": "2020-01-01T00:00:00.750Z",
  "credit_check_requested_at": "2020-01-01T00:00:00.750Z",
  "duns_number": "00-123-4567",
  "credit_decisions": [
    {
      "id": "abc123",
      "created_at": "2020-01-01T00:00:00.750Z",
      "decision": "approved",
      "amount": 10000,
      "advance_rate": 0.75,
      "decline_code": "no_business_found",
      "hold_code": "past_due"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.