SfCustomerResponse
Less than to read
API version of CustomerResponse
Methods
The following API methods use this data model.
- Retrieve Customer
- Create Customer
Optional Fields
customerId
string, nullable
The unique identifier of the customer.
companyId
string, nullable
The identifier of the company that this customer is a customer of.
externalId
string, nullable
The external identifier of this customer.
status
string, nullable
Enum: “ACTIVE” “DELETED” “NOT_ASSIGNED” “DELETED_MANUAL_MERGE” The status of the customer.
autoMatched
boolean, nullable
Status if the customer is automatched with provider.
primaryCountry
string, nullable
Country (based on 3-char ISO/DI-3166 country code)
currency
string, nullable
Currency of the customer account as an ISO 4217 currency code.
firstName
string, nullable
The first name of the customer.
lastName
string, nullable
The last name of the customer.
companyName
string, nullable
The name of the company if this customer is a company.
emailAddress
string, nullable
The email address of the customer.
contactTelNo
string, nullable
The telephone number of the customer.
taxNumber
string, nullable
The tax number for the customer. This may be a VAT number for a company, or some other form of ID number for an individual.
createdDateTime
date-time, nullable
Date the customer record was created. ISO 8601 date format.
updatedDateTime
date-time, nullable
Date the customer was last updated. ISO 8601 date format. Customers may be updated by WPB or external servicers.
address
Address, nullable
Address of a Company, Provider or Customer. All fields are optional; without address line 1, city or country some operations may not be supported.
paymentInstruments
PaymentInstrument[], nullable
The set of reusable payment instruments that have been saved for this customer.