SimplicityCollect Web Services API

<back to all web services

AddAccount

The following routes are available for this service:
All Verbs/accounts/add
AddAccount Parameters:
NameParameterData TypeRequiredDescription
ApiTokenquerystringNo
AccountNumberquerystringNo
ClientNamequerystringNo
ClientClaimNumberquerystringNo
AccountTypequerystringNo
StatusquerystringNo
NotequerystringNo
LastUpdatedDatequerystringNo
DateOfFirstDelinquencyquerystringNo
CreditorNamequerystringNo
DebtorFirstNamequerystringNo
DebtorMiddleNamequerystringNo
DebtorLastNamequerystringNo
DebtorPrefixquerystringNo
DebtorAddressOnequerystringNo
DebtorAddressTwoquerystringNo
DebtorCityquerystringNo
DebtorStatequerystringNo
DebtorZipquerystringNo
DebtorSsnquerystringNo
DebtorDobquerystringNo
DebtorPhonequerystringNo
DebtorCellPhonequerystringNo
DebtorEmailquerystringNo
DebtorEmailConsentTypequerystringNo
DebtorEmployerNamequerystringNo
DebtorEmployerPhonequerystringNo
DebtorIsCompanyqueryboolNo
DebtorCompanyContactquerystringNo
DebtorCompanyContactTitlequerystringNo
DebtorCompanyNamequerystringNo
CoDebtorFirstNamequerystringNo
CoDebtorMiddleNamequerystringNo
CoDebtorLastNamequerystringNo
CoDebtorAddressOnequerystringNo
CoDebtorAddressTwoquerystringNo
CoDebtorCityquerystringNo
CoDebtorStatequerystringNo
CoDebtorZipquerystringNo
CoDebtorSsnquerystringNo
CoDebtorDobquerystringNo
CoDebtorPhonequerystringNo
CoDebtorCellPhonequerystringNo
CoDebtorEmailquerystringNo
CoDebtorEmployerNamequerystringNo
CoDebtorEmployerPhonequerystringNo
CoDebtorIsCompanyqueryboolNo
CoDebtorCompanyContactquerystringNo
CoDebtorCompanyContactTitlequerystringNo
CoDebtorCompanyNamequerystringNo
OriginalAmountquerydecimalNo
InterestRatequerystringNo
InterestStartDatequerystringNo
AccountCustomFieldsqueryList<AccountCustomField>No
AccountCustomField Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
FieldNameformstringNo
FieldValueformstringNo
TableColumnNameformstringNo
DataTypeformstringNo
AddAccountResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /accounts/add HTTP/1.1 
Host: app.simplicitycollect.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiToken":"String","AccountNumber":"String","ClientName":"String","ClientClaimNumber":"String","AccountType":"String","Status":"String","Note":"String","LastUpdatedDate":"String","DateOfFirstDelinquency":"String","CreditorName":"String","DebtorFirstName":"String","DebtorMiddleName":"String","DebtorLastName":"String","DebtorPrefix":"String","DebtorAddressOne":"String","DebtorAddressTwo":"String","DebtorCity":"String","DebtorState":"String","DebtorZip":"String","DebtorSsn":"String","DebtorDob":"String","DebtorPhone":"String","DebtorCellPhone":"String","DebtorEmail":"String","DebtorEmailConsentType":"String","DebtorEmployerName":"String","DebtorEmployerPhone":"String","DebtorIsCompany":false,"DebtorCompanyContact":"String","DebtorCompanyContactTitle":"String","DebtorCompanyName":"String","CoDebtorFirstName":"String","CoDebtorMiddleName":"String","CoDebtorLastName":"String","CoDebtorAddressOne":"String","CoDebtorAddressTwo":"String","CoDebtorCity":"String","CoDebtorState":"String","CoDebtorZip":"String","CoDebtorSsn":"String","CoDebtorDob":"String","CoDebtorPhone":"String","CoDebtorCellPhone":"String","CoDebtorEmail":"String","CoDebtorEmployerName":"String","CoDebtorEmployerPhone":"String","CoDebtorIsCompany":false,"CoDebtorCompanyContact":"String","CoDebtorCompanyContactTitle":"String","CoDebtorCompanyName":"String","OriginalAmount":0,"InterestRate":"String","InterestStartDate":"String","AccountCustomFields":[{"Id":"String","FieldName":"String","FieldValue":"String","TableColumnName":"String","DataType":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Status":"String","Message":"String"}