Update an organisation

put

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}

Update an organisation by its organisation id

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

organisationId

int64

required

Body Params

A company, organisation or grouping of customers which can in turn own a wallet, have an address or have associated documents. Typically known as a Juristic but organisation can also include just a grouping of people like a family, club or association.

bankDetails

array of objects

bankDetails

businessRegistrationDate

string

length between 8 and 8

Business registration date must be in form of yyyyMMdd

businessType

string

enum

The type of the business. This will be supplementary to organisation type when selected type of business.

categoryCode

int64

Four digit Category code for this organisation.

companyNumber

string

length between 5 and 20

Legal company number of the organisation

created

date-time

ISO 8601 date/time of when the record was first created

string

Email address of the organisation

externalUniqueId

string

A globally unique identifier set by the tenant for this organisation. Useful for correlating between the tenants systems and Eclipse

industrialClassification

string

length between 3 and 50

industrialSector

string

length between 3 and 50

lastModified

date-time

ISO 8601 date/time of when the record was last modified

merchantId

string

Merchant Id used for some card payment types to the organisations wallet

name

string

length between 3 and 50

Name of the organisation

organisationId

int64

Unique system generated identifier for an organisation

phone1

string

required

Organisations primary phone number

phone2

string

length between 10 and 20

Organisations secondary phone number

status

string

enum

Status of the eclipse organisation. ACTIVE:Organisation is active, INACTIVE:Organisation is in active, BARRED:Organisation is in barred

Allowed:

taxNumber

string

length between 3 and 20

Tax number of the organisation

tenantId

int64

tradingName

string

length between 3 and 50

type

string

enum

The type of the organisation

Allowed:

vatNumber

string

VAT number of organisation

version

int32

required

≥ 0

A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.

Responses

400

Bad Request

200OK