Create Broker

POST

https://app.hisabkitab.co/third-party/broker-masters

This endpoint allows users to add a new broker to the system by making an HTTP POST request. The broker's details, including personal information, taxation identifiers, brokerage commission structure, address, and contact details, must be provided in the request body.

Request

The broker's details, including personal information, taxation identifiers, brokerage commission structure, address, and contact details, must be provided in the request body.

Response

Upon successful creation, the API will return a confirmation message along with the unique identifier of the newly added broker.

Request

Authorization

Add parameter in header

ApiKey

Example:

ApiKey: ********************

Body Params application/json

broker_name

string

required

Represents the name of the broker, which is a required field.

gstin

string

optional

Stores the GST Identification Number of the broker, which can be null if not applicable.

pan

string

optional

Holds the Permanent Account Number (PAN) of the broker, used for tax purposes, and can be null if not provided.

entity_type

integer

optional

Specifies the unique identifier for the broker's legal classification, which can be retrieved from the Form Detail API response.

brokerage_for_sale

integer

optional

Specifies the brokerage commission percentage the broker earns on sales transactions.

brokerage_for_sale_type

integer

optional

Indicates whether the brokerage for sales is calculated based on the Invoice Value (1) or Taxable Value (2).

brokerage_for_purchase

integer

optional

Represents the percentage of brokerage charged by the broker on purchase transactions.

brokerage_for_purchase_type

integer

optional

Determines whether the brokerage for purchases is calculated on the Invoice Value (1) or Taxable Value (2).

address_1

string | null

optional

stores the first line of the broker’s address, which can include the building number, street name, or locality.

address_2

string | null

optional

Holds additional address details, such as apartment numbers or landmarks, and can be null if not applicable.

country_id

integer

optional

Numeric identifier representing the broker's country.

state_id

integer

optional

Stores the numeric identifier for the state where the broker is located.

city_id

integer

optional

Represents the numeric identifier for the city associated with the broker’s address.

pin_code

integer | null

optional

Stores the postal code of the broker’s location for accurate geographical mapping.

contact_detail_name

string

optional

Specifies the name of the contact person associated with the broker.

region_iso

string

optional

Defines the ISO country code (e.g., "IN" for India), ensuring international compatibility.

region_code

string

optional

Stores the country’s dialing code (e.g., "91" for India) for phone number standardization.

phone

integer

optional

Holds the broker’s contact number, which is essential for communication.

string

optional

Stores the broker’s email address.

Example

{
    "broker_name": "Joan22",
    "gstin": null,
    "pan": null,
    "entity_type": null,
    "brokerage_for_sale": 10, // in %
    "brokerage_for_sale_type": 1, //invoive value=1, taxable value=2
    "brokerage_for_purchase": 5,
    "brokerage_for_purchase_type": 1, //invoive value=1, taxable value=2
    // address
    "address_1": null,
    "address_2": null,
    "country_id": 1,
    "state_id": 1,
    "city_id": 1,
    "pin_code": 1,
    //contact details
    "contact_detail_name": "test",
    "region_iso": "in",
    "region_code": "91",
    "phone": 9541021036,
    "email": null
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.hisabkitab.co/third-party/broker-masters' \
--header 'Content-Type: application/json' \
--header 'ApiKey;' \
--data-raw '{
    "broker_name": "Joan22",
    "gstin": null,
    "pan": null,
    "entity_type": null,
    "brokerage_for_sale": 10, // in %
    "brokerage_for_sale_type": 1, //invoive value=1, taxable value=2
    "brokerage_for_purchase": 5,
    "brokerage_for_purchase_type": 1, //invoive value=1, taxable value=2
    // address
    "address_1": null,
    "address_2": null,
    "country_id": 1,
    "state_id": 1,
    "city_id": 1,
    "pin_code": 1,
    //contact details
    "contact_detail_name": "test",
    "region_iso": "in",
    "region_code": "91",
    "phone": 9541021036,
    "email": null
}'

Responses

🟢200Create Broker

application/json

Body

data

object

required

integer

required

Unique identifier for the broker.

broker_name

string

required

Represents the name of the broker, which is a required field.

gstin

string

required

Stores the GST Identification Number of the broker, which can be null if not applicable.

pan

string

required

Holds the Permanent Account Number (PAN) of the broker, used for tax purposes, and can be null if not provided.

company_id

integer

required

The unique identifier of the company to which the broker belongs.

entity_type

integer

required

Specifies the unique identifier for the broker's legal classification, which can be retrieved from the Form Detail API response.

contact_detail_name

string

required

Specifies the name of the contact person associated with the broker.

string

required

Stores the broker’s email address.

region_iso

string

required

Defines the ISO country code (e.g., "IN" for India), ensuring international compatibility.

region_code

string

required

Stores the country’s dialing code (e.g., "91" for India) for phone number standardization.

phone

integer

required

Holds the broker’s contact number, which is essential for communication.

brokerage_for_sale

integer

required

Specifies the brokerage commission percentage the broker earns on sales transactions.

brokerage_for_purchase

integer

required

Represents the percentage of brokerage charged by the broker on purchase transactions.

brokerage_for_sale_type

integer

required

Indicates whether the brokerage for sales is calculated based on the Invoice Value (1) or Taxable Value (2).

brokerage_for_purchase_type

integer

required

Determines whether the brokerage for purchases is calculated on the Invoice Value (1) or Taxable Value (2).

via_api

boolean

required

updated_at

string

required

The date and time indicating when the record was last modified or updated in the system.

created_at

string

required

The date and time indicating when the record was initially created in the system.

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 3,
        "broker_name": "Joan",
        "gstin": null,
        "pan": null,
        "company_id": 6,
        "entity_type": null,
        "contact_detail_name": "test",
        "email": null,
        "region_iso": "in",
        "region_code": "91",
        "phone": 9541021036,
        "brokerage_for_sale": 10,
        "brokerage_for_purchase": 5,
        "brokerage_for_sale_type": 1,
        "brokerage_for_purchase_type": 1,
        "via_api": true,
        "created_at": "2025-02-19T12:51:43.000000Z",
        "updated_at": "2025-02-19T12:51:43.000000Z"
    },
    "success": true,
    "message": "Broker Master Created Successfully."
}

Modified at 2025-04-03 09:49:17

List of Brokers

Edit Broker

Create Broker

Request#

Response#

Request

Request samples

Responses

Request

Response