Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
e) Organisation Management

Search for organisations

Returns organisations registered under the tenant, optionally filtered by name, email, or external unique ID.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations

Path parameters

tenantIdinteger required

Query parameters

emailstring
externalUniqueIdstring

External unique Id

limitinteger
namestring
offsetinteger
onlyShowAllowedboolean

If true, returns only organisations the authenticated user has permission to access. If false and the user lacks permission, an error is returned.

Response

OK

businessRegistrationDatestring

Business registration date must be in form of yyyyMMdd

businessType'CLOSE_CORPORATION' | 'LIMITED_COMPANY' | 'PARTNERSHIP' | 'PERSONAL_LIABILITY_COMPANY' | 'PUBLIC_LISTED_COMPANY' | 'SOLE_PROPRIETOR' | 'STATE_OWNED_COMPANY' | 'TRUST' | 'UNREGISTERED'
categoryCodeinteger

Four digit Category code for this organisation.

companyNumberstring

Legal company number of the organisation

createdstring date-time

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

emailstring

Email address of the organisation

externalUniqueIdstring

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

industrialClassificationstring
industrialSectorstring
lastModifiedstring date-time

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

merchantIdstring

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

namestring

Name of the organisation

organisationIdinteger

Unique system generated identifier for an organisation

phone1string required

Organisations primary phone number

phone2string

Organisations secondary phone number

status'ACTIVE' | 'BARRED' | 'INACTIVE'

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

taxNumberstring

Tax number of the organisation

tenantIdinteger
tradingNamestring
type'BUSINESS' | 'CLUB' | 'FAMILY' | 'MERCHANT' | 'OTHER' | 'PERMISSION_GROUP' | 'RAP'

OrganisationType

vatNumberstring

VAT number of organisation

versioninteger required

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.

Example response

[
  {
    "created": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00"
  }
]