Provider Onboarding

Server

List clusters

GET

https://accounts.multitenant.slade360.co.ke

/api/branches/clusters

Cluster resource viewset.

List clusters › Responses

200

Untitled Response

count

string

next

string

previous

string

object[]

GET/api/branches/clusters

curl https://accounts.multitenant.slade360.co.ke/api/branches/clusters \
  --header 'sessionid: <api-key>'

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "children": "<string>",
      "default_store": {
        "branch": "<string>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "name": "<string>",
        "org_id": "<uuid>",
        "org_unit": "<uuid>",
        "org_unit_name": "<string>",
        "store_expiry_report": "<string>",
        "active": true,
        "is_org_unit_default_store": "<boolean>",
        "description": "<string>"
      },
      "id": "<uuid>",
      "is_etims_verified": "<string>",
      "name": "<string>",
      "org_id": "<uuid>",
      "organisation": "<uuid>",
      "organisation_tax_pin": "<string>",
      "orgunit_logo": {
        "content_type": "application/vnd.ms-excel",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation_unit": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "orgunit_type": "dept",
      "parent_name": "<string>",
      "parent_phone_number": "<string>",
      "phone_number": "<string>",
      "identifiers": [
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        },
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        }
      ],
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>",
      "email_address": "<email>",
      "physical_address": "<string>",
      "postal_address": "<string>",
      "web_address": "<uri>",
      "default_country": "PRY",
      "etims_branch_id": "<string>",
      "branch_status": "<boolean>",
      "county_name": "<string>",
      "sub_county_name": "<string>",
      "tax_locality_name": "<string>",
      "location_description": "<string>",
      "manager_name": "<string>",
      "is_headquater": "<boolean>",
      "etims_web_address": "<uri>",
      "etims_device_serial_no": "<string>",
      "username": "<string>",
      "password": "<string>",
      "use_cluster_doc_details": "<boolean>",
      "parent": "<uuid>"
    },
    {
      "children": "<string>",
      "default_store": {
        "branch": "<string>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "name": "<string>",
        "org_id": "<uuid>",
        "org_unit": "<uuid>",
        "org_unit_name": "<string>",
        "store_expiry_report": "<string>",
        "active": true,
        "is_org_unit_default_store": "<boolean>",
        "description": "<string>"
      },
      "id": "<uuid>",
      "is_etims_verified": "<string>",
      "name": "<string>",
      "org_id": "<uuid>",
      "organisation": "<uuid>",
      "organisation_tax_pin": "<string>",
      "orgunit_logo": {
        "content_type": "image/png",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation_unit": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "orgunit_type": "cluster",
      "parent_name": "<string>",
      "parent_phone_number": "<string>",
      "phone_number": "<string>",
      "identifiers": [
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        },
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        }
      ],
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>",
      "email_address": "<email>",
      "physical_address": "<string>",
      "postal_address": "<string>",
      "web_address": "<uri>",
      "default_country": "MRT",
      "etims_branch_id": "<string>",
      "branch_status": "<boolean>",
      "county_name": "<string>",
      "sub_county_name": "<string>",
      "tax_locality_name": "<string>",
      "location_description": "<string>",
      "manager_name": "<string>",
      "is_headquater": "<boolean>",
      "etims_web_address": "<uri>",
      "etims_device_serial_no": "<string>",
      "username": "<string>",
      "password": "<string>",
      "use_cluster_doc_details": "<boolean>",
      "parent": "<uuid>"
    }
  ]
}

json

application/json

Create clusters

POST

https://accounts.multitenant.slade360.co.ke

/api/branches/clusters

Create and persist single or multiple records.

Create clusters › Request Body

orgunit_type

string

phone_number

string · utc-millisec

name

string

description

string

email_address

string · email

physical_address

string

postal_address

string · utc-millisec

organisation

string

Create clusters › Responses

Untitled Response

children

string

object

id

string

is_etims_verified

string

name

string

org_id

string

organisation

string

organisation_tax_pin

string

object

orgunit_type

string

parent_name

string

parent_phone_number

string

phone_number

string

object[]

active

string

created

string

created_by

string

updated

string

updated_by

string

description

string

email_address

string

physical_address

string

postal_address

string

web_address

string

default_country

string

etims_branch_id

string

branch_status

string

county_name

string

sub_county_name

string

tax_locality_name

string

location_description

string

manager_name

string

is_headquater

string

etims_web_address

string

etims_device_serial_no

string

username

string

password

string

use_cluster_doc_details

string

parent

string

POST/api/branches/clusters

curl https://accounts.multitenant.slade360.co.ke/api/branches/clusters \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "orgunit_type": "cluster",
  "phone_number": "+254709823456",
  "name": "Test cluster",
  "description": "Desc",
  "email_address": "test@gmail.com",
  "physical_address": "ELdoret",
  "postal_address": "30100",
  "organisation": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d"
}'

Example Request Body

{
  "orgunit_type": "cluster",
  "phone_number": "+254709823456",
  "name": "Test cluster",
  "description": "Desc",
  "email_address": "test@gmail.com",
  "physical_address": "ELdoret",
  "postal_address": "30100",
  "organisation": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d"
}

json

application/json

Example Responses

{
  "children": "<string>",
  "default_store": {
    "branch": "<string>",
    "created_by_name": "<string>",
    "id": "<uuid>",
    "name": "<string>",
    "org_id": "<uuid>",
    "org_unit": "<uuid>",
    "org_unit_name": "<string>",
    "store_expiry_report": "<string>",
    "active": true,
    "is_org_unit_default_store": "<boolean>",
    "description": "<string>"
  },
  "id": "<uuid>",
  "is_etims_verified": "<string>",
  "name": "<string>",
  "org_id": "<uuid>",
  "organisation": "<uuid>",
  "organisation_tax_pin": "<string>",
  "orgunit_logo": {
    "content_type": "application/msword",
    "data": "<uri>",
    "id": "<uuid>",
    "organisation_unit": "<uuid>",
    "size": "<integer>",
    "title": "<string>",
    "active": "<boolean>",
    "creation_date": "<dateTime>",
    "description": "<string>",
    "aspect_ratio": "<string>"
  },
  "orgunit_type": "branch",
  "parent_name": "<string>",
  "parent_phone_number": "<string>",
  "phone_number": "<string>",
  "identifiers": [
    {
      "id": "<uuid>",
      "identifier_type": "kraPIN",
      "identifier_value": "<string>",
      "org_unit_id": "<uuid>"
    },
    {
      "id": "<uuid>",
      "identifier_type": "kraPIN",
      "identifier_value": "<string>",
      "org_unit_id": "<uuid>"
    }
  ],
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "description": "<string>",
  "email_address": "<email>",
  "physical_address": "<string>",
  "postal_address": "<string>",
  "web_address": "<uri>",
  "default_country": "ISR",
  "etims_branch_id": "<string>",
  "branch_status": "<boolean>",
  "county_name": "<string>",
  "sub_county_name": "<string>",
  "tax_locality_name": "<string>",
  "location_description": "<string>",
  "manager_name": "<string>",
  "is_headquater": "<boolean>",
  "etims_web_address": "<uri>",
  "etims_device_serial_no": "<string>",
  "username": "<string>",
  "password": "<string>",
  "use_cluster_doc_details": "<boolean>",
  "parent": "<uuid>"
}

json

application/json

List departments

GET

https://accounts.multitenant.slade360.co.ke

/api/branches/departments

Department resource viewset.

List departments › Responses

200

Untitled Response

count

string

next

string

previous

string

object[]

GET/api/branches/departments

curl https://accounts.multitenant.slade360.co.ke/api/branches/departments \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "children": "<string>",
      "default_store": {
        "branch": "<string>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "name": "<string>",
        "org_id": "<uuid>",
        "org_unit": "<uuid>",
        "org_unit_name": "<string>",
        "store_expiry_report": "<string>",
        "active": true,
        "is_org_unit_default_store": "<boolean>",
        "description": "<string>"
      },
      "id": "<uuid>",
      "is_etims_verified": "<string>",
      "name": "<string>",
      "org_id": "<uuid>",
      "organisation": "<uuid>",
      "organisation_tax_pin": "<string>",
      "orgunit_logo": {
        "content_type": "application/vnd.ms-excel",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation_unit": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "orgunit_type": "dept",
      "parent_name": "<string>",
      "parent_phone_number": "<string>",
      "phone_number": "<string>",
      "identifiers": [
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        },
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        }
      ],
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>",
      "email_address": "<email>",
      "physical_address": "<string>",
      "postal_address": "<string>",
      "web_address": "<uri>",
      "default_country": "PRY",
      "etims_branch_id": "<string>",
      "branch_status": "<boolean>",
      "county_name": "<string>",
      "sub_county_name": "<string>",
      "tax_locality_name": "<string>",
      "location_description": "<string>",
      "manager_name": "<string>",
      "is_headquater": "<boolean>",
      "etims_web_address": "<uri>",
      "etims_device_serial_no": "<string>",
      "username": "<string>",
      "password": "<string>",
      "use_cluster_doc_details": "<boolean>",
      "parent": "<uuid>"
    },
    {
      "children": "<string>",
      "default_store": {
        "branch": "<string>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "name": "<string>",
        "org_id": "<uuid>",
        "org_unit": "<uuid>",
        "org_unit_name": "<string>",
        "store_expiry_report": "<string>",
        "active": true,
        "is_org_unit_default_store": "<boolean>",
        "description": "<string>"
      },
      "id": "<uuid>",
      "is_etims_verified": "<string>",
      "name": "<string>",
      "org_id": "<uuid>",
      "organisation": "<uuid>",
      "organisation_tax_pin": "<string>",
      "orgunit_logo": {
        "content_type": "image/png",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation_unit": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "orgunit_type": "cluster",
      "parent_name": "<string>",
      "parent_phone_number": "<string>",
      "phone_number": "<string>",
      "identifiers": [
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        },
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        }
      ],
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>",
      "email_address": "<email>",
      "physical_address": "<string>",
      "postal_address": "<string>",
      "web_address": "<uri>",
      "default_country": "MRT",
      "etims_branch_id": "<string>",
      "branch_status": "<boolean>",
      "county_name": "<string>",
      "sub_county_name": "<string>",
      "tax_locality_name": "<string>",
      "location_description": "<string>",
      "manager_name": "<string>",
      "is_headquater": "<boolean>",
      "etims_web_address": "<uri>",
      "etims_device_serial_no": "<string>",
      "username": "<string>",
      "password": "<string>",
      "use_cluster_doc_details": "<boolean>",
      "parent": "<uuid>"
    }
  ]
}

json

application/json

Create departments

POST

https://accounts.multitenant.slade360.co.ke

/api/branches/departments

Create and persist single or multiple records.

Create departments › Request Body

orgunit_type

string

phone_number

string · utc-millisec

name

string

parent

string

description

string

email_address

string · email

physical_address

string

postal_address

string · color

organisation

string

Create departments › Responses

Untitled Response

children

string

object

id

string

is_etims_verified

string

name

string

org_id

string

organisation

string

organisation_tax_pin

string

object

orgunit_type

string

parent_name

string

parent_phone_number

string

phone_number

string

object[]

active

string

created

string

created_by

string

updated

string

updated_by

string

description

string

email_address

string

physical_address

string

postal_address

string

web_address

string

default_country

string

etims_branch_id

string

branch_status

string

county_name

string

sub_county_name

string

tax_locality_name

string

location_description

string

manager_name

string

is_headquater

string

etims_web_address

string

etims_device_serial_no

string

username

string

password

string

use_cluster_doc_details

string

parent

string

POST/api/branches/departments

curl https://accounts.multitenant.slade360.co.ke/api/branches/departments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "orgunit_type": "dept",
  "phone_number": "+254789234567",
  "name": "Test department",
  "parent": "23bafb80-2702-4bba-9a0c-65b7b8c7a9de",
  "description": "test",
  "email_address": "test@gmail.com",
  "physical_address": "Eldsoret",
  "postal_address": "310200",
  "organisation": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d"
}'

Example Request Body

{
  "orgunit_type": "dept",
  "phone_number": "+254789234567",
  "name": "Test department",
  "parent": "23bafb80-2702-4bba-9a0c-65b7b8c7a9de",
  "description": "test",
  "email_address": "test@gmail.com",
  "physical_address": "Eldsoret",
  "postal_address": "310200",
  "organisation": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d"
}

json

application/json

Example Responses

{
  "children": "<string>",
  "default_store": {
    "branch": "<string>",
    "created_by_name": "<string>",
    "id": "<uuid>",
    "name": "<string>",
    "org_id": "<uuid>",
    "org_unit": "<uuid>",
    "org_unit_name": "<string>",
    "store_expiry_report": "<string>",
    "active": true,
    "is_org_unit_default_store": "<boolean>",
    "description": "<string>"
  },
  "id": "<uuid>",
  "is_etims_verified": "<string>",
  "name": "<string>",
  "org_id": "<uuid>",
  "organisation": "<uuid>",
  "organisation_tax_pin": "<string>",
  "orgunit_logo": {
    "content_type": "application/msword",
    "data": "<uri>",
    "id": "<uuid>",
    "organisation_unit": "<uuid>",
    "size": "<integer>",
    "title": "<string>",
    "active": "<boolean>",
    "creation_date": "<dateTime>",
    "description": "<string>",
    "aspect_ratio": "<string>"
  },
  "orgunit_type": "branch",
  "parent_name": "<string>",
  "parent_phone_number": "<string>",
  "phone_number": "<string>",
  "identifiers": [
    {
      "id": "<uuid>",
      "identifier_type": "kraPIN",
      "identifier_value": "<string>",
      "org_unit_id": "<uuid>"
    },
    {
      "id": "<uuid>",
      "identifier_type": "kraPIN",
      "identifier_value": "<string>",
      "org_unit_id": "<uuid>"
    }
  ],
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "description": "<string>",
  "email_address": "<email>",
  "physical_address": "<string>",
  "postal_address": "<string>",
  "web_address": "<uri>",
  "default_country": "ISR",
  "etims_branch_id": "<string>",
  "branch_status": "<boolean>",
  "county_name": "<string>",
  "sub_county_name": "<string>",
  "tax_locality_name": "<string>",
  "location_description": "<string>",
  "manager_name": "<string>",
  "is_headquater": "<boolean>",
  "etims_web_address": "<uri>",
  "etims_device_serial_no": "<string>",
  "username": "<string>",
  "password": "<string>",
  "use_cluster_doc_details": "<boolean>",
  "parent": "<uuid>"
}

json

application/json

List branches

GET

https://accounts.multitenant.slade360.co.ke

/api/branches/branches

Branch resource viewset.

List branches › Responses

200

Untitled Response

count

string

next

string

previous

string

object[]

GET/api/branches/branches

curl https://accounts.multitenant.slade360.co.ke/api/branches/branches \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "children": "<string>",
      "default_store": {
        "branch": "<string>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "name": "<string>",
        "org_id": "<uuid>",
        "org_unit": "<uuid>",
        "org_unit_name": "<string>",
        "store_expiry_report": "<string>",
        "active": true,
        "is_org_unit_default_store": "<boolean>",
        "description": "<string>"
      },
      "id": "<uuid>",
      "is_etims_verified": "<string>",
      "name": "<string>",
      "org_id": "<uuid>",
      "organisation": "<uuid>",
      "organisation_tax_pin": "<string>",
      "orgunit_logo": {
        "content_type": "application/vnd.ms-excel",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation_unit": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "orgunit_type": "dept",
      "parent_name": "<string>",
      "parent_phone_number": "<string>",
      "phone_number": "<string>",
      "identifiers": [
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        },
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        }
      ],
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>",
      "email_address": "<email>",
      "physical_address": "<string>",
      "postal_address": "<string>",
      "web_address": "<uri>",
      "default_country": "PRY",
      "etims_branch_id": "<string>",
      "branch_status": "<boolean>",
      "county_name": "<string>",
      "sub_county_name": "<string>",
      "tax_locality_name": "<string>",
      "location_description": "<string>",
      "manager_name": "<string>",
      "is_headquater": "<boolean>",
      "etims_web_address": "<uri>",
      "etims_device_serial_no": "<string>",
      "username": "<string>",
      "password": "<string>",
      "use_cluster_doc_details": "<boolean>",
      "parent": "<uuid>"
    },
    {
      "children": "<string>",
      "default_store": {
        "branch": "<string>",
        "created_by_name": "<string>",
        "id": "<uuid>",
        "name": "<string>",
        "org_id": "<uuid>",
        "org_unit": "<uuid>",
        "org_unit_name": "<string>",
        "store_expiry_report": "<string>",
        "active": true,
        "is_org_unit_default_store": "<boolean>",
        "description": "<string>"
      },
      "id": "<uuid>",
      "is_etims_verified": "<string>",
      "name": "<string>",
      "org_id": "<uuid>",
      "organisation": "<uuid>",
      "organisation_tax_pin": "<string>",
      "orgunit_logo": {
        "content_type": "image/png",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation_unit": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "orgunit_type": "cluster",
      "parent_name": "<string>",
      "parent_phone_number": "<string>",
      "phone_number": "<string>",
      "identifiers": [
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        },
        {
          "id": "<uuid>",
          "identifier_type": "kraPIN",
          "identifier_value": "<string>",
          "org_unit_id": "<uuid>"
        }
      ],
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>",
      "email_address": "<email>",
      "physical_address": "<string>",
      "postal_address": "<string>",
      "web_address": "<uri>",
      "default_country": "MRT",
      "etims_branch_id": "<string>",
      "branch_status": "<boolean>",
      "county_name": "<string>",
      "sub_county_name": "<string>",
      "tax_locality_name": "<string>",
      "location_description": "<string>",
      "manager_name": "<string>",
      "is_headquater": "<boolean>",
      "etims_web_address": "<uri>",
      "etims_device_serial_no": "<string>",
      "username": "<string>",
      "password": "<string>",
      "use_cluster_doc_details": "<boolean>",
      "parent": "<uuid>"
    }
  ]
}

json

application/json

Create branches

POST

https://accounts.multitenant.slade360.co.ke

/api/branches/branches

Create and persist single or multiple records.

Create branches › Request Body

orgunit_type

string

phone_number

string · utc-millisec

name

string

parent

string

description

string

email_address

string · email

physical_address

string

postal_address

string · utc-millisec

organisation

string

Create branches › Responses

Untitled Response

children

string

object

id

string

is_etims_verified

string

name

string

org_id

string

organisation

string

organisation_tax_pin

string

object

orgunit_type

string

parent_name

string

parent_phone_number

string

phone_number

string

object[]

active

string

created

string

created_by

string

updated

string

updated_by

string

description

string

email_address

string

physical_address

string

postal_address

string

web_address

string

default_country

string

etims_branch_id

string

branch_status

string

county_name

string

sub_county_name

string

tax_locality_name

string

location_description

string

manager_name

string

is_headquater

string

etims_web_address

string

etims_device_serial_no

string

username

string

password

string

use_cluster_doc_details

string

parent

string

POST/api/branches/branches

curl https://accounts.multitenant.slade360.co.ke/api/branches/branches \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "orgunit_type": "branch",
  "phone_number": "+254789234567",
  "name": "test branch",
  "parent": "f88319a9-fafe-4f61-9178-11fe193620e7",
  "description": "test",
  "email_address": "test@gmail.com",
  "physical_address": "Eldoret",
  "postal_address": "30100",
  "organisation": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d"
}'

Example Request Body

{
  "orgunit_type": "branch",
  "phone_number": "+254789234567",
  "name": "test branch",
  "parent": "f88319a9-fafe-4f61-9178-11fe193620e7",
  "description": "test",
  "email_address": "test@gmail.com",
  "physical_address": "Eldoret",
  "postal_address": "30100",
  "organisation": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d"
}

json

application/json

Example Responses

{
  "children": "<string>",
  "default_store": {
    "branch": "<string>",
    "created_by_name": "<string>",
    "id": "<uuid>",
    "name": "<string>",
    "org_id": "<uuid>",
    "org_unit": "<uuid>",
    "org_unit_name": "<string>",
    "store_expiry_report": "<string>",
    "active": true,
    "is_org_unit_default_store": "<boolean>",
    "description": "<string>"
  },
  "id": "<uuid>",
  "is_etims_verified": "<string>",
  "name": "<string>",
  "org_id": "<uuid>",
  "organisation": "<uuid>",
  "organisation_tax_pin": "<string>",
  "orgunit_logo": {
    "content_type": "application/msword",
    "data": "<uri>",
    "id": "<uuid>",
    "organisation_unit": "<uuid>",
    "size": "<integer>",
    "title": "<string>",
    "active": "<boolean>",
    "creation_date": "<dateTime>",
    "description": "<string>",
    "aspect_ratio": "<string>"
  },
  "orgunit_type": "branch",
  "parent_name": "<string>",
  "parent_phone_number": "<string>",
  "phone_number": "<string>",
  "identifiers": [
    {
      "id": "<uuid>",
      "identifier_type": "kraPIN",
      "identifier_value": "<string>",
      "org_unit_id": "<uuid>"
    },
    {
      "id": "<uuid>",
      "identifier_type": "kraPIN",
      "identifier_value": "<string>",
      "org_unit_id": "<uuid>"
    }
  ],
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "description": "<string>",
  "email_address": "<email>",
  "physical_address": "<string>",
  "postal_address": "<string>",
  "web_address": "<uri>",
  "default_country": "ISR",
  "etims_branch_id": "<string>",
  "branch_status": "<boolean>",
  "county_name": "<string>",
  "sub_county_name": "<string>",
  "tax_locality_name": "<string>",
  "location_description": "<string>",
  "manager_name": "<string>",
  "is_headquater": "<boolean>",
  "etims_web_address": "<uri>",
  "etims_device_serial_no": "<string>",
  "username": "<string>",
  "password": "<string>",
  "use_cluster_doc_details": "<boolean>",
  "parent": "<uuid>"
}

json

application/json

Settings