HisabKitab
  1. Broker Master
HisabKitab
  • Third Party APIs
    • How to Generate ApiKey ?
    • Account Master
      • Ledger Groups
        • List of All Groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Ledgers
        • Create Ledger
          • Customer Ledger
          • Supplier Ledger
          • Bank Ledger
          • Capital Ledger
          • Cash Ledger
          • Income Ledger
          • Expense Ledger
          • Fixed Asset Ledger
          • Investment Ledger
          • Loan and Advance (Asset) Ledger
          • Misc Assets Ledger
          • Other Current Assets Ledger
          • Taxes - GST Ledger
          • Taxes - TDS Ledger
          • Taxes - TCS Ledger
          • Provisions Ledger
          • Reserve and Surplus Ledger
          • Secured Loan Ledger
          • Unsecured Loan Ledger
          • Stock In Hand Ledger
          • Other Current Liabilities Ledger
          • TDS Receivable Ledger
          • TCS Receivable Ledger
        • Ledger Detail
        • List of all Ledgers
        • Edit Ledger
        • Update Ledger
        • Delete Ledger
        • Delete Ledger Media
        • Add Location(Fixed Asset )
        • Check Unique GST Number
        • Check Unique GST Number with Ledger
        • Holding & Profit Ratio
        • Ledger TDS tax Data
        • Ledger TCS tax Data
    • Item Master
      • Item Groups
        • List of all groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Items
        • Item Form Details
        • List of items
        • Create Good Item
        • Create Service Item
        • Edit Item
        • Update Item
        • Delete Item
      • Unit of Measurement
        • List of Unit of Measurement
        • Create Unit of Measurement
        • Edit Unit of Measurement
        • Update Unit of Measurement
        • Delete Unit of Measurement
    • Broker Master
      • List of Brokers
        GET
      • Create Broker
        POST
      • Edit Broker
        GET
      • Update Broker
        POST
      • Delete Broker
        DELETE
    • Transport Master
      • List of Transport
      • Create Transport
      • Edit Transport
      • Update Transport
      • Delete Transport
    • Cess Rate
      • List of Cess Rate
      • Create Cess Rate
      • Edit Cess Rate
      • Update Cess Rate
      • Delete Cess Rate
    • Dispatch Address
      • List of Dispatch Address
      • Create Dispatch Address
      • Edit Dispatch Address
      • Update Dispatch Address
      • Delete Dispatch Address
    • Shipping Address
      • List of Shipping Addresses
      • Create Shipping Address
      • Edit Shipping Address
      • Update Shipping Address
      • Delete Shipping Address
    • Comman APIs
      • Company Details
      • Countries
      • States
      • Cities
      • Gst Rates
      • Classification-nature-type
    • Configuration
      • Sale
        • Sale Configuration
        • Update Configuration
        • Update Configuration with Type
      • Sale Return
        • Sale Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Debit Note
        • Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Credit Note
        • Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Estimate Quote
        • Estimate Configuration
        • Update Configuration with Type
        • Update Configuration
      • Delivery Challan
        • Delivery Challan Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase
        • Purchase Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Return
        • Purchase Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Credit Note
        • Expense Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Debit Note
        • Expense Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Order
        • Purchase Order Configuration
        • Update Configuration
        • Update Configuration with Type
    • Sale Transactions
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale
      • Create Accounting Sale
      • Edit Sale
      • Update Sale
      • Duplicate Sale
      • Delete Sale
      • Get Sale For Sale Return
      • Create Challan From Sale Invoice
    • Sale Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale Return
      • Create Accounting Sale Return
      • Edit Sale Return
      • Update Sale Return
      • Duplicate Sale Return
      • Delete Sale Return
    • Income Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Debit Note
      • Create Accounting Debit Note
      • Edit Debit Note
      • Update Debit Note
      • Duplicate Debit Note
      • Delete Debit Note
    • Income Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Credit Note
      • Create Accounting Credit Note
      • Edit Credit Note
      • Update Credit Note
      • Duplicate Credit Note
      • Delete Credit Note
    • Estimate Quote Transaction
      • List of Transactions
      • Next Estimate Number
      • Create Item Estimate
      • Create Accounting Estimate
      • Edit Estimate
      • Update Estimate
      • Duplicate Estimate
      • Create Sale From Estimate
      • Delete Estimate
    • Delivery Challan Transaction
      • List of Transactions
      • Next Challan Number
      • Create Delivery Challan
      • Edit Delivery Challan
      • Update Delivery Challan
      • Duplicate Delivery Challan
      • Create Sale From Delivery Challan
      • Delete Delivery Challan
    • Purchase Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase
      • Create Accounting Purchase
      • Edit purchase
      • Update purchase
      • Duplicate purchase
      • Get purchase For purchase Return
      • Delete purchase
    • Purchase Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Return
      • Create Accounting Purchase Return
      • Edit purchase Return
      • Update purchase Return
      • Duplicate purchase Return
      • Delete purchase Return
    • Expense Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Credit Note
      • Create Accounting Expense Credit Note
      • Edit Expense Credit Note
      • Update Expense Credit Note
      • Duplicate Expense Credit Note
      • Delete Expense Credit Note
    • Expense Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Debit Note
      • Create Accounting Expense Debit Note
      • Edit Expense Debit Note
      • Update Expense Debit Note
      • Duplicate Expense Debit Note
      • Delete Expense Debit Note
    • Purchase Order Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Order
      • Create Accounting Purchase Order
      • Edit purchase Order
      • Update Purchase Order
      • Duplicate purchase Order
      • Delete purchase Order
      • Book Purchase Order
    • Receipt Transaction
      • List of Receipts
      • Next invoice number
      • Create Receipt
      • Edit Receipt
      • Update Receipt
      • Delete Receipt
    • Payment Transaction
      • List of Payments
      • Next invoice number
      • Create Payment
      • Edit Payment
      • Update Payment
      • Delete Payment
    • Journal Transaction
      • List of Journals
      • Next invoice number
      • Create Journal
      • Edit Journal
      • Update Journal
      • Delete Journal
  1. Broker Master

Edit Broker

GET
https://app.hisabkitab.co/third-party/broker-masters/{id}
This endpoint allows users to retrieve detailed information about a specific broker by making an HTTP GET request.

Request#

The request must include the broker id in the URL to fetch the details of the broker for editing. No request body is required for this step.

Response#

Upon successful retrieval, the response will contain the details of the broker, including the name, unique_code, etc.

Request

Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Path Params
id
integer 
required
It represents the id of the broker master to retrieve it.
Example:
1

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.hisabkitab.co/third-party/broker-masters/1' \
--header 'ApiKey;'

Responses

🟢200Edit Broker
application/json
Body
data
object 
required
id
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.
email
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_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
integer 
required
Represents the percentage of brokerage charged by the broker on purchase transactions.
brokerage_for_purchase_type
integer 
required
Determines whether the brokerage for purchases is calculated on the Invoice Value (1) or Taxable Value (2).
addresses
object 
required
via_api
boolean 
required
created_at
string 
required
The date and time indicating when the record was initially created in the system.
updated_at
string 
required
The date and time indicating when the record was last modified or updated in the system.
success
boolean 
required
message
string 
required
Example
{
    "data": {
        "id": 1,
        "broker_name": "Joan",
        "gstin": null,
        "pan": null,
        "contact_detail_name": "test",
        "email": null,
        "region_iso": "in",
        "region_code": "91",
        "phone": "9541021036",
        "company_id": 6,
        "entity_type": null,
        "brokerage_for_sale": 10,
        "brokerage_for_purchase": 5,
        "brokerage_for_sale_type": 1,
        "brokerage_for_purchase_type": 1,
        "addresses": {
            "id": 2,
            "address_1": null,
            "address_2": null,
            "country_id": 1,
            "state_id": 1,
            "city_id": 1,
            "pin_code": "1",
            "model_id": 3,
            "model_type": "App\\Models\\Master\\Broker",
            "address_type": null,
            "created_at": "2025-02-11T10:18:14.000000Z",
            "updated_at": "2025-02-11T10:18:14.000000Z"
        },
        "via_api": 1,
        "created_at": "2025-02-11T10:18:14.000000Z",
        "updated_at": "2025-02-11T10:18:14.000000Z"
    },
    "success": true,
    "message": "Broker Master Fetched Successfully."
}
Modified at 2025-04-03 09:49:24
Previous
Create Broker
Next
Update Broker
Built with