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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<AddAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Accounts">
  <AccountCustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Accounts">
    <d2p1:AccountCustomField>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:FieldValue>String</d2p1:FieldValue>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:TableColumnName>String</d2p1:TableColumnName>
    </d2p1:AccountCustomField>
  </AccountCustomFields>
  <AccountNumber>String</AccountNumber>
  <AccountType>String</AccountType>
  <ApiToken>String</ApiToken>
  <ClientClaimNumber>String</ClientClaimNumber>
  <ClientName>String</ClientName>
  <CoDebtorAddressOne>String</CoDebtorAddressOne>
  <CoDebtorAddressTwo>String</CoDebtorAddressTwo>
  <CoDebtorCellPhone>String</CoDebtorCellPhone>
  <CoDebtorCity>String</CoDebtorCity>
  <CoDebtorCompanyContact>String</CoDebtorCompanyContact>
  <CoDebtorCompanyContactTitle>String</CoDebtorCompanyContactTitle>
  <CoDebtorCompanyName>String</CoDebtorCompanyName>
  <CoDebtorDob>String</CoDebtorDob>
  <CoDebtorEmail>String</CoDebtorEmail>
  <CoDebtorEmployerName>String</CoDebtorEmployerName>
  <CoDebtorEmployerPhone>String</CoDebtorEmployerPhone>
  <CoDebtorFirstName>String</CoDebtorFirstName>
  <CoDebtorIsCompany>false</CoDebtorIsCompany>
  <CoDebtorLastName>String</CoDebtorLastName>
  <CoDebtorMiddleName>String</CoDebtorMiddleName>
  <CoDebtorPhone>String</CoDebtorPhone>
  <CoDebtorSsn>String</CoDebtorSsn>
  <CoDebtorState>String</CoDebtorState>
  <CoDebtorZip>String</CoDebtorZip>
  <CreditorName>String</CreditorName>
  <DateOfFirstDelinquency>String</DateOfFirstDelinquency>
  <DebtorAddressOne>String</DebtorAddressOne>
  <DebtorAddressTwo>String</DebtorAddressTwo>
  <DebtorCellPhone>String</DebtorCellPhone>
  <DebtorCity>String</DebtorCity>
  <DebtorCompanyContact>String</DebtorCompanyContact>
  <DebtorCompanyContactTitle>String</DebtorCompanyContactTitle>
  <DebtorCompanyName>String</DebtorCompanyName>
  <DebtorDob>String</DebtorDob>
  <DebtorEmail>String</DebtorEmail>
  <DebtorEmailConsentType>String</DebtorEmailConsentType>
  <DebtorEmployerName>String</DebtorEmployerName>
  <DebtorEmployerPhone>String</DebtorEmployerPhone>
  <DebtorFirstName>String</DebtorFirstName>
  <DebtorIsCompany>false</DebtorIsCompany>
  <DebtorLastName>String</DebtorLastName>
  <DebtorMiddleName>String</DebtorMiddleName>
  <DebtorPhone>String</DebtorPhone>
  <DebtorPrefix>String</DebtorPrefix>
  <DebtorSsn>String</DebtorSsn>
  <DebtorState>String</DebtorState>
  <DebtorZip>String</DebtorZip>
  <InterestRate>String</InterestRate>
  <InterestStartDate>String</InterestStartDate>
  <LastUpdatedDate>String</LastUpdatedDate>
  <Note>String</Note>
  <OriginalAmount>0</OriginalAmount>
  <Status>String</Status>
</AddAccount>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Accounts">
  <Message>String</Message>
  <Status>String</Status>
</AddAccountResponse>