All Verbs | /debtors/search |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiToken | query | string | No | |
DebtorFirstName | query | string | No | |
DebtorMiddleName | query | string | No | |
DebtorLastName | query | string | No | |
DebtorCompanyName | query | string | No | |
DebtorAddress | query | string | No | |
DebtorCity | query | string | No | |
DebtorState | query | string | No | |
DebtorZip | query | string | No | |
DebtorDOB | query | string | No | |
DebtorEmployerName | query | string | No | |
DebtorHomePhone | query | string | No | |
DebtorCellPhone | query | string | No | |
DebtorEmail | query | string | No | |
DebtorSSN | query | string | No | |
DebtorEmailConsentType | query | string | No | |
DebtorCustomFields | query | List<DebtorCustomField> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldName | form | string | No | |
FieldValue | form | string | No | |
TableColumnName | form | string | No | |
DataType | form | MySqlDbType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | string | No | |
Message | form | string | No | |
Debtors | form | List<Debtor> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | ulong | No | |
first_name | form | string | No | |
middle_name | form | string | No | |
last_name | form | string | No | |
aka | form | string | No | |
prefix | form | string | No | |
suffix | form | string | No | |
company_name | form | string | No | |
ssn | form | string | No | |
dob | form | DateTime? | No | |
type | form | string | No | |
is_company | form | bool | No | |
form | string | No | ||
EmailTypeID | form | int | No | |
last_updated | form | DateTime | No | |
EmailConsentTypeID | form | int | No | |
paymentIDList | form | List<string> | No | |
employer | form | Employer | No | |
phoneList | form | List<Phone> | No | |
addressList | form | List<Address> | No | |
contacts | form | List<DebtorContact> | No | |
customFieldsList | form | List<DebtorCustomField> | No | |
accountList | form | List<DebtorAccount> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | ulong | No | |
updated_by_user_id | form | int | No | |
full_time | form | bool | No | |
garnish_return_days | form | string | No | |
name | form | string | No | |
contact | form | string | No | |
address | form | string | No | |
address_two | form | string | No | |
state | form | string | No | |
city | form | string | No | |
zip | form | string | No | |
county | form | string | No | |
phone | form | string | No | |
fax | form | string | No | |
cell | form | string | No | |
form | string | No | ||
notes | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
phoneId | form | string | No | |
isPrimary | form | bool | No | |
displayPhone | form | string | No | |
phone | form | string | No | |
phoneNumber | form | string | No | |
statusId | form | int | No | |
statusName | form | string | No | |
statusStyle | form | string | No | |
typeId | form | int | No | |
typeName | form | string | No | |
timezoneName | form | string | No | |
descriptionId | form | int | No | |
descriptionName | form | string | No | |
skipped_date | form | DateTime? | No | |
VoiceConsentTypeID | form | int | No | |
VoiceConsentTypeName | form | string | No | |
SMSConsentTypeID | form | int | No | |
SMSConsentTypeName | form | string | No | |
VoiceConsentDate | form | DateTime? | No | |
SMSConsentDate | form | DateTime? | No | |
DebtorID | form | ulong | No | |
clickToDialLink | form | string | No | |
extension | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
addressId | form | string | No | |
isPrimary | form | bool | No | |
statusId | form | int | No | |
statusName | form | string | No | |
statusStyle | form | string | No | |
typeId | form | int | No | |
typeName | form | string | No | |
address | form | string | No | |
addressTwo | form | string | No | |
state | form | string | No | |
city | form | string | No | |
zip | form | string | No | |
county | form | string | No | |
country | form | string | No | |
fullAddressString | form | string | No | |
skipped_date | form | DateTime? | No | |
IsDefault | form | bool | No | |
ExpressConsentTypeID | form | int | No | |
ExpressConsentTypeName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | ulong | No | |
DebtorID | form | ulong | No | |
Name | form | string | No | |
Title | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InternalId | form | ulong | No | |
AccountNumber | form | string | No | |
AccountStatus | form | string | No | |
clientName | form | string | No | |
currentBalanceDue | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /debtors/search HTTP/1.1
Host: app.simplicitycollect.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiToken: String,
DebtorFirstName: String,
DebtorMiddleName: String,
DebtorLastName: String,
DebtorCompanyName: String,
DebtorAddress: String,
DebtorCity: String,
DebtorState: String,
DebtorZip: String,
DebtorDOB: String,
DebtorEmployerName: String,
DebtorHomePhone: String,
DebtorCellPhone: String,
DebtorEmail: String,
DebtorSSN: String,
DebtorEmailConsentType: String,
DebtorCustomFields:
[
{
FieldName: String,
FieldValue: String,
TableColumnName: String,
DataType: Decimal
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Status: String, Message: String, Debtors: [ { id: 0, first_name: String, middle_name: String, last_name: String, aka: String, prefix: String, suffix: String, company_name: String, ssn: String, dob: 0001-01-01, type: String, is_company: False, email: String, EmailTypeID: 0, last_updated: 0001-01-01, EmailConsentTypeID: 0, paymentIDList: [ String ], employer: { id: 0, updated_by_user_id: 0, full_time: False, garnish_return_days: String, name: String, contact: String, address: String, address_two: String, state: String, city: String, zip: String, county: String, phone: String, fax: String, cell: String, email: String, notes: String }, phoneList: [ { phoneId: String, isPrimary: False, displayPhone: String, phone: String, phoneNumber: String, statusId: 0, statusName: String, statusStyle: String, typeId: 0, typeName: String, timezoneName: String, descriptionId: 0, descriptionName: String, skipped_date: 0001-01-01, VoiceConsentTypeID: 0, VoiceConsentTypeName: String, SMSConsentTypeID: 0, SMSConsentTypeName: String, VoiceConsentDate: 0001-01-01, SMSConsentDate: 0001-01-01, DebtorID: 0, clickToDialLink: String, extension: String } ], addressList: [ { addressId: String, isPrimary: False, statusId: 0, statusName: String, statusStyle: String, typeId: 0, typeName: String, address: String, addressTwo: String, state: String, city: String, zip: String, county: String, country: String, fullAddressString: String, skipped_date: 0001-01-01, IsDefault: False, ExpressConsentTypeID: 0, ExpressConsentTypeName: String } ], contacts: [ { ID: 0, DebtorID: 0, Name: String, Title: String } ], customFieldsList: [ { FieldName: String, FieldValue: String, TableColumnName: String, DataType: Decimal } ], accountList: [ { InternalId: 0, AccountNumber: String, AccountStatus: String, clientName: String, currentBalanceDue: 0 } ] } ] }