List organisations for a company
Retrieves all organisations (suppliers, customers, distributors, etc.) belonging to the specified company with their assigned roles.
path Parameters
companyIdThe unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555
query Parameters
roleIdOptional filter by organisation role ID (e.g., 1 for Supplier). If omitted, returns all organisations.
List organisations for a company › Responses
List of organisations retrieved successfully
createdAtTimestamp when the record was created (UTC)
updatedAtTimestamp when the record was last updated (UTC)
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs assigned to this organisation
rolesList of role names assigned to this organisation
organisationIdUnique identifier for the organisation
companyIdIdentifier of the owning company
nameOrganisation name
Create new organisations
Creates one or more new organisations for the specified company. Each organisation can have multiple roles assigned.
path Parameters
companyIdThe unique identifier of the company
Create new organisations › Request Body
nameOrganisation name
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs to assign to this organisation
Create new organisations › Responses
Organisations created successfully
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs assigned to this organisation
rolesList of role names assigned to this organisation
organisationIdUnique identifier for the organisation
companyIdIdentifier of the owning company
nameOrganisation name
Get organisation by ID
Retrieves a specific organisation by its unique identifier.
path Parameters
companyIdThe unique identifier of the company
organisationIdThe unique identifier of the organisation
Get organisation by ID › Responses
Organisation retrieved successfully
createdAtTimestamp when the record was created (UTC)
updatedAtTimestamp when the record was last updated (UTC)
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs assigned to this organisation
rolesList of role names assigned to this organisation
organisationIdUnique identifier for the organisation
companyIdIdentifier of the owning company
nameOrganisation name
Update an existing organisation
Updates an existing organisation's details and role mappings.
path Parameters
companyIdThe unique identifier of the company
organisationIdThe unique identifier of the organisation to update
Update an existing organisation › Request Body
nameOrganisation name
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs to assign to this organisation
Update an existing organisation › Responses
Organisation updated successfully
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs assigned to this organisation
rolesList of role names assigned to this organisation
organisationIdUnique identifier for the organisation
companyIdIdentifier of the owning company
nameOrganisation name
Delete organisation
Soft deletes an organisation by marking it as inactive. The organisation will no longer appear in lists but data is preserved for audit purposes.
path Parameters
companyIdThe unique identifier of the company
organisationIdThe unique identifier of the organisation to delete
Delete organisation › Responses
Organisation deleted successfully
deletedCountNumber of organisations deleted
deletedIdsList of organisation IDs that were deleted
Upload organisations from CSV
Uploads and processes a CSV file to create or update organisations in bulk. If OrganisationId is provided in CSV, existing records will be updated (merged); otherwise new records are created. Supports case-insensitive and flexible header names.
path Parameters
companyIdThe unique identifier of the company
Upload organisations from CSV › Responses
CSV uploaded and processed successfully