The Company object
Attributes
id string
Unique identifier for the object.
created_at string
ISO 8601 timestamp of when the object was created.
updated_at string
ISO 8601 timestamp of when the object was last updated.
parent_id string
is_group boolean
Default: false
company_name string required
abbr string required
default_finance_book string
domain string
parent_company string
company_logo string
company_description string
sales_monthly_history string
transactions_annual_history string
monthly_sales_target number
total_monthly_sales number
default_currency string required
default_letter_head string
default_holiday_list string
default_warehouse_for_sales_return string
country string required
create_chart_of_accounts_based_on string
chart_of_accounts string
existing_company string
tax_id string
date_of_establishment string
default_bank_account string
default_cash_account string
default_receivable_account string
round_off_account string
round_off_cost_center string
write_off_account string
exchange_gain_loss_account string
unrealized_exchange_gain_loss_account string
allow_account_creation_against_child_company boolean
Default: false
default_payable_account string
default_expense_account string
default_income_account string
default_deferred_revenue_account string
default_deferred_expense_account string
cost_center string
credit_limit number
payment_terms string
enable_perpetual_inventory boolean
Default: true
default_inventory_account string
stock_adjustment_account string
stock_received_but_not_billed string
accumulated_depreciation_account string
depreciation_expense_account string
series_for_depreciation_entry string
disposal_account string
depreciation_cost_center string
capital_work_in_progress_account string
asset_received_but_not_billed string
exception_budget_approver_role string
date_of_incorporation string
date_of_commencement string
phone_no string
fax string
email string
website string
registration_details string
default_selling_terms string
default_buying_terms string
default_in_transit_warehouse string
unrealized_profit_loss_account string
default_discount_account string
enable_provisional_accounting_for_non_stock_items boolean
Default: false
default_provisional_account string
default_advance_received_account string
default_advance_paid_account string
book_advance_payments_in_separate_party_account boolean
Default: false
auto_exchange_rate_revaluation boolean
Default: false
auto_err_frequency string
submit_err_jv boolean
Default: false
reconcile_on_advance_payment_date boolean
Default: false
default_operating_cost_account string
round_off_for_opening string
reconciliation_takes_effect_on string
Default: Oldest Of Invoice Or Advance
reporting_currency string
purchase_expense_account string
purchase_expense_contra_account string
service_expense_account string
enable_item_wise_inventory_account boolean
Default: false
valuation_method string
Default: FIFO
default_wip_warehouse string
default_fg_warehouse string
default_scrap_warehouse string
default_sales_contact string
accounts_frozen_till_date string
role_allowed_for_frozen_entries string
The Company object
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
} GET
/api/setup/company/{id} Retrieve a company
Retrieves the details of an existing company. Supply the unique company ID that was returned from a previous request.
Path parameters
id string required
The identifier of the company to retrieve.
Returns
Returns the company object if a valid identifier was provided.
GET /api/setup/company/{id}
curl https://api.overplane.dev/api/setup/company/company_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
} GET
/api/setup/company List all companys
Returns a list of companys. The results are sorted by creation date, with the most recently created appearing first.
Query parameters
limit integer
Maximum number of objects to return. Default: 20.
offset integer
Number of objects to skip for pagination. Default: 0.
Returns
A paginated list of company objects.
GET /api/setup/company
curl https://api.overplane.dev/api/setup/company \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
}
],
"has_more": false,
"total": 1
} POST
/api/setup/company Create a company
Creates a new company object.
Body parameters
parent_id string
is_group boolean
Default: false
company_name string required
abbr string required
default_finance_book string
domain string
parent_company string
company_logo string
company_description string
sales_monthly_history string
transactions_annual_history string
monthly_sales_target number
total_monthly_sales number
default_currency string required
default_letter_head string
default_holiday_list string
default_warehouse_for_sales_return string
country string required
create_chart_of_accounts_based_on string
chart_of_accounts string
existing_company string
tax_id string
date_of_establishment string
default_bank_account string
default_cash_account string
default_receivable_account string
round_off_account string
round_off_cost_center string
write_off_account string
exchange_gain_loss_account string
unrealized_exchange_gain_loss_account string
allow_account_creation_against_child_company boolean
Default: false
default_payable_account string
default_expense_account string
default_income_account string
default_deferred_revenue_account string
default_deferred_expense_account string
cost_center string
credit_limit number
payment_terms string
enable_perpetual_inventory boolean
Default: true
default_inventory_account string
stock_adjustment_account string
stock_received_but_not_billed string
accumulated_depreciation_account string
depreciation_expense_account string
series_for_depreciation_entry string
disposal_account string
depreciation_cost_center string
capital_work_in_progress_account string
asset_received_but_not_billed string
exception_budget_approver_role string
date_of_incorporation string
date_of_commencement string
phone_no string
fax string
email string
website string
registration_details string
default_selling_terms string
default_buying_terms string
default_in_transit_warehouse string
unrealized_profit_loss_account string
default_discount_account string
enable_provisional_accounting_for_non_stock_items boolean
Default: false
default_provisional_account string
default_advance_received_account string
default_advance_paid_account string
book_advance_payments_in_separate_party_account boolean
Default: false
auto_exchange_rate_revaluation boolean
Default: false
auto_err_frequency string
submit_err_jv boolean
Default: false
reconcile_on_advance_payment_date boolean
Default: false
default_operating_cost_account string
round_off_for_opening string
reconciliation_takes_effect_on string
Default: Oldest Of Invoice Or Advance
reporting_currency string
purchase_expense_account string
purchase_expense_contra_account string
service_expense_account string
enable_item_wise_inventory_account boolean
Default: false
valuation_method string
Default: FIFO
default_wip_warehouse string
default_fg_warehouse string
default_scrap_warehouse string
default_sales_contact string
accounts_frozen_till_date string
role_allowed_for_frozen_entries string
Returns
Returns the newly created company object if the call succeeded.
POST /api/setup/company
curl https://api.overplane.dev/api/setup/company \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"company_name":"Example Corp","abbr":"abbr_example","default_currency":"USD","country":"country_example"}' Response
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
} PATCH
/api/setup/company/{id} Update a company
Updates the specified company by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Path parameters
id string required
The identifier of the company to update.
Body parameters
parent_id string
is_group boolean
Default: false
company_name string
abbr string
default_finance_book string
domain string
parent_company string
company_logo string
company_description string
sales_monthly_history string
transactions_annual_history string
monthly_sales_target number
total_monthly_sales number
default_currency string
default_letter_head string
default_holiday_list string
default_warehouse_for_sales_return string
country string
create_chart_of_accounts_based_on string
chart_of_accounts string
existing_company string
tax_id string
date_of_establishment string
default_bank_account string
default_cash_account string
default_receivable_account string
round_off_account string
round_off_cost_center string
write_off_account string
exchange_gain_loss_account string
unrealized_exchange_gain_loss_account string
allow_account_creation_against_child_company boolean
Default: false
default_payable_account string
default_expense_account string
default_income_account string
default_deferred_revenue_account string
default_deferred_expense_account string
cost_center string
credit_limit number
payment_terms string
enable_perpetual_inventory boolean
Default: true
default_inventory_account string
stock_adjustment_account string
stock_received_but_not_billed string
accumulated_depreciation_account string
depreciation_expense_account string
series_for_depreciation_entry string
disposal_account string
depreciation_cost_center string
capital_work_in_progress_account string
asset_received_but_not_billed string
exception_budget_approver_role string
date_of_incorporation string
date_of_commencement string
phone_no string
fax string
email string
website string
registration_details string
default_selling_terms string
default_buying_terms string
default_in_transit_warehouse string
unrealized_profit_loss_account string
default_discount_account string
enable_provisional_accounting_for_non_stock_items boolean
Default: false
default_provisional_account string
default_advance_received_account string
default_advance_paid_account string
book_advance_payments_in_separate_party_account boolean
Default: false
auto_exchange_rate_revaluation boolean
Default: false
auto_err_frequency string
submit_err_jv boolean
Default: false
reconcile_on_advance_payment_date boolean
Default: false
default_operating_cost_account string
round_off_for_opening string
reconciliation_takes_effect_on string
Default: Oldest Of Invoice Or Advance
reporting_currency string
purchase_expense_account string
purchase_expense_contra_account string
service_expense_account string
enable_item_wise_inventory_account boolean
Default: false
valuation_method string
Default: FIFO
default_wip_warehouse string
default_fg_warehouse string
default_scrap_warehouse string
default_sales_contact string
accounts_frozen_till_date string
role_allowed_for_frozen_entries string
Returns
Returns the updated company object.
PATCH /api/setup/company/{id}
curl https://api.overplane.dev/api/setup/company/company_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"parent_id":null,"is_group":false}' Response
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
} DELETE
/api/setup/company/{id} Delete a company
Permanently deletes a company. This cannot be undone.
Path parameters
id string required
The identifier of the company to delete.
Returns
Returns a confirmation that the company has been deleted.
DELETE /api/setup/company/{id}
curl https://api.overplane.dev/api/setup/company/company_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "company_abc123",
"deleted": true
} GET
/api/setup/company/{id}/children Get children
Returns the direct children of the specified node in the tree.
Path parameters
id string required
The identifier of the company to act on.
Returns
A list of direct child objects.
GET /api/setup/company/{id}/children
curl https://api.overplane.dev/api/setup/company/company_abc123/children \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
} GET
/api/setup/company/{id}/ancestors Get ancestors
Returns all ancestors from the immediate parent up to the root of the tree.
Path parameters
id string required
The identifier of the company to act on.
Returns
A list of ancestor objects from parent to root.
GET /api/setup/company/{id}/ancestors
curl https://api.overplane.dev/api/setup/company/company_abc123/ancestors \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
} GET
/api/setup/company/{id}/descendants Get descendants
Returns all descendants of the specified node in the tree.
Path parameters
id string required
The identifier of the company to act on.
Returns
A list of all descendant objects.
GET /api/setup/company/{id}/descendants
curl https://api.overplane.dev/api/setup/company/company_abc123/descendants \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "company_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"parent_id": null,
"is_group": false,
"company_name": "Example Corp",
"abbr": "abbr_example",
"default_finance_book": "default_finance_book_example",
"domain": "domain_example",
"parent_company": "Example Corp",
"company_logo": "Example Corp",
"company_description": "Example Corp",
"sales_monthly_history": "sales_monthly_history_example",
"transactions_annual_history": "transactions_annual_history_example",
"monthly_sales_target": 0,
"total_monthly_sales": 0,
"default_currency": "USD",
"default_letter_head": "default_letter_head_example",
"default_holiday_list": "default_holiday_list_example",
"default_warehouse_for_sales_return": "default_warehouse_for_sales_return_example",
"country": "country_example",
"create_chart_of_accounts_based_on": "create_chart_of_accounts_based_on_example",
"chart_of_accounts": "chart_of_accounts_example",
"existing_company": "Example Corp",
"tax_id": "tax_id_example",
"date_of_establishment": "2024-01-15",
"default_bank_account": "default_bank_account_example",
"default_cash_account": "default_cash_account_example",
"default_receivable_account": "default_receivable_account_example",
"round_off_account": "round_off_account_example",
"round_off_cost_center": "round_off_cost_center_example",
"write_off_account": "write_off_account_example",
"exchange_gain_loss_account": "exchange_gain_loss_account_example",
"unrealized_exchange_gain_loss_account": "unrealized_exchange_gain_loss_account_example",
"allow_account_creation_against_child_company": false,
"default_payable_account": "default_payable_account_example",
"default_expense_account": "default_expense_account_example",
"default_income_account": "default_income_account_example",
"default_deferred_revenue_account": "default_deferred_revenue_account_example",
"default_deferred_expense_account": "default_deferred_expense_account_example",
"cost_center": "cost_center_example",
"credit_limit": 0,
"payment_terms": "payment_terms_example",
"enable_perpetual_inventory": true,
"default_inventory_account": "default_inventory_account_example",
"stock_adjustment_account": "stock_adjustment_account_example",
"stock_received_but_not_billed": "stock_received_but_not_billed_example",
"accumulated_depreciation_account": "accumulated_depreciation_account_example",
"depreciation_expense_account": "depreciation_expense_account_example",
"series_for_depreciation_entry": "series_for_depreciation_entry_example",
"disposal_account": "disposal_account_example",
"depreciation_cost_center": "depreciation_cost_center_example",
"capital_work_in_progress_account": "capital_work_in_progress_account_example",
"asset_received_but_not_billed": "asset_received_but_not_billed_example",
"exception_budget_approver_role": "exception_budget_approver_role_example",
"date_of_incorporation": "2024-01-15",
"date_of_commencement": "2024-01-15",
"phone_no": "phone_no_example",
"fax": "fax_example",
"email": "[email protected]",
"website": "website_example",
"registration_details": "registration_details_example",
"default_selling_terms": "default_selling_terms_example",
"default_buying_terms": "default_buying_terms_example",
"default_in_transit_warehouse": "default_in_transit_warehouse_example",
"unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
"default_discount_account": "default_discount_account_example",
"enable_provisional_accounting_for_non_stock_items": false,
"default_provisional_account": "default_provisional_account_example",
"default_advance_received_account": "default_advance_received_account_example",
"default_advance_paid_account": "default_advance_paid_account_example",
"book_advance_payments_in_separate_party_account": false,
"auto_exchange_rate_revaluation": false,
"auto_err_frequency": "auto_err_frequency_example",
"submit_err_jv": false,
"reconcile_on_advance_payment_date": false,
"default_operating_cost_account": "default_operating_cost_account_example",
"round_off_for_opening": "round_off_for_opening_example",
"reconciliation_takes_effect_on": "Oldest Of Invoice Or Advance",
"reporting_currency": "USD",
"purchase_expense_account": "purchase_expense_account_example",
"purchase_expense_contra_account": "purchase_expense_contra_account_example",
"service_expense_account": "service_expense_account_example",
"enable_item_wise_inventory_account": false,
"valuation_method": "FIFO",
"default_wip_warehouse": "default_wip_warehouse_example",
"default_fg_warehouse": "default_fg_warehouse_example",
"default_scrap_warehouse": "default_scrap_warehouse_example",
"default_sales_contact": "default_sales_contact_example",
"accounts_frozen_till_date": "2024-01-15",
"role_allowed_for_frozen_entries": "role_allowed_for_frozen_entries_example"
}