Company
The retailer's company (or each company of a group), which owns the stores, the books and the stock.
Area: Stock and stores · Why it is here: recipe lucky_draw; retail core · Fields: 83
iVendNext's own description: Legal Entity / Subsidiary with a separate Chart of Accounts belonging to the Organization.
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Company?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Company/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Company" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"company_name": …, "abbr": …, "default_currency": …, "country": …}'
Change one with PUT /api/resource/Company/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s4_receipt_pack · s24_price_checker · s30_units_as_serials · s44_lucky_draw · s45_restaurant_back_office
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company_name |
Data | yes | |||
| Abbr | abbr |
Data | yes | |||
| Default Currency | default_currency |
Link | yes | Currency | ||
| Country | country |
Link | yes | Country | ||
| Is Group | is_group |
Check | ||||
| Default Holiday List | default_holiday_list |
Link | Holiday List | |||
| Default Letter Head | default_letter_head |
Link | Letter Head | |||
| Tax ID | tax_id |
Data | ||||
| Domain | domain |
Data | ||||
| Date of Establishment | date_of_establishment |
Date | ||||
| Parent Company | parent_company |
Link | Company | |||
| Company Logo | company_logo |
Attach Image | yes | |||
| Date of Incorporation | date_of_incorporation |
Date | ||||
| Phone No | phone_no |
Data | ||||
email |
Data | |||||
| Company Description | company_description |
Text Editor | ||||
| Date of Commencement | date_of_commencement |
Date | ||||
| Fax | fax |
Data | ||||
| Website | website |
Data | ||||
| Registration Details | registration_details |
Code | ||||
| Lft | lft |
Int | yes | yes | ||
| Rgt | rgt |
Int | yes | yes | ||
| old_parent | old_parent |
Data | yes | yes | ||
| Create Chart Of Accounts Based On | create_chart_of_accounts_based_on |
Select | one of: Standard Template, Existing Company | |||
| Existing Company | existing_company |
Link | Company | |||
| Chart Of Accounts Template | chart_of_accounts |
Select | ||||
| Default Bank Account | default_bank_account |
Link | Account | |||
| Default Cash Account | default_cash_account |
Link | Account | |||
| Default Receivable Account | default_receivable_account |
Link | Account | |||
| Default Payable Account | default_payable_account |
Link | Account | |||
| Write Off Account | write_off_account |
Link | Account | |||
| Unrealized Profit / Loss Account | unrealized_profit_loss_account |
Link | Account | |||
| Allow Account Creation Against Child Company | allow_account_creation_against_child_company |
Check | ||||
| Default Cost of Goods Sold Account | default_expense_account |
Link | Account | |||
| Default Income Account | default_income_account |
Link | Account | |||
| Default Payment Discount Account | default_discount_account |
Link | Account | |||
| Default Payment Terms Template | payment_terms |
Link | Payment Terms Template | |||
| Default Cost Center | cost_center |
Link | Cost Center | |||
| Default Finance Book | default_finance_book |
Link | Finance Book | |||
| Exchange Gain / Loss Account | exchange_gain_loss_account |
Link | Account | |||
| Unrealized Exchange Gain/Loss Account | unrealized_exchange_gain_loss_account |
Link | Account | |||
| Round Off Account | round_off_account |
Link | Account | |||
| Round Off Cost Center | round_off_cost_center |
Link | Cost Center | |||
| Round Off for Opening | round_off_for_opening |
Link | Account | |||
| Default Deferred Revenue Account | default_deferred_revenue_account |
Link | Account | |||
| Default Deferred Expense Account | default_deferred_expense_account |
Link | Account | |||
| Book Advance Payments in Separate Party Account | book_advance_payments_in_separate_party_account |
Check | ||||
| Reconcile on Advance Payment Date | reconcile_on_advance_payment_date |
Check | yes | |||
| Reconciliation Takes Effect On | reconciliation_takes_effect_on |
Select | one of: Advance Payment Date, Oldest Of Invoice Or Advance, Reconciliation Date | |||
| Default Advance Received Account | default_advance_received_account |
Link | Account | |||
| Default Advance Paid Account | default_advance_paid_account |
Link | Account | |||
| Auto Create Exchange Rate Revaluation | auto_exchange_rate_revaluation |
Check | ||||
| Frequency | auto_err_frequency |
Select | one of: Daily, Weekly, Monthly | |||
| Submit ERR Journals? | submit_err_jv |
Check | ||||
| Exception Budget Approver Role | exception_budget_approver_role |
Link | Role | |||
| Accumulated Depreciation Account | accumulated_depreciation_account |
Link | Account | |||
| Depreciation Expense Account | depreciation_expense_account |
Link | Account | |||
| Series for Asset Depreciation Entry (Journal Entry) | series_for_depreciation_entry |
Data | ||||
| Expenses Included In Asset Valuation | expenses_included_in_asset_valuation |
Link | Account | |||
| Gain/Loss Account on Asset Disposal | disposal_account |
Link | Account | |||
| Asset Depreciation Cost Center | depreciation_cost_center |
Link | Cost Center | |||
| Capital Work In Progress Account | capital_work_in_progress_account |
Link | Account | |||
| Asset Received But Not Billed | asset_received_but_not_billed |
Link | Account | |||
| Default Buying Terms | default_buying_terms |
Link | Terms and Conditions | |||
| Sales Monthly History | sales_monthly_history |
Small Text | yes | yes | ||
| Monthly Sales Target | monthly_sales_target |
Currency | ||||
| Total Monthly Sales | total_monthly_sales |
Currency | yes | |||
| Default Selling Terms | default_selling_terms |
Link | Terms and Conditions | |||
| Default Warehouse for Sales Return | default_warehouse_for_sales_return |
Link | Warehouse | |||
| Credit Limit | credit_limit |
Currency | ||||
| Transactions Annual History | transactions_annual_history |
Code | yes | yes | ||
| Enable Perpetual Inventory | enable_perpetual_inventory |
Check | ||||
| Enable Provisional Accounting For Non Stock Items | enable_provisional_accounting_for_non_stock_items |
Check | ||||
| Default Inventory Account | default_inventory_account |
Link | Account | |||
| Stock Adjustment Account | stock_adjustment_account |
Link | Account | |||
| Default In-Transit Warehouse | default_in_transit_warehouse |
Link | Warehouse | |||
| Stock Received But Not Billed | stock_received_but_not_billed |
Link | Account | |||
| Default Provisional Account | default_provisional_account |
Link | Account | |||
| Expenses Included In Valuation | expenses_included_in_valuation |
Link | Account | |||
| Default Operating Cost Account | default_operating_cost_account |
Link | Account | |||
| One to One-Real Time Posting (added by iVendNext) | custom_one_to_onertp |
Check | ||||
| One to One-On Shift Closure (added by iVendNext) | custom_one_to_oneosc |
Check | ||||
| Roll up posting-On Shift Closure (added by iVendNext) | custom_roll_up_postingosc |
Check |