SUsurense
Customers

Create a customer

post/customers

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/customers
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: customers:create

Request body

forceCreationboolean

Force creation even if conflicts exist

idType1 | 2 | 3 | 4 | 5 | 6

Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ

idNumberstring

ID number

idCardIssueDatestring

ID card issue date

firstNamestring

First name

shortNamestring

Short name

lastNamestring

Last name

maidenNamestring

Maiden name

engFirstNamestring

English first name

engLastNamestring

English last name

phoneNumber1string

Phone number 1

phoneNumber2string

Phone number 2

phoneNumber3string

Phone number 3

faxNumberstring

Fax number

email1string

Email address 1

email2string

Email address 2

gender1 | 2 | 3

Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה

birthDatestring

Birth date

birthDateYearOnlyboolean

Only the birth year is known; birthDate is then stored as Jan 1 of that year

deathboolean

Death status

deathDatestring

Death date

maritalStatus1 | 2 | 3 | 4 | 5

Marital Status:<br/>1 - רווק/ה<br/>2 - נשוי/אה<br/>3 - גרוש/ה<br/>4 - אלמן/ה<br/>5 - ידוע/ה בציבור

professionstring

Profession

employmentStatus1 | 2 | 3 | 4 | 5 | 6 | 7

Employment Status:<br/>1 - שכיר/ה<br/>2 - עצמאי/ת<br/>3 - שכיר/ה ועצמאי/ת<br/>4 - שכיר/ה בעל/ת שליטה<br/>5 - לא מועסק/ת<br/>6 - שכיר/ה בעל/ת שליטה ועצמאי/ת<br/>7 - פנסיונר/ית

managerIdstring

Manager ID

statusIdstring

Customer status ID

sourceIdstring

Customer source ID

classIdstring

Customer class ID

sensitiveboolean

Sensitive customer flag

mailingStatus1 | 2 | 3 | 4

Mailing Status:<br/>1 - אושר דיוור<br/>2 - לא אושר דיוור<br/>3 - הוסר מדיוור<br/>4 - לא התבקש אישור

mailingStatusDatestring

Mailing status date

streetstring

Street name

streetNumberstring

Street number

apartmentNumberstring

Apartment number

postalBoxinteger

Postal box number

citystring

City

postalCodeinteger

Postal code

countrystring

Country

usCitizenboolean

US citizen status

foreignTaxResidencyboolean

Foreign tax residency status

engAddressstring

English address

kupatHolim1 | 2 | 3 | 4 | 5

Kupat Holim:<br/>1 - כללית<br/>2 - מכבי<br/>3 - מאוחדת<br/>4 - לאומית<br/>5 - צה"לית

kupatHolimComplementary10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41

Kupat Holim Complementary:<br/>10 - כללית מושלם זהב<br/>11 - כללית פלטינום<br/>20 - מכבי שלי<br/>21 - מכבי כסף<br/>22 - מכבי זהב<br/>30 - מאוחדת עדיף<br/>31 - מאוחדת שיא<br/>40 - לאומית כסף<br/>41 - לאומית זהב

heightinteger

Height in cm

weightinteger

Weight in kg

smokerboolean

Smoker status

cigarettesCountPerDayinteger

Cigarettes count per day

drugsstring

Drugs information

surgeriesstring

Surgeries information

hospitalizationsstring

Hospitalizations information

backgroundDiseasesstring

Background diseases

bankAccountTypestring

Bank account type

bankCodeinteger

Bank code

bankBranchCodeinteger

Bank branch code

bankAccountNumberstring

Bank account number

notesstring

Notes

notesAlertboolean

Notes alert

Example request

{
  "idType": 1,
  "idNumber": "123456789",
  "idCardIssueDate": "2020-01-15",
  "firstName": "John",
  "shortName": "Johnny",
  "lastName": "Doe",
  "maidenName": "Smith",
  "engFirstName": "John",
  "engLastName": "Doe",
  "phoneNumber1": "+972501234567",
  "phoneNumber2": "+972507654321",
  "phoneNumber3": "+972509876543",
  "faxNumber": "+972501234567",
  "email1": "john.doe@example.com",
  "email2": "john.work@example.com",
  "gender": 2,
  "birthDate": "1990-01-15",
  "deathDate": "2023-12-31",
  "maritalStatus": 2,
  "profession": "Software Engineer",
  "employmentStatus": 1,
  "managerId": "123e4567-e89b-12d3-a456-426614174000",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "mailingStatus": 1,
  "mailingStatusDate": "2024-01-15T10:00:00Z",
  "street": "Main Street",
  "streetNumber": "123",
  "apartmentNumber": "5A",
  "postalBox": 1234,
  "city": "Tel Aviv",
  "postalCode": 12345,
  "country": "Israel",
  "engAddress": "123 Main St, Tel Aviv",
  "kupatHolim": 1,
  "kupatHolimComplementary": 10,
  "height": 175,
  "weight": 70,
  "cigarettesCountPerDay": 10,
  "drugs": "None",
  "surgeries": "None",
  "hospitalizations": "None",
  "backgroundDiseases": "None",
  "bankAccountType": "CHECKING",
  "bankCode": 10,
  "bankBranchCode": 123,
  "bankAccountNumber": "123456789",
  "notes": "Important customer notes",
  "notesAlert": true
}

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
duplicateboolean
statusIdstring uuid
statusNamestring
statusActiveboolean
sourceIdstring uuid
sourceNamestring
customerClassIdstring uuid
classIdstring uuid
classNamestring
managerIdstring uuid
managersstring[]
sensitiveboolean
mailingStatus1 | 2 | 3 | 4

Mailing Status:<br/>1 - אושר דיוור<br/>2 - לא אושר דיוור<br/>3 - הוסר מדיוור<br/>4 - לא התבקש אישור

mailingStatusDatestring date-time
idType1 | 2 | 3 | 4 | 5 | 6

Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ

idNumberstring
idNumberLockedboolean
idCardIssueDatestring date
firstNamestring
shortNamestring
lastNamestring
fullNamestring
fullNameReversestring
maidenNamestring
engFirstNamestring
engLastNamestring
cellNumberstring
cellNumberVerifiedboolean
cellNumberFormattedstring
cellNumberUristring
cellNumberWhatsAppUristring
phoneNumberstring
phoneNumberFormattedstring
phoneNumberUristring
phoneNumberWhatsAppUristring
phoneNumber2string
phoneNumber2Formattedstring
phoneNumber2Uristring
phoneNumber2WhatsAppUristring
phoneNumber3string
phoneNumber3Formattedstring
phoneNumber3Uristring
phoneNumber3WhatsAppUristring
faxNumberstring
faxNumberFormattedstring
faxNumberUristring
emailstring
emailBounceboolean
emailComplaintboolean
otherEmailstring
gender1 | 2 | 3

Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה

birthDatestring date
birthDayinteger
birthMonthinteger
birthYearinteger
birthDateYearOnlyboolean
agestring
minorboolean
deathboolean
deathDatestring date
streetstring
streetNumberstring
apartmentNumberstring
postalBoxinteger
citystring
postalCodeinteger
countrystring
addressstring
maritalStatus1 | 2 | 3 | 4 | 5

Marital Status:<br/>1 - רווק/ה<br/>2 - נשוי/אה<br/>3 - גרוש/ה<br/>4 - אלמן/ה<br/>5 - ידוע/ה בציבור

childrenCountinteger
partnerIdstring uuid
partnerNamestring
professionstring
employmentStatus1 | 2 | 3 | 4 | 5 | 6 | 7

Employment Status:<br/>1 - שכיר/ה<br/>2 - עצמאי/ת<br/>3 - שכיר/ה ועצמאי/ת<br/>4 - שכיר/ה בעל/ת שליטה<br/>5 - לא מועסק/ת<br/>6 - שכיר/ה בעל/ת שליטה ועצמאי/ת<br/>7 - פנסיונר/ית

employerId1string uuid
employerName1string
employmentIncome1integer
employerId2string uuid
employerName2string
employmentIncome2integer
usCitizenboolean
foreignTaxResidencyboolean
engAddressstring
kupatHolim1 | 2 | 3 | 4 | 5

Kupat Holim:<br/>1 - כללית<br/>2 - מכבי<br/>3 - מאוחדת<br/>4 - לאומית<br/>5 - צה"לית

kupatHolimComplementary10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41

Kupat Holim Complementary:<br/>10 - כללית מושלם זהב<br/>11 - כללית פלטינום<br/>20 - מכבי שלי<br/>21 - מכבי כסף<br/>22 - מכבי זהב<br/>30 - מאוחדת עדיף<br/>31 - מאוחדת שיא<br/>40 - לאומית כסף<br/>41 - לאומית זהב

heightinteger
weightinteger
smokerboolean
cigarettesCountPerDayinteger
drugsstring
surgeriesstring
hospitalizationsstring
backgroundDiseasesstring
bankAccountTypestring
bankCodeinteger
bankBranchCodeinteger
bankAccountNumberstring
swiftnessProxyInviteDatestring date
swiftnessProxySignDatestring date
swiftnessProxyExpiryDatestring date
swiftnessProxyExpiredboolean
lastE9100DataDatestring date
outdatedE9100Databoolean
swiftnessDataboolean
hbProxyInviteDatestring date
hbProxySignDatestring date
hbProxyExpiryDatestring date
hbProxyExpiredboolean
hbDataDatestring date
policiesProxyInviteDatestring date
policiesProxySignDatestring date
policiesProxyExpiryDatestring date
policiesProxyExpiredboolean
lastSwiftnessProductiaMonthstring
lastPratProductiaMonthstring
lastProductiaMonthstring
notesstring
notesUpdatedBystring uuid
notesUpdatedAtstring date-time
notesAlertboolean
reportEnabledboolean
reportPeriod'חד_פעמי' | 'חודשי' | 'רבעוני' | 'חצי_שנתי' | 'שנתי'
reportFormat'ממשק_אינטרנטי' | 'PDF'
reportByEmailboolean
reportByCellNumberboolean
reportIncludesInvestmentProductsboolean
reportIncludesInsuranceProductsboolean
reportDetailType1 | 2 | 3
reportFamilyboolean
reportFamilyDatestring date-time
reportFamilyExpiryDatestring date-time
reportFamilyExpiredboolean
lastSentConsultingReportIdstring uuid
lastSentConsultingReportTimestampstring date-time
lastSentProductiaReportIdstring uuid
lastSentProductiaReportTimestampstring date-time
lastProductiaReportAccessDatestring date-time
lastActivityDatestring date-time
lastActivityBystring uuid
lastMeetingDatestring date
monthlyRevenuenumber
appMailAddressstring
customerServiceEnabledboolean
customerServiceRecurrence1 | 2 | 3 | 4
customerServiceSmsboolean
customerServiceEmailboolean
tagsstring[]
surenseOneActiveboolean

Changes

No recorded changes to this operation across all 1 revision of this API.