Skip to main content
POST
Create a client entity

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Body

entityTypeID
integer<int32>
entityType
string | null
Maximum string length: 50
clientStatus
string | null
Maximum string length: 20
entityCode
string | null
Maximum string length: 10
externalSystemID
string | null
Maximum string length: 100
entityName
string | null
Maximum string length: 255
otherName
string | null
Maximum string length: 255
entitySurname
string | null
Maximum string length: 255
entityInitials
string | null
Maximum string length: 10
birthDate
string<date> | null
incorporationDate
string<date> | null
birthPlace
string | null
Maximum string length: 100
email
string | null
Maximum string length: 100
telephone
string | null
Maximum string length: 45
mobile
string | null
Maximum string length: 45
taxNumber
string | null
Maximum string length: 15
taxNotRequired
boolean
salesTaxNumber
string | null
Maximum string length: 20
regNumber
string | null
Maximum string length: 20
idNumber
string | null
Maximum string length: 20
gender
string | null
Maximum string length: 10
note
string | null
Maximum string length: 65535
physicalAddress
object
postalAddress
object

Response

Created