Sales and Inventory

Server

List inventory adjustments

GET

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

/api/inventory/inventoryadjustment

This endoint lists all the inventory adjustments.

List inventory adjustments › Headers

X-Workstation

string

[REQUIRED] Workstation ID

List inventory adjustments › Responses

200

Untitled Response

count

string

next

string

previous

string

object[]

GET/api/inventory/inventoryadjustment

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

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "active_pricelist": "<string>",
      "branch_name": "<string>",
      "department": "<string>",
      "document_latest_comment": "<string>",
      "id": "<uuid>",
      "inventory_reference": "<string>",
      "location_name": "<string>",
      "made_by": "<string>",
      "organisation": "<uuid>",
      "parent_document_number": "<string>",
      "source_organisation_unit": "<uuid>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "document_number": "<string>",
      "workflow_state": "DRAFT",
      "source_document": "<string>",
      "reference_number": "<string>",
      "document_count": "<long>",
      "reason": "<string>",
      "description": "<string>",
      "date": "<dateTime>",
      "sent_to_etims": "<boolean>",
      "financial_year": "<uuid>",
      "parent_document": "<uuid>",
      "location": "<uuid>"
    },
    {
      "active_pricelist": "<string>",
      "branch_name": "<string>",
      "department": "<string>",
      "document_latest_comment": "<string>",
      "id": "<uuid>",
      "inventory_reference": "<string>",
      "location_name": "<string>",
      "made_by": "<string>",
      "organisation": "<uuid>",
      "parent_document_number": "<string>",
      "source_organisation_unit": "<uuid>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "document_number": "<string>",
      "workflow_state": "INVALIDATED",
      "source_document": "<string>",
      "reference_number": "<string>",
      "document_count": "<long>",
      "reason": "<string>",
      "description": "<string>",
      "date": "<dateTime>",
      "sent_to_etims": "<boolean>",
      "financial_year": "<uuid>",
      "parent_document": "<uuid>",
      "location": "<uuid>"
    }
  ]
}

json

application/json

Create inventory adjustment

POST

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

/api/inventory/inventoryadjustment

Description

This API endpoint creates an inventory adjustment to adjust stock

Create inventory adjustment › Responses

Untitled Response

active_pricelist

string

branch_name

string

department

string

document_latest_comment

string

id

string

inventory_reference

string

location_name

string

made_by

string

organisation

string

parent_document_number

string

source_organisation_unit

string

updated_by_name

string

active

string

created

string

created_by

string

updated

string

updated_by

string

document_number

string

workflow_state

string

source_document

string

reference_number

string

document_count

string

reason

string

description

string

date

string

sent_to_etims

string

financial_year

string

parent_document

string

location

string

POST/api/inventory/inventoryadjustment

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

Example Responses

{
  "active_pricelist": "<string>",
  "branch_name": "<string>",
  "department": "<string>",
  "document_latest_comment": "<string>",
  "id": "<uuid>",
  "inventory_reference": "<string>",
  "location_name": "<string>",
  "made_by": "<string>",
  "organisation": "<uuid>",
  "parent_document_number": "<string>",
  "source_organisation_unit": "<uuid>",
  "updated_by_name": "<string>",
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "document_number": "<string>",
  "workflow_state": "RETURNED",
  "source_document": "<string>",
  "reference_number": "<string>",
  "document_count": "<long>",
  "reason": "<string>",
  "description": "<string>",
  "date": "<dateTime>",
  "sent_to_etims": "<boolean>",
  "financial_year": "<uuid>",
  "parent_document": "<uuid>",
  "location": "<uuid>"
}

json

application/json

Create inventory adjustment line

POST

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

/api/inventory/inventoryadjustmentline

This endpoint creates an inventory adjustment line and adds it to an inventory adjustment

Create inventory adjustment line › Responses

Untitled Response

active_pricelist

string

document_latest_comment

string

id

string

initial_quantity

string

inventory_adjustment

string

inventory_adjustment_reference

string

made_by

string

organisation

string

parent_document_number

string

product

string

product_name

string

quantity

string

updated_by_name

string

active

string

created

string

created_by

string

updated

string

updated_by

string

price_inclusive_tax

string

price_exclusive_tax

string

new_price

string

pricelist_product

string

product_uom

string

lot

string

POST/api/inventory/inventoryadjustmentline

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

Example Responses

{
  "active_pricelist": "<string>",
  "document_latest_comment": "<string>",
  "id": "<uuid>",
  "initial_quantity": "<string>",
  "inventory_adjustment": "<uuid>",
  "inventory_adjustment_reference": "<string>",
  "made_by": "<string>",
  "organisation": "<uuid>",
  "parent_document_number": "<string>",
  "product": "<uuid>",
  "product_name": "<string>",
  "quantity": "<double>",
  "updated_by_name": "<string>",
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "price_inclusive_tax": "<double>",
  "price_exclusive_tax": "<double>",
  "new_price": "<double>",
  "pricelist_product": "<uuid>",
  "product_uom": "<uuid>",
  "lot": "<uuid>"
}

json

application/json

Process inventory adjustment

PATCH

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

/api/inventory/inventoryadjustment/{id}/transition/DRAFT_SUBMIT_APPROVE

This endpoint is used to transition an inventory adjustment from draft to submit and then to approve status.

Process inventory adjustment › path Parameters

id

string · required

(Required) ID string identifying this inventory adjustment.

Process inventory adjustment › Headers

X-Workstation

string

[REQUIRED] Workstation ID

Process inventory adjustment › Request Body

Process inventory adjustment › Responses

200

Untitled Response

active_pricelist

string

branch_name

string

department

string

document_latest_comment

string

id

string

inventory_reference

string

location_name

string

made_by

string

organisation

string

parent_document_number

string

source_organisation_unit

string

updated_by_name

string

active

string

created

string

created_by

string

updated

string

updated_by

string

document_number

string

workflow_state

string

source_document

string

reference_number

string

document_count

string

reason

string

description

string

date

string

sent_to_etims

string

financial_year

string

parent_document

string

location

string

PATCH/api/inventory/inventoryadjustment/{id}/transition/DRAFT_SUBMIT_APPROVE

curl https://accounts.multitenant.slade360.co.ke/api/inventory/inventoryadjustment/:id/transition/DRAFT_SUBMIT_APPROVE \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "active_pricelist": "<string>",
  "branch_name": "<string>",
  "department": "<string>",
  "document_latest_comment": "<string>",
  "id": "<uuid>",
  "inventory_reference": "<string>",
  "location_name": "<string>",
  "made_by": "<string>",
  "organisation": "<uuid>",
  "parent_document_number": "<string>",
  "source_organisation_unit": "<uuid>",
  "updated_by_name": "<string>",
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "document_number": "<string>",
  "workflow_state": "RETURNED",
  "source_document": "<string>",
  "reference_number": "<string>",
  "document_count": "<long>",
  "reason": "<string>",
  "description": "<string>",
  "date": "<dateTime>",
  "sent_to_etims": "<boolean>",
  "financial_year": "<uuid>",
  "parent_document": "<uuid>",
  "location": "<uuid>"
}

json

application/json

List stockout report recipients

GET

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

/inventory/inventoryrecipientalerts

List stockout report recipients › Responses

200

List stockout report recipients

count

integer

next

previous

page_size

integer

current_page

integer

total_pages

integer

start_index

integer

end_index

integer

object[]

GET/inventory/inventoryrecipientalerts

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

Example Responses

{
  "count": 7,
  "next": null,
  "previous": null,
  "page_size": 50,
  "current_page": 1,
  "total_pages": 1,
  "start_index": 1,
  "end_index": 7,
  "results": [
    {
      "id": "acdbff0a-a82a-4f40-8710-d50bb750dbe0",
      "recipient_first_name": "Clifford",
      "recipient_last_name": "Ouma",
      "recipient_name": "Clifford Ouma",
      "recipient_email": "Clifford.ouma+test@savannahinformatics.com",
      "active": true,
      "created": "2025-05-09T10:23:06.957165+03:00",
      "created_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "updated": "2025-05-09T10:23:06.957175+03:00",
      "updated_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "location": "367d744e-11af-4789-be49-2be54193e835"
    },
    {
      "id": "8e1c6e3d-cc4b-4b0a-a726-ac77e64ef886",
      "recipient_first_name": "Clifford",
      "recipient_last_name": "Ouma",
      "recipient_name": "Clifford Ouma",
      "recipient_email": "Clifford.ouma+test@savannahinformatics.com",
      "inventory_location_name": "Karatina",
      "branch_org_unit_id": "6eea6e6c-201e-44ea-b3da-3039aec3d25b",
      "active": true,
      "created": "2025-02-20T12:11:48.786954+03:00",
      "created_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "updated": "2025-02-20T12:11:48.786963+03:00",
      "updated_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "location": "4415f014-478a-488b-9278-848edaccac99"
    },
    {
      "id": "cea465ed-1477-4b20-aa28-4689f602e89c",
      "recipient_first_name": "Samson",
      "recipient_last_name": "Muoki",
      "recipient_name": "Samson Muoki",
      "recipient_email": "smuoki+457@savannahinformatics.com",
      "inventory_location_name": "Laare",
      "branch_org_unit_id": "4e23eb0a-0f63-4960-b245-30776b0315c6",
      "active": true,
      "created": "2025-02-20T07:53:03.346919+03:00",
      "created_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "updated": "2025-02-20T07:53:03.346930+03:00",
      "updated_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "122bc46c-d967-4cc0-ba26-03fa525022b5",
      "location": "741abcb8-8609-4f60-b917-af96c8b29e2a"
    },
    {
      "id": "44d00625-dc3d-4f9d-9fd4-603e7de2789f",
      "recipient_first_name": "Clifford",
      "recipient_last_name": "Ouma",
      "recipient_name": "Clifford Ouma",
      "recipient_email": "Clifford.ouma+test@savannahinformatics.com",
      "inventory_location_name": "Juja Branch",
      "branch_org_unit_id": "7d8c26c6-677b-4aa7-81fe-00c620547a4d",
      "active": true,
      "created": "2025-02-20T07:52:35.805715+03:00",
      "created_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "updated": "2025-02-20T07:52:35.805723+03:00",
      "updated_by": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "fbbbd72e-b45d-4cc6-8d65-6eccd35d5b6d",
      "location": "21771de1-f8f4-47a5-9ca4-83fda2728302"
    },
    {
      "id": "924bf788-31e2-4868-8c42-79d96f5a224c",
      "recipient_first_name": "Kenneth",
      "recipient_last_name": "Kimani",
      "recipient_name": "Kenneth Kimani",
      "recipient_email": "Kenneth.kimani@savannahinformatics.com",
      "active": true,
      "created": "2025-01-14T12:51:09.081954+03:00",
      "created_by": "a8463777-e5b8-4ba9-b639-93f656dd6961",
      "updated": "2025-01-14T12:51:09.081968+03:00",
      "updated_by": "a8463777-e5b8-4ba9-b639-93f656dd6961",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "a8463777-e5b8-4ba9-b639-93f656dd6961",
      "location": "5721cab0-42f7-45dd-b3fb-b4b90a56e835"
    },
    {
      "id": "987bc9cf-851e-40d8-9194-22159afddc1f",
      "recipient_first_name": "Tester",
      "recipient_last_name": "Account",
      "recipient_name": "Tester Account",
      "recipient_email": "tester2@testaccount.com",
      "inventory_location_name": "Main",
      "branch_org_unit_id": "e0016d97-e24b-4f5f-b19f-cf78c69ffd55",
      "active": true,
      "created": "2025-01-03T18:02:59.284822+03:00",
      "created_by": "34855fae-ffec-4db3-876b-e7fec7ced738",
      "updated": "2025-01-03T18:02:59.284833+03:00",
      "updated_by": "34855fae-ffec-4db3-876b-e7fec7ced738",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "6970bd77-af6f-44ff-b98f-68b27a2adfab",
      "location": "6af7093a-7536-4185-b38d-7659bc8bd35f"
    },
    {
      "id": "a8356d91-b2d0-402a-94da-42ec25960e42",
      "recipient_first_name": "Sarah",
      "recipient_last_name": "Njuguna",
      "recipient_name": "Sarah Njuguna",
      "recipient_email": "sarah.njuguna+5113@savannahinformatics.com",
      "active": true,
      "created": "2024-12-11T14:31:23.169164+03:00",
      "created_by": "34855fae-ffec-4db3-876b-e7fec7ced738",
      "updated": "2024-12-11T14:31:23.169178+03:00",
      "updated_by": "34855fae-ffec-4db3-876b-e7fec7ced738",
      "organisation": "18d2cb54-b4dd-4b2c-baad-13df951bfed9",
      "user": "34855fae-ffec-4db3-876b-e7fec7ced738",
      "location": "619b3a99-162d-433d-8dda-7f5932aa8798"
    }
  ]
}

json

application/json

List payment methods

GET

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

/api/financial_accounts/paymentmethods

Payment methods view.

List payment methods › Responses

200

Untitled Response

count

string

next

string

previous

string

object[]

GET/api/financial_accounts/paymentmethods

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

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "account": "<uuid>",
      "account_details": "<string>",
      "bank_account_number": "<string>",
      "bank_branch": "<string>",
      "bank_name": "<string>",
      "id": "<uuid>",
      "mobile_money_business_number": "<string>",
      "mobile_money_type": "<string>",
      "name": "<string>",
      "organisation": "<uuid>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>"
    },
    {
      "account": "<uuid>",
      "account_details": "<string>",
      "bank_account_number": "<string>",
      "bank_branch": "<string>",
      "bank_name": "<string>",
      "id": "<uuid>",
      "mobile_money_business_number": "<string>",
      "mobile_money_type": "<string>",
      "name": "<string>",
      "organisation": "<uuid>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "description": "<string>"
    }
  ]
}

json

application/json

Create payment method

POST

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

/api/financial_accounts/paymentmethods

Create and persist single or multiple records.

Create payment method › Request Body

name

string

description

string

account

string

Create payment method › Responses

Untitled Response

account

string

account_details

string

bank_account_number

string

bank_branch

string

bank_name

string

id

string

mobile_money_business_number

string

mobile_money_type

string

name

string

organisation

string

active

string

created

string

created_by

string

updated

string

updated_by

string

description

string

POST/api/financial_accounts/paymentmethods

curl https://accounts.multitenant.slade360.co.ke/api/financial_accounts/paymentmethods \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "testpayment",
  "description": "Test method\n",
  "account": "0d8bccca-f7af-413c-91b4-5f496cf71be8"
}'

Example Request Body

{
  "name": "testpayment",
  "description": "Test method\n",
  "account": "0d8bccca-f7af-413c-91b4-5f496cf71be8"
}

json

application/json

Example Responses

{
  "account": "<uuid>",
  "account_details": "<string>",
  "bank_account_number": "<string>",
  "bank_branch": "<string>",
  "bank_name": "<string>",
  "id": "<uuid>",
  "mobile_money_business_number": "<string>",
  "mobile_money_type": "<string>",
  "name": "<string>",
  "organisation": "<uuid>",
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "description": "<string>"
}

json

application/json

List customers

GET

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

/api/business_partners/customers

Customer viewset.

List customers › Responses

200

Untitled Response

count

string

next

string

previous

string

object[]

GET/api/business_partners/customers

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

Example Responses

{
  "count": "<integer>",
  "next": "<uri>",
  "previous": "<uri>",
  "results": [
    {
      "billing_accounts": [
        {
          "id": "<uuid>",
          "name": "<string>",
          "description": "<string>",
          "is_active": "<boolean>",
          "_identifiers": "<string>",
          "number": "<string>",
          "tag": "<string>"
        },
        {
          "id": "<uuid>",
          "name": "<string>",
          "description": "<string>",
          "is_active": "<boolean>",
          "_identifiers": "<string>",
          "number": "<string>",
          "tag": "<string>"
        }
      ],
      "business_partner_attachments": [
        {
          "business_partner": "<uuid>",
          "content_type": "application/pdf",
          "data": "<uri>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "size": "<integer>",
          "title": "<string>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "creation_date": "<dateTime>",
          "description": "<string>",
          "aspect_ratio": "<string>",
          "attachment_type": "NATIONAL_IDENTITY"
        },
        {
          "business_partner": "<uuid>",
          "content_type": "application/vnd.ms-excel",
          "data": "<uri>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "size": "<integer>",
          "title": "<string>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "creation_date": "<dateTime>",
          "description": "<string>",
          "aspect_ratio": "<string>",
          "attachment_type": "BACK_OF_NATIONAL_IDENTITY"
        }
      ],
      "business_partner_contact": [
        {
          "business_partner": "<uuid>",
          "contact": "<string>",
          "contact_type": "email",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>"
        },
        {
          "business_partner": "<uuid>",
          "contact": "<string>",
          "contact_type": "phone_number",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>"
        }
      ],
      "business_partner_id": {
        "business_partner": "<uuid>",
        "id": "<uuid>",
        "id_document_type": "payerID",
        "id_value": "<string>",
        "organisation": "<uuid>",
        "active": "<boolean>",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>"
      },
      "business_partner_person": {
        "business_partner": "<uuid>",
        "first_name": "<string>",
        "id": "<uuid>",
        "last_name": "<string>",
        "organisation": "<uuid>",
        "active": "<boolean>",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "other_names": "<string>",
        "title_option": "<string>",
        "date_of_birth": "<date>",
        "title": "<string>",
        "metadata": "<string>"
      },
      "business_partner_photo": {
        "business_partner": "<uuid>",
        "content_type": "image/png",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "code": "<integer>",
      "country": "CMR",
      "currency": "<uuid>",
      "customer_amount_owed": "<string>",
      "customer_credit_utilized": "<string>",
      "customer_deposits_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "customer_sync_to_etims": "<string>",
      "id": "<uuid>",
      "identifiers": [
        {
          "business_partner": "<uuid>",
          "id": "<uuid>",
          "identifier_type": "SHIF",
          "identifier_value": "<string>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "valid_from": "<dateTime>",
          "valid_to": "<dateTime>"
        },
        {
          "business_partner": "<uuid>",
          "id": "<uuid>",
          "identifier_type": "SLADE",
          "identifier_value": "<string>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "valid_from": "<dateTime>",
          "valid_to": "<dateTime>"
        }
      ],
      "organisation": "<uuid>",
      "partner_name": "<string>",
      "payables_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "receivables_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "supplier_amount_owed": "<string>",
      "supplier_credit_utilized": "<string>",
      "supplier_deposits_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "slade_code": "<integer>",
      "description": "<string>",
      "physical_address": "<string>",
      "town": "<string>",
      "box_number": "<string>",
      "credit_limit": "<double>",
      "is_supplier": "<boolean>",
      "is_customer": "<boolean>",
      "supplier_type": "TRANSPORT",
      "customer_type": "STATIONERY",
      "bp_type": "<string>",
      "phone_number": "<string>",
      "email_address": "<email>",
      "customer_tax_pin": "<string>",
      "parent": "<uuid>"
    },
    {
      "billing_accounts": [
        {
          "id": "<uuid>",
          "name": "<string>",
          "description": "<string>",
          "is_active": "<boolean>",
          "_identifiers": "<string>",
          "number": "<string>",
          "tag": "<string>"
        },
        {
          "id": "<uuid>",
          "name": "<string>",
          "description": "<string>",
          "is_active": "<boolean>",
          "_identifiers": "<string>",
          "number": "<string>",
          "tag": "<string>"
        }
      ],
      "business_partner_attachments": [
        {
          "business_partner": "<uuid>",
          "content_type": "application/vnd.ms-excel",
          "data": "<uri>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "size": "<integer>",
          "title": "<string>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "creation_date": "<dateTime>",
          "description": "<string>",
          "aspect_ratio": "<string>",
          "attachment_type": "PASSPORT"
        },
        {
          "business_partner": "<uuid>",
          "content_type": "application/pdf",
          "data": "<uri>",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "size": "<integer>",
          "title": "<string>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "creation_date": "<dateTime>",
          "description": "<string>",
          "aspect_ratio": "<string>",
          "attachment_type": "FACIAL_PHOTO"
        }
      ],
      "business_partner_contact": [
        {
          "business_partner": "<uuid>",
          "contact": "<string>",
          "contact_type": "email",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>"
        },
        {
          "business_partner": "<uuid>",
          "contact": "<string>",
          "contact_type": "phone_number",
          "id": "<uuid>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "verified": "<boolean>",
          "consent_to_contact_given": "<boolean>",
          "is_primary_contact": "<boolean>"
        }
      ],
      "business_partner_id": {
        "business_partner": "<uuid>",
        "id": "<uuid>",
        "id_document_type": "payerID",
        "id_value": "<string>",
        "organisation": "<uuid>",
        "active": "<boolean>",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>"
      },
      "business_partner_person": {
        "business_partner": "<uuid>",
        "first_name": "<string>",
        "id": "<uuid>",
        "last_name": "<string>",
        "organisation": "<uuid>",
        "active": "<boolean>",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "other_names": "<string>",
        "title_option": "<string>",
        "date_of_birth": "<date>",
        "title": "<string>",
        "metadata": "<string>"
      },
      "business_partner_photo": {
        "business_partner": "<uuid>",
        "content_type": "application/vnd.ms-excel",
        "data": "<uri>",
        "id": "<uuid>",
        "organisation": "<uuid>",
        "size": "<integer>",
        "title": "<string>",
        "active": "<boolean>",
        "created": "<dateTime>",
        "created_by": "<uuid>",
        "updated": "<dateTime>",
        "updated_by": "<uuid>",
        "creation_date": "<dateTime>",
        "description": "<string>",
        "aspect_ratio": "<string>"
      },
      "code": "<integer>",
      "country": "TWN",
      "currency": "<uuid>",
      "customer_amount_owed": "<string>",
      "customer_credit_utilized": "<string>",
      "customer_deposits_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "customer_sync_to_etims": "<string>",
      "id": "<uuid>",
      "identifiers": [
        {
          "business_partner": "<uuid>",
          "id": "<uuid>",
          "identifier_type": "MFL",
          "identifier_value": "<string>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "valid_from": "<dateTime>",
          "valid_to": "<dateTime>"
        },
        {
          "business_partner": "<uuid>",
          "id": "<uuid>",
          "identifier_type": "SLADE",
          "identifier_value": "<string>",
          "organisation": "<uuid>",
          "active": "<boolean>",
          "created": "<dateTime>",
          "created_by": "<uuid>",
          "updated": "<dateTime>",
          "updated_by": "<uuid>",
          "valid_from": "<dateTime>",
          "valid_to": "<dateTime>"
        }
      ],
      "organisation": "<uuid>",
      "partner_name": "<string>",
      "payables_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "receivables_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "supplier_amount_owed": "<string>",
      "supplier_credit_utilized": "<string>",
      "supplier_deposits_account": {
        "id": "<uuid>",
        "name": "<string>",
        "description": "<string>",
        "is_active": "<boolean>",
        "_identifiers": "<string>",
        "number": "<string>",
        "tag": "<string>"
      },
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "slade_code": "<integer>",
      "description": "<string>",
      "physical_address": "<string>",
      "town": "<string>",
      "box_number": "<string>",
      "credit_limit": "<double>",
      "is_supplier": "<boolean>",
      "is_customer": "<boolean>",
      "supplier_type": "PATIENT",
      "customer_type": "PROVIDER",
      "bp_type": "<string>",
      "phone_number": "<string>",
      "email_address": "<email>",
      "customer_tax_pin": "<string>",
      "parent": "<uuid>"
    }
  ]
}

json

application/json

Create customer

POST

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

/api/business_partners/customers

Create a new business partner.

Create customer › Request Body

is_customer

boolean

phone_number

string · utc-millisec

slade_code

string · color

partner_name

string

customer_type

string

customer_tax_pin

string

country

string

currency

string

email_address

string · email

Create customer › Responses

Untitled Response

object[]

object

code

string

country

string

currency

string

customer_amount_owed

string

customer_credit_utilized

string

object

customer_sync_to_etims

string

id

string

object[]

organisation

string

partner_name

string

object

supplier_amount_owed

string

supplier_credit_utilized

string

object

active

string

created

string

created_by

string

updated

string

updated_by

string

slade_code

string

description

string

physical_address

string

town

string

box_number

string

credit_limit

string

is_supplier

string

is_customer

string

supplier_type

string

customer_type

string

bp_type

string

phone_number

string

email_address

string

customer_tax_pin

string

parent

string

POST/api/business_partners/customers

curl https://accounts.multitenant.slade360.co.ke/api/business_partners/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "is_customer": true,
  "phone_number": "+254712345678",
  "slade_code": "234567",
  "partner_name": "Test customer",
  "customer_type": "EMPLOYER",
  "customer_tax_pin": "A1234567EG1",
  "country": "KEN",
  "currency": "f6e049a0-10fd-4d9f-8470-571c9efa546c",
  "email_address": "test@gmail.com"
}'

Example Request Body

{
  "is_customer": true,
  "phone_number": "+254712345678",
  "slade_code": "234567",
  "partner_name": "Test customer",
  "customer_type": "EMPLOYER",
  "customer_tax_pin": "A1234567EG1",
  "country": "KEN",
  "currency": "f6e049a0-10fd-4d9f-8470-571c9efa546c",
  "email_address": "test@gmail.com"
}

json

application/json

Example Responses

{
  "billing_accounts": [
    {
      "id": "<uuid>",
      "name": "<string>",
      "description": "<string>",
      "is_active": "<boolean>",
      "_identifiers": "<string>",
      "number": "<string>",
      "tag": "<string>"
    },
    {
      "id": "<uuid>",
      "name": "<string>",
      "description": "<string>",
      "is_active": "<boolean>",
      "_identifiers": "<string>",
      "number": "<string>",
      "tag": "<string>"
    }
  ],
  "business_partner_attachments": [
    {
      "business_partner": "<uuid>",
      "content_type": "application/vnd.ms-excel",
      "data": "<uri>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "size": "<integer>",
      "title": "<string>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "creation_date": "<dateTime>",
      "description": "<string>",
      "aspect_ratio": "<string>",
      "attachment_type": "PASSPORT"
    },
    {
      "business_partner": "<uuid>",
      "content_type": "image/jpeg",
      "data": "<uri>",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "size": "<integer>",
      "title": "<string>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "creation_date": "<dateTime>",
      "description": "<string>",
      "aspect_ratio": "<string>",
      "attachment_type": "PASSPORT"
    }
  ],
  "business_partner_contact": [
    {
      "business_partner": "<uuid>",
      "contact": "<string>",
      "contact_type": "phone_number",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "verified": "<boolean>",
      "consent_to_contact_given": "<boolean>",
      "is_primary_contact": "<boolean>"
    },
    {
      "business_partner": "<uuid>",
      "contact": "<string>",
      "contact_type": "email",
      "id": "<uuid>",
      "organisation": "<uuid>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "verified": "<boolean>",
      "consent_to_contact_given": "<boolean>",
      "is_primary_contact": "<boolean>"
    }
  ],
  "business_partner_id": {
    "business_partner": "<uuid>",
    "id": "<uuid>",
    "id_document_type": "nationalID",
    "id_value": "<string>",
    "organisation": "<uuid>",
    "active": "<boolean>",
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "updated": "<dateTime>",
    "updated_by": "<uuid>"
  },
  "business_partner_person": {
    "business_partner": "<uuid>",
    "first_name": "<string>",
    "id": "<uuid>",
    "last_name": "<string>",
    "organisation": "<uuid>",
    "active": "<boolean>",
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "updated": "<dateTime>",
    "updated_by": "<uuid>",
    "other_names": "<string>",
    "title_option": "<string>",
    "date_of_birth": "<date>",
    "title": "<string>",
    "metadata": "<string>"
  },
  "business_partner_photo": {
    "business_partner": "<uuid>",
    "content_type": "application/vnd.ms-excel",
    "data": "<uri>",
    "id": "<uuid>",
    "organisation": "<uuid>",
    "size": "<integer>",
    "title": "<string>",
    "active": "<boolean>",
    "created": "<dateTime>",
    "created_by": "<uuid>",
    "updated": "<dateTime>",
    "updated_by": "<uuid>",
    "creation_date": "<dateTime>",
    "description": "<string>",
    "aspect_ratio": "<string>"
  },
  "code": "<integer>",
  "country": "ROU",
  "currency": "<uuid>",
  "customer_amount_owed": "<string>",
  "customer_credit_utilized": "<string>",
  "customer_deposits_account": {
    "id": "<uuid>",
    "name": "<string>",
    "description": "<string>",
    "is_active": "<boolean>",
    "_identifiers": "<string>",
    "number": "<string>",
    "tag": "<string>"
  },
  "customer_sync_to_etims": "<string>",
  "id": "<uuid>",
  "identifiers": [
    {
      "business_partner": "<uuid>",
      "id": "<uuid>",
      "identifier_type": "KNHTS",
      "identifier_value": "<string>",
      "organisation": "<uuid>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "valid_from": "<dateTime>",
      "valid_to": "<dateTime>"
    },
    {
      "business_partner": "<uuid>",
      "id": "<uuid>",
      "identifier_type": "SLADE",
      "identifier_value": "<string>",
      "organisation": "<uuid>",
      "active": "<boolean>",
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "valid_from": "<dateTime>",
      "valid_to": "<dateTime>"
    }
  ],
  "organisation": "<uuid>",
  "partner_name": "<string>",
  "payables_account": {
    "id": "<uuid>",
    "name": "<string>",
    "description": "<string>",
    "is_active": "<boolean>",
    "_identifiers": "<string>",
    "number": "<string>",
    "tag": "<string>"
  },
  "receivables_account": {
    "id": "<uuid>",
    "name": "<string>",
    "description": "<string>",
    "is_active": "<boolean>",
    "_identifiers": "<string>",
    "number": "<string>",
    "tag": "<string>"
  },
  "supplier_amount_owed": "<string>",
  "supplier_credit_utilized": "<string>",
  "supplier_deposits_account": {
    "id": "<uuid>",
    "name": "<string>",
    "description": "<string>",
    "is_active": "<boolean>",
    "_identifiers": "<string>",
    "number": "<string>",
    "tag": "<string>"
  },
  "active": "<boolean>",
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "slade_code": "<integer>",
  "description": "<string>",
  "physical_address": "<string>",
  "town": "<string>",
  "box_number": "<string>",
  "credit_limit": "<double>",
  "is_supplier": "<boolean>",
  "is_customer": "<boolean>",
  "supplier_type": "PATIENT",
  "customer_type": "PATIENT",
  "bp_type": "<string>",
  "phone_number": "<string>",
  "email_address": "<email>",
  "customer_tax_pin": "<string>",
  "parent": "<uuid>"
}

json

application/json

Message Groups Products and Pricelists