| Method and Path | Description | ||
|---|---|---|---|
| GET | /customers/customers | Search for a specific customer. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users. |
|
| GET | /customers/:customerName | Returns information about the user with this financialAccountNumber. |
|
| POST | /customers/customers | Create a new customer. |
|
| PUT | /customers/:customerName | Updates information about the customer with the specified financialAccountNumber. |
|
Interfaces: None
Customer
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| financialAccountNumber | uuid | Yes | - | financialAccountNumber
|
| customerName | string | Yes | - | customerName
|
| branchNumber | string | Yes | - | branchNumber
|
| address1 | string | No | - | address1
|
| address2 | string | No | - | address2
|
| city | string | No | - | city
|
| state | string | No | - | state
|
| zip | string | No | - | zip
|
Interfaces: None
customer Creation Form
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| branchNumber | string | Yes | - | Branch Number
|
| customerName | string | Yes | - | customer Name
|
| string | Yes | - |
|
|
| address1 | string | Yes | - | Address1
|
| address2 | string | No | - | Address2
|
| city | string | Yes | - | City
|
| state | string | Yes | - | State
|
| zip | string | Yes | - | Zip
|
Interfaces: None
Customer Summery
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| financialAccountNumber | uuid | Yes | - | Financial Account Number
|
| customerName | string | Yes | - | Customer Name
|
Interfaces: None
customer Update Form
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| financialAccountNumber | string | Yes | - | Financial Account Number
|
| customerName | string | Yes | - | Customer Name
|
| string | Yes | - |
|
|
| address1 | string | Yes | - | Address1
|
| address2 | string | Yes | - | Address2
|
| city | string | Yes | - | City
|
| state | string | Yes | - | State
|
| zip | string | Yes | - | Zip
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| code | string | Yes | - | Machine readable code for this specific error message
|
| description | string | Yes | - | Description of the error
|
