Employers

Create an employer

Create a new employer.

post/employers

Request

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

Request body

agencyIdstring

Agency ID

idType1 | 2 | 3 | 4 | 5 | 6 | 10 required

Employer Identity Type:<br/>1 - עוסק מורשה<br/>2 - חברה פרטית<br/>3 - חברה ציבורית<br/>4 - עמותה רשומה<br/>5 - אגודה שיתופית<br/>6 - שותפות<br/>10 - אחר

idNumberstring required

ID number

namestring required

Employer name

streetstring

Street address

streetNumberstring

Street number

apartmentNumberstring

Apartment number

mailBoxinteger

Mail box number

citystring

City

postalCodeinteger

Postal code

countrystring

Country

managerIdstring

Manager ID

Example request

{
  "agencyId": "123e4567-e89b-12d3-a456-426614174000",
  "idNumber": "123456789",
  "name": "ABC Company Ltd",
  "street": "Main Street",
  "streetNumber": "123",
  "apartmentNumber": "4A",
  "mailBox": 123,
  "city": "Tel Aviv",
  "postalCode": 12345,
  "country": "Israel",
  "managerId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
idType'עוסק_מורשה' | 'חברה_פרטית' | 'חברה_ציבורית' | 'עמותה_רשומה' | 'אגודה_שיתופית' | 'שותפות' | 'אחר'
idNumberstring
namestring
streetstring
streetNumberstring
apartmentNumberstring
postalBoxinteger
citystring
countrystring
postalCodeinteger
notesstring
notesUpdatedBystring uuid
notesUpdatedAtstring date-time
notesAlertboolean
misparTikNikuimstring
managerIdstring uuid
managerNamestring
tagsstring[]
lastActivityDatestring date-time
lastActivityBystring uuid
appMailAddressstring

Changes

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