Class CreateCustomerRequest
This method is used to create a customer.
Properties
NAME | TYPE | DESCRIPTION |
---|---|---|
RequestId | string | Unique identifier used to identify the request. Used when associating the request to the response. |
RequestDate | dateTime | DateTime request was made. Request timeout is 1 minute. |
Credentials | TokenCredentials | REQUIRED. The credentials given from your last response. |
CustomerFields | DataFieldValue[] | The list of fields and their value used to create a customer. |
CustomerType | CustomerType | An enumeration identifying the type of customer or end user. Possible values are: Individual or Business. Required field. |
LocationReference | string | REQUIRED. The unique value assigned to each Location used to find the customer fields. |
Relationship | Relationship | An enumeration identifying the type of customer relationship. Possible values are: Customer or Vendor. Required field. |
DataFieldValue
NAME | TYPE | DESCRIPTION |
---|---|---|
FieldName | string | The dynamic field name used to capture custom values. |
Value | string | The value the user input. |
CustomerType
NAME | TYPE | DESCRIPTION |
---|---|---|
Individual | 0 | |
Business | 1 |
Relationship
NAME | TYPE | DESCRIPTION |
---|---|---|
Customer | 1 | |
Vendor | 2 |
CustomerFields
FieldName | Description | Notes |
---|---|---|
Address1 | Address | Max length is 50 characters |
Address2 | Suite/APT# | Max length is 50 characters |
City | City | Max length is 40 characters |
State | State/Region | Max length is 2 characters |
PostalCode | Postal Code | Max length is 10 characters |
Country | Country | Max length is 40 characters |
CustomerNumber | Unique identifier for the customer in the system. A unique value will be auto generated if one is not supplied. | Max length is 50 characters |
DaytimePhone | Daytime Phone | Max length is 14 characters |
DaytimePhoneExt | Daytime Phone Extension | Max length is 6 characters |
EveningPhone | Evening Phone | Max length is 14 characters |
EveningPhoneExt | Evening Phone Extension | Max length is 6 characters |
DLNumber | Driver's License Number | Max length is 50 characters. Required when CustomerType is 'Individual' and config setting is set to required. |
DLState | Driver's License State | Max length is 2 characters. Required when CustomerType is 'Individual' and config setting is set to required. |
Max length is 60 characters | ||
Fax | Fax Number | Max length is 20 characters |
FirstName | First Name | Max length is 30 characters. Required when CustomerType is 'Individual' or config setting is set to required. |
LastName | This field should contain the company name when CustomerType is 'Business' or the last name when CustomerType is 'Individual'. | Max length is 60 characters. Required field. |
SSNFedTaxID | This field should contain the Federal Tax ID when CustomerType is 'Business' or the SSN when CustomerType is 'Individual'. | Max length is 15 characters |
Examples
{
"__type":"CreateCustomerRequest:#JackHenry.Eps.Mobile.RDC",
"LocationReference":"String Content",
"CustomerType":
"Relationship":
"CustomerFields":
[
{
"__type":"DataFieldValue:#JackHenry.Eps.Mobile.RDC",
"FieldName":"String Content",
"Value":"String Content",
}
],
}