This API allows you to retrieve an entity's holding ratio and profit-loss sharing ratio. The query parameters are optional, and if not provided, the system will return default or available values based on the data.
This API helps retrieve the holding and profit-loss sharing ratios for an entity, ensuring asset and financial distribution is clear and accurate. If no query parameters are provided, default values will be returned.
Request
Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Query Params
id
integerÂ
optional
This is the ledger ID that will be excluded from the calculation of holding and profit-loss ratio.
Example:
1
holding_ratio
integerÂ
optional
This represents the percentage of ownership or share in the total assets.
Example:
80
profit_loss_sharing_ratio
integerÂ
optional
This defines the percentage at which profit or loss will be shared between the stakeholders. It determines how the financial outcomes (profits or losses) are distributed among the parties involved.
Example:
30
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/holding-profit-ratio?id=1&holding_ratio=80&profit_loss_sharing_ratio=30' \
--header'ApiKey;'
Responses
🟢200Holding & Profit Ratio
application/json
Body
data
objectÂ
required
for_holding
objectÂ
required
for_profit_loss
objectÂ
required
success
booleanÂ
required
message
stringÂ
required
Example
{"data":{"for_holding":{"holding_ratio":70,"available_ratio":30,"model":false},"for_profit_loss":{"profit_loss_sharing_ratio":70,"available_ratio":30,"model":false}},"success":true,"message":"Retrieve the available holding ratio and profit and loss ratio."}