{
"modules": [
{
"name": "accounting_settings",
"description": "Accounting settings",
"icon": "fa-book-spells",
"methods": [
"get_sortcodes",
"get_main_accounts"
]
},
{
"name": "auth",
"description": "Authentication",
"icon": "fa-key",
"methods": [
"login",
"logout",
"info",
"privs",
"sso_token",
"otp_verify",
"connected_accounts",
"login_to_connected_account",
"return_to_main_account"
]
},
{
"name": "autoinvoice",
"description": "Autoinvoices for receipts",
"icon": "fa-file-invoice",
"methods": [
"search",
"info",
"update",
"cancel"
]
},
{
"name": "bank",
"description": "Banks list",
"icon": "fa-bank",
"methods": [
"get_list",
"accounts"
]
},
{
"name": "billing",
"description": "Account Billing information",
"icon": "",
"methods": [
"connected_accounts",
"get_monthly_billing_data"
]
},
{
"name": "cc",
"description": "Credit-card billing",
"icon": "fa-credit-card",
"methods": [
"provider",
"store_card_info",
"get_token_info",
"get_card_info",
"bill",
"refund",
"emv",
"googlepay",
"transactions",
"card_types",
"detect_cc_type",
"detect_cc_issuer",
"validate_card_info",
"validate_card_cvv",
"validate_cc_number",
"validate_cc_validity",
"get_successful_shva_transactions",
"j5",
"j5_status"
]
},
{
"name": "cc_storage",
"description": "Credit-card storage",
"icon": "fa-credit-card",
"methods": [
"store",
"update",
"delete",
"token_info",
"card_info"
]
},
{
"name": "chart",
"description": "Report charts data",
"icon": "fa-chart-pie",
"methods": [
"monthly_profitability"
]
},
{
"name": "client",
"description": "Customers management",
"icon": "fa-users",
"methods": [
"create",
"update",
"create_or_update",
"delete",
"info",
"types",
"add_type",
"update_type",
"get_custom_fields",
"get_custom_info",
"set_custom_info",
"get_contacts",
"contact_types",
"add_contact",
"update_contact",
"delete_contact",
"get_cc_tokens",
"get_balance",
"get_list",
"get_open_docs",
"ledger",
"merge",
"upload_profile_image",
"delete_profile_image"
]
},
{
"name": "company",
"description": "Company information",
"icon": "fa-building",
"methods": [
"info",
"settings",
"bank_accounts",
"new_customers_counter",
"business_types",
"upload_logo",
"stored_files",
"cancel_account",
"cancel_child_account",
"get_child_accounts"
]
},
{
"name": "crm",
"description": "Customer Relations Management",
"icon": "fa-people-arrows",
"methods": [
"event",
"task",
"notification",
"client_status",
"client_portal_link"
]
},
{
"name": "crm_client_status",
"description": "Customer status management",
"icon": "fa-user-tag",
"methods": [
"get_list",
"info",
"add",
"update",
"delete",
"reorder"
]
},
{
"name": "crm_lead",
"description": "Leads management",
"icon": "fa-alien",
"methods": [
"add",
"get_list"
]
},
{
"name": "crm_notification",
"description": "CRM events / tasks reminders",
"icon": "fa-bell-exclamation",
"methods": [
"info",
"get_list",
"add",
"update",
"delete"
]
},
{
"name": "currency",
"description": "Currency information",
"icon": "fa-dollar-sign",
"methods": [
"today",
"by_date",
"info",
"get_rates",
"get_rates_by_date",
"get_list"
]
},
{
"name": "deduction_type",
"description": "Deduction types",
"icon": "fa-funnel-dollar",
"methods": [
"get_list",
"add"
]
},
{
"name": "doc",
"description": "Document management",
"icon": "fa-file-invoice-dollar",
"methods": [
"info",
"search",
"create",
"edit",
"cancel",
"close",
"reopen",
"email",
"sms",
"get_doc_url",
"get_paynow_link",
"get_doc_iqr",
"types",
"get_next_docnums",
"set_next_docnums",
"get_doc_conversion_options",
"prepare_base_docs_conversion",
"update_doc_income_type",
"payment_methods",
"doc_sign_enable",
"doc_sign_disable",
"doc_sign_status",
"doc_sign_details"
]
},
{
"name": "doc_template",
"description": "Document template management",
"icon": "",
"methods": [
"get_list",
"info",
"settings",
"update_settings",
"set_active"
]
},
{
"name": "expense",
"description": "Expense reporting",
"icon": "fa-money-check-alt",
"methods": [
"types",
"doctypes",
"create",
"scan",
"update",
"delete",
"delete_scan",
"info",
"search"
]
},
{
"name": "expense_type",
"description": "Manage expense types",
"icon": "fa-money-check-alt",
"methods": [
"info",
"get_list",
"get_permanent_list",
"add",
"update",
"delete"
]
},
{
"name": "export",
"description": "Export data",
"icon": "fa-file-export",
"methods": [
"accounting_data",
"accounting_export_types"
]
},
{
"name": "file_manager",
"description": "File manager",
"icon": "fa-folder-tree",
"methods": [
"upload",
"get_list",
"info",
"rename",
"delete",
"download",
"quota"
]
},
{
"name": "geocoding",
"description": "Geo-coding module",
"icon": "fa-globe",
"methods": [
"get_countries",
"get_country_subdivisions",
"get_states",
"ip_to_location"
]
},
{
"name": "googlepay",
"description": "Google Pay integration",
"icon": "fa-google-wallet",
"methods": [
"decrypt"
]
},
{
"name": "hk",
"description": "Recurring billing",
"icon": "fa-calendar-day",
"methods": [
"info",
"create",
"update",
"add_one_time_payment",
"pause",
"resume",
"cancel",
"restore",
"charge",
"get_list",
"debts_report",
"get_debt_details",
"cancel_debt"
]
},
{
"name": "hour_reporting",
"description": "Billable hours reporting",
"icon": "fa-hourglass",
"methods": [
"get_hour_types",
"add_hour_type",
"update_hour_type",
"delete_hour_type",
"add_activity",
"get_activities",
"update_activity",
"delete_activity",
"start_activity",
"end_activity",
"status"
]
},
{
"name": "income_type",
"description": "Manage income types",
"icon": "fa-sack-dollar",
"methods": [
"get_list",
"add",
"update"
]
},
{
"name": "inventory",
"description": "Products inventory management",
"icon": "fa-warehouse",
"methods": [
"get_items",
"get_item",
"add_item",
"update_item",
"delete_item",
"delete_items",
"move_item",
"get_item_images",
"add_item_image",
"delete_item_image",
"replace_item_image",
"set_main_image",
"add_stock",
"reduce_stock",
"get_item_types",
"add_item_type",
"update_item_type",
"delete_item_type",
"get_conditions",
"add_condition",
"update_condition",
"delete_condition",
"get_unit_types",
"add_unit_type",
"update_unit_type",
"delete_unit_type",
"get_manufacturers",
"add_manufacturer",
"update_manufacturer",
"delete_manufacturer",
"get_warehouses",
"get_warehouse",
"add_warehouse",
"update_warehouse",
"delete_warehouse",
"summary_report"
]
},
{
"name": "itrack",
"description": "iTrack analytics",
"icon": "fa-analytics",
"methods": [
"analytics_id",
"analytics_code",
"track"
]
},
{
"name": "lang",
"description": "",
"icon": "",
"methods": [
"load"
]
},
{
"name": "payment_method",
"description": "Payment methods definitiona",
"icon": "",
"methods": [
"get_list"
]
},
{
"name": "paypage",
"description": "PayPages API",
"icon": "fa-shopping-cart",
"methods": [
"get_list",
"info",
"create",
"update",
"add_image",
"delete_image",
"delete",
"enable",
"disable",
"generate_sale"
]
},
{
"name": "price_index",
"description": "Price indexation",
"icon": "fa-chart-line",
"methods": [
"get_types",
"get_bases",
"get_bases_for_type",
"get_value"
]
},
{
"name": "project",
"description": "Project management",
"icon": "fa-tasks",
"methods": [
"info",
"create",
"update",
"delete",
"undelete",
"archive",
"unarchive",
"get_list"
]
},
{
"name": "project_management",
"description": "Project management",
"icon": "fa-tasks",
"methods": [
"get_projects",
"create_project",
"update_project",
"delete_project",
"undelete_project",
"archive_project",
"unarchive_project",
"get_project_info",
"get_project_status"
]
},
{
"name": "punchclock",
"description": "Punchio",
"icon": "fa-user-clock",
"methods": [
"punchIn",
"punchOut",
"get_punch",
"add_punch",
"update_punch",
"delete_punch",
"punchStatus",
"start",
"stop",
"status",
"report",
"job_types",
"day_types",
"get_special_day_requests",
"get_pending_file_uploads",
"add_special_day",
"approve_special_day",
"decline_special_day",
"upload_special_day_attachment"
]
},
{
"name": "quick_start",
"description": "",
"icon": "",
"methods": [
"status"
]
},
{
"name": "registration",
"description": "New account registration",
"icon": "fa-ballot-check",
"methods": [
"cid_valid",
"cid_available",
"password_policy",
"password_strength",
"register",
"wizard",
"otp_status",
"otp_send_sms",
"otp_send_email",
"otp_verify"
]
},
{
"name": "reports",
"description": "Reports",
"icon": "fa-chart-pie",
"methods": [
"vat_report",
"income_tax_report",
"income_report",
"summary_report",
"full_report",
"deductions_report",
"sales_report_summary",
"sales_report_totals",
"sales_report_details"
]
},
{
"name": "sign",
"description": "",
"icon": "",
"methods": [
"get_templates",
"get_my_template_fields",
"send_template"
]
},
{
"name": "sms",
"description": "Send SMS",
"icon": "fa-sms",
"methods": [
"send",
"credit"
]
},
{
"name": "supplier",
"description": "Suppliers management",
"icon": "fa-user-hard-hat",
"methods": [
"info",
"get_list",
"add",
"update",
"delete",
"upload_profile_image",
"delete_profile_image"
]
},
{
"name": "system_notification",
"description": "System notifications",
"icon": "fa-bell",
"methods": [
"get_list",
"seen",
"dismiss",
"archive",
"unarchive",
"delete"
]
},
{
"name": "tag",
"description": "Tags management",
"icon": "fa-tag",
"methods": [
"info",
"add",
"update",
"delete",
"get_list"
]
},
{
"name": "ticket",
"description": "Support tickets (iTKT)",
"icon": "fa-life-ring",
"methods": [
"search",
"info",
"create",
"update_contact_info",
"close",
"delete",
"assign",
"unassign",
"get_updates",
"add_update",
"get_statuses",
"add_status",
"edit_status",
"delete_status"
]
},
{
"name": "token",
"description": "Token management",
"icon": "fa-id-badge",
"methods": [
"info",
"create",
"revoke",
"refresh",
"get_list"
]
},
{
"name": "user",
"description": "User management",
"icon": "fa-user",
"methods": [
"info",
"create",
"update",
"delete",
"undelete",
"get_list",
"priv_levels",
"password_policy",
"upload_profile_image",
"delete_profile_image",
"update_fcm_token"
]
},
{
"name": "vat",
"description": "VAT (Value Added Tax)",
"icon": "fa-percentage",
"methods": [
"today",
"by_date"
]
},
{
"name": "webhook",
"description": "WebHook management",
"icon": "fa-sensor-alert",
"methods": [
"add",
"info",
"delete",
"get_list",
"valid_actions"
]
},
{
"name": "woocommerce",
"description": "WooCommerce plugin integration",
"icon": "/images/woo.png",
"methods": [
"connect",
"disconnect",
"generate_sale"
]
}
],
"entries": [
{
"kind": "method",
"module": "accounting_settings",
"method": "get_sortcodes",
"description": "Get Sortcodes",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "accounting_settings",
"method": "get_main_accounts",
"description": "Get Main Accounts",
"params": [
"list_type"
]
},
{
"kind": "type",
"module": "accounting_settings",
"name": "iCountSortCodeInfo",
"full_name": "iCountSortCodeInfo",
"description": "Accounting sort code info",
"properties": [
"id",
"code",
"name"
]
},
{
"kind": "method",
"module": "auth",
"method": "login",
"description": "Start session",
"params": [
"cid",
"user",
"pass",
"require_module",
"require_priv",
"get_company_info",
"get_settings",
"get_bank_accounts",
"list_type"
]
},
{
"kind": "method",
"module": "auth",
"method": "logout",
"description": "Close session",
"params": []
},
{
"kind": "method",
"module": "auth",
"method": "info",
"description": "Get auth session details",
"params": [
"get_company_info",
"get_settings",
"get_bank_accounts",
"list_type"
]
},
{
"kind": "method",
"module": "auth",
"method": "privs",
"description": "Privs",
"params": []
},
{
"kind": "method",
"module": "auth",
"method": "sso_token",
"description": "Generate SSO token to provide seamless authentication to the web\nUse the token as the _ist query-string param value added direct links to the web app links",
"params": []
},
{
"kind": "method",
"module": "auth",
"method": "otp_verify",
"description": "Internal OTP verification flow",
"params": []
},
{
"kind": "method",
"module": "auth",
"method": "connected_accounts",
"description": "Get connected accounts that the user can access from the current account\nReturns only approved/active connected accounts",
"params": []
},
{
"kind": "method",
"module": "auth",
"method": "login_to_connected_account",
"description": "Login to a connected account that the user has access to\nSwitches the current session to the specified connected account",
"params": [
"company_id"
]
},
{
"kind": "method",
"module": "auth",
"method": "return_to_main_account",
"description": "Return to the original account from a connected account session\nSwitches back to the main account that the user originally logged into",
"params": []
},
{
"kind": "method",
"module": "autoinvoice",
"method": "search",
"description": "Search autoinvoices",
"params": [
"autoinvoice_type",
"autoinvoice_id",
"receiptnumber",
"date2issue",
"start_date2issue",
"end_date2issue",
"show_issued",
"show_pending",
"show_cancelled"
]
},
{
"kind": "method",
"module": "autoinvoice",
"method": "info",
"description": "Get autoinvoice info",
"params": [
"autoinvoice_type",
"autoinvoice_id"
]
},
{
"kind": "method",
"module": "autoinvoice",
"method": "update",
"description": "Update autoinvoice details",
"params": [
"autoinvoice_type",
"autoinvoice_id",
"date2issue",
"detail_line",
"user_id",
"income_type_id",
"tax_exempt"
]
},
{
"kind": "method",
"module": "autoinvoice",
"method": "cancel",
"description": "Cancel autoinvoice",
"params": [
"autoinvoice_type",
"autoinvoice_id"
]
},
{
"kind": "type",
"module": "autoinvoice",
"name": "iCountAutoinvoiceInfo",
"full_name": "iCountAutoinvoiceInfo",
"description": "Autoinvoice information",
"properties": [
"autoinvoice_type",
"autoinvoice_id",
"date2issue",
"receiptnumber",
"user_id",
"income_type_id",
"tax_exempt",
"currency_id",
"sum",
"cheque_bank",
"cheque_branch",
"cheque_account",
"cheque_number",
"cc_type",
"cc_last4",
"connfirmation_code",
"detail_line",
"is_issued",
"is_pending",
"is_cancelled"
]
},
{
"kind": "method",
"module": "bank",
"method": "get_list",
"description": "Get list of banks",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "bank",
"method": "accounts",
"description": "Get list of company bank accounts",
"params": []
},
{
"kind": "method",
"module": "billing",
"method": "connected_accounts",
"description": "Connected Accounts",
"params": []
},
{
"kind": "method",
"module": "billing",
"method": "get_monthly_billing_data",
"description": "Get monthly billing data",
"params": [
"billing_date"
]
},
{
"kind": "type",
"module": "billing",
"name": "iCountBillingData",
"full_name": "iCountBillingData",
"description": "iCount billing information",
"properties": []
},
{
"kind": "method",
"module": "cc",
"method": "provider",
"description": "Provider",
"params": []
},
{
"kind": "method",
"module": "cc",
"method": "store_card_info",
"description": "Store Credt-Card information",
"params": []
},
{
"kind": "method",
"module": "cc",
"method": "get_token_info",
"description": "Get stored Credit-Card token",
"params": []
},
{
"kind": "method",
"module": "cc",
"method": "get_card_info",
"description": "Get stored Credit-Card info",
"params": []
},
{
"kind": "method",
"module": "cc",
"method": "bill",
"description": "Charge Credit-Card",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"sum",
"use_j5_if_available",
"num_of_payments",
"first_payment",
"is_credit",
"currency_id",
"currency_code",
"currency",
"cc_token_id",
"cc_number",
"cc_type",
"cc_cvv",
"cc_validity",
"cc_holder_id",
"cc_holder_name",
"payment_description",
"is_test"
]
},
{
"kind": "method",
"module": "cc",
"method": "refund",
"description": "Refund credit card transaction (iCount SHVA only)",
"params": [
"cc_bill_log_id",
"sum"
]
},
{
"kind": "method",
"module": "cc",
"method": "emv",
"description": "Charge credit-card using EMV (requires EMV-enabled device to be configured in the system)",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"sum",
"num_of_payments",
"is_credit",
"currency_id",
"currency_code",
"currency"
]
},
{
"kind": "method",
"module": "cc",
"method": "googlepay",
"description": "Charge with GooglePay encrypted token",
"params": [
"googlepay_token",
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"sum",
"num_of_payments",
"is_credit",
"currency_id",
"currency_code",
"currency"
]
},
{
"kind": "method",
"module": "cc",
"method": "transactions",
"description": "Search Credit-Card transactions",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"start_date",
"end_date",
"cc_last4",
"confirmation_code"
]
},
{
"kind": "method",
"module": "cc",
"method": "card_types",
"description": "Get Credit-Card types",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "cc",
"method": "detect_cc_type",
"description": "Detect card type by number",
"params": [
"cc_number"
]
},
{
"kind": "method",
"module": "cc",
"method": "detect_cc_issuer",
"description": "Detect card type by number",
"params": [
"cc_number"
]
},
{
"kind": "method",
"module": "cc",
"method": "validate_card_info",
"description": "Validate Credit-Card number and validity and discover card type",
"params": [
"cc_number",
"cc_validity",
"cc_cvv",
"cc_holder_id"
]
},
{
"kind": "method",
"module": "cc",
"method": "validate_card_cvv",
"description": "Perform authorization transaction to check if the card can actually be charged",
"params": [
"cc_number",
"cc_validity",
"cc_cvv",
"cc_holder_id"
]
},
{
"kind": "method",
"module": "cc",
"method": "validate_cc_number",
"description": "Validate Credit-Card number",
"params": [
"cc_number"
]
},
{
"kind": "method",
"module": "cc",
"method": "validate_cc_validity",
"description": "Validate Credit-Card validity",
"params": [
"cc_validity"
]
},
{
"kind": "method",
"module": "cc",
"method": "get_successful_shva_transactions",
"description": "Get Shva Transactions",
"params": [
"start_date",
"end_date"
]
},
{
"kind": "method",
"module": "cc",
"method": "j5",
"description": "Create J5 Preapproval Transaction",
"params": [
"cc_number",
"cc_validity",
"cc_cvv",
"cc_holder_id",
"sum",
"currency_id",
"currency_code"
]
},
{
"kind": "method",
"module": "cc",
"method": "j5_status",
"description": "Get J5 preapproval status for a card",
"params": [
"cc_token_id",
"cc_number",
"sum"
]
},
{
"kind": "type",
"module": "cc",
"name": "iCountCreditCardType",
"full_name": "iCountCreditCardType",
"description": "Credit-Card type",
"properties": [
"card_type_id",
"card_type_code",
"card_type_name",
"card_type_title"
]
},
{
"kind": "type",
"module": "cc",
"name": "iCountJ5Status",
"full_name": "iCountJ5Status",
"description": "J5 preapproval status information",
"properties": [
"j5_available",
"total_amount",
"used_amount",
"remaining_amount",
"confirmation_code",
"ts",
"uid",
"transaction_id"
]
},
{
"kind": "method",
"module": "cc_storage",
"method": "store",
"description": "Store Credit-Card information",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"cc_number",
"cc_type",
"cc_cvv",
"cc_validity",
"cc_holder_id",
"cc_holder_name",
"die_if_exists"
]
},
{
"kind": "method",
"module": "cc_storage",
"method": "update",
"description": "Update information for stored card",
"params": [
"cc_token_id",
"cc_validity",
"cc_holder_id",
"cc_holder_name"
]
},
{
"kind": "method",
"module": "cc_storage",
"method": "delete",
"description": "Delete stored credit-card token",
"params": [
"cc_token_id",
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name"
]
},
{
"kind": "method",
"module": "cc_storage",
"method": "token_info",
"description": "Get stored credit-card token information",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"cc_token_id"
]
},
{
"kind": "method",
"module": "cc_storage",
"method": "card_info",
"description": "Get stored credit-card information",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"cc_token_id"
]
},
{
"kind": "type",
"module": "cc_storage",
"name": "iCountCCTokenInfo",
"full_name": "iCountCCTokenInfo",
"description": "Stored card information",
"properties": [
"token_id",
"token",
"cc_type",
"cc_last4",
"cc_holder_id",
"cc_holder_name",
"cc_validity",
"cc_exp_year",
"cc_exp_month",
"cc_exp_date"
]
},
{
"kind": "method",
"module": "chart",
"method": "monthly_profitability",
"description": "Get company monthly profitability chart data",
"params": [
"start_date",
"end_date"
]
},
{
"kind": "type",
"module": "chart",
"name": "iCountChartDataSet",
"full_name": "iCountChartDataSet",
"description": "Data set options",
"properties": [
"title",
"color"
]
},
{
"kind": "type",
"module": "chart",
"name": "iCountChartData",
"full_name": "iCountChartData",
"description": "Chart data definition",
"properties": [
"chart_type",
"labels",
"datasets",
"data"
]
},
{
"kind": "method",
"module": "client",
"method": "create",
"description": "Create client",
"params": [
"custom_client_id",
"vat_id",
"email",
"client_name",
"first_name",
"last_name",
"phone",
"mobile",
"fax",
"bus_country",
"bus_state",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_state",
"home_city",
"home_zip",
"home_street",
"home_no",
"bank",
"branch",
"account",
"faccount",
"notes",
"digsig",
"custom_info"
]
},
{
"kind": "method",
"module": "client",
"method": "update",
"description": "Update client",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"first_name",
"last_name",
"phone",
"mobile",
"fax",
"bus_country",
"bus_state",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_state",
"home_city",
"home_zip",
"home_street",
"home_no",
"bank",
"branch",
"account",
"faccount",
"notes",
"digsig",
"custom_info"
]
},
{
"kind": "method",
"module": "client",
"method": "create_or_update",
"description": "Create or update client information",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"first_name",
"last_name",
"phone",
"mobile",
"fax",
"website",
"bus_country",
"bus_state",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_state",
"home_city",
"home_zip",
"home_street",
"home_no",
"bank",
"branch",
"account",
"iban",
"swift_code",
"routing_number",
"faccount",
"employee_assigned",
"client_type_id",
"client_type_name",
"payment_terms",
"client_type_discount",
"notes",
"digsig",
"custom_info"
]
},
{
"kind": "method",
"module": "client",
"method": "delete",
"description": "Delete a client",
"params": [
"client_id"
]
},
{
"kind": "method",
"module": "client",
"method": "info",
"description": "Get client information",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"get_custom_info",
"get_balance",
"get_contacts",
"get_cc_tokens",
"get_portal_link"
]
},
{
"kind": "method",
"module": "client",
"method": "types",
"description": "Get client types list",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "client",
"method": "add_type",
"description": "Add client type",
"params": [
"client_type_name",
"client_type_discount"
]
},
{
"kind": "method",
"module": "client",
"method": "update_type",
"description": "Update client type",
"params": [
"client_type_name",
"client_type_discount"
]
},
{
"kind": "method",
"module": "client",
"method": "get_custom_fields",
"description": "Get client custom fields definitions",
"params": []
},
{
"kind": "method",
"module": "client",
"method": "get_custom_info",
"description": "Get client custom info",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name"
]
},
{
"kind": "method",
"module": "client",
"method": "set_custom_info",
"description": "Set client custom info",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"custom_info"
]
},
{
"kind": "method",
"module": "client",
"method": "get_contacts",
"description": "Get client contacts",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name"
]
},
{
"kind": "method",
"module": "client",
"method": "contact_types",
"description": "Contact Types",
"params": []
},
{
"kind": "method",
"module": "client",
"method": "add_contact",
"description": "Add Contact",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"contact_type",
"contact_uuid",
"email",
"phone",
"mobile",
"id_no",
"company_name",
"first_name",
"last_name",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_city",
"home_zip",
"home_street",
"home_no",
"dob"
]
},
{
"kind": "method",
"module": "client",
"method": "update_contact",
"description": "Update client contact",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"contact_id",
"contact_uuid",
"phone",
"mobile",
"id_no",
"company_name",
"first_name",
"last_name",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_city",
"home_zip",
"home_street",
"home_no",
"dob"
]
},
{
"kind": "method",
"module": "client",
"method": "delete_contact",
"description": "Delete client contact",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"contact_id"
]
},
{
"kind": "method",
"module": "client",
"method": "get_cc_tokens",
"description": "Get client stored Credit-Card tokens information",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name"
]
},
{
"kind": "method",
"module": "client",
"method": "get_balance",
"description": "Get client balance",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name"
]
},
{
"kind": "method",
"module": "client",
"method": "get_list",
"description": "Get clients list",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"phone",
"mobile",
"client_name",
"first_name",
"last_name",
"is_lead",
"include_leads",
"detail_level",
"search_contacts_if_not_found",
"sort_field",
"sort_order",
"offset",
"limit",
"list_type"
]
},
{
"kind": "method",
"module": "client",
"method": "get_open_docs",
"description": "Get the list of client open docs",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"doctype",
"get_items",
"list_type"
]
},
{
"kind": "method",
"module": "client",
"method": "ledger",
"description": "Get client ledger",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"start_date",
"end_date"
]
},
{
"kind": "method",
"module": "client",
"method": "merge",
"description": "Merge clients. This moves all documents and activity from source client (old) to destination (new) and removes the old client profile.",
"params": [
"src_client_id",
"dst_client_id"
]
},
{
"kind": "method",
"module": "client",
"method": "upload_profile_image",
"description": "Upload customer profile image",
"params": [
"client_id",
"profile_image"
]
},
{
"kind": "method",
"module": "client",
"method": "delete_profile_image",
"description": "Delete customer profile image",
"params": [
"client_id"
]
},
{
"kind": "type",
"module": "client",
"name": "iCountClientInfo",
"full_name": "iCountClientInfo",
"description": "Client information",
"properties": [
"client_id",
"custom_client_id",
"vat_id",
"company_name",
"client_name",
"fname",
"lname",
"email",
"phone",
"mobile",
"fax",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_city",
"home_zip",
"home_street",
"home_no",
"bank",
"branch",
"account",
"card_id",
"faccount",
"client_type_id",
"payment_terms",
"notes",
"custom",
"balance"
]
},
{
"kind": "type",
"module": "client",
"name": "iCountClientTypeInfo",
"full_name": "iCountClientTypeInfo",
"description": "Client type information",
"properties": [
"client_type_id",
"client_type_name",
"client_type_discount"
]
},
{
"kind": "type",
"module": "client",
"name": "iCountClientCustomFieldInfo",
"full_name": "iCountClientCustomFieldInfo",
"description": "Client custom field information",
"properties": [
"name",
"comment",
"type",
"default",
"values"
]
},
{
"kind": "type",
"module": "client",
"name": "iCountClientLedgerReport",
"full_name": "iCountClientLedgerReport",
"description": "Client ledger report",
"properties": [
"opening_balance",
"opening_balance_date",
"total_debit",
"total_credit",
"closing_balance",
"closing_balance_date",
"ledger_entries"
]
},
{
"kind": "type",
"module": "client",
"name": "iCountClientLedgerEntry",
"full_name": "iCountClientLedgerEntry",
"description": "Client ledger entry",
"properties": [
"entry_type",
"entry_date",
"doctype",
"docnum",
"currency_rate",
"debit_sum",
"credit_sum",
"currency_id",
"currency_code",
"currency_debit_sum",
"currency_credit_sum",
"balance",
"details"
]
},
{
"kind": "method",
"module": "company",
"method": "info",
"description": "Get company information",
"params": [
"get_settings",
"get_bank_accounts",
"list_type"
]
},
{
"kind": "method",
"module": "company",
"method": "settings",
"description": "Get company settings",
"params": []
},
{
"kind": "method",
"module": "company",
"method": "bank_accounts",
"description": "Get company bank accounts",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "company",
"method": "new_customers_counter",
"description": "Get new customers counter",
"params": []
},
{
"kind": "method",
"module": "company",
"method": "business_types",
"description": "List business types",
"params": []
},
{
"kind": "method",
"module": "company",
"method": "upload_logo",
"description": "Upload company logo",
"params": [
"logo"
]
},
{
"kind": "method",
"module": "company",
"method": "stored_files",
"description": "List company approval documents",
"params": []
},
{
"kind": "method",
"module": "company",
"method": "cancel_account",
"description": "Cancel account (delete payment details)\nMUST be admin user",
"params": [
"no_email"
]
},
{
"kind": "method",
"module": "company",
"method": "cancel_child_account",
"description": "Cancel child account (delete payment details) using parent (paying) account credentials\nMUST be admin user in parent (paying) account",
"params": [
"cid_to_cancel",
"no_email"
]
},
{
"kind": "method",
"module": "company",
"method": "get_child_accounts",
"description": "Get list of child accounts paid by current account\nMUST be admin user in parent (paying) account",
"params": []
},
{
"kind": "type",
"module": "company",
"name": "iCountCompanyInfo",
"full_name": "iCountCompanyInfo",
"description": "Company information",
"properties": [
"vat_id",
"businessName",
"businessName_he",
"businessName_en",
"businessNameSubTitle",
"businessNameSubTitle_he",
"businessNameSubTitle_en",
"businessType",
"businessTypeName",
"businessTypeName_he",
"businessTypeName_en",
"businessTypeAbbr",
"businessTypeAbbr_he",
"businessTypeAbbr_en",
"is_non_profit",
"is_tax_exempt",
"is_vat_exempt",
"email",
"phone",
"fax",
"logo",
"site"
]
},
{
"kind": "type",
"module": "company",
"name": "iCountCompanySettings",
"full_name": "iCountCompanySettings",
"description": "Company settings",
"properties": [
"cc_enabled",
"cc_require_cvv",
"cc_storage_enabled",
"pos_enabled",
"iqr_enabled",
"hk_enabled",
"expense_enabled",
"inventory_enabled",
"inventory_min_stock_alerts",
"punchclock_enabled",
"punchclock_require_location",
"project_management_enabled",
"crm_enabled",
"file_manager_enabled",
"file_upload_enabled",
"display_decimals",
"display_decimals_incvat",
"multi_deduction",
"long_description_enabled"
]
},
{
"kind": "type",
"module": "company",
"name": "iCountCompanyBankAccount",
"full_name": "iCountCompanyBankAccount",
"description": "Bank account information",
"properties": [
"account_id",
"bank",
"branch",
"account",
"currency_id",
"title"
]
},
{
"kind": "type",
"module": "company",
"name": "iCountCompanyStoredFile",
"full_name": "iCountCompanyStoredFile",
"description": "Company stored file information",
"properties": [
"type",
"title",
"url",
"comment"
]
},
{
"kind": "method",
"module": "crm",
"method": "event",
"description": "Proxy for crm_event methods",
"params": [
"event_method"
]
},
{
"kind": "method",
"module": "crm",
"method": "task",
"description": "Proxy for crm_task methods",
"params": [
"task_method"
]
},
{
"kind": "method",
"module": "crm",
"method": "notification",
"description": "Proxy for crm_notification methods",
"params": [
"notification_method"
]
},
{
"kind": "method",
"module": "crm",
"method": "client_status",
"description": "Proxy for crm_client_status methods",
"params": [
"client_status_method"
]
},
{
"kind": "method",
"module": "crm",
"method": "client_portal_link",
"description": "Get client portal link",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name"
]
},
{
"kind": "method",
"module": "crm_client_status",
"method": "get_list",
"description": "Get client status list",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "crm_client_status",
"method": "info",
"description": "Get client status info",
"params": [
"client_status_id"
]
},
{
"kind": "method",
"module": "crm_client_status",
"method": "add",
"description": "Add client status",
"params": [
"status_name",
"status_description",
"is_milestone"
]
},
{
"kind": "method",
"module": "crm_client_status",
"method": "update",
"description": "Update client status information",
"params": [
"client_status_id",
"status_name",
"status_description",
"is_milestone"
]
},
{
"kind": "method",
"module": "crm_client_status",
"method": "delete",
"description": "Delete client status",
"params": [
"client_status_id",
"force"
]
},
{
"kind": "method",
"module": "crm_client_status",
"method": "reorder",
"description": "Reorder client status list",
"params": [
"client_status_order"
]
},
{
"kind": "type",
"module": "crm_client_status",
"name": "iCountCRMClientStatusInfo",
"full_name": "iCountCRMClientStatusInfo",
"description": "CRM Client Status information",
"properties": [
"status_id",
"status_name",
"status_description",
"is_milestone",
"sortkey"
]
},
{
"kind": "method",
"module": "crm_lead",
"method": "add",
"description": "Add",
"params": [
"vat_id",
"email",
"client_name",
"first_name",
"last_name",
"phone",
"mobile",
"fax",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"home_country",
"home_city",
"home_zip",
"home_street",
"home_no",
"bank",
"branch",
"account",
"notes",
"custom_info"
]
},
{
"kind": "method",
"module": "crm_lead",
"method": "get_list",
"description": "Get list of leads\nThis is a shortcut to client/get_list with parameter is_lead=true",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"phone",
"mobile",
"client_name",
"first_name",
"last_name",
"detail_level",
"search_contacts_if_not_found",
"list_type"
]
},
{
"kind": "method",
"module": "crm_notification",
"method": "info",
"description": "Get notification information",
"params": [
"notification_id"
]
},
{
"kind": "method",
"module": "crm_notification",
"method": "get_list",
"description": "Get notifications list",
"params": [
"user_id",
"event_id",
"task_id",
"show_all",
"show_pending",
"show_sent",
"show_deleted",
"list_type"
]
},
{
"kind": "method",
"module": "crm_notification",
"method": "add",
"description": "Add notification",
"params": [
"notification_text",
"notification_time",
"notification_type",
"user_id",
"parent",
"parent_id",
"tags"
]
},
{
"kind": "method",
"module": "crm_notification",
"method": "update",
"description": "Update notification",
"params": [
"notification_id",
"notification_text",
"notification_time",
"notification_type",
"user_id",
"parent",
"parent_id",
"tags"
]
},
{
"kind": "method",
"module": "crm_notification",
"method": "delete",
"description": "Delete notification",
"params": [
"notification_id"
]
},
{
"kind": "type",
"module": "crm_notification",
"name": "iCountCRMNotificationInfo",
"full_name": "iCountCRMNotificationInfo",
"description": "Notification information",
"properties": [
"notification_id",
"notification_text",
"notification_time",
"notification_type",
"user_id",
"parent",
"parent_id",
"tags",
"is_sent",
"is_deleted"
]
},
{
"kind": "method",
"module": "currency",
"method": "today",
"description": "Get currency exchange rate for today",
"params": [
"currency_id",
"currency_code",
"currency"
]
},
{
"kind": "method",
"module": "currency",
"method": "by_date",
"description": "Get currency exchange rate for given date",
"params": [
"currency_id",
"currency_code",
"currency",
"date"
]
},
{
"kind": "method",
"module": "currency",
"method": "info",
"description": "Get currency information",
"params": [
"currency_id",
"currency_code",
"currency"
]
},
{
"kind": "method",
"module": "currency",
"method": "get_rates",
"description": "Get currencies rates (latest)",
"params": []
},
{
"kind": "method",
"module": "currency",
"method": "get_rates_by_date",
"description": "Get currencies rates by date",
"params": [
"date"
]
},
{
"kind": "method",
"module": "currency",
"method": "get_list",
"description": "Get currencies list",
"params": [
"list_type",
"get_rates"
]
},
{
"kind": "type",
"module": "currency",
"name": "CurrencyID",
"full_name": "CurrencyID",
"description": "Currency ID",
"properties": []
},
{
"kind": "type",
"module": "currency",
"name": "CurrencyCode",
"full_name": "CurrencyCode",
"description": "Currency Code (3-letter code defined by ISO-4217)",
"properties": []
},
{
"kind": "type",
"module": "currency",
"name": "CurrencyInfo",
"full_name": "CurrencyInfo",
"description": "Currency information",
"properties": [
"currency_id",
"currency_code",
"currency_name",
"currency_sign"
]
},
{
"kind": "method",
"module": "deduction_type",
"method": "get_list",
"description": "List deduction types",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "deduction_type",
"method": "add",
"description": "Add deduction type",
"params": [
"deduction_type_name",
"deduction_percent"
]
},
{
"kind": "type",
"module": "deduction_type",
"name": "iCountDeductionType",
"full_name": "iCountDeductionType",
"description": "Deduction type information",
"properties": [
"deduction_type_id",
"deduction_type_name",
"deduction_percent",
"card_id",
"card_number",
"faccount"
]
},
{
"kind": "method",
"module": "doc",
"method": "info",
"description": "Get document information",
"params": [
"doctype",
"docnum",
"get_items",
"get_payments",
"get_custom_info",
"get_autoinvoices",
"get_base_doc_url",
"get_doctype_info",
"get_pdf_link",
"get_paynow_link",
"get_conversion_options",
"shortlink",
"max_clicks",
"expire_days",
"lang"
]
},
{
"kind": "method",
"module": "doc",
"method": "search",
"description": "Search documents",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"client_ids",
"custom_client_ids",
"user_id",
"username",
"user_email",
"doc_date",
"start_date",
"end_date",
"start_ts",
"end_ts",
"paydate",
"start_paydate",
"end_paydate",
"duedate",
"start_duedate",
"end_duedate",
"income_type_id",
"status",
"doctype",
"docnum",
"cc_last4",
"confirmation_code",
"pp_txn_id",
"max_results",
"sort_field",
"sort_order",
"offset",
"limit",
"detail_level",
"get_doc_url",
"get_base_docs"
]
},
{
"kind": "method",
"module": "doc",
"method": "create",
"description": "Create document",
"params": [
"doctype",
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"client_address",
"supplier_id",
"supplier_name",
"supplier_address",
"user_id",
"username",
"user_email",
"salesman_id",
"doc_date",
"paydate",
"duedate",
"income_type_id",
"income_type_name",
"expense_type_id",
"currency_id",
"currency_code",
"rate",
"tax_exempt",
"vat_percent",
"totalsum",
"discount",
"discount_incvat",
"roundup",
"afterdiscount",
"totalwithvat",
"paid",
"totalwht",
"totalpaid",
"items",
"cash",
"cheques",
"banktransfer",
"cc",
"paypal",
"barter",
"payments",
"deductions",
"autoinvoice",
"autocheque_detail",
"autoinvoice_cc",
"autocc_detail",
"autocc_income_type_id",
"autocc_exempt",
"enable_paynow",
"based_on",
"doc_title",
"hwc",
"append_preset_comments",
"sanity_string",
"doc_lang",
"send_email",
"send_sms"
]
},
{
"kind": "method",
"module": "doc",
"method": "edit",
"description": "Edit existing document",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "method",
"module": "doc",
"method": "cancel",
"description": "Cancel a document",
"params": [
"doctype",
"docnum",
"refund_cc",
"reason"
]
},
{
"kind": "method",
"module": "doc",
"method": "close",
"description": "Close document\nIf based_on list provided - close base documents and update remaining sums for all documents (target and base)\nOtherwise, just mark document as closed",
"params": [
"doctype",
"docnum",
"based_on"
]
},
{
"kind": "method",
"module": "doc",
"method": "reopen",
"description": "Mark document as open",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "method",
"module": "doc",
"method": "email",
"description": "Send document by email",
"params": [
"doctype",
"docnum",
"orig",
"hidenis",
"email_lang",
"email_to",
"email_to_client",
"email_to_creator",
"email_to_me",
"email_cc",
"email_cc_client",
"email_cc_creator",
"email_cc_me",
"email_bcc",
"email_bcc_client",
"email_bcc_creator",
"email_bcc_me",
"email_subject",
"email_subject_prefix",
"email_subject_suffix",
"email_comment"
]
},
{
"kind": "method",
"module": "doc",
"method": "sms",
"description": "Send document link in SMS",
"params": [
"doctype",
"docnum",
"orig",
"hidenis",
"sms_lang",
"sms_to",
"sms_to_client",
"sms_to_creator",
"sms_to_me",
"sms_prefix",
"sms_comment"
]
},
{
"kind": "method",
"module": "doc",
"method": "get_doc_url",
"description": "Get doc URL",
"params": [
"doctype",
"docnum",
"orig",
"hidenis",
"doc_lang",
"email_to",
"lang"
]
},
{
"kind": "method",
"module": "doc",
"method": "get_paynow_link",
"description": "Get PayNow (self-payment page) URL for document",
"params": [
"doctype",
"docnum",
"shortlink",
"max_clicks",
"expire_days"
]
},
{
"kind": "method",
"module": "doc",
"method": "get_doc_iqr",
"description": "Get doc iQR",
"params": [
"doctype",
"docnum",
"doc_lang",
"lang"
]
},
{
"kind": "method",
"module": "doc",
"method": "types",
"description": "Get available doctypes",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "doc",
"method": "get_next_docnums",
"description": "Get next document numbers for every type",
"params": [
"next_docnums"
]
},
{
"kind": "method",
"module": "doc",
"method": "set_next_docnums",
"description": "Set next (initial) document numbers",
"params": [
"docnums"
]
},
{
"kind": "method",
"module": "doc",
"method": "get_doc_conversion_options",
"description": "Get document conversion options",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "method",
"module": "doc",
"method": "prepare_base_docs_conversion",
"description": "Prepare new document items from base documents",
"params": [
"client_id",
"doctype",
"based_on"
]
},
{
"kind": "method",
"module": "doc",
"method": "update_doc_income_type",
"description": "Update document income type",
"params": [
"doctype",
"docnum",
"income_type_id",
"income_type_name"
]
},
{
"kind": "method",
"module": "doc",
"method": "payment_methods",
"description": "Get enabled payment methods",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "doc",
"method": "doc_sign_enable",
"description": "Enable doc_sign for document",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "method",
"module": "doc",
"method": "doc_sign_disable",
"description": "Disable doc_sign for document",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "method",
"module": "doc",
"method": "doc_sign_status",
"description": "Get doc_sign status for document",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "method",
"module": "doc",
"method": "doc_sign_details",
"description": "Get detailed doc_sign status for document",
"params": [
"doctype",
"docnum"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountDocItem",
"full_name": "iCountDocItem",
"description": "Document Item",
"properties": [
"item_id",
"inventory_item_id",
"sku",
"description",
"long_description",
"currency_id",
"currency_rate",
"unitprice",
"unitprice_incvat",
"unitprice_exempt",
"tax_exempt",
"quantity",
"serial",
"taxes"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountCashPayment",
"full_name": "iCountCashPayment",
"description": "Cash payment",
"properties": [
"sum"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountChequePayment",
"full_name": "iCountChequePayment",
"description": "Cheque payment",
"properties": [
"sum",
"date",
"bank",
"branch",
"account",
"number"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountBankTransferPayment",
"full_name": "iCountBankTransferPayment",
"description": "BankTransfer payment",
"properties": [
"sum",
"date",
"account"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountCreditCardPayment",
"full_name": "iCountCreditCardPayment",
"description": "Credit-Card payment",
"properties": [
"sum",
"date",
"num_of_payments",
"first_payment",
"token_id",
"card_number",
"card_type",
"cvv",
"exp_year",
"exp_month",
"holder_id",
"holder_name",
"confirmation_code"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountPayPalPayment",
"full_name": "iCountPayPalPayment",
"description": "PayPal payment method",
"properties": [
"sum",
"date",
"txn_id",
"payer_name"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountBarterPayment",
"full_name": "iCountBarterPayment",
"description": "Barter payment method",
"properties": [
"sum"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountDocPayment",
"full_name": "iCountDocPayment",
"description": "Generic payment method. for details",
"properties": [
"sum",
"payment_date",
"card_brand",
"card_number",
"payer_name",
"payer_email",
"payer_phone",
"payer_address",
"confirmation_code"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountBaseDoc",
"full_name": "iCountBaseDoc",
"description": "Base document info",
"properties": [
"doctype",
"docnum",
"doc_url"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountDocInfo",
"full_name": "iCountDocInfo",
"description": "Document information",
"properties": [
"doctype",
"docnum",
"dateissued",
"timeissued",
"client_id",
"custom_client_id",
"client_idno",
"client_name",
"client_address",
"currency_id",
"currency_code",
"rate",
"user_id",
"salesman_id",
"paydate",
"duedate",
"income_type_id",
"expense_type_id",
"invoice_reference_number",
"tax_exempt",
"vat_percent",
"totalsum",
"totalsum_currency",
"discount",
"discount_currency",
"roundup",
"roundup_currency",
"afterdiscount",
"afterdiscount_currency",
"totalwithvat",
"totalwithvat_currency",
"paid",
"paid_currency",
"totalwht",
"totalwht_currency",
"totalpaid",
"totalpaid_currency",
"remainingsum",
"remainingsum_currency",
"remainingsum_before_vat",
"remainingsum_before_vat_currency",
"status",
"is_cancelled",
"is_cancellation",
"cancellation_reason",
"cancellation_doctype",
"cancellation_docnum",
"cancelled_doctype",
"cancelled_docnum",
"items",
"cash",
"cheques",
"banktransfer",
"cc",
"paypal",
"barter",
"based_on",
"based_on_this"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountDocTypeInfo",
"full_name": "iCountDocTypeInfo",
"description": "Document type information",
"properties": [
"doctype",
"title",
"has_vat",
"has_items",
"has_lawyer_items",
"has_payment",
"has_paydate",
"has_duedate",
"has_paynow",
"has_discount",
"has_roundup",
"has_incometype",
"has_self_function",
"has_po_field",
"has_reason_field"
]
},
{
"kind": "type",
"module": "doc",
"name": "iCountDocEmailStatus",
"full_name": "iCountDocEmailStatus",
"description": "Document email sending status",
"properties": [
"email",
"name",
"email_sent",
"reason"
]
},
{
"kind": "method",
"module": "doc_template",
"method": "get_list",
"description": "Get templates list",
"params": [
"get_settings"
]
},
{
"kind": "method",
"module": "doc_template",
"method": "info",
"description": "Get template information",
"params": [
"template",
"get_settings"
]
},
{
"kind": "method",
"module": "doc_template",
"method": "settings",
"description": "Get template information",
"params": [
"template"
]
},
{
"kind": "method",
"module": "doc_template",
"method": "update_settings",
"description": "Update template-specific settings",
"params": [
"template",
"settings"
]
},
{
"kind": "method",
"module": "doc_template",
"method": "set_active",
"description": "Set active template",
"params": [
"template"
]
},
{
"kind": "type",
"module": "doc_template",
"name": "iCountDocTemplateInfo",
"full_name": "iCountDocTemplateInfo",
"description": "Document template information",
"properties": [
"name",
"he",
"en",
"logo_size",
"is_active",
"settings"
]
},
{
"kind": "method",
"module": "expense",
"method": "types",
"description": "Get expense types list",
"params": []
},
{
"kind": "method",
"module": "expense",
"method": "doctypes",
"description": "Get the list of possible values for expense_doctype field",
"params": []
},
{
"kind": "method",
"module": "expense",
"method": "create",
"description": "Create expense",
"params": [
"supplier_id",
"expense_type_id",
"expense_doctype",
"expense_docnum",
"expense_sum",
"deduction",
"currency_id",
"currency_code",
"rate",
"client_id",
"project_id",
"expense_date",
"invoice_date",
"vat_date",
"is_draft",
"is_recurring",
"recurring_period",
"recurring_number",
"recurring_end_date",
"expense_paid",
"expense_paid_date",
"payments",
"allocation_number",
"comment",
"scan"
]
},
{
"kind": "method",
"module": "expense",
"method": "scan",
"description": "Scan document and create expense",
"params": [
"scan"
]
},
{
"kind": "method",
"module": "expense",
"method": "update",
"description": "Update expense",
"params": [
"expense_id",
"supplier_id",
"expense_type_id",
"expense_doctype",
"expense_docnum",
"expense_sum",
"deduction",
"currency_id",
"currency_code",
"rate",
"client_id",
"project_id",
"expense_date",
"invoice_date",
"vat_date",
"is_draft",
"is_recurring",
"recurring_period",
"recurring_number",
"recurring_end_date",
"expense_paid",
"expense_paid_date",
"payments",
"allocation_number",
"comment",
"storno_reason",
"delete_scan",
"scan"
]
},
{
"kind": "method",
"module": "expense",
"method": "delete",
"description": "Delete an expense",
"params": [
"expense_id",
"storno_reason"
]
},
{
"kind": "method",
"module": "expense",
"method": "delete_scan",
"description": "Delete an attached scanned document from expense",
"params": [
"expense_id"
]
},
{
"kind": "method",
"module": "expense",
"method": "info",
"description": "Get expense information",
"params": [
"expense_id"
]
},
{
"kind": "method",
"module": "expense",
"method": "search",
"description": "Search expenses",
"params": [
"expense_id",
"expense_id_start",
"expense_id_end",
"expense_type_id",
"client_id",
"supplier_id",
"project_id",
"user_id",
"expense_date",
"start_date",
"end_date",
"expense_doctype",
"expense_docnum",
"is_draft",
"show_paid",
"show_unpaid",
"show_self_invoices",
"show_drafts",
"permanent_property",
"show_both",
"sort_field",
"sort_order",
"limit",
"offset"
]
},
{
"kind": "type",
"module": "expense",
"name": "iCountExpenseInfo",
"full_name": "iCountExpenseInfo",
"description": "Expense information",
"properties": [
"expense_id",
"supplier_id",
"expense_type_id",
"expense_doctype",
"expense_docnum",
"expense_sum",
"deduction",
"currency_id",
"rate",
"client_id",
"project_id",
"expense_date",
"invoice_date",
"vat_date",
"is_draft",
"is_recurring",
"recurring_period",
"recurring_number",
"recurring_end_date",
"cc",
"cheques",
"comment",
"scan",
"allocation_number",
"is_storno",
"is_stornoed",
"storno_ref_id"
]
},
{
"kind": "type",
"module": "expense",
"name": "iCountExpensePayments",
"full_name": "iCountExpensePayments",
"description": "Expense payments. Each key is a payment method code; value is either a single payment object or an array of payment objects depending on the method. When provided on update, existing payment rows are replaced.",
"properties": [
"cash",
"cheques",
"banktransfer",
"cc",
"paypal",
"barter",
"deductions"
]
},
{
"kind": "method",
"module": "expense_type",
"method": "info",
"description": "Get expense type info",
"params": [
"expense_type_id"
]
},
{
"kind": "method",
"module": "expense_type",
"method": "get_list",
"description": "Get expense types list",
"params": [
"permanent_property",
"list_type"
]
},
{
"kind": "method",
"module": "expense_type",
"method": "get_permanent_list",
"description": "Get permanent property types list",
"params": []
},
{
"kind": "method",
"module": "expense_type",
"method": "add",
"description": "Add expense type",
"params": [
"expense_type_name",
"deductable_expense",
"deductable_vat",
"permanent_property",
"no_vat",
"vat_to_expense",
"sortcode_id"
]
},
{
"kind": "method",
"module": "expense_type",
"method": "update",
"description": "Add expense type",
"params": [
"expense_type_id",
"expense_type_name",
"deductable_expense",
"deductable_vat",
"permanent_property"
]
},
{
"kind": "method",
"module": "expense_type",
"method": "delete",
"description": "Add expense type",
"params": [
"expense_type_id"
]
},
{
"kind": "type",
"module": "expense_type",
"name": "iCountExpenseType",
"full_name": "iCountExpenseType",
"description": "Expense type",
"properties": [
"expense_type_id",
"expense_type_name",
"card_id",
"card_number",
"deductable_expense",
"deductable_vat",
"no_vat",
"main_account_id",
"sortcode_id",
"permanent_property"
]
},
{
"kind": "method",
"module": "export",
"method": "accounting_data",
"description": "Export data to external accounting software",
"params": [
"export_type",
"start_date",
"end_date",
"export_docs",
"export_expenses",
"export_clients",
"export_suppliers",
"webhook_url",
"webhook_method"
]
},
{
"kind": "method",
"module": "export",
"method": "accounting_export_types",
"description": "Get available export types",
"params": []
},
{
"kind": "type",
"module": "export",
"name": "iCountExportAccountingWebhook",
"full_name": "iCountExportAccountingWebhook",
"description": "Accounting data export webhook information",
"properties": [
"export_type",
"start_date",
"end_date",
"export_docs",
"export_expenses",
"export_clients",
"export_suppliers",
"url"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "upload",
"description": "Upload file(s)",
"params": [
"file",
"get_quota"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "get_list",
"description": "Get files list",
"params": [
"sort_field",
"sort_order",
"file_type",
"filename",
"uploaded_date",
"uploaded_date_start",
"uploaded_date_end",
"limit",
"offset",
"show_deleted"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "info",
"description": "Get file information",
"params": [
"file_id"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "rename",
"description": "Rename file",
"params": [
"file_id",
"filename"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "delete",
"description": "Delete file(s)",
"params": [
"file_id",
"file_ids",
"get_quota"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "download",
"description": "Download a file",
"params": [
"file_id"
]
},
{
"kind": "method",
"module": "file_manager",
"method": "quota",
"description": "Get file manager quota",
"params": []
},
{
"kind": "type",
"module": "file_manager",
"name": "iCountFileInfo",
"full_name": "iCountFileInfo",
"description": "File information",
"properties": [
"id",
"filename",
"file_type",
"size",
"url",
"entity_type",
"entity_id",
"uploaded",
"deleted"
]
},
{
"kind": "type",
"module": "file_manager",
"name": "iCountFileUploadError",
"full_name": "iCountFileUploadError",
"description": "File upload error",
"properties": [
"id",
"filename",
"file_type",
"size",
"url",
"entity_type",
"entity_id",
"uploaded",
"deleted",
"error_description"
]
},
{
"kind": "type",
"module": "file_manager",
"name": "iCountFileDeleteStatus",
"full_name": "iCountFileDeleteStatus",
"description": "File delete status",
"properties": [
"file_id",
"status_code"
]
},
{
"kind": "type",
"module": "file_manager",
"name": "iCountFileDeleteStatusCode",
"full_name": "iCountFileDeleteStatusCode",
"description": "File delete status code. Possible values: 0=OK, 1=File not found, 2=Access denied, 3=Delete failed",
"properties": []
},
{
"kind": "type",
"module": "file_manager",
"name": "iCountFileManagerQuota",
"full_name": "iCountFileManagerQuota",
"description": "File manager quota",
"properties": [
"valid_until",
"quota",
"used",
"percent_used"
]
},
{
"kind": "method",
"module": "geocoding",
"method": "get_countries",
"description": "Get countries list",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "geocoding",
"method": "get_country_subdivisions",
"description": "Get country subdivisions (States / Provinces)",
"params": [
"country_code",
"list_type"
]
},
{
"kind": "method",
"module": "geocoding",
"method": "get_states",
"description": "Get country states/provinces",
"params": []
},
{
"kind": "method",
"module": "geocoding",
"method": "ip_to_location",
"description": "Get IPv4 physical location (country, city, latitude/longitude)",
"params": []
},
{
"kind": "type",
"module": "geocoding",
"name": "iCountCountryInfo",
"full_name": "iCountCountryInfo",
"description": "Country information",
"properties": [
"id",
"country_code",
"numeric_code",
"alpha2",
"alpha3",
"name_en",
"name_he",
"name",
"official_name"
]
},
{
"kind": "type",
"module": "geocoding",
"name": "iCountCountrySubdivisionInfo",
"full_name": "iCountCountrySubdivisionInfo",
"description": "Country subdivision information",
"properties": [
"id",
"country_id",
"subdivision_type",
"postal_code",
"iso3166_code",
"fips_code",
"name_en",
"name_he",
"name"
]
},
{
"kind": "type",
"module": "geocoding",
"name": "iCountCityInfo",
"full_name": "iCountCityInfo",
"description": "City information",
"properties": [
"name"
]
},
{
"kind": "type",
"module": "geocoding",
"name": "iCountGeoCoordinates",
"full_name": "iCountGeoCoordinates",
"description": "Geographical coordinates",
"properties": [
"latitude",
"longitude"
]
},
{
"kind": "type",
"module": "geocoding",
"name": "iCountGeoLocation",
"full_name": "iCountGeoLocation",
"description": "Geo-Location object",
"properties": [
"country",
"city",
"coordinates"
]
},
{
"kind": "method",
"module": "googlepay",
"method": "decrypt",
"description": "Process and decrypt Google Pay payment token",
"params": [
"payload"
]
},
{
"kind": "type",
"module": "googlepay",
"name": "iCountGooglePayDecryptedToken",
"full_name": "iCountGooglePayDecryptedToken",
"description": "Google Pay decrypted token information",
"properties": [
"gatewayMerchantId",
"messageId",
"messageExpiration",
"paymentMethodDetails",
"paymentMethodDetails.pan",
"paymentMethodDetails.expirationMonth",
"paymentMethodDetails.expirationYear",
"paymentMethodDetails.authMethod",
"paymentMethodDetails.cryptogram",
"paymentMethodDetails.eciIndicator",
"paymentMethodDetails.tokenizationData"
]
},
{
"kind": "type",
"module": "googlepay",
"name": "iCountGooglePayPayload",
"full_name": "iCountGooglePayPayload",
"description": "Google Pay encrypted payload",
"properties": [
"protocolVersion",
"signature",
"signedMessage",
"intermediateSigningKey",
"intermediateSigningKey.signedKey",
"intermediateSigningKey.signatures"
]
},
{
"kind": "method",
"module": "hk",
"method": "info",
"description": "Get recurring billing profile information",
"params": [
"hk_id",
"get_transactions",
"get_billing_cycles",
"get_debts"
]
},
{
"kind": "method",
"module": "hk",
"method": "create",
"description": "Create new recurring billing profile",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"doctype",
"tax_exempt",
"incvat",
"bank_number",
"bank_branch",
"bank_account",
"deposit_to_bank",
"cc_token_id",
"cc_number",
"cc_cvv",
"cc_type",
"cc_validity",
"cc_holder_id",
"cc_holder_name",
"start_date",
"num_of_payments",
"issue_every",
"currency",
"income_type_id",
"employee_assigned",
"items",
"price_indexing",
"email_to_client",
"email_cc",
"email_client_on_issue",
"lang",
"hk_cc_auto_retry"
]
},
{
"kind": "method",
"module": "hk",
"method": "update",
"description": "Update recurring billing profile",
"params": [
"hk_id",
"tax_exempt",
"incvat",
"bank_number",
"bank_branch",
"bank_account",
"deposit_to_bank",
"cc_token_id",
"cc_number",
"cc_cvv",
"cc_type",
"cc_validity",
"cc_holder_id",
"cc_holder_name",
"start_date",
"num_of_payments",
"issue_every",
"currency",
"income_type_id",
"employee_assigned",
"items",
"price_indexing",
"email_to_client",
"email_cc",
"email_client_on_issue",
"hk_cc_auto_retry"
]
},
{
"kind": "method",
"module": "hk",
"method": "add_one_time_payment",
"description": "Add a one-time payment based on existing recurring payment profile.\nThis is a shortcut to hk/create with num_of_payments=1 and same payment option",
"params": [
"hk_id",
"payment_sum",
"payment_date",
"currency",
"payment_description"
]
},
{
"kind": "method",
"module": "hk",
"method": "pause",
"description": "Pause a recurring billing profile",
"params": [
"hk_id"
]
},
{
"kind": "method",
"module": "hk",
"method": "resume",
"description": "Resume a recurring billing profile",
"params": [
"hk_id"
]
},
{
"kind": "method",
"module": "hk",
"method": "cancel",
"description": "Cancel a recurring billing profile",
"params": [
"hk_id",
"client_id"
]
},
{
"kind": "method",
"module": "hk",
"method": "restore",
"description": "Restore a cancelled recurring billing profile",
"params": [
"hk_id"
]
},
{
"kind": "method",
"module": "hk",
"method": "charge",
"description": "Perform billing attempt manually on credit-card recurring billing profile",
"params": [
"hk_id",
"force"
]
},
{
"kind": "method",
"module": "hk",
"method": "get_list",
"description": "Get recurring billing profiles list",
"params": [
"hk_id",
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"show_active",
"show_paused",
"show_finished",
"show_deleted",
"show_all",
"list_type",
"limit",
"offset"
]
},
{
"kind": "method",
"module": "hk",
"method": "debts_report",
"description": "Debts report",
"params": [
"get_details",
"hk_id",
"client_id",
"custom_client_id",
"last_failure_cycle",
"last_success_cycle",
"last_failure_date",
"last_success_date"
]
},
{
"kind": "method",
"module": "hk",
"method": "get_debt_details",
"description": "Get debt details for a specific recurring billing profile",
"params": [
"hk_id",
"show_cancelled"
]
},
{
"kind": "method",
"module": "hk",
"method": "cancel_debt",
"description": "Cancel (forgive) failed billing cycles for a recurring billing profile",
"params": [
"hk_id",
"cycle",
"cycles",
"cancel_all_failed",
"reason"
]
},
{
"kind": "type",
"module": "hk",
"name": "iCountHKInfo",
"full_name": "iCountHKInfo",
"description": "Recurring billing profile information",
"properties": [
"hk_id",
"hk_type",
"client_id",
"custom_client_id",
"client_idno",
"client_name",
"userid",
"employee_assigned",
"bank_number",
"bank_branch",
"bank_account",
"cc_type",
"cc_last4",
"cc_expires",
"cc_holder_id",
"cc_holder_name",
"items",
"currency_id",
"currency",
"currency_rate",
"tax_exempt",
"start_date",
"num_of_payments",
"price_indexing",
"current_payment_num",
"last_debit",
"last_debit_num",
"last_debit_success",
"last_transaction",
"last_success",
"last_success_num",
"next_debit",
"next_debit_num",
"issue_every",
"income_type",
"deposit_to_bank",
"hk_send_doc_to_client",
"hk_mail_recipients",
"lang",
"ts_created",
"ts_updated",
"is_donation",
"is_deleted",
"is_paused",
"is_finished"
]
},
{
"kind": "type",
"module": "hk",
"name": "iCountHKPriceIndexing",
"full_name": "iCountHKPriceIndexing",
"description": "Price indexing settings",
"properties": [
"type",
"adjustment",
"price_index",
"price_index_base",
"price_index_value",
"currency_code",
"currency_rate"
]
},
{
"kind": "type",
"module": "hk",
"name": "iCountHKTransaction",
"full_name": "iCountHKTransaction",
"description": "Recurring billing attempt information",
"properties": [
"hk_id",
"history_id",
"currency_id",
"currency_rate",
"currency_sum",
"debit_sum",
"debit_date",
"debit_status",
"status_code",
"more_info",
"doctype",
"docnum"
]
},
{
"kind": "type",
"module": "hk",
"name": "iCountHKBillingCycle",
"full_name": "iCountHKBillingCycle",
"description": "Billing cycle information",
"properties": [
"hk_id",
"month",
"client_id",
"currency_id",
"currency_rate",
"currency_sum",
"debit_sum",
"attempts",
"failure_count",
"success_count",
"first_attempt",
"last_attempt",
"last_debit_date",
"last_debit_status",
"last_status_code",
"last_status_text",
"doctype",
"docnum"
]
},
{
"kind": "type",
"module": "hk",
"name": "iCountHKDebtSummary",
"full_name": "iCountHKDebtSummary",
"description": "Recurring billing profile debt summary",
"properties": [
"hk_id",
"client_id",
"custom_client_id",
"client_name",
"start_date",
"end_date",
"num_of_payments",
"issue_every",
"last_cycle",
"last_success_cycle",
"last_failure_cycle",
"total_count",
"success_count",
"failure_count",
"cancelled_count",
"total_sum",
"success_sum",
"failure_sum",
"cancelled_sum",
"last_success_date",
"last_failure_date",
"last_status_code",
"last_status_text",
"details"
]
},
{
"kind": "type",
"module": "hk",
"name": "iCountHKCCIPNMessage",
"full_name": "iCountHKCCIPNMessage",
"description": "This information is sent as POST-DATA (application/x-www-form-urlencoded) for credit card billing attempts",
"properties": [
"status",
"hk_id",
"client_id",
"custom_client_id",
"client_name",
"payment_sum",
"currency_id",
"currency_code",
"cc_last4",
"cc_type",
"cc_exp_date",
"confirmation_code",
"doctype",
"docnum",
"doc_url"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "get_hour_types",
"description": "Get billable hour types",
"params": []
},
{
"kind": "method",
"module": "hour_reporting",
"method": "add_hour_type",
"description": "Add hour type",
"params": [
"hour_type_name",
"hourly_rate",
"client_id",
"user_id"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "update_hour_type",
"description": "Update hour type",
"params": [
"hour_type_id",
"client_id",
"user_id",
"hour_type_name",
"hourly_rate"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "delete_hour_type",
"description": "Delete hour type",
"params": [
"hour_type_id"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "add_activity",
"description": "Add activity",
"params": [
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"project_id",
"user_id",
"activity_date",
"start_ts",
"end_ts",
"start_lat",
"start_lon",
"end_lat",
"end_lon",
"hour_type_id",
"total_hours",
"activity_description",
"expense_sum",
"expense_currency_id",
"expense_currency_code",
"expense_description"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "get_activities",
"description": "Get activities list",
"params": [
"start_date",
"end_date",
"all_users",
"user_id",
"client_id",
"split_days"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "update_activity",
"description": "Update activity",
"params": [
"activity_id",
"client_id",
"custom_client_id",
"vat_id",
"email",
"client_name",
"project_id",
"activity_date",
"start_ts",
"end_ts",
"start_lat",
"start_lon",
"end_lat",
"end_lon",
"hour_type_id",
"total_hours",
"activity_description",
"expense_sum",
"expense_currency_id",
"expense_currency_code",
"expense_description"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "delete_activity",
"description": "Delete activity",
"params": [
"activity_id"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "start_activity",
"description": "Start activity",
"params": [
"client_id",
"start_lat",
"start_lon",
"activity_description",
"expense_currency_id",
"expense_sum",
"expense_description"
]
},
{
"kind": "method",
"module": "hour_reporting",
"method": "end_activity",
"description": "End activity",
"params": []
},
{
"kind": "method",
"module": "hour_reporting",
"method": "status",
"description": "Get current activity status",
"params": []
},
{
"kind": "type",
"module": "hour_reporting",
"name": "ActivityInfo",
"full_name": "ActivityInfo",
"description": "Activity information",
"properties": [
"activity_id",
"user_id",
"client_id",
"project_id",
"hour_type_id",
"activity_description",
"activity_date",
"start_ts",
"start_lat",
"start_lon",
"end_ts",
"end_lat",
"end_lon",
"duration",
"total_hours",
"expense_sum",
"expense_currency_id",
"expense_currency_code",
"expense_description"
]
},
{
"kind": "method",
"module": "income_type",
"method": "get_list",
"description": "Get list of income types",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "income_type",
"method": "add",
"description": "Add income type",
"params": [
"income_type_name",
"sortcode_id",
"main_account",
"faccount"
]
},
{
"kind": "method",
"module": "income_type",
"method": "update",
"description": "Update income type",
"params": [
"income_type_id",
"income_type_name",
"faccount"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_items",
"description": "Search items",
"params": [
"inventory_item_id",
"sku",
"barcode",
"description",
"q",
"long_description",
"client_id",
"manufacturer_id",
"type_id",
"condition_id",
"unit_type_id",
"warehouse_id",
"min_stock_alert",
"sort",
"sort_order",
"limit",
"offset",
"list_type"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_item",
"description": "Get inventory item information",
"params": [
"inventory_item_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "add_item",
"description": "Add item to inventory",
"params": [
"description",
"long_description",
"sku",
"item_type_id",
"condition_id",
"unit_type_id",
"unitprice",
"tax_exempt",
"unit_price_includes_vat",
"currency_id",
"cost_amount",
"cost_currency_id",
"stock",
"entry_date",
"warehouse_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "update_item",
"description": "Update inventory item",
"params": [
"inventory_item_id",
"description",
"long_description",
"sku",
"item_type_id",
"condition_id",
"unit_type_id",
"unitprice",
"tax_exempt",
"unit_price_includes_vat",
"currency_id",
"cost_amount",
"cost_currency_id",
"stock",
"entry_date",
"warehouse_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_item",
"description": "Delete inventory item",
"params": [
"inventory_item_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_items",
"description": "Delete multiple items",
"params": [
"inventory_item_ids",
"list_type"
]
},
{
"kind": "method",
"module": "inventory",
"method": "move_item",
"description": "Move inventory item to another warehouse",
"params": [
"inventory_item_id",
"warehouse_id",
"quantity"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_item_images",
"description": "Get inventory item images",
"params": [
"inventory_item_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "add_item_image",
"description": "Add item image (upload)",
"params": [
"inventory_item_id",
"image"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_item_image",
"description": "Delete item image",
"params": [
"inventory_item_id",
"image_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "replace_item_image",
"description": "Replace item image with a new one",
"params": [
"inventory_item_id",
"image_id",
"image"
]
},
{
"kind": "method",
"module": "inventory",
"method": "set_main_image",
"description": "Set image as main item image",
"params": [
"inventory_item_id",
"image_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "add_stock",
"description": "Add quantity to item stock",
"params": [
"inventory_item_id",
"quantity"
]
},
{
"kind": "method",
"module": "inventory",
"method": "reduce_stock",
"description": "Reduce quantity from item stock",
"params": [
"inventory_item_id",
"quantity"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_item_types",
"description": "Get item types list",
"params": []
},
{
"kind": "method",
"module": "inventory",
"method": "add_item_type",
"description": "Add item type",
"params": [
"item_type_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "update_item_type",
"description": "Update item type name",
"params": [
"item_type_id",
"item_type_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_item_type",
"description": "Delete item type",
"params": [
"item_type_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_conditions",
"description": "Get Inventory Item conditions list",
"params": []
},
{
"kind": "method",
"module": "inventory",
"method": "add_condition",
"description": "Add item condition\nthrows missing_condition_name, condition_creation_failed",
"params": [
"condition_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "update_condition",
"description": "Update item condition name",
"params": [
"condition_id",
"condition_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_condition",
"description": "Delete item condition",
"params": [
"condition_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_unit_types",
"description": "Get item measurement unit types list",
"params": []
},
{
"kind": "method",
"module": "inventory",
"method": "add_unit_type",
"description": "Add item measurement unit type",
"params": [
"unit_type_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "update_unit_type",
"description": "Update unit type name",
"params": [
"unit_type_id",
"unit_type_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_unit_type",
"description": "Delete unit type",
"params": [
"unit_type_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_manufacturers",
"description": "Get Manufacturers list",
"params": []
},
{
"kind": "method",
"module": "inventory",
"method": "add_manufacturer",
"description": "Add manufacturer",
"params": [
"manufacturer_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "update_manufacturer",
"description": "Update manufacturer information",
"params": [
"manufacturer_id",
"manufacturer_name"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_manufacturer",
"description": "Delete manufacturer",
"params": [
"manufacturer_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "get_warehouses",
"description": "Get warehouses list",
"params": []
},
{
"kind": "method",
"module": "inventory",
"method": "get_warehouse",
"description": "Get warehouse information",
"params": [
"warehouse_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "add_warehouse",
"description": "Add warehouse",
"params": [
"warehouse_name",
"warehouse_street_name",
"warehouse_street_number",
"warehouse_country_name",
"warehouse_city_name",
"warehouse_zip",
"is_locked"
]
},
{
"kind": "method",
"module": "inventory",
"method": "update_warehouse",
"description": "Update warehouse information",
"params": [
"warehouse_id",
"warehouse_name",
"warehouse_street_name",
"warehouse_street_number",
"warehouse_country_name",
"warehouse_city_name",
"warehouse_zip",
"is_locked"
]
},
{
"kind": "method",
"module": "inventory",
"method": "delete_warehouse",
"description": "Delete warehouse",
"params": [
"warehouse_id"
]
},
{
"kind": "method",
"module": "inventory",
"method": "summary_report",
"description": "Inventory summary report",
"params": [
"report_date"
]
},
{
"kind": "type",
"module": "inventory",
"name": "iCountInventoryItem",
"full_name": "iCountInventoryItem",
"description": "Inventory item",
"properties": [
"inventory_item_id",
"sku",
"description",
"long_description",
"item_type_id",
"condition_id",
"unit_type_id",
"manufacturer_id",
"unitprice",
"unitprice_incvat",
"currency_id",
"cost_amount",
"cost_currency_id",
"warehouse_id",
"stock",
"min_stock"
]
},
{
"kind": "type",
"module": "inventory",
"name": "iCountWarehouse",
"full_name": "iCountWarehouse",
"description": "Warehouse",
"properties": [
"warehouse_id",
"warehouse_name",
"warehouse_street_name",
"warehouse_street_number",
"warehouse_country_name",
"warehouse_city_name",
"warehouse_zip"
]
},
{
"kind": "type",
"module": "inventory",
"name": "iCountInventoryImageInfo",
"full_name": "iCountInventoryImageInfo",
"description": "Image file info",
"properties": [
"id",
"filename",
"file_type",
"size",
"url",
"entity_type",
"entity_id",
"uploaded",
"deleted",
"is_main_image"
]
},
{
"kind": "method",
"module": "itrack",
"method": "analytics_id",
"description": "Get iTrack analytics ID for the account",
"params": []
},
{
"kind": "method",
"module": "itrack",
"method": "analytics_code",
"description": "Get iTrack analytics code",
"params": [
"domains"
]
},
{
"kind": "method",
"module": "itrack",
"method": "track",
"description": "Record tracking action (server-to-server)",
"params": [
"action"
]
},
{
"kind": "method",
"module": "lang",
"method": "load",
"description": "Load",
"params": []
},
{
"kind": "method",
"module": "payment_method",
"method": "get_list",
"description": "Get enabled payment methods",
"params": [
"list_type"
]
},
{
"kind": "type",
"module": "payment_method",
"name": "iCountPaymentMethodInfo",
"full_name": "iCountPaymentMethodInfo",
"description": "Payment methods info",
"properties": [
"id",
"code",
"name",
"name_en",
"name_he",
"icon",
"logo",
"enabled",
"is_card",
"allow_multiple",
"sortkey"
]
},
{
"kind": "type",
"module": "payment_method",
"name": "card_brands",
"full_name": "card_brands",
"description": "List of applicable card brands. Relevant only for payment methods with is_card=true. Keys are card brand ids",
"properties": []
},
{
"kind": "type",
"module": "payment_method",
"name": "iCountPaymentMethodCardBrandInfo",
"full_name": "iCountPaymentMethodCardBrandInfo",
"description": "Card brand information",
"properties": [
"id",
"name",
"name_en",
"name_he",
"icon",
"faccount",
"enabled"
]
},
{
"kind": "method",
"module": "paypage",
"method": "get_list",
"description": "Get list of PayPages",
"params": []
},
{
"kind": "method",
"module": "paypage",
"method": "info",
"description": "GEt Paypage info",
"params": [
"paypage_id"
]
},
{
"kind": "method",
"module": "paypage",
"method": "create",
"description": "Create new Paypage",
"params": [
"page_name",
"page_name_en",
"header_text",
"header_text_en",
"extended_description",
"extended_description_en",
"currency_id",
"items",
"tax_exempt",
"require_id",
"require_fname_lname",
"require_phone",
"request_address",
"display_delivery_address",
"delivery_methods",
"require_3ds",
"captcha",
"require_tos",
"tos_link",
"max_payments",
"max_payments_advanced",
"installments_interest_rate",
"doctype",
"user_id",
"income_type_id",
"client_type_id",
"page_lang",
"hide_lang",
"hk_start_date",
"hk_billing_day",
"hk_start_after",
"hk_issue_every",
"hk_payments",
"hk_payment_sum_calc",
"custom_css",
"success_url",
"ipn_url"
]
},
{
"kind": "method",
"module": "paypage",
"method": "update",
"description": "Update Paypage",
"params": [
"paypage_id",
"page_name",
"page_name_en",
"header_text",
"header_text_en",
"extended_description",
"extended_description_en",
"currency_id",
"items",
"tax_exempt",
"require_id",
"require_fname_lname",
"require_phone",
"request_address",
"display_delivery_address",
"delivery_methods",
"require_3ds",
"captcha",
"require_tos",
"tos_link",
"max_payments",
"max_payments_advanced",
"installments_interest_rate",
"doctype",
"user_id",
"income_type_id",
"client_type_id",
"page_lang",
"hide_lang",
"hk_start_date",
"hk_billing_day",
"hk_start_after",
"hk_issue_every",
"hk_payments",
"hk_payment_sum_calc",
"custom_css",
"success_url",
"ipn_url"
]
},
{
"kind": "method",
"module": "paypage",
"method": "add_image",
"description": "Add image to PayPage",
"params": [
"paypage_id",
"file_id",
"url"
]
},
{
"kind": "method",
"module": "paypage",
"method": "delete_image",
"description": "Delete image from PayPage",
"params": [
"paypage_id",
"image_id"
]
},
{
"kind": "method",
"module": "paypage",
"method": "delete",
"description": "Delete Paypage",
"params": [
"paypage_id"
]
},
{
"kind": "method",
"module": "paypage",
"method": "enable",
"description": "Enable Paypage",
"params": [
"paypage_id"
]
},
{
"kind": "method",
"module": "paypage",
"method": "disable",
"description": "Disable Paypage",
"params": [
"paypage_id"
]
},
{
"kind": "method",
"module": "paypage",
"method": "generate_sale",
"description": "Generate sale",
"params": [
"paypage_id",
"currency_id",
"currency_code",
"items",
"sum",
"description",
"x_order_id",
"client_type_id",
"income_type_id",
"vat_id",
"client_name",
"first_name",
"last_name",
"email",
"phone",
"country_code",
"city",
"zip",
"street",
"street_num",
"recipient_name",
"recipient_email",
"recipient_phone",
"recipient_city",
"recipient_zip",
"recipient_state",
"recipient_country",
"recipient_street1",
"recipient_street2",
"delivery_methods",
"max_payments",
"max_payments_advanced",
"hk_start_date",
"hk_billing_day",
"hk_start_after",
"hk_issue_every",
"hk_payments",
"hk_payment_sum_calc",
"page_lang",
"success_url",
"failure_url",
"cancel_url",
"ipn_url",
"is_iframe",
"utm_campaign",
"utm_source",
"utm_medium",
"utm_term",
"utm_content"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageInfo",
"full_name": "iCountPayPageInfo",
"description": "Paypage info",
"properties": [
"id",
"page_url",
"page_name",
"page_name_en",
"header_text",
"header_text_en",
"extended_description",
"extended_description_en",
"currency_id",
"items",
"tax_exempt",
"require_id",
"require_fname_lname",
"require_phone",
"request_address",
"display_delivery_address",
"delivery_methods",
"require_3ds",
"captcha",
"require_tos",
"tos_link",
"max_payments",
"max_payments_advanced",
"installments_interest_rate",
"doctype",
"user_id",
"income_type_id",
"client_type_id",
"page_lang",
"hide_lang",
"custom_fields_info",
"is_active",
"is_deleted",
"created_ts",
"created_by",
"updated_ts",
"updated_by"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageItem",
"full_name": "iCountPayPageItem",
"description": "PayPage item information",
"properties": [
"id",
"inventory_item_id",
"sku",
"description",
"description_en",
"description_he",
"unitprice",
"unitprice_incl",
"orig_price",
"quantity",
"min_quantity",
"max_quantity",
"default_quantity",
"quantity_step"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageImage",
"full_name": "iCountPayPageImage",
"description": "PayPage image information",
"properties": [
"id",
"name",
"size",
"url",
"uploaded"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageDeliveryMethod",
"full_name": "iCountPayPageDeliveryMethod",
"description": "Delivery method",
"properties": [
"he",
"en",
"price",
"self_pickup"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageCustomField",
"full_name": "iCountPayPageCustomField",
"description": "Custom field definition",
"properties": [
"name",
"type",
"title:en",
"title:he",
"title",
"options",
"default",
"required",
"comments"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageCustomFieldOption",
"full_name": "iCountPayPageCustomFieldOption",
"description": "Custom field option (for select/radio field types)",
"properties": [
"value",
"title:en",
"title:he",
"title"
]
},
{
"kind": "type",
"module": "paypage",
"name": "iCountPayPageIPNMessage",
"full_name": "iCountPayPageIPNMessage",
"description": "IPN message POST data fields",
"properties": [
"cp",
"payment_date",
"currency_code",
"num_of_payments",
"cc_type",
"cc_last4",
"confirmation_code",
"items",
"items_info",
"coupon_code",
"discount",
"sum",
"doctype",
"docnum",
"customer_id",
"customer_name",
"hk_id",
"cc_token_id",
"customer_fname",
"customer_lname",
"customer_email",
"customer_vat_id",
"customer_phone",
"customer_country",
"customer_city",
"customer_zip",
"customer_street",
"customer_street_number",
"customer_dob",
"delivery_method",
"shipping_fee",
"recipient_name",
"recipient_fname",
"recipient_lname",
"recipient_email",
"recipient_phone",
"recipient_city",
"recipient_zip",
"recipient_street1",
"recipient_street2"
]
},
{
"kind": "method",
"module": "price_index",
"method": "get_types",
"description": "Get Types",
"params": []
},
{
"kind": "method",
"module": "price_index",
"method": "get_bases",
"description": "Get Bases",
"params": []
},
{
"kind": "method",
"module": "price_index",
"method": "get_bases_for_type",
"description": "Get Bases For Type",
"params": []
},
{
"kind": "method",
"module": "price_index",
"method": "get_value",
"description": "Get Value",
"params": []
},
{
"kind": "method",
"module": "project",
"method": "info",
"description": "Get project info",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project",
"method": "create",
"description": "Create project",
"params": []
},
{
"kind": "method",
"module": "project",
"method": "update",
"description": "Update project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project",
"method": "delete",
"description": "Delete project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project",
"method": "undelete",
"description": "Undelete project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project",
"method": "archive",
"description": "Archive project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project",
"method": "unarchive",
"description": "Unarchive project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project",
"method": "get_list",
"description": "Get projects list",
"params": []
},
{
"kind": "method",
"module": "project_management",
"method": "get_projects",
"description": "Get projects list",
"params": [
"show",
"start_date",
"end_date",
"user_id",
"client_id",
"list_type"
]
},
{
"kind": "method",
"module": "project_management",
"method": "create_project",
"description": "Create new project",
"params": [
"project_name",
"start_date",
"end_date",
"user_id",
"client_id",
"income_type_id",
"budget"
]
},
{
"kind": "method",
"module": "project_management",
"method": "update_project",
"description": "Update project",
"params": [
"project_id",
"project_name",
"start_date",
"end_date",
"user_id",
"client_id",
"income_type_id",
"budget"
]
},
{
"kind": "method",
"module": "project_management",
"method": "delete_project",
"description": "Delete project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project_management",
"method": "undelete_project",
"description": "Undelete project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project_management",
"method": "archive_project",
"description": "Archive project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project_management",
"method": "unarchive_project",
"description": "Unarchive project",
"params": [
"project_id"
]
},
{
"kind": "method",
"module": "project_management",
"method": "get_project_info",
"description": "Get project information",
"params": [
"project_id",
"get_status"
]
},
{
"kind": "method",
"module": "project_management",
"method": "get_project_status",
"description": "Get project information",
"params": [
"project_id"
]
},
{
"kind": "type",
"module": "project_management",
"name": "iCountProjectInfo",
"full_name": "iCountProjectInfo",
"description": "Project information",
"properties": [
"project_id",
"project_name",
"start_date",
"end_date",
"user_id",
"client_id",
"income_type_id",
"budget",
"archived",
"deleted",
"active"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "punchIn",
"description": "Punch-In",
"params": [
"lat",
"lon"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "punchOut",
"description": "Punch-Out",
"params": [
"lat",
"lon"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "get_punch",
"description": "Delete punchclock report",
"params": [
"punch_id"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "add_punch",
"description": "Add manual punchclock report",
"params": [
"in_ts",
"out_ts",
"user_id",
"comments"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "update_punch",
"description": "Update punchclock report manually",
"params": [
"punch_id",
"in_ts",
"out_ts",
"comments"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "delete_punch",
"description": "Delete punchclock report",
"params": [
"punch_id"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "punchStatus",
"description": "Get current punchclock status",
"params": [
"get_activity_status"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "start",
"description": "Start",
"params": []
},
{
"kind": "method",
"module": "punchclock",
"method": "stop",
"description": "Stop",
"params": []
},
{
"kind": "method",
"module": "punchclock",
"method": "status",
"description": "Status",
"params": []
},
{
"kind": "method",
"module": "punchclock",
"method": "report",
"description": "Get punchclock report",
"params": [
"user_id",
"start_date",
"end_date",
"get_details",
"split_days"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "job_types",
"description": "Job Types",
"params": []
},
{
"kind": "method",
"module": "punchclock",
"method": "day_types",
"description": "Day Types",
"params": []
},
{
"kind": "method",
"module": "punchclock",
"method": "get_special_day_requests",
"description": "Get special day requests",
"params": [
"all_users",
"user_id",
"status"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "get_pending_file_uploads",
"description": "Get pending file uploads - special day requests awaiting file upload",
"params": [
"user_id"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "add_special_day",
"description": "Add special day",
"params": [
"day_type_id",
"start_date",
"end_date",
"comments"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "approve_special_day",
"description": "Approve special day (Manager only)",
"params": [
"punch_id"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "decline_special_day",
"description": "Decline special day (Manager only)",
"params": [
"punch_id",
"day_type_id",
"start_date",
"end_date"
]
},
{
"kind": "method",
"module": "punchclock",
"method": "upload_special_day_attachment",
"description": "Upload special day attachment (supports multiple punch IDs)",
"params": [
"punch_ids",
"file"
]
},
{
"kind": "type",
"module": "punchclock",
"name": "iCountPunchStatus",
"full_name": "iCountPunchStatus",
"description": "Punch Status",
"properties": [
"in",
"ts",
"ip",
"lat",
"lon",
"is_special_day",
"special_day_type_id",
"special_day_type_name"
]
},
{
"kind": "type",
"module": "punchclock",
"name": "iCountPunchclockEventInfo",
"full_name": "iCountPunchclockEventInfo",
"description": "Punchclock event info",
"properties": [
"punch_id",
"user_id",
"duration",
"in_ip",
"in_lat",
"in_lon",
"in_ts",
"out_ip",
"out_lat",
"out_lon",
"out_ts",
"day_type_id",
"is_special_day",
"required_approval",
"status",
"comments"
]
},
{
"kind": "method",
"module": "quick_start",
"method": "status",
"description": "Status",
"params": []
},
{
"kind": "method",
"module": "registration",
"method": "cid_valid",
"description": "Check if cid is valid",
"params": [
"cid"
]
},
{
"kind": "method",
"module": "registration",
"method": "cid_available",
"description": "Check if cid is available",
"params": [
"cid"
]
},
{
"kind": "method",
"module": "registration",
"method": "password_policy",
"description": "Password Policy",
"params": []
},
{
"kind": "method",
"module": "registration",
"method": "password_strength",
"description": "Password Strength",
"params": [
"pass"
]
},
{
"kind": "method",
"module": "registration",
"method": "register",
"description": "Perform registration",
"params": [
"cid",
"email",
"reg_code",
"business_type"
]
},
{
"kind": "method",
"module": "registration",
"method": "wizard",
"description": "Initial setup wizard",
"params": [
"company_name",
"company_name_en",
"vat_id",
"business_type_id",
"first_name",
"first_name_en",
"last_name",
"last_name_en",
"email",
"mobile",
"password1",
"password2",
"sales_tax",
"logo",
"profile_image",
"doc_template"
]
},
{
"kind": "method",
"module": "registration",
"method": "otp_status",
"description": "Get OTP status",
"params": []
},
{
"kind": "method",
"module": "registration",
"method": "otp_send_sms",
"description": "Send OTP verification code via SMS",
"params": [
"phone"
]
},
{
"kind": "method",
"module": "registration",
"method": "otp_send_email",
"description": "Send OTP verification code via Email",
"params": [
"email"
]
},
{
"kind": "method",
"module": "registration",
"method": "otp_verify",
"description": "Verify OTP code",
"params": [
"code"
]
},
{
"kind": "type",
"module": "registration",
"name": "iCountOTPStatus",
"full_name": "iCountOTPStatus",
"description": "OTP status information",
"properties": [
"enabled",
"verified",
"created_at",
"verified_at",
"sms_send_count",
"email_send_count",
"method",
"target"
]
},
{
"kind": "method",
"module": "reports",
"method": "vat_report",
"description": "VAT report",
"params": [
"start_month",
"end_month"
]
},
{
"kind": "method",
"module": "reports",
"method": "income_tax_report",
"description": "Income tax report",
"params": [
"start_month",
"end_month"
]
},
{
"kind": "method",
"module": "reports",
"method": "income_report",
"description": "Create income report",
"params": [
"start_date",
"end_date",
"client_id",
"client_type_id",
"income_type_id"
]
},
{
"kind": "method",
"module": "reports",
"method": "summary_report",
"description": "Documents Summary Report",
"params": [
"start_date",
"end_date",
"email"
]
},
{
"kind": "method",
"module": "reports",
"method": "full_report",
"description": "Get full report data (details for summary_report)",
"params": [
"start_date",
"end_date",
"email"
]
},
{
"kind": "method",
"module": "reports",
"method": "deductions_report",
"description": "Deductions report - Returns documents with deductions along with totals",
"params": [
"start_date",
"end_date",
"client_id",
"show_zeros",
"deduction_type_ids"
]
},
{
"kind": "method",
"module": "reports",
"method": "sales_report_summary",
"description": "Sales report summary",
"params": [
"start_date",
"end_date",
"client_id",
"item_description",
"item_sku"
]
},
{
"kind": "method",
"module": "reports",
"method": "sales_report_totals",
"description": "Sales report totals",
"params": [
"start_date",
"end_date",
"group_by"
]
},
{
"kind": "method",
"module": "reports",
"method": "sales_report_details",
"description": "Sales report details",
"params": [
"start_date",
"end_date",
"group_by"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountVATReport",
"full_name": "iCountVATReport",
"description": "VAT report",
"properties": [
"vat_period",
"start_month",
"start_date",
"end_month",
"end_date",
"taxable",
"exempt",
"total_taxable",
"total_exempt",
"total_vat",
"total_expenses",
"total_permanent",
"total_payment"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountIncomeTaxReport",
"full_name": "iCountIncomeTaxReport",
"description": "Income tax report",
"properties": [
"start_month",
"start_date",
"end_month",
"end_date",
"taxable",
"exempt",
"total_taxable",
"total_exempt",
"total_income",
"receipt_deductions",
"invrec_deductions",
"extra_deductions",
"total_deductions",
"income_tax_advance_percent",
"income_tax_advances",
"income_tax_payment"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountSalesReportRow",
"full_name": "iCountSalesReportRow",
"description": "sales report row",
"properties": [
"min",
"max",
"avg",
"quantity",
"total",
"total_before_vat",
"total_vat",
"currency",
"client_name",
"client_id",
"item_name",
"item_id"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountSalesReportDetailsItem",
"full_name": "iCountSalesReportDetailsItem",
"description": "sales report row",
"properties": [
"total",
"total_with_vat",
"quantity",
"item_id",
"item_description",
"clients"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountSalesReportDetailsItemClient",
"full_name": "iCountSalesReportDetailsItemClient",
"description": "detailed client object",
"properties": [
"docnum",
"doctype",
"dateissued",
"total",
"total_with_vat",
"quantity",
"client_id",
"client_name"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountSalesReportDetailsClient",
"full_name": "iCountSalesReportDetailsClient",
"description": "sales report row",
"properties": [
"total",
"total_with_vat",
"quantity",
"client_id",
"client_name",
"items"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountSalesReportDetailsClientItem",
"full_name": "iCountSalesReportDetailsClientItem",
"description": "detailed item object",
"properties": [
"docnum",
"doctype",
"dateissued",
"total",
"total_with_vat",
"quantity",
"item_id",
"item_description",
"item_sku",
"item_inventory_id"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountSummaryReport",
"full_name": "iCountSummaryReport",
"description": "Documents summary metrics",
"properties": [
"total_taxable",
"total_exempt",
"total_vat",
"total_receipts",
"total_expenses",
"total_permanent",
"vat_payment"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountDeductionDocument",
"full_name": "iCountDeductionDocument",
"description": "Document with deductions",
"properties": [
"doctype",
"docnum",
"dateissued",
"timeissued",
"client_id",
"client_name",
"client_hp",
"total_before_deductions",
"total_deductions",
"total_with_deductions",
"currency",
"rate",
"deductions"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountDeductionsReport",
"full_name": "iCountDeductionsReport",
"description": "Deductions report with totals and details",
"properties": [
"total_count",
"total_before_deductions",
"total_deductions",
"total_with_deductions",
"details"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountFullReportDocTypeInvoice",
"full_name": "iCountFullReportDocTypeInvoice",
"description": "Invoice/Refund/Invrec document type details",
"properties": [
"total_count",
"total_sum",
"total_discount",
"total_roundup",
"total_afterdiscount",
"total_vat",
"total_inc",
"details"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountFullReportDocTypeReceipt",
"full_name": "iCountFullReportDocTypeReceipt",
"description": "Receipt/Trec document type details",
"properties": [
"total_count",
"total_paid",
"details"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountFullReportExpenses",
"full_name": "iCountFullReportExpenses",
"description": "Expenses summary",
"properties": [
"total_count",
"total_sum",
"total_deductible_sum",
"total_deductible_vat",
"details"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountFullReportSummary",
"full_name": "iCountFullReportSummary",
"description": "Overall summary totals",
"properties": [
"total_count",
"total_sum",
"total_discount",
"total_roundup",
"total_afterdiscount",
"total_vat",
"total_inc",
"total_paid"
]
},
{
"kind": "type",
"module": "reports",
"name": "iCountFullReport",
"full_name": "iCountFullReport",
"description": "Full report data",
"properties": [
"invoice_taxable",
"invoice_exempt",
"refund_taxable",
"refund_exempt",
"invrec_taxable",
"invrec_exempt",
"receipt",
"trec",
"expenses",
"summary"
]
},
{
"kind": "method",
"module": "sign",
"method": "get_templates",
"description": "List templates",
"params": []
},
{
"kind": "method",
"module": "sign",
"method": "get_my_template_fields",
"description": "Get list of \"my\" fields in template",
"params": [
"template_id"
]
},
{
"kind": "method",
"module": "sign",
"method": "send_template",
"description": "Send template to recipient",
"params": [
"template_id",
"recipient",
"client_id",
"supplier_id",
"user_id",
"hide_owner_signature",
"send_via",
"fields"
]
},
{
"kind": "type",
"module": "sign",
"name": "iCountSignTemplate",
"full_name": "iCountSignTemplate",
"description": "Template information",
"properties": [
"template_id"
]
},
{
"kind": "method",
"module": "sms",
"method": "send",
"description": "Send SMS message(s)",
"params": [
"from",
"to",
"text"
]
},
{
"kind": "method",
"module": "sms",
"method": "credit",
"description": "Get remaining SMS credit",
"params": []
},
{
"kind": "type",
"module": "sms",
"name": "iCountSMSStatus",
"full_name": "iCountSMSStatus",
"description": "SMS message status",
"properties": [
"to",
"status",
"error_text"
]
},
{
"kind": "method",
"module": "supplier",
"method": "info",
"description": "Get supplier information",
"params": [
"supplier_id",
"supplier_vat_id",
"supplier_name"
]
},
{
"kind": "method",
"module": "supplier",
"method": "get_list",
"description": "Get suppliers list",
"params": [
"supplier_id",
"supplier_name",
"vat_id",
"email",
"phone",
"mobile",
"detail_level",
"list_type",
"sort_field",
"sort_order",
"offset",
"limit"
]
},
{
"kind": "method",
"module": "supplier",
"method": "add",
"description": "Add supplier",
"params": [
"supplier_name",
"vat_id",
"fname",
"lname",
"email",
"phone",
"mobile",
"fax",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"bank",
"branch",
"account",
"faccount",
"wht_percent",
"wht_validity",
"notes"
]
},
{
"kind": "method",
"module": "supplier",
"method": "update",
"description": "Update supplier",
"params": [
"supplier_id",
"supplier_name",
"vat_id",
"fname",
"lname",
"email",
"phone",
"mobile",
"fax",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"bank",
"branch",
"account",
"faccount",
"wht_percent",
"wht_validity",
"notes"
]
},
{
"kind": "method",
"module": "supplier",
"method": "delete",
"description": "Delete a supplier",
"params": [
"supplier_id"
]
},
{
"kind": "method",
"module": "supplier",
"method": "upload_profile_image",
"description": "Upload supplier profile image",
"params": [
"supplier_id",
"profile_image"
]
},
{
"kind": "method",
"module": "supplier",
"method": "delete_profile_image",
"description": "Delete supplier profile image",
"params": [
"supplier_id"
]
},
{
"kind": "type",
"module": "supplier",
"name": "iCountSupplierInfo",
"full_name": "iCountSupplierInfo",
"description": "Supplier information",
"properties": [
"supplier_id",
"vat_id",
"supplier_name",
"company_name",
"fname",
"lname",
"email",
"phone",
"mobile",
"fax",
"bus_country",
"bus_city",
"bus_zip",
"bus_street",
"bus_no",
"bank",
"branch",
"account",
"card_id",
"faccount",
"wht_percent",
"wht_validity",
"profile_image",
"notes"
]
},
{
"kind": "method",
"module": "system_notification",
"method": "get_list",
"description": "GEt notifications list",
"params": [
"limit"
]
},
{
"kind": "method",
"module": "system_notification",
"method": "seen",
"description": "Mark notifications as seen",
"params": [
"notification_ids"
]
},
{
"kind": "method",
"module": "system_notification",
"method": "dismiss",
"description": "Dismiss notifications",
"params": [
"notification_ids"
]
},
{
"kind": "method",
"module": "system_notification",
"method": "archive",
"description": "Archive notifications",
"params": [
"notification_ids"
]
},
{
"kind": "method",
"module": "system_notification",
"method": "unarchive",
"description": "Unarchive notifications",
"params": [
"notification_ids"
]
},
{
"kind": "method",
"module": "system_notification",
"method": "delete",
"description": "Delete notifications",
"params": [
"notification_ids"
]
},
{
"kind": "type",
"module": "system_notification",
"name": "iCountSystemNotification",
"full_name": "iCountSystemNotification",
"description": "System notification information",
"properties": [
"id",
"module",
"message_code",
"title",
"description",
"user_id",
"actions",
"require_action",
"priority",
"status",
"created_at",
"created_by",
"updated_at",
"updated_by"
]
},
{
"kind": "method",
"module": "tag",
"method": "info",
"description": "Get tag info",
"params": [
"tag_id"
]
},
{
"kind": "method",
"module": "tag",
"method": "add",
"description": "Add new tag",
"params": [
"tag_name"
]
},
{
"kind": "method",
"module": "tag",
"method": "update",
"description": "Update tag",
"params": [
"tag_id",
"tag_name"
]
},
{
"kind": "method",
"module": "tag",
"method": "delete",
"description": "Delete tag",
"params": [
"tag_id"
]
},
{
"kind": "method",
"module": "tag",
"method": "get_list",
"description": "Get tags list",
"params": [
"list_type"
]
},
{
"kind": "type",
"module": "tag",
"name": "iCountTagInfo",
"full_name": "iCountTagInfo",
"description": "Tag info",
"properties": [
"tag_id",
"tag_name"
]
},
{
"kind": "method",
"module": "ticket",
"method": "search",
"description": "Search tickets",
"params": [
"user_id",
"client_id",
"status"
]
},
{
"kind": "method",
"module": "ticket",
"method": "info",
"description": "Get ticket information by ID",
"params": [
"ticket_id",
"get_updates"
]
},
{
"kind": "method",
"module": "ticket",
"method": "create",
"description": "Create new ticket",
"params": [
"client_id",
"title",
"desc",
"phone",
"email",
"email_cc"
]
},
{
"kind": "method",
"module": "ticket",
"method": "update_contact_info",
"description": "Update ticket contact information",
"params": [
"phone",
"email",
"email_cc"
]
},
{
"kind": "method",
"module": "ticket",
"method": "close",
"description": "Close ticket",
"params": [
"ticket_id"
]
},
{
"kind": "method",
"module": "ticket",
"method": "delete",
"description": "Delete ticket",
"params": [
"ticket_id"
]
},
{
"kind": "method",
"module": "ticket",
"method": "assign",
"description": "Assign ticket to specific user",
"params": [
"ticket_id",
"user_id"
]
},
{
"kind": "method",
"module": "ticket",
"method": "unassign",
"description": "Unassign ticket",
"params": [
"ticket_id"
]
},
{
"kind": "method",
"module": "ticket",
"method": "get_updates",
"description": "Get ticket updates",
"params": [
"ticket_id"
]
},
{
"kind": "method",
"module": "ticket",
"method": "add_update",
"description": "Add ticket update\n$throws missing_ticket_id, update_ticket_failed",
"params": [
"ticket_id",
"update_type",
"status",
"desc",
"internal_comment"
]
},
{
"kind": "method",
"module": "ticket",
"method": "get_statuses",
"description": "Get ticket statuses list",
"params": []
},
{
"kind": "method",
"module": "ticket",
"method": "add_status",
"description": "Add ticket status",
"params": [
"new_status_name"
]
},
{
"kind": "method",
"module": "ticket",
"method": "edit_status",
"description": "Update ticket status name",
"params": [
"existing_status_name",
"new_status_name"
]
},
{
"kind": "method",
"module": "ticket",
"method": "delete_status",
"description": "Delete ticket status",
"params": [
"status_name"
]
},
{
"kind": "type",
"module": "ticket",
"name": "iCountTicketInfo",
"full_name": "iCountTicketInfo",
"description": "Ticket information",
"properties": [
"ticket_id",
"title",
"desc",
"client_id",
"email",
"email_cc",
"phone",
"status",
"user_id",
"files",
"created_ts",
"updated_ts",
"updater",
"user_agent"
]
},
{
"kind": "type",
"module": "ticket",
"name": "iCountTicketUpdate",
"full_name": "iCountTicketUpdate",
"description": "Ticket update",
"properties": [
"id",
"ticket_id",
"desc",
"files",
"internal_comment",
"update_type",
"updater",
"user_agent"
]
},
{
"kind": "type",
"module": "ticket",
"name": "iCountTicketUpdater",
"full_name": "iCountTicketUpdater",
"description": "Ticket updater information",
"properties": [
"type",
"name",
"email",
"user_id",
"username",
"client_id"
]
},
{
"kind": "method",
"module": "token",
"method": "info",
"description": "Get API token information",
"params": [
"token_id",
"access_token"
]
},
{
"kind": "method",
"module": "token",
"method": "create",
"description": "Create new API token",
"params": [
"user_id",
"expires_in",
"no_refresh",
"metadata"
]
},
{
"kind": "method",
"module": "token",
"method": "revoke",
"description": "Revoke an existing API token",
"params": [
"token_id",
"access_token"
]
},
{
"kind": "method",
"module": "token",
"method": "refresh",
"description": "Refresh API token\nThis method generates a new access_token/refresh_token pair and returns updated token information",
"params": [
"access_token",
"refresh_token"
]
},
{
"kind": "method",
"module": "token",
"method": "get_list",
"description": "Get list of existing API tokens",
"params": [
"user_id",
"list_type"
]
},
{
"kind": "type",
"module": "token",
"name": "iCountTokenInfo",
"full_name": "iCountTokenInfo",
"description": "Token information",
"properties": [
"token_id",
"provider",
"user_id",
"token_type",
"scope",
"subject",
"access_token",
"refresh_token",
"client_id",
"created",
"expires",
"last_update"
]
},
{
"kind": "method",
"module": "user",
"method": "info",
"description": "Get user info",
"params": [
"user_id",
"username",
"user_email"
]
},
{
"kind": "method",
"module": "user",
"method": "create",
"description": "Create a new user",
"params": [
"new_user",
"new_pass",
"first_name",
"last_name",
"first_name_en",
"last_name_en",
"email",
"mobile",
"phone",
"address",
"priv_level",
"privs",
"profile_image"
]
},
{
"kind": "method",
"module": "user",
"method": "update",
"description": "Update user information",
"params": [
"user_id",
"first_name",
"last_name",
"first_name_en",
"last_name_en",
"email",
"mobile",
"phone",
"address",
"priv_level",
"privs",
"profile_image"
]
},
{
"kind": "method",
"module": "user",
"method": "delete",
"description": "Delete user (deactivate)",
"params": [
"user_id"
]
},
{
"kind": "method",
"module": "user",
"method": "undelete",
"description": "Undelete user (reactivate)",
"params": [
"user_id"
]
},
{
"kind": "method",
"module": "user",
"method": "get_list",
"description": "Get users list",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "user",
"method": "priv_levels",
"description": "Get user privilege levels",
"params": [
"list_type"
]
},
{
"kind": "method",
"module": "user",
"method": "password_policy",
"description": "Password Policy",
"params": []
},
{
"kind": "method",
"module": "user",
"method": "upload_profile_image",
"description": "Upload user profile image",
"params": [
"profile_image"
]
},
{
"kind": "method",
"module": "user",
"method": "delete_profile_image",
"description": "Delete user profile image",
"params": []
},
{
"kind": "method",
"module": "user",
"method": "update_fcm_token",
"description": "Update FCM device token for push notifications",
"params": [
"device_token",
"app_name"
]
},
{
"kind": "type",
"module": "user",
"name": "iCountUserPrivLevel",
"full_name": "iCountUserPrivLevel",
"description": "User privilege level",
"properties": []
},
{
"kind": "type",
"module": "user",
"name": "iCountUserPrivLevelInfo",
"full_name": "iCountUserPrivLevelInfo",
"description": "User privilege level information",
"properties": [
"priv_level",
"priv_name"
]
},
{
"kind": "type",
"module": "user",
"name": "iCountUserInfo",
"full_name": "iCountUserInfo",
"description": "User information",
"properties": [
"user_id",
"username",
"email",
"first_name",
"last_name",
"full_name",
"priv_level",
"priv_name",
"is_enabled",
"is_deleted"
]
},
{
"kind": "method",
"module": "vat",
"method": "today",
"description": "Get current VAT percent",
"params": []
},
{
"kind": "method",
"module": "vat",
"method": "by_date",
"description": "Get VAT percent by date",
"params": [
"date"
]
},
{
"kind": "method",
"module": "webhook",
"method": "add",
"description": "Add webhook",
"params": [
"action",
"url",
"method"
]
},
{
"kind": "method",
"module": "webhook",
"method": "info",
"description": "Get WebHook information",
"params": [
"webhook_id"
]
},
{
"kind": "method",
"module": "webhook",
"method": "delete",
"description": "Delete webhook",
"params": [
"webhook_id"
]
},
{
"kind": "method",
"module": "webhook",
"method": "get_list",
"description": "Get webhooks list",
"params": [
"action",
"list_type"
]
},
{
"kind": "method",
"module": "webhook",
"method": "valid_actions",
"description": "Get list of valid webhook actions",
"params": []
},
{
"kind": "type",
"module": "webhook",
"name": "iCountWebHook",
"full_name": "iCountWebHook",
"description": "WebHook information",
"properties": [
"webhook_id",
"action",
"url",
"method"
]
},
{
"kind": "method",
"module": "woocommerce",
"method": "connect",
"description": "Connect woocommerce domain (link to paypage)",
"params": [
"wc_domain",
"wc_version",
"wp_siteurl",
"wp_version",
"ic_version",
"paypage_id",
"cc_provider",
"cc_refund_enabled"
]
},
{
"kind": "method",
"module": "woocommerce",
"method": "disconnect",
"description": "Disconnect woocommerce domain (unlink from paypage)",
"params": [
"wc_domain",
"wc_version",
"wp_siteurl",
"wp_version",
"ic_version",
"paypage_id"
]
},
{
"kind": "method",
"module": "woocommerce",
"method": "generate_sale",
"description": "Generate PayPage sale request for WooCommerce plugin",
"params": [
"wc_domain",
"wc_version",
"wc_order_id",
"wp_siteurl",
"wp_version",
"ic_version",
"paypage_id",
"currency_id",
"currency_code",
"items",
"sum",
"description",
"client_type_id",
"income_type_id",
"vat_id",
"client_name",
"first_name",
"last_name",
"email",
"phone",
"country_code",
"city",
"zip",
"street",
"street_num",
"delivery_methods",
"max_payments",
"max_payments_advanced",
"hk_start_date",
"hk_billing_day",
"hk_start_after",
"hk_issue_every",
"hk_payments",
"hk_payment_sum_calc",
"page_lang",
"success_url",
"failure_url",
"cancel_url",
"ipn_url",
"is_iframe",
"utm_campaign",
"utm_source",
"utm_medium",
"utm_term",
"utm_content"
]
}
]
}