Onboarding
FIYGE provides the flexibility of an onboarding form. An onboarding form is a list of information that the users need to provide before being able to use the FIYGE system, which may consist of the fiscal year configuration of the company, the detailed contact information of the company, etc. Once an onboarding form is configured, users must complete the form before using the FIYGE system.
Get onboarding form
Users can retrieve the onboarding form using the following request.
Request
GET /access_controls/users/onboarding.json
Response
Form in response body
"form": {
"name": "signup - step 2",
"name_model": "schema",
"__name": "signup - step 2",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"on_change_field_model": "schema",
"mapped_field_model": "schema",
"filter_field_model": "schema",
"filter_by_fields_model": "schema",
"container": "0",
"allow_copy_to_clipboard": "0",
"allow_user_to_specify_user_level_default": "0",
"enable_split_layout": 0,
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67fe7bb7-c7dc-4eae-9548-48a2ac69033c",
"model_class": "\\module\\crm_base\\model\\organizations",
"template": "form",
"children": [
{
"name": [
"Accounting Information"
],
"label": "Accounting Information",
"compute_field_sequence": "1",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "block",
"show_collapsed": "0",
"hide_label_column": "0",
"allow_copy_to_clipboard": "0",
"allow_user_to_specify_user_level_default": "0",
"business_key": "67bca5f8-6f4c-4abe-821c-4aefac69033c",
"template": "block",
"packaged_with_module": "crm_base",
"mw": false,
"children": [
{
"name": [
"organizations",
"organization_accounts",
"date_of_incorporation"
],
"label": "date_of_incorporation",
"class": "col-12 col-sm-12 col-md-6 col-lg-6 col-xl-6",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "date",
"allow_copy_to_clipboard": "0",
"disable_autofill_while_cloning": "0",
"allow_user_to_specify_user_level_default": "0",
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67f06654-5264-4a2e-8182-4abaac69033c",
"template": "input",
"packaged_with_module": "crm_base",
"mw": false
},
{
"name": [
"organizations",
"organization_accounts",
"cra_business_number"
],
"label": "cra_business_number",
"tooltip": "Your CRA Business Number is a unique 9-digit identifier assigned to your business by the Canada Revenue Agency. It helps the government keep track of the taxes your business needs to file or pay (like GST/HST, payroll, or corporate income taxes).",
"help": " ",
"class": "col-12 col-sm-12 col-md-6 col-lg-6 col-xl-6",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "input",
"allow_copy_to_clipboard": "0",
"disable_autofill_while_cloning": "0",
"allow_user_to_specify_user_level_default": "0",
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67f3fd3c-7898-4d2d-8fc2-4068ac69033c",
"template": "input",
"packaged_with_module": "crm_base",
"mw": false
},
{
"name": [
"organizations",
"organization_accounts",
"current_fiscal_year_start_date"
],
"label": "current_fiscal_year_start_date",
"tooltip": "This is the date your accounting year begins. If your business starts in the middle of a calendar year, your first fiscal year will start on that exact day. From this date onward, you’ll track and record all of your financial transactions—such as income and expenses—within this specified timeframe.",
"help": " ",
"class": "col-12 col-sm-12 col-md-6 col-lg-6 col-xl-6",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "date",
"allow_copy_to_clipboard": "0",
"disable_autofill_while_cloning": "0",
"allow_user_to_specify_user_level_default": "0",
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67f3fd76-4f14-4fe6-a8e6-4fefac69033c",
"template": "input",
"packaged_with_module": "crm_base",
"mw": false
},
{
"name": [
"organizations",
"organization_accounts",
"current_fiscal_year_closing_date"
],
"label": "current_fiscal_year_closing_date",
"tooltip": "This is the date your accounting year ends. If you want to “cut short” the current year in order to align future fiscal years with a new cycle, choose this date accordingly. After you establish this date, all subsequent fiscal years will follow the same month and day as your end date for reporting and tax purposes.",
"help": " ",
"class": "col-12 col-sm-12 col-md-6 col-lg-6 col-xl-6",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "date",
"allow_copy_to_clipboard": "0",
"disable_autofill_while_cloning": "0",
"allow_user_to_specify_user_level_default": "0",
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67f3fd91-2498-4b6a-b1eb-4996ac69033c",
"template": "input",
"packaged_with_module": "crm_base",
"mw": false
},
{
"name": [
"organizations",
"fiscal_period_duration"
],
"label": "fiscal_period_duration",
"tooltip": "ADVANCED CONFIGURATION: A fiscal period (also called an accounting period) is simply the time span your business uses to track its finances and report its earnings and expenses. Most businesses choose a 12-month fiscal period—often matching the calendar year (January 1 to December 31)—but you can start and end your fiscal period at different dates if it makes sense for your operations.",
"help": " ",
"class": "col-12 col-sm-12 col-md-6 col-lg-6 col-xl-6",
"empty": "1",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "select",
"allow_copy_to_clipboard": "0",
"disable_autofill_while_cloning": "0",
"allow_user_to_specify_user_level_default": "0",
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67f3fdad-16ac-4512-94aa-4503ac69033c",
"template": "select",
"packaged_with_module": "accounting",
"mw": false,
"children": [
{
"value": "yearly",
"__value": "yearly",
"text": "yearly",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"template": "option",
"packaged_with_module": "accounting"
},
{
"value": "half-yearly",
"__value": "half-yearly",
"text": "half-yearly",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"template": "option",
"packaged_with_module": "accounting"
},
{
"value": "quaterly",
"__value": "quaterly",
"text": "quaterly",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"template": "option",
"packaged_with_module": "accounting"
},
{
"value": "monthly",
"__value": "monthly",
"text": "monthly",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"template": "option",
"packaged_with_module": "accounting"
}
]
},
{
"name": [
"organizations",
"organization_accounts",
"create_past_fiscal_periods"
],
"label": "Create Past Fiscal Periods",
"tooltip": "Select this option if you want the system to automatically generate fiscal years and periods starting from the date of incorporation up to the current fiscal year. This is useful for maintaining historical financial records or entering backdated transactions.",
"help": " ",
"is_web_compatible": "1",
"is_mobile_compatible": "1",
"rules_grid": "1",
"roles_grid": "1",
"helper": "\\kernel\\form",
"method": "checkbox",
"allow_copy_to_clipboard": "0",
"disable_autofill_while_cloning": "0",
"allow_user_to_specify_user_level_default": "0",
"import_config_field": "0",
"import_key_field": "0",
"is_importable": "0",
"business_key": "67f3fdbe-7844-4dd0-a53e-4c03ac69033c",
"template": "checkbox",
"packaged_with_module": "crm_base",
"mw": false
}
]
},
{
"name": [
"organizations",
"id"
],
"label": "id",
"colspan": 2,
"is_web_compatible": 1,
"is_mobile_compatible": 1,
"helper": "\\kernel\\form",
"method": "hidden",
"template": "input"
},
{
"info_class": "width-100",
"is_web_compatible": 1,
"is_mobile_compatible": 1,
"helper": "\\kernel\\form",
"method": "panel",
"template": "panel",
"children": [
{
"name": [
"action",
"save"
],
"label": "Complete",
"class": "float-right",
"helper": "\\kernel\\form",
"method": "submit",
"template": "submit"
}
]
}
],
"labels": {
"Accounting Information": "Accounting Information",
"date_of_incorporation": "Date Of Incorporation",
"cra_business_number": "Cra Business Number",
"current_fiscal_year_start_date": "Current Fiscal Year Start Date",
"current_fiscal_year_closing_date": "Current Fiscal Year Closing Date",
"fiscal_period_duration": "Fiscal Period Duration",
"Create Past Fiscal Periods": "Create Past Fiscal Periods"
},
"form_metadata_id": "67bca59a-7eec-40d6-8351-4a6bac69033c",
"form_view_href": "/development_base/forms/view/id:67bca59a-7eec-40d6-8351-4a6bac69033c",
"form_id": "67bca59a-7eec-40d6-8351-4a6bac69033c",
"permission": 2
}
Full Response Body
{
"data": {
"organizations": {
"created": "2025-06-13 16:12:50",
"created_by": null,
"currency_id": "75",
"default_delete_acl_group_id": "3149",
"default_edit_acl_group_id": "3149",
"default_read_acl_group_id": "3149",
"deleted": "0",
"email": null,
"fax_number": null,
"flags": null,
"header_data": null,
"header_logo_width": null,
"id": "379",
"is_demo_data": "0",
"modified": "2025-06-13 16:12:50",
"modified_by": null,
"name": "ORGANIZATION_NAME",
"owned_by": "1416",
"parent_id": null,
"primary_address_line_1": null,
"primary_address_line_2": null,
"primary_address_line_3": null,
"primary_city": null,
"primary_country": null,
"primary_phone_number": null,
"primary_state": null,
"primary_zip": null,
"revision": "1",
"sales_shop_id": null,
"secondary_phone_number": null,
"website": null,
"primary_acl_group": null,
"portal_url": null,
"sequence": "0",
"company_id": null,
"support_manager_id": null,
"default_legal_acl_group_id": "3149",
"default_accounting_acl_group_id": "3149",
"default_support_acl_group_id": "3149",
"email_header": null,
"email_footer": null,
"enforce_ip_check": null,
"enforce_geo_check": null,
"fiscal_period_duration": null,
"initialize_organization": "1",
"business_key": "A02FFD91ECE5E7EFEB46DB8F10A74059",
"parent_organization_code": null,
"app_description": null,
"app_key_features_1": null,
"app_key_features_2": null,
"app_key_features_3": null,
"__parent_id": "",
"parent_id_business_key": null,
"__currency_id": "MNT",
"__created_by": "",
"created_by_user_name": null,
"__modified_by": "",
"modified_by_user_name": null,
"__owned_by": "Jacky Yip",
"owned_by_user_name": "jacky+30@fiyge.com",
"__primary_country": "",
"__sales_shop_id": "",
"__default_read_acl_group_id": "a business name - All Users",
"__default_edit_acl_group_id": "a business name - All Users",
"__default_delete_acl_group_id": "a business name - All Users",
"__company_id": "",
"company_id_name": null,
"__support_manager_id": "",
"support_manager_id_user_name": null,
"__default_legal_acl_group_id": "a business name - All Users",
"__default_accounting_acl_group_id": "a business name - All Users",
"__default_support_acl_group_id": "a business name - All Users",
"currency_id_model": "currencies",
"owned_by_model": "owned_by_user",
"default_read_acl_group_id_model": "default_read_acl_groups",
"default_edit_acl_group_id_model": "default_edit_acl_groups",
"default_delete_acl_group_id_model": "default_delete_acl_groups",
"default_legal_acl_group_id_model": "default_legal_acl_group",
"default_accounting_acl_group_id_model": "default_accounting_acl_group",
"default_support_acl_group_id_model": "default_support_acl_group",
"temporary_acl": [],
"message_error": "",
"inherited_read_acl": "",
"inherited_acl_from_models": "",
"login_image": {
"deleted": 0
},
"organization_image": {
"deleted": 0
},
"favicon_image": {
"deleted": 0
},
"organization_accounts": {
"deleted": 0
},
"organization_locations": [],
"organization_ip_addresses": [],
"organization_mail_server_settings": [],
"app_image": {
"deleted": 0
}
}
},
"errors": [],
"message": [],
"onboarding_steps": [
// multiple form body
],
"onboarding_status": "inprogress",
"primary_key": "id",
"display_field": "name",
"model": "organizations",
"permissions": [],
"form": {
// above form body
},
"inherit_views": 1,
"alias": "users",
"singular": "user",
"controllerClass": "\\module\\access_controls\\controller\\users",
"modelClass": "\\module\\access_controls\\model\\users",
"notEmptyField": {
"organizations": {
"name": "name",
"currency_id": "currency_id",
"email": "email",
"organization_image.organization_logo": "organization_image.organization_logo",
"login_image": [],
"organization_image": [],
"favicon_image": [],
"organization_accounts": {
"name": "name",
"current_fiscal_year_start_date": "current_fiscal_year_start_date",
"current_fiscal_year_closing_date": "current_fiscal_year_closing_date"
},
"organization_locations": {
"latitude": "latitude",
"longitude": "longitude",
"radius": "radius",
"name": "name"
},
"organization_ip_addresses": {
"ip_start": "ip_start",
"ip_end": "ip_end",
"name": "name"
},
"organization_mail_server_settings": {
"server_type": "server_type",
"encryption_type": "encryption_type",
"mail_server": "mail_server",
"port": "port"
},
"app_image": []
},
"login_image": [],
"organization_image": [],
"favicon_image": [],
"organization_accounts": {
"name": "name",
"current_fiscal_year_start_date": "current_fiscal_year_start_date",
"current_fiscal_year_closing_date": "current_fiscal_year_closing_date"
},
"organization_locations": {
"latitude": "latitude",
"longitude": "longitude",
"radius": "radius",
"name": "name"
},
"organization_ip_addresses": {
"ip_start": "ip_start",
"ip_end": "ip_end",
"name": "name"
},
"organization_mail_server_settings": {
"server_type": "server_type",
"encryption_type": "encryption_type",
"mail_server": "mail_server",
"port": "port"
},
"app_image": []
},
"organization_name": null,
"organization_id": "1",
"user_id": "1",
"user_fullname": "User fullname"
}
Submit onboarding form
Request
POST /access_controls/users/onboarding.json
Payload
data[normalized]: 1
data[action][save]: Next
data[organizations][email]: jacky@fiyge.com
data[organizations][primary_phone_number]: 00000000
data[organizations][primary_address_line_1]: Address line 1
data[organizations][primary_address_line_2]: Address line 2
data[organizations][primary_city]: City
data[organizations][primary_state]: State
data[organizations][primary_country]: 1
data[organizations][__primary_country]: Canada
data[organizations][primary_country_model]
data[organizations][primary_zip]: 000000
data[organizations][organization_image][id]
data[organizations][organization_image][__id]: company_logo.jpg
data[organizations][organization_image][organization_logo]: (binary)
data[form_id]: 677b50d9-fc64-4e9b-a4cf-4774ac69033c
data[organizations][id]: 1
Response
Example Response
{
"data": {
"normalized": "1",
"action": {
"save": "Next"
},
"organizations": {
"email": "jacky@fiyge.com",
"primary_phone_number": "00000000",
"primary_address_line_1": "Address line 1",
"primary_address_line_2": "Address line 2",
"primary_city": "City",
"primary_state": "State",
"primary_country": "38",
"__primary_country": "Canada",
"primary_country_model": "",
"primary_zip": "000000",
"organization_image": {
"0": {
"name": "company_logo.jpg",
"field_type": "organization_logo",
"type": "image/jpeg",
"tmp_name": "/tmp/phpqvPZt0",
"error": 0,
"related_to_model": ""
},
"id": "",
"__id": "company_logo.jpg"
},
"id": "379"
},
"form_id": "677b50d9-fc64-4e9b-a4cf-4774ac69033c"
},
"errors": [],
"message": [],
"onboarding_steps": [
// multiple form body
],
"onboarding_status": "pending",
"primary_key": "id",
"display_field": "name",
"model": "organizations",
"model_class": "\\module\\crm_base\\model\\organizations",
"permissions": [],
"form": {
// form body
},
"inherit_views": 1,
"alias": "users",
"singular": "user",
"controllerClass": "\\module\\access_controls\\controller\\users",
"modelClass": "\\module\\access_controls\\model\\users",
"notEmptyField": {
"organizations": {
"name": "name",
"currency_id": "currency_id",
"email": "email",
"organization_image.organization_logo": "organization_image.organization_logo"
},
"login_image": [],
"organization_image": {
"name": "name"
},
"favicon_image": [],
"organization_accounts": {
"name": "name",
"current_fiscal_year_start_date": "current_fiscal_year_start_date",
"current_fiscal_year_closing_date": "current_fiscal_year_closing_date"
},
"organization_locations": {
"latitude": "latitude",
"longitude": "longitude",
"radius": "radius",
"name": "name"
},
"organization_ip_addresses": {
"ip_start": "ip_start",
"ip_end": "ip_end",
"name": "name"
},
"organization_mail_server_settings": {
"server_type": "server_type",
"encryption_type": "encryption_type",
"mail_server": "mail_server",
"port": "port"
},
"app_image": [],
"groups": {
"name": "name"
}
},
"organization_name": null,
"organization_id": "1",
"user_id": "1",
"user_fullname": "User fullname"
}
Multistep Onboarding Form
The onboarding form may consist of multiple parts, where only one part of the form is given to the user every time. When proceeding to the next part, users have to provide the form_id in the request payload. Requerying endpoint GET /access_controls/users/onboarding.json will give user the next part of the form
Additional Request Params
form_idis a unique identifier for FIYGE to identify the corresponding form
Example Request
data[normalized]: 1
data[action][save]: Next
data[organizations][email]: example@gmail.com
data[organizations][primary_phone_number]: 0000000000
data[organizations][primary_address_line_1]: Primary Address Line 1
data[organizations][primary_address_line_2]: Primary Address Line 2
data[organizations][primary_city]: Primary City
data[organizations][primary_state]: Primary State
data[organizations][primary_country]: 1
data[organizations][__primary_country]: Primary Country
data[organizations][primary_country_model]
data[organizations][primary_zip]: 000000
data[organizations][organization_image][id]
data[organizations][organization_image][__id]: company_logo.jpg
data[organizations][organization_image][organization_logo]: (binary)
data[form_id]: 47838c23-0108-470e-9088-cc38cce10d78
data[organizations][id]: 1
Additional Response Params
onboarding_statusis the current status of the onboarding form, can bepending,inprogressandcomplete
Example Response
Example Response
{
"data": {
"normalized": "1",
"action": {
"save": "Next"
},
"organizations": {
"email": "example@gmail.com",
"primary_phone_number": "",
"primary_address_line_1": "",
"primary_address_line_2": "",
"primary_city": "",
"primary_state": "",
"primary_country": "",
"__primary_country": "",
"primary_country_model": "",
"primary_zip": "",
"organization_image": {
"0": {
"name": "company_logo.jpg",
"field_type": "organization_logo",
"type": "image/jpeg",
"tmp_name": "/tmp/phpsITtTg",
"error": 0,
"related_to_model": ""
},
"id": "",
"__id": "company_logo.jpg"
},
"id": "380"
},
"form_id": "47838c23-0108-470e-9088-cc38cce10d78"
},
"errors": [],
"message": [],
"onboarding_steps": [
// multiple form body
],
"onboarding_status": "pending",
"primary_key": "id",
"display_field": "name",
"permissions": [],
"form": {
// ...rest of the form body
},
"inherit_views": 1,
"alias": "users",
"singular": "user",
"controllerClass": "\\module\\access_controls\\controller\\users",
"modelClass": "\\module\\access_controls\\model\\users",
"notEmptyField": {
"organizations": {
"name": "name",
"currency_id": "currency_id",
"email": "email",
"organization_image.organization_logo": "organization_image.organization_logo"
},
"login_image": [],
"organization_image": {
"name": "name"
},
"favicon_image": [],
"organization_accounts": {
"name": "name",
"current_fiscal_year_start_date": "current_fiscal_year_start_date",
"current_fiscal_year_closing_date": "current_fiscal_year_closing_date"
},
"organization_locations": {
"latitude": "latitude",
"longitude": "longitude",
"radius": "radius",
"name": "name"
},
"organization_ip_addresses": {
"ip_start": "ip_start",
"ip_end": "ip_end",
"name": "name"
},
"organization_mail_server_settings": {
"server_type": "server_type",
"encryption_type": "encryption_type",
"mail_server": "mail_server",
"port": "port"
},
"app_image": [],
"groups": {
"name": "name"
}
},
"organization_name": null,
"organization_id": "1",
"user_id": "1",
"user_fullname": "User fullname"
}